- added TPCLib to doxygen docu, code corrections according to documentation and effC++
[u/mrichter/AliRoot.git] / HLT / TPCLib / AliHLTTPCTransform.h
1 // @(#) $Id$
2 // Original: AliL3Transform.h,v 1.37 2005/06/14 10:55:21 cvetan 
3
4 #ifndef ALIHLTTPCTRANSFORM_H
5 #define ALIHLTTPCTRANSFORM_H
6
7 #ifdef use_aliroot
8   class AliRunLoader;
9 #endif
10
11 #include "AliHLTTPCRootTypes.h"
12
13 class AliHLTTPCTransform {
14
15  public:
16     AliHLTTPCTransform();
17   enum VersionType { kVdefault=0, kVdeprecated=1, kValiroot=10, kVcosmics=100};
18
19  private:
20   static const Double_t fgkBFACT; //bfield
21   static const Double_t fgkPi;    //pi
22   static const Double_t fgkPi2;   //2pi
23   static const Double_t fgk2Pi;   //pi/2
24   static const Double_t fgkAnodeWireSpacing; //anode wire spacing 
25   static const Double_t fgkToDeg; //rad to deg
26
27   static Int_t fgNPatches;   //6 (dont change this) 
28   static Int_t fgRows[6][2]; //rows per patch
29   static Int_t fgNRows[6];   //rows per patch
30
31   static Double_t fgBField;         //field
32   static Double_t fgBFieldFactor;   //field 
33   static Double_t fgSolenoidBField; //field
34   static Int_t fgNTimeBins;  //ntimebins
35   static Int_t fgNRowLow;    //nrows
36   static Int_t fgNRowUp;     //nrows
37   static Int_t fgNRowUp1;    //nrows
38   static Int_t fgNRowUp2;    //nrows
39   static Int_t fgNSectorLow; //nsector
40   static Int_t fgNSectorUp;  //nsector
41   static Int_t fgSlice2Sector[36][2]; //nslice
42   static Int_t fgSector2Slice[72];    //nslice
43   static Int_t fgSectorLow[72];       //nsector
44   static Double_t fgPadPitchWidthLow; //pad pitch
45   static Double_t fgPadPitchWidthUp;  //pad pitch
46   static Double_t fgZWidth;  //width
47   static Double_t fgZSigma;  //sigma
48   static Double_t fgZLength; //length
49   static Double_t fgZOffset; //offset
50   static Int_t fgNSector; //72  (dont change this)
51   static Int_t fgNSlice;  //36  (dont change this)
52   static Int_t fgNRow;    //159 (dont change this)
53   static Double_t fgNRotShift; //Rotation shift (eg. 0.5 for 10 degrees)
54   static Int_t fgNPads[159]; //fill this following Init and fVersion
55   static Double_t fgX[159];  //X position in local coordinates
56   static Int_t fgVersion;  //flags the version
57   static Double_t fgDiffT; //Transversal diffusion constant
58   static Double_t fgDiffL; //Longitudinal diffusion constant
59   static Double_t fgOmegaTau; //ExB effects
60   static Double_t fgInnerPadLength;  //innner pad length
61   static Double_t fgOuter1PadLength; //outer pad length
62   static Double_t fgOuter2PadLength; //outer pad length
63   static Double_t fgInnerPRFSigma;   //inner pad response function
64   static Double_t fgOuter1PRFSigma;  //outer pad response function
65   static Double_t fgOuter2PRFSigma;  //outer pad response function
66   static Double_t fgTimeSigma; //Minimal longitudinal width
67   static Int_t fgADCSat; //ADC Saturation (1024 = 10 bit)
68   static Int_t fgZeroSup; //Zero suppression threshold
69   static Double_t fgCos[36]; //stores the cos value for local to global rotations  
70   static Double_t fgSin[36]; //stores the sin value for local to global rotations  
71
72  public:
73   virtual ~AliHLTTPCTransform() {}
74 #ifdef use_aliroot
75   static Bool_t Init(AliRunLoader *runLoader); //init transformer params using a run loader
76 #endif
77   static Bool_t Init(Char_t* path,Bool_t UseAliTPCParam=kFALSE); //init transformer settings (versions)
78   static Bool_t MakeInitFile(Char_t *rootfilename,Char_t *filename); //create the init file from rootfile
79   static Bool_t ReadInit(Char_t *path);         //read init (possibly from root file)
80   static Bool_t ReadInitFile(Char_t *path);     //read init from text file 
81   static Bool_t SaveInitFile(Char_t *filename); //save parameters in init file
82
83   //setters
84   static void SetNPatches(Int_t i){fgNPatches = i;}
85   static void SetNRows(Int_t s[6]){for(Int_t i=0;i<fgNPatches;i++) fgNRows[i] = s[i];}
86   static void SetRows(Int_t s[6][2]){
87     for(Int_t i=0;i<fgNPatches;i++){
88       fgRows[i][0] = s[i][0];
89       fgRows[i][1] = s[i][1];
90     }
91   }
92   static void SetBField(Double_t f) {fgBField = f;} //careful, these 3 are not independent!
93   static void SetBFieldFactor(Double_t f) {
94     fgBFieldFactor = f;
95     fgBField=fgBFieldFactor*fgSolenoidBField*0.1;
96   }
97   static void SetSolenoidBField(Double_t f){
98     fgSolenoidBField = f;
99     fgBField=fgBFieldFactor*fgSolenoidBField*0.1;
100   }
101   static void SetNTimeBins(Int_t i){fgNTimeBins = i;}
102   static void SetNRowLow(Int_t i){fgNRowLow = i;}
103   static void SetNRowUp(Int_t i){fgNRowUp = i;}
104   static void SetNRowUp1(Int_t i){fgNRowUp1 = i;}
105   static void SetNRowUp2(Int_t i){fgNRowUp2 = i;}
106   static void SetSlice2Sector(Int_t s[36][2]){
107     for(Int_t i=0;i<fgNSlice;i++){
108       fgSlice2Sector[i][0] = s[i][0];
109       fgSlice2Sector[i][1] = s[i][1];
110     }
111   }
112   static void SetSector2Slice(Int_t s[72]){
113     for(Int_t i=0;i<fgNSector;i++) fgSector2Slice[i] = s[i];}
114   static void SetSectorLow(Int_t s[72]){
115     for(Int_t i=0;i<fgNSector;i++) fgSectorLow[i] = s[i];}
116   static void SetNSectorLow(Int_t i){fgNSectorLow = i;}
117   static void SetNSectorUp(Int_t i){fgNSectorUp = i;}
118   static void SetPadPitchWidthLow(Double_t f){fgPadPitchWidthLow = f;}
119   static void SetPadPitchWidthUp(Double_t f){fgPadPitchWidthUp = f;}
120   static void SetZWidth(Double_t f){fgZWidth = f;}
121   static void SetZSigma(Double_t f){fgZSigma = f;}
122   static void SetZLength(Double_t f){fgZLength = f;}
123   static void SetZOffset(Double_t f){fgZOffset = f;}
124   static void SetNSector(Int_t i){fgNSector = i;}
125   static void SetNSlice(Int_t i){fgNSlice = i;}
126   static void SetNRow(Int_t i){fgNRow = i;}
127   static void SetNRotShift(Double_t f){fgNRotShift = f;}
128   static void SetNPads(Int_t pads[159]){
129     for(Int_t i=0;i<fgNRow;i++) fgNPads[i] = pads[i];}
130   static void SetX(Double_t xs[159]){
131     for(Int_t i=0;i<fgNRow;i++) fgX[i] = xs[i];}
132   static void SetVersion(Int_t i){fgVersion = i;}
133   static void SetDiffT(Double_t f){fgDiffT = f;}
134   static void SetDiffL(Double_t f){fgDiffL = f;}
135   static void SetOmegaTau(Double_t f){fgOmegaTau = f;}
136   static void SetInnerPadLength(Double_t f){fgInnerPadLength = f;}
137   static void SetOuter1PadLength(Double_t f){fgOuter1PadLength = f;}
138   static void SetOuter2PadLength(Double_t f){fgOuter2PadLength = f;}
139   static void SetInnerPRFSigma(Double_t f){fgInnerPRFSigma = f;}
140   static void SetOuter1PRFSigma(Double_t f){fgOuter1PRFSigma = f;}
141   static void SetOuter2PRFSigma(Double_t f){fgOuter2PRFSigma = f;}
142   static void SetTimeSigma(Double_t f){fgTimeSigma = f;}
143   static void SetADCSat(Int_t i) {fgADCSat = i;}
144   static void SetZeroSup(Int_t i) {fgZeroSup = i;}
145
146   //getters
147   static const Char_t* GetParamName() {return "75x40_100x60_150x60";}
148   static Double_t Pi()     {return fgkPi;}
149   static Double_t PiHalf() {return fgkPi2;}
150   static Double_t TwoPi()  {return fgk2Pi;}
151   static Double_t GetAnodeWireSpacing() {return fgkAnodeWireSpacing;}
152   static Double_t GetBFact() {return fgkBFACT;}
153   static Double_t ToRad() {return 1./fgkToDeg;}
154   static Double_t ToDeg() {return fgkToDeg;}
155
156   static Int_t GetNumberOfPatches();
157   static Int_t GetFirstRow(Int_t patch);
158   static Int_t GetLastRow(Int_t patch);
159   static Int_t GetFirstRowOnDDL(Int_t patch);
160   static Int_t GetLastRowOnDDL(Int_t patch);
161   static Int_t GetNRows(Int_t patch);
162   static Int_t GetPatch(Int_t padrow);
163   static Int_t GetNRows() {return fgNRow;}
164   static Int_t GetNRowLow() {return fgNRowLow;}
165   static Int_t GetNRowUp1() {return fgNRowUp1;}
166   static Int_t GetNRowUp2() {return fgNRowUp2;}
167   static Int_t GetPadRow(Float_t x);
168   static Int_t GetNPatches() {return fgNPatches;}
169   static Int_t GetNPads(Int_t row);
170   static Int_t GetNTimeBins(){return fgNTimeBins;}
171   static Double_t GetBField() {return fgBField;}
172   static Double_t GetSolenoidField() {return fgSolenoidBField;}
173   static Double_t GetBFactFactor() {return fgBFieldFactor;}
174   static Double_t GetBFieldValue() {return (fgBField*fgkBFACT);}
175   static Float_t Deg2Rad(Float_t angle) {return angle/fgkToDeg;}
176   static Float_t Rad2Deg(Float_t angle) {return angle*fgkToDeg;}
177   static Int_t GetVersion(){return fgVersion;}
178   static Double_t GetPadPitchWidthLow() {return fgPadPitchWidthLow;}
179   static Double_t GetPadPitchWidthUp() {return fgPadPitchWidthUp;}
180   static Double_t GetPadPitchWidth(Int_t patch);
181   static Double_t GetZWidth() {return fgZWidth;}
182   static Double_t GetZLength() {return fgZLength;}
183   static Double_t GetZOffset() {return fgZOffset;}
184   static Double_t GetDiffT() {return fgDiffT;}
185   static Double_t GetDiffL() {return fgDiffL;}
186   static Double_t GetParSigmaY2(Int_t padrow,Float_t z,Float_t angle);
187   static Double_t GetParSigmaZ2(Int_t padrow,Float_t z,Float_t tgl);
188   static Double_t GetOmegaTau() {return fgOmegaTau;}
189   static Double_t GetPadLength(Int_t padrow);
190   static Double_t GetPRFSigma(Int_t padrow);
191   static Double_t GetTimeSigma() {return fgTimeSigma;}
192   static Double_t GetZSigma() {return fgZSigma;}
193   static Int_t GetADCSat() {return fgADCSat;}
194   static Int_t GetZeroSup() {return fgZeroSup;}
195   static Int_t GetNSlice() {return fgNSlice;}
196   static Int_t GetNSector() {return fgNSector;}
197   static Int_t GetNSectorLow() {return fgNSectorLow;}
198   static Int_t GetNSectorUp() {return fgNSectorUp;}
199   
200   static Bool_t Slice2Sector(Int_t slice, Int_t slicerow, Int_t &sector, Int_t &row);
201   static Bool_t Sector2Slice(Int_t &slice, Int_t sector);
202   static Bool_t Sector2Slice(Int_t &slice, Int_t &slicerow, Int_t sector, Int_t row);
203
204   static Double_t Row2X(Int_t slicerow);
205   static Double_t GetMaxY(Int_t slicerow);
206   static Double_t GetEta(Float_t *xyz);
207   static Double_t GetEta(Int_t slice,Int_t padrow, Int_t pad, Int_t time);
208   static Double_t GetPhi(Float_t *xyz);
209   static Double_t GetZFast(Int_t slice, Int_t time, Float_t vertex=0.);
210
211   static void XYZtoRPhiEta(Float_t *rpe, Float_t *xyz);
212   static void Local2Global(Float_t *xyz, Int_t slice);
213   static void Local2GlobalAngle(Float_t *angle, Int_t slice);
214   static void Global2LocalAngle(Float_t *angle, Int_t slice);
215
216   //we have 3 different system: Raw   : row, pad, time
217   //                            Local : x,y and global z
218   //                            Global: global x,y and global z
219   //the methods with HLT in the name differ from the other
220   //as you specify slice and slicerow, instead of sector
221   //and sector row. In that way we safe "a few ifs"
222   static void Raw2Local(Float_t *xyz, Int_t sector, Int_t row, Float_t pad, Float_t time);
223   static void RawHLT2Local(Float_t *xyz,Int_t slice,Int_t slicerow,Float_t pad,Float_t time);
224   static void Raw2Local(Float_t *xyz, Int_t sector, Int_t row, Int_t pad, Int_t time);
225   static void RawHLT2Local(Float_t *xyz,Int_t slice,Int_t slicerow,Int_t pad,Int_t time);
226   static void Local2Global(Float_t *xyz, Int_t sector, Int_t row);
227   static void LocHLT2Global(Float_t *xyz, Int_t slice, Int_t slicerow);
228   static void Global2Local(Float_t *xyz, Int_t sector);
229   static void Global2LocHLT(Float_t *xyz, Int_t slice);
230   static void Raw2Global(Float_t *xyz, Int_t sector, Int_t row, Float_t pad, Float_t time);
231   static void RawHLT2Global(Float_t *xyz, Int_t slice, Int_t slicerow, Float_t pad, Float_t time);
232   static void Raw2Global(Float_t *xyz, Int_t sector, Int_t row, Int_t pad, Int_t time);
233   static void RawHLT2Global(Float_t *xyz, Int_t slice, 
234                             Int_t slicerow, Int_t pad, Int_t time);
235   static void Local2Raw(Float_t *xyz, Int_t sector, Int_t row);
236   static void LocHLT2Raw(Float_t *xyz, Int_t slice, Int_t slicerow);
237   static void Global2Raw(Float_t *xyz, Int_t sector, Int_t row);
238   static void Global2HLT(Float_t *xyz, Int_t slice, Int_t slicerow);
239
240   static void PrintCompileOptions();
241   
242   ClassDef(AliHLTTPCTransform,1)
243 };
244 #endif