doxy: TPC/TPCbase converted

[u/mrichter/AliRoot.git] / TPC / TPCbase / AliTPCROCVoltError3D.h

diff --git a/TPC/TPCbase/AliTPCROCVoltError3D.h b/TPC/TPCbase/AliTPCROCVoltError3D.h
index 93a6c9efb328b75d5f2d9607e6a9c76e2c95d4bd..8051e6045405ca01811319f2789f097a5a89a1be 100644 (file)
--- a/TPC/TPCbase/AliTPCROCVoltError3D.h
+++ b/TPC/TPCbase/AliTPCROCVoltError3D.h
@@ -4,10 +4,8 @@
 /* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
  * See cxx source for full Copyright notice                               */
 
-////////////////////////////////////////////////////////////////////////////
-// AliTPCROCVoltError3D class                                             //
-// Authors: Jim Thomas, Stefan Rossegger                                  //
-////////////////////////////////////////////////////////////////////////////
+/// \class AliTPCROCVoltError3D
+/// \author Jim Thomas, Stefan Rossegger
 
 #include "AliTPCCorrection.h"
 #include "TH2F.h"
@@ -32,33 +30,33 @@ public:
   Float_t GetC0() const {return fC0;}
   Float_t GetC1() const {return fC1;}
   void SetROCData(TMatrixD * matrix);
-  // setters and getters 
+  // setters and getters
   void SetROCDataFileName(const char * fname);
   const Char_t* GetROCDataFileName() const {return fROCDataFileName.Data();}
 
-  // flag to wheter or not include the z aligment in the dz calculation 
+  // flag to wheter or not include the z aligment in the dz calculation
   // if FALSE, the dz offset is purely due to the electric field change
-  void SetROCDisplacement(Bool_t flag) { 
+  void SetROCDisplacement(Bool_t flag) {
     if (flag!=fROCdisplacement) { fROCdisplacement = flag; fInitLookUp=kFALSE; }
   }
   Bool_t GetROCDisplacement() const { return fROCdisplacement; }
-  
+
   // flag on wheter to consider the difference in the electron arrival between IROC and OROC
   // due to the different position of the Anode wires
-  void SetElectronArrivalCorrection(Bool_t flag) { 
+  void SetElectronArrivalCorrection(Bool_t flag) {
     if (flag!=fElectronArrivalCorrection) { fElectronArrivalCorrection = flag; fInitLookUp=kFALSE; }
   }
   Bool_t GetElectronArrivalCorrection() const { return fElectronArrivalCorrection; }
 
 
   void InitROCVoltError3D(); // Fill the lookup tables
-  void ForceInitROCVoltError3D() { fInitLookUp=kFALSE; InitROCVoltError3D(); }; 
+  void ForceInitROCVoltError3D() { fInitLookUp=kFALSE; InitROCVoltError3D(); };
 
   Float_t GetROCVoltOffset(Int_t side, Float_t r0, Float_t phi0);
   TH2F* CreateHistoOfZAlignment(Int_t side, Int_t nx=250, Int_t ny=250);
 
   virtual void Print(const Option_t* option="") const;
-  TMatrixD *GetMatrix() const {return fdzDataLinFit;}  // Linear fits of dz survey points (each sector=72) (z0,slopeX,slopeY)         
+  TMatrixD *GetMatrix() const {return fdzDataLinFit;}  // Linear fits of dz survey points (each sector=72) (z0,slopeX,slopeY)
 
 protected:
   virtual void GetCorrection(const Float_t x[],const Short_t roc,Float_t dx[]);
@@ -68,32 +66,34 @@ private:
   AliTPCROCVoltError3D(const AliTPCROCVoltError3D &);               // not implemented
   AliTPCROCVoltError3D &operator=(const AliTPCROCVoltError3D &);    // not implemented
 
-  Float_t fC0; // coefficient C0           (compare Jim Thomas's notes for definitions)
-  Float_t fC1; // coefficient C1           (compare Jim Thomas's notes for definitions)
+  Float_t fC0; ///< coefficient C0           (compare Jim Thomas's notes for definitions)
+  Float_t fC1; ///< coefficient C1           (compare Jim Thomas's notes for definitions)
 
-  Bool_t fROCdisplacement;      // flag on wheter to consider the ROC displacement 
+  Bool_t fROCdisplacement;      ///< flag on wheter to consider the ROC displacement
                                 // when calculating the z distortions
-  Bool_t fElectronArrivalCorrection; // flag on wheter to consider the difference 
+  Bool_t fElectronArrivalCorrection; ///< flag on wheter to consider the difference
                                       // in the electron arrival between IROC and OROC
                                       // due to the different position of the Anode wires
 
-  Bool_t fInitLookUp;           // flag to check it the Look Up table was created (SUM)
+  Bool_t fInitLookUp;           ///< flag to check it the Look Up table was created (SUM)
 
-  TMatrixF *fLookUpErOverEz[kNPhi];   // Array to store electric field integral (int Er/Ez)
-  TMatrixF *fLookUpEphiOverEz[kNPhi]; // Array to store electric field integral (int Er/Ez)
-  TMatrixF *fLookUpDeltaEz[kNPhi];    // Array to store electric field integral (int Er/Ez)
+  TMatrixF *fLookUpErOverEz[kNPhi];   ///< Array to store electric field integral (int Er/Ez)
+  TMatrixF *fLookUpEphiOverEz[kNPhi]; ///< Array to store electric field integral (int Er/Ez)
+  TMatrixF *fLookUpDeltaEz[kNPhi];    ///< Array to store electric field integral (int Er/Ez)
 
-  TString  fROCDataFileName;         // filename of the survey data containing the lin Fit values
-  TMatrixD *fdzDataLinFit;  // Linear fits of dz survey points (each sector=72) (z0,slopeX,slopeY)         
+  TString  fROCDataFileName;         ///< filename of the survey data containing the lin Fit values
+  TMatrixD *fdzDataLinFit;  ///< Linear fits of dz survey points (each sector=72) (z0,slopeX,slopeY)
 
   // basic numbers for the poisson relaxation //can be set individually in each class
   enum {kRows   =257}; // grid size in r direction used in the poisson relaxation // ( 2**n + 1 ) eg. 65, 129, 257 etc.
   enum {kColumns=129}; // grid size in z direction used in the poisson relaxation // ( 2**m + 1 ) eg. 65, 129, 257 etc.
   enum {kPhiSlicesPerSector=10};  // phi slices per sector
   enum {kPhiSlices = 18*kPhiSlicesPerSector };    // number of points in phi for the basic lookup tables
-  enum {kIterations=100}; // Number of iterations within the poisson relaxation 
+  enum {kIterations=100}; // Number of iterations within the poisson relaxation
 
-  ClassDef(AliTPCROCVoltError3D,2); 
+  /// \cond CLASSIMP
+  ClassDef(AliTPCROCVoltError3D,2);
+  /// \endcond
 };
 
 #endif