doxy: converted TPC/ main dir

[u/mrichter/AliRoot.git] / TPC / AliTPCEfield.h

diff --git a/TPC/AliTPCEfield.h b/TPC/AliTPCEfield.h
index 46408e60f703ca9fb0947dc31bf8daee62eef972..e32ea68461a0c140333a6cc25102600a08068d0b 100644 (file)
--- a/TPC/AliTPCEfield.h
+++ b/TPC/AliTPCEfield.h
@@ -4,8 +4,8 @@
 /* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
  * See cxx source for full Copyright notice                               */
 
-/* $Id: AliTPCEfield.h 35613 2009-10-16 03:24:40Z marian $ */
-
+/// \class AliTPCEfield
+/// \brief Calculation of the electric field
 
 #include "TNamed.h"
 #include "TMatrixD.h"
@@ -21,7 +21,8 @@ public:
   void SetRange(Double_t x0, Double_t x1, Double_t y0, Double_t y1, Double_t z00,Double_t z1=0);
   void AddBoundaryLine(Double_t x0,Double_t y0, Double_t z0, Double_t v0, Double_t x1, Double_t y1, Double_t z1, Double_t v1, Int_t id=0, Int_t npoints=100);
   TTree * GetTree(const char * tname="Boundary");
-  //
+/// \class AliTPCEfield
+
   void MakeFitFunctions(Int_t maxFreq);
   void FitField();
   void DumpField(Double_t gridSize=5, Double_t step=0.5);
@@ -40,19 +41,19 @@ public:
   Double_t SinHNorm(Double_t x, Double_t norm){ return 0.5*(TMath::Exp(x-norm)-TMath::Exp(-x-norm));}
   Double_t CosHNorm(Double_t x, Double_t norm){ return 0.5*(TMath::Exp(x-norm)+TMath::Exp(-x-norm));}
  public:
-  Double_t fMin[3];      // range of coordinates from Min to Max
-  Double_t fMax[3];      //  
-  Double_t fScale;       // scaling factor
-  Int_t    fMaxFreq;     // maximal frequency of expansion
-  Bool_t   fIs2D;        // flag for 2D field
-  Bool_t   fUseLinear;   // flag to use also linear term of the field 
+  Double_t fMin[3];      ///< range of coordinates from Min to Max
+  Double_t fMax[3];      ///< 
+  Double_t fScale;       ///< scaling factor
+  Int_t    fMaxFreq;     ///< maximal frequency of expansion
+  Bool_t   fIs2D;        ///< flag for 2D field
+  Bool_t   fUseLinear;   ///< flag to use also linear term of the field
   //
-  TTreeSRedirector * fWorkspace;    //! workspace
-  TMatrixD  *fFitFunctions;         // fit function description
-  TVectorD  *fFitParam;             // fit parameters - coeficients
-  TMatrixD  *fFitCovar;             // fit covariance
-  TLinearFitter *fFitter;           // linear fitter - temporary solution - integrals to be calculated
-  static AliTPCEfield* fgInstance;  // instance of fied  - for visualization
+  TTreeSRedirector * fWorkspace;    //!< workspace
+  TMatrixD  *fFitFunctions;         ///< fit function description
+  TVectorD  *fFitParam;             ///< fit parameters - coeficients
+  TMatrixD  *fFitCovar;             ///< fit covariance
+  TLinearFitter *fFitter;           ///< linear fitter - temporary solution - integrals to be calculated
+  static AliTPCEfield* fgInstance;  ///< instance of fied  - for visualization
   ClassDef(AliTPCEfield,1)
 };