Coding conventions fixed
[u/mrichter/AliRoot.git] / STEER / STEERBase / AliMagWrapCheb.h
1
2 // Author: ruben.shahoyan@cern.ch   20/03/2007
3
4 ///////////////////////////////////////////////////////////////////////////////////
5 //                                                                               //
6 //  Wrapper for the set of mag.field parameterizations by Chebyshev polinomials  //
7 //  To obtain the field in cartesian coordinates/components use                  //
8 //    Field(double* xyz, double* bxyz);                                          //
9 //  For cylindrical coordinates/components:                                      //
10 //    FieldCyl(double* rphiz, double* brphiz)                                    //
11 //                                                                               //
12 //  The solenoid part is parameterized in the volume  R<500, -550<Z<550 cm       //
13 //                                                                               //
14 //  The region R<423 cm,  -343.3<Z<481.3 for 30kA and -343.3<Z<481.3 for 12kA    //
15 //  is parameterized using measured data while outside the Tosca calculation     //
16 //  is used (matched to data on the boundary of the measurements)                //
17 //                                                                               //
18 //  Two options are possible:                                                    //
19 //  1) _BRING_TO_BOUNDARY_ is defined in the AliCheb3D:                          //
20 //     If the querried point is outside of the validity region then the field    //
21 //     at the closest point on the fitted surface is returned.                   //
22 //  2) _BRING_TO_BOUNDARY_ is not defined in the AliCheb3D:                      //
23 //     If the querried point is outside of the validity region the return        //
24 //     value for the field components are set to 0.                              //
25 //                                                                               //
26 //  To obtain the field integral in the TPC region from given point to nearest   //
27 //  cathod plane (+- 250 cm) use:                                                //
28 //  GetTPCInt(double* xyz, double* bxyz);  for Cartesian frame                   //
29 //  or                                                                           //
30 //  GetTPCIntCyl(Double_t *rphiz, Double_t *b); for Cylindrical frame            //
31 //                                                                               //
32 //                                                                               //
33 //  The units are kiloGauss and cm.                                              //
34 //                                                                               //
35 ///////////////////////////////////////////////////////////////////////////////////
36
37 #ifndef ALIMAGWRAPCHEB_H
38 #define ALIMAGWRAPCHEB_H
39
40 #include <TMath.h>
41 #include <TNamed.h>
42 #include <TObjArray.h>
43 class AliCheb3D;
44
45 class TSystem;
46 class TArrayF;
47 class TArrayI;
48
49 class AliMagWrapCheb: public TNamed
50 {
51  public:
52   AliMagWrapCheb();
53   AliMagWrapCheb(const AliMagWrapCheb& src);
54   ~AliMagWrapCheb() {Clear();}
55   //
56   void       CopyFrom(const AliMagWrapCheb& src);
57   AliMagWrapCheb& operator=(const AliMagWrapCheb& rhs);
58   virtual void Clear(const Option_t * = "");
59   //
60   Int_t      GetNParamsSol()                              const {return fNParamsSol;}
61   Int_t      GetNSegZSol()                                const {return fNZSegSol;}
62   Float_t*   GetSegZSol()                                 const {return fSegZSol;}
63   //
64   Int_t      GetNParamsTPCInt()                           const {return fNParamsTPC;}
65   Int_t      GetNSegZTPCInt()                             const {return fNZSegTPC;}
66   //
67   Int_t      GetNParamsTPCRatInt()                        const {return fNParamsTPCRat;}
68   Int_t      GetNSegZTPCRatInt()                          const {return fNZSegTPCRat;}
69   //
70   Int_t      GetNParamsDip()                              const {return fNParamsDip;}
71   Int_t      GetNSegZDip()                                const {return fNZSegDip;}
72   //
73   Float_t    GetMaxZ()                                    const {return GetMaxZSol();}
74   Float_t    GetMinZ()                                    const {return fParamsDip ? GetMinZDip() : GetMinZSol();}
75   //
76   Float_t    GetMinZSol()                                 const {return fMinZSol;}
77   Float_t    GetMaxZSol()                                 const {return fMaxZSol;}
78   Float_t    GetMaxRSol()                                 const {return fMaxRSol;}
79   //
80   Float_t    GetMinZDip()                                 const {return fMinZDip;}
81   Float_t    GetMaxZDip()                                 const {return fMaxZDip;}
82   //
83   Float_t    GetMinZTPCInt()                              const {return fMinZTPC;}
84   Float_t    GetMaxZTPCInt()                              const {return fMaxZTPC;}
85   Float_t    GetMaxRTPCInt()                              const {return fMaxRTPC;}
86   //
87   Float_t    GetMinZTPCRatInt()                           const {return fMinZTPCRat;}
88   Float_t    GetMaxZTPCRatInt()                           const {return fMaxZTPCRat;}
89   Float_t    GetMaxRTPCRatInt()                           const {return fMaxRTPCRat;}
90   //
91   AliCheb3D* GetParamSol(Int_t ipar)                      const {return (AliCheb3D*)fParamsSol->UncheckedAt(ipar);}
92   AliCheb3D* GetParamTPCRatInt(Int_t ipar)                const {return (AliCheb3D*)fParamsTPCRat->UncheckedAt(ipar);}
93   AliCheb3D* GetParamTPCInt(Int_t ipar)                   const {return (AliCheb3D*)fParamsTPC->UncheckedAt(ipar);}
94   AliCheb3D* GetParamDip(Int_t ipar)                      const {return (AliCheb3D*)fParamsDip->UncheckedAt(ipar);}
95   //
96   virtual void Print(Option_t * = "")                     const;
97   //
98   virtual void Field(const Double_t *xyz, Double_t *b)    const;
99   Double_t     GetBz(const Double_t *xyz)                 const;
100   //
101   void FieldCyl(const Double_t *rphiz, Double_t  *b)      const;  
102   void GetTPCInt(const Double_t *xyz, Double_t *b)        const;
103   void GetTPCIntCyl(const Double_t *rphiz, Double_t *b)   const;
104   void GetTPCRatInt(const Double_t *xyz, Double_t *b)     const;
105   void GetTPCRatIntCyl(const Double_t *rphiz, Double_t *b) const;
106   //
107   Int_t       FindSolSegment(const Double_t *xyz)         const; 
108   Int_t       FindTPCSegment(const Double_t *xyz)         const; 
109   Int_t       FindTPCRatSegment(const Double_t *xyz)      const; 
110   Int_t       FindDipSegment(const Double_t *xyz)         const; 
111   static void CylToCartCylB(const Double_t *rphiz, const Double_t *brphiz,Double_t *bxyz);
112   static void CylToCartCartB(const Double_t *xyz,  const Double_t *brphiz,Double_t *bxyz);
113   static void CartToCylCartB(const Double_t *xyz,  const Double_t *bxyz,  Double_t *brphiz);
114   static void CartToCylCylB(const Double_t *rphiz, const Double_t *bxyz,  Double_t *brphiz);
115   static void CartToCyl(const Double_t *xyz,  Double_t *rphiz);
116   static void CylToCart(const Double_t *rphiz,Double_t *xyz);
117   //
118 #ifdef  _INC_CREATION_ALICHEB3D_                          // see AliCheb3D.h for explanation
119   void         LoadData(const char* inpfile);
120   //
121   AliMagWrapCheb(const char* inputFile);
122   void       SaveData(const char* outfile)                const;
123   Int_t      SegmentDimension(Float_t** seg,const TObjArray* par,int npar, int dim, 
124                               Float_t xmn,Float_t xmx,Float_t ymn,Float_t ymx,Float_t zmn,Float_t zmx);
125   //
126   void       AddParamSol(const AliCheb3D* param);
127   void       AddParamTPCInt(const AliCheb3D* param);
128   void       AddParamTPCRatInt(const AliCheb3D* param);
129   void       AddParamDip(const AliCheb3D* param);
130   void       BuildTable(Int_t npar,TObjArray *parArr, Int_t &nZSeg, Int_t &nYSeg, Int_t &nXSeg,
131                         Float_t &minZ,Float_t &maxZ,Float_t **segZ,Float_t **segY,Float_t **segX,
132                         Int_t **begSegY,Int_t **nSegY,Int_t **begSegX,Int_t **nSegX,Int_t **segID);
133   void       BuildTableSol();
134   void       BuildTableDip();
135   void       BuildTableTPCInt();
136   void       BuildTableTPCRatInt();
137   void       ResetTPCInt();
138   void       ResetTPCRatInt();
139   //
140   //
141 #endif
142   //
143  protected:
144   void     FieldCylSol(const Double_t *rphiz, Double_t *b)    const;
145   Double_t FieldCylSolBz(const Double_t *rphiz)               const;
146   //
147  protected:
148   //
149   Int_t      fNParamsSol;            // Total number of parameterization pieces for solenoid 
150   Int_t      fNZSegSol;              // number of distinct Z segments in Solenoid
151   Int_t      fNPSegSol;              // number of distinct P segments in Solenoid
152   Int_t      fNRSegSol;              // number of distinct R segments in Solenoid
153   Float_t*   fSegZSol;               //[fNZSegSol] coordinates of distinct Z segments in Solenoid
154   Float_t*   fSegPSol;               //[fNPSegSol] coordinated of P segments for each Zsegment in Solenoid
155   Float_t*   fSegRSol;               //[fNRSegSol] coordinated of R segments for each Psegment in Solenoid
156   Int_t*     fBegSegPSol;            //[fNPSegSol] beginning of P segments array for each Z segment
157   Int_t*     fNSegPSol;              //[fNZSegSol] number of P segments for each Z segment
158   Int_t*     fBegSegRSol;            //[fNPSegSol] beginning of R segments array for each P segment
159   Int_t*     fNSegRSol;              //[fNPSegSol] number of R segments for each P segment
160   Int_t*     fSegIDSol;              //[fNRSegSol] ID of the solenoid parameterization for given RPZ segment
161   Float_t    fMinZSol;               // Min Z of Solenoid parameterization
162   Float_t    fMaxZSol;               // Max Z of Solenoid parameterization
163   TObjArray* fParamsSol;             // Parameterization pieces for Solenoid field
164   Float_t    fMaxRSol;               // max raduis for Solenoid field
165   //
166   Int_t      fNParamsTPC;            // Total number of parameterization pieces for TPCint 
167   Int_t      fNZSegTPC;              // number of distinct Z segments in TPCint
168   Int_t      fNPSegTPC;              // number of distinct P segments in TPCint
169   Int_t      fNRSegTPC;              // number of distinct R segments in TPCint
170   Float_t*   fSegZTPC;               //[fNZSegTPC] coordinates of distinct Z segments in TPCint
171   Float_t*   fSegPTPC;               //[fNPSegTPC] coordinated of P segments for each Zsegment in TPCint
172   Float_t*   fSegRTPC;               //[fNRSegTPC] coordinated of R segments for each Psegment in TPCint
173   Int_t*     fBegSegPTPC;            //[fNPSegTPC] beginning of P segments array for each Z segment
174   Int_t*     fNSegPTPC;              //[fNZSegTPC] number of P segments for each Z segment
175   Int_t*     fBegSegRTPC;            //[fNPSegTPC] beginning of R segments array for each P segment
176   Int_t*     fNSegRTPC;              //[fNPSegTPC] number of R segments for each P segment
177   Int_t*     fSegIDTPC;              //[fNRSegTPC] ID of the TPCint parameterization for given RPZ segment
178   Float_t    fMinZTPC;               // Min Z of TPCint parameterization
179   Float_t    fMaxZTPC;               // Max Z of TPCint parameterization
180   TObjArray* fParamsTPC;             // Parameterization pieces for TPCint field
181   Float_t    fMaxRTPC;               // max raduis for Solenoid field integral in TPC
182   //
183   Int_t      fNParamsTPCRat;         // Total number of parameterization pieces for tr.field to Bz integrals in TPC region 
184   Int_t      fNZSegTPCRat;           // number of distinct Z segments in TpcRatInt
185   Int_t      fNPSegTPCRat;           // number of distinct P segments in TpcRatInt
186   Int_t      fNRSegTPCRat;           // number of distinct R segments in TpcRatInt
187   Float_t*   fSegZTPCRat;            //[fNZSegTPCRat] coordinates of distinct Z segments in TpcRatInt
188   Float_t*   fSegPTPCRat;            //[fNPSegTPCRat] coordinated of P segments for each Zsegment in TpcRatInt
189   Float_t*   fSegRTPCRat;            //[fNRSegTPCRat] coordinated of R segments for each Psegment in TpcRatInt
190   Int_t*     fBegSegPTPCRat;         //[fNPSegTPCRat] beginning of P segments array for each Z segment
191   Int_t*     fNSegPTPCRat;           //[fNZSegTPCRat] number of P segments for each Z segment
192   Int_t*     fBegSegRTPCRat;         //[fNPSegTPCRat] beginning of R segments array for each P segment
193   Int_t*     fNSegRTPCRat;           //[fNPSegTPCRat] number of R segments for each P segment
194   Int_t*     fSegIDTPCRat;           //[fNRSegTPCRat] ID of the TpcRatInt parameterization for given RPZ segment
195   Float_t    fMinZTPCRat;            // Min Z of TpcRatInt parameterization
196   Float_t    fMaxZTPCRat;            // Max Z of TpcRatInt parameterization
197   TObjArray* fParamsTPCRat;          // Parameterization pieces for TpcRatInt field
198   Float_t    fMaxRTPCRat;            // max raduis for Solenoid field ratios integral in TPC 
199   //
200   Int_t      fNParamsDip;            // Total number of parameterization pieces for dipole 
201   Int_t      fNZSegDip;              // number of distinct Z segments in Dipole
202   Int_t      fNYSegDip;              // number of distinct Y segments in Dipole
203   Int_t      fNXSegDip;              // number of distinct X segments in Dipole
204   Float_t*   fSegZDip;               //[fNZSegDip] coordinates of distinct Z segments in Dipole
205   Float_t*   fSegYDip;               //[fNYSegDip] coordinated of Y segments for each Zsegment in Dipole
206   Float_t*   fSegXDip;               //[fNXSegDip] coordinated of X segments for each Ysegment in Dipole
207   Int_t*     fBegSegYDip;            //[fNZSegDip] beginning of Y segments array for each Z segment
208   Int_t*     fNSegYDip;              //[fNZSegDip] number of Y segments for each Z segment
209   Int_t*     fBegSegXDip;            //[fNYSegDip] beginning of X segments array for each Y segment
210   Int_t*     fNSegXDip;              //[fNYSegDip] number of X segments for each Y segment
211   Int_t*     fSegIDDip;              //[fNXSegDip] ID of the dipole parameterization for given XYZ segment
212   Float_t    fMinZDip;               // Min Z of Dipole parameterization
213   Float_t    fMaxZDip;               // Max Z of Dipole parameterization
214   TObjArray* fParamsDip;             // Parameterization pieces for Dipole field
215   //
216   ClassDef(AliMagWrapCheb,7)         // Wrapper class for the set of Chebishev parameterizations of Alice mag.field
217   //
218  };
219
220
221 //__________________________________________________________________________________________
222 inline void AliMagWrapCheb::FieldCyl(const Double_t *rphiz, Double_t *b) const
223 {
224   // compute field in Cylindircal coordinates
225   //  if (rphiz[2]<GetMinZSol() || rphiz[2]>GetMaxZSol() || rphiz[0]>GetMaxRSol()) {for (int i=3;i--;) b[i]=0; return;}
226   b[0] = b[1] = b[2] = 0;
227   FieldCylSol(rphiz,b);
228 }
229
230 //__________________________________________________________________________________________________
231 inline void AliMagWrapCheb::CylToCartCylB(const Double_t *rphiz, const Double_t *brphiz,Double_t *bxyz)
232 {
233   // convert field in cylindrical coordinates to cartesian system, point is in cyl.system
234   Double_t btr = TMath::Sqrt(brphiz[0]*brphiz[0]+brphiz[1]*brphiz[1]);
235   Double_t psiPLUSphi = TMath::ATan2(brphiz[1],brphiz[0]) + rphiz[1];
236   bxyz[0] = btr*TMath::Cos(psiPLUSphi);
237   bxyz[1] = btr*TMath::Sin(psiPLUSphi);
238   bxyz[2] = brphiz[2];
239   //
240 }
241
242 //__________________________________________________________________________________________________
243 inline void AliMagWrapCheb::CylToCartCartB(const Double_t* xyz, const Double_t *brphiz, Double_t *bxyz)
244 {
245   // convert field in cylindrical coordinates to cartesian system, point is in cart.system
246   Double_t btr = TMath::Sqrt(brphiz[0]*brphiz[0]+brphiz[1]*brphiz[1]);
247   Double_t phiPLUSpsi = TMath::ATan2(xyz[1],xyz[0]) +  TMath::ATan2(brphiz[1],brphiz[0]);
248   bxyz[0] = btr*TMath::Cos(phiPLUSpsi);
249   bxyz[1] = btr*TMath::Sin(phiPLUSpsi);
250   bxyz[2] = brphiz[2];
251   //
252 }
253
254 //__________________________________________________________________________________________________
255 inline void AliMagWrapCheb::CartToCylCartB(const Double_t *xyz, const Double_t *bxyz, Double_t *brphiz)
256 {
257   // convert field in cylindrical coordinates to cartesian system, poin is in cart.system
258   Double_t btr = TMath::Sqrt(bxyz[0]*bxyz[0]+bxyz[1]*bxyz[1]);
259   Double_t psiMINphi = TMath::ATan2(bxyz[1],bxyz[0]) - TMath::ATan2(xyz[1],xyz[0]);
260   //
261   brphiz[0] = btr*TMath::Cos(psiMINphi);
262   brphiz[1] = btr*TMath::Sin(psiMINphi);
263   brphiz[2] = bxyz[2];
264   //
265 }
266
267 //__________________________________________________________________________________________________
268 inline void AliMagWrapCheb::CartToCylCylB(const Double_t *rphiz, const Double_t *bxyz, Double_t *brphiz)
269 {
270   // convert field in cylindrical coordinates to cartesian system, point is in cyl.system
271   Double_t btr = TMath::Sqrt(bxyz[0]*bxyz[0]+bxyz[1]*bxyz[1]);
272   Double_t psiMINphi =  TMath::ATan2(bxyz[1],bxyz[0]) - rphiz[1];
273   brphiz[0] = btr*TMath::Cos(psiMINphi);
274   brphiz[1] = btr*TMath::Sin(psiMINphi);
275   brphiz[2] = bxyz[2];
276   //
277 }
278
279 //__________________________________________________________________________________________________
280 inline void AliMagWrapCheb::CartToCyl(const Double_t *xyz, Double_t *rphiz)
281 {
282   rphiz[0] = TMath::Sqrt(xyz[0]*xyz[0]+xyz[1]*xyz[1]);
283   rphiz[1] = TMath::ATan2(xyz[1],xyz[0]);
284   rphiz[2] = xyz[2];
285 }
286
287 //__________________________________________________________________________________________________
288 inline void AliMagWrapCheb::CylToCart(const Double_t *rphiz, Double_t *xyz)
289 {
290   xyz[0] = rphiz[0]*TMath::Cos(rphiz[1]);
291   xyz[1] = rphiz[0]*TMath::Sin(rphiz[1]);
292   xyz[2] = rphiz[2];
293 }
294
295 #endif