Updated comments for Doxygen
[u/mrichter/AliRoot.git] / MUON / AliMUONAlignment.h
index 1701bb7..5e12c18 100644 (file)
@@ -29,6 +29,7 @@ public:
   virtual ~AliMUONAlignment();
 
   void ProcessTrack(AliMUONTrack *track);
+  /// Set geometry transformer
   void SetGeometryTransformer(AliMUONGeometryTransformer * transformer) {
     fTransform = transformer;
   }
@@ -44,9 +45,11 @@ public:
   void SetNonLinear(Int_t param);
   void AddConstraint(Double_t *factor, Double_t value );
   void InitGlobalParameters(Double_t *par);   
+  /// Set array of local derivatives
   void SetLocalDerivative(Int_t index, Double_t value) {      
     fLocalDerivatives[index] = value;
   }
+  /// Set array of global derivatives
   void SetGlobalDerivative(Int_t index, Double_t value) {
     fGlobalDerivatives[index] = value;
   }  
@@ -58,12 +61,11 @@ public:
   AliMUONGeometryTransformer* 
     ReAlign(const AliMUONGeometryTransformer * transformer, double *misAlignments, Bool_t verbose);
 
- protected:
+ private:
+  /// Not implemented
   AliMUONAlignment(const AliMUONAlignment& right);
+  /// Not implemented
   AliMUONAlignment&  operator = (const AliMUONAlignment& right);
-  
- private:
 
   void Init(Int_t nGlobal, Int_t nLocal, Int_t nStdDev);
   void ConstrainT(Int_t lDetElem, Int_t lCh, Double_t *lConstraintT, Int_t iVar);
@@ -79,77 +81,77 @@ public:
 
   TGeoCombiTrans ReAlign(const TGeoCombiTrans& transform, double *detElemMisAlignment) const;
 
-  Bool_t fBFieldOn;        // Flag for Magnetic filed On/Off
+  Bool_t fBFieldOn;        ///< Flag for Magnetic filed On/Off
                                                                       
-  Bool_t fDoF[3];          // Flags degrees of freedom to align (x,y,phi)
-  Double_t fAllowVar[3];   // "Encouraged" variation for degrees of freedom 
-  Double_t fStartFac;      // Initial value for chi2 cut 
-                           // if > 1 Iterations in AliMillepede are turned on
-  Double_t fResCutInitial; // Cut on residual for first iteration
-  Double_t fResCut;        // Cut on residual for other iterations 
-
-  AliMillepede *fMillepede; // Detector independent alignment class
+  Bool_t fDoF[3];          ///< Flags degrees of freedom to align (x,y,phi)
+  Double_t fAllowVar[3];   ///< "Encouraged" variation for degrees of freedom 
+  Double_t fStartFac;      ///< Initial value for chi2 cut 
+                           ///< if > 1 Iterations in AliMillepede are turned on
+  Double_t fResCutInitial; ///< Cut on residual for first iteration
+  Double_t fResCut;        ///< Cut on residual for other iterations 
+
+  AliMillepede *fMillepede; ///< Detector independent alignment class
   
-  TClonesArray *fTrackParamAtHit; // Array of track parameters 
-  TClonesArray *fHitForRecAtHit;  // Array of track hits 
-  AliMUONTrack *fTrack;           // AliMUONTrack 
-  AliMUONHitForRec *fRecHit;      // AliMUONHitForRec
-  AliMUONTrackParam *fTrackParam; // Track parameters 
-
-  Int_t fNGlobal;  // Number of global parameters
-  Int_t fNLocal;   // Number of local parameters
-  Int_t fNStdDev;  // Number of standard deviations for chi2 cut
-  Double_t fClustPos[3];    // Cluster position
-  Double_t fClustPosLoc[3]; // Cluster position in local coordinates
-  Double_t fTrackSlope0[2]; // Track slope at reference point
-  Double_t fTrackSlope[2];  // Track slope at current point
-  Double_t fTrackPos0[3];   // Track intersection at reference point
-  Double_t fTrackPos[3];    // Track intersection at current point
-  Double_t fTrackPosLoc[3]; // Track intersection at current point in local coordinates 
-  Double_t fMeas[2];        // Current measurement (depend on B field On/Off)  
-  Double_t fSigma[2];       // Estimated resolution on measurement
-
-  Double_t fGlobalDerivatives[468]; // Array of global derivatives
-  Double_t fLocalDerivatives[4];    // Array of local derivatives
-
-  Double_t fConstraintX[468];   // Array for constraint equation all X
-  Double_t fConstraintY[468];   // Array for constraint equation all Y
-  Double_t fConstraintP[468];   // Array for constraint equation all P
-  Double_t fConstraintXT[468];  // Array for constraint equation X Top half
-  Double_t fConstraintYT[468];  // Array for constraint equation Y Top half
-  Double_t fConstraintPT[468];  // Array for constraint equation P Top half
-  Double_t fConstraintXB[468];  // Array for constraint equation X Bottom half
-  Double_t fConstraintYB[468];  // Array for constraint equation Y Bottom half
-  Double_t fConstraintPB[468];  // Array for constraint equation P Bottom half
-  Double_t fConstraintXR[468];  // Array for constraint equation X Right half
-  Double_t fConstraintYR[468];  // Array for constraint equation Y Right half
-  Double_t fConstraintPR[468];  // Array for constraint equation P Right half
-  Double_t fConstraintXL[468];  // Array for constraint equation X Left half
-  Double_t fConstraintYL[468];  // Array for constraint equation Y Left half
-  Double_t fConstraintPL[468];  // Array for constraint equation P Left half
-  Double_t fConstraintX3[468];  // Array for constraint equation St3 X
-  Double_t fConstraintY3[468];  // Array for constraint equation St3 Y
-  Double_t fConstraintX4[468];  // Array for constraint equation St4 X
-  Double_t fConstraintY4[468];  // Array for constraint equation St4 Y
-  Double_t fConstraintP4[468];  // Array for constraint equation St4 P
-  Double_t fConstraintX5[468];  // Array for constraint equation St5 X
-  Double_t fConstraintY5[468];  // Array for constraint equation St5 Y
-
-  Int_t fDetElemId;        // Detection element id
-  Int_t fDetElemNumber;    // Detection element number
-  Double_t fPhi;           // Azimuthal tilt of detection element 
-  Double_t fCosPhi;        // Cosine of fPhi
-  Double_t fSinPhi;        // Sine of fPhi
-  Double_t fDetElemPos[3]; // Position of detection element
-
-  AliMUONGeometryTransformer *fTransform; // Geometry transformation
-
-  static Int_t fgNSt;            // Number tracking stations
-  static Int_t fgNCh;            // Number tracking chambers
-  static Int_t fgNParCh;         // Number of degrees of freedom per chamber
-  static Int_t fgNDetElem;       // Total number of detection elements
-  static Int_t fgNDetElemCh[10]; // Number of detection elements per chamber
-  static Int_t fgSNDetElemCh[10];// Sum of detection elements up to this chamber (inc)
+  TClonesArray *fTrackParamAtHit; ///< Array of track parameters 
+  TClonesArray *fHitForRecAtHit;  ///< Array of track hits 
+  AliMUONTrack *fTrack;           ///< AliMUONTrack 
+  AliMUONHitForRec *fRecHit;      ///< AliMUONHitForRec
+  AliMUONTrackParam *fTrackParam; ///< Track parameters 
+
+  Int_t fNGlobal;  ///< Number of global parameters
+  Int_t fNLocal;   ///< Number of local parameters
+  Int_t fNStdDev;  ///< Number of standard deviations for chi2 cut
+  Double_t fClustPos[3];    ///< Cluster position
+  Double_t fClustPosLoc[3]; ///< Cluster position in local coordinates
+  Double_t fTrackSlope0[2]; ///< Track slope at reference point
+  Double_t fTrackSlope[2];  ///< Track slope at current point
+  Double_t fTrackPos0[3];   ///< Track intersection at reference point
+  Double_t fTrackPos[3];    ///< Track intersection at current point
+  Double_t fTrackPosLoc[3]; ///< Track intersection at current point in local coordinates 
+  Double_t fMeas[2];        ///< Current measurement (depend on B field On/Off)  
+  Double_t fSigma[2];       ///< Estimated resolution on measurement
+
+  Double_t fGlobalDerivatives[468]; ///< Array of global derivatives
+  Double_t fLocalDerivatives[4];    ///< Array of local derivatives
+
+  Double_t fConstraintX[468];   ///< Array for constraint equation all X
+  Double_t fConstraintY[468];   ///< Array for constraint equation all Y
+  Double_t fConstraintP[468];   ///< Array for constraint equation all P
+  Double_t fConstraintXT[468];  ///< Array for constraint equation X Top half
+  Double_t fConstraintYT[468];  ///< Array for constraint equation Y Top half
+  Double_t fConstraintPT[468];  ///< Array for constraint equation P Top half
+  Double_t fConstraintXB[468];  ///< Array for constraint equation X Bottom half
+  Double_t fConstraintYB[468];  ///< Array for constraint equation Y Bottom half
+  Double_t fConstraintPB[468];  ///< Array for constraint equation P Bottom half
+  Double_t fConstraintXR[468];  ///< Array for constraint equation X Right half
+  Double_t fConstraintYR[468];  ///< Array for constraint equation Y Right half
+  Double_t fConstraintPR[468];  ///< Array for constraint equation P Right half
+  Double_t fConstraintXL[468];  ///< Array for constraint equation X Left half
+  Double_t fConstraintYL[468];  ///< Array for constraint equation Y Left half
+  Double_t fConstraintPL[468];  ///< Array for constraint equation P Left half
+  Double_t fConstraintX3[468];  ///< Array for constraint equation St3 X
+  Double_t fConstraintY3[468];  ///< Array for constraint equation St3 Y
+  Double_t fConstraintX4[468];  ///< Array for constraint equation St4 X
+  Double_t fConstraintY4[468];  ///< Array for constraint equation St4 Y
+  Double_t fConstraintP4[468];  ///< Array for constraint equation St4 P
+  Double_t fConstraintX5[468];  ///< Array for constraint equation St5 X
+  Double_t fConstraintY5[468];  ///< Array for constraint equation St5 Y
+
+  Int_t fDetElemId;        ///< Detection element id
+  Int_t fDetElemNumber;    ///< Detection element number
+  Double_t fPhi;           ///< Azimuthal tilt of detection element 
+  Double_t fCosPhi;        ///< Cosine of fPhi
+  Double_t fSinPhi;        ///< Sine of fPhi
+  Double_t fDetElemPos[3]; ///< Position of detection element
+
+  AliMUONGeometryTransformer *fTransform; ///< Geometry transformation
+
+  static Int_t fgNSt;            ///< Number tracking stations
+  static Int_t fgNCh;            ///< Number tracking chambers
+  static Int_t fgNParCh;         ///< Number of degrees of freedom per chamber
+  static Int_t fgNDetElem;       ///< Total number of detection elements
+  static Int_t fgNDetElemCh[10]; ///< Number of detection elements per chamber
+  static Int_t fgSNDetElemCh[10];///< Sum of detection elements up to this chamber (inc)
 
 ClassDef(AliMUONAlignment, 0)};