f7818bd20f8007888b68c041735fbbd4817a9c35
[u/mrichter/AliRoot.git] / EMCAL / AliEMCALGeoUtils.h
1 #ifndef ALIEMCALGEOUTILS_H
2 #define ALIEMCALGEOUTILS_H
3 /* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
4  * See cxx source for full Copyright notice                               */
5
6 //_________________________________________________________________________
7 // class for geometry transformations in EMCAL
8 // this class contains AliRoot-independent transformations,
9 // AliRoot part is in AliEMCALGeometry
10 // 
11 //*-- Author: Magali Estienne
12
13 // --- ROOT system ---
14 #include <TNamed.h>
15 #include <TMath.h>
16 #include <TArrayD.h>
17 #include <TVector3.h>
18 #include <TGeoMatrix.h> 
19 class TBrowser ;
20 class TParticle ;
21
22 // --- AliRoot header files ---
23 #include "AliEMCALEMCGeometry.h"
24 #include "AliEMCALGeoParams.h"
25 class AliEMCALShishKebabTrd1Module;
26 #include "AliLog.h"
27
28 class AliEMCALGeoUtils : public TNamed {
29
30 public: 
31
32   AliEMCALGeoUtils();
33   AliEMCALGeoUtils(const Text_t* name, const Text_t* title="");
34   AliEMCALGeoUtils(const AliEMCALGeoUtils & geom);
35   
36   virtual ~AliEMCALGeoUtils(void); 
37   AliEMCALGeoUtils & operator = (const AliEMCALGeoUtils  & rvalue);
38
39   /////////////
40   // TRD1 stuff
41   void    CreateListOfTrd1Modules();
42   TList  *GetShishKebabTrd1Modules() const {return fShishKebabTrd1Modules;}
43   AliEMCALShishKebabTrd1Module *GetShishKebabModule(Int_t neta) const;
44
45   void PrintGeometry(); 
46   void PrintCellIndexes(Int_t absId=0, int pri=0, const char *tit="") const ;  //*MENU*
47   virtual void Browse(TBrowser* b);
48   virtual Bool_t  IsFolder() const;
49
50   virtual Bool_t Impact(const TParticle *) const;
51   void ImpactOnEmcal(TVector3 vtx, Double_t theta, Double_t phi, Int_t & absId, TVector3 & vimpact) const;
52   Bool_t IsInEMCAL(Double_t x, Double_t y, Double_t z) const;
53
54
55   AliEMCALEMCGeometry* GetEMCGeometry() const { return fEMCGeometry;}
56
57   //////////////////////////
58   // Global geometry methods
59   //
60   void GetGlobal(const Double_t *loc, Double_t *glob, int ind) const;
61   void GetGlobal(const TVector3 &vloc, TVector3 &vglob, int ind) const;
62   void GetGlobal(Int_t absId, Double_t glob[3]) const;
63   void GetGlobal(Int_t absId, TVector3 &vglob) const;
64
65   ////////////////////////////////////////
66   // May 31, 2006; ALICE numbering scheme: 
67   // see ALICE-INT-2003-038: ALICE Coordinate System and Software Numbering Convention
68   // All indexes are stared from zero now.
69   // 
70   // abs id <-> indexes; Shish-kebab case, only TRD1 now.
71   // EMCAL -> Super Module -> module -> tower(or cell) - logic tree of EMCAL
72   // 
73   //**  Usual name of variable - Dec 18,2006 **
74   //  nSupMod - index of super module (SM)
75   //  nModule - index of module in SM
76   //  nIphi   - phi index of tower(cell) in module
77   //  nIeta   - eta index of tower(cell) in module
78   //  
79   //  Inside SM
80   //  iphim   - phi index of module in SM  
81   //  ietam   - eta index of module in SM  
82   //
83   //  iphi    - phi index of tower(cell) in SM  
84   //  ieta    - eta index of tower(cell) in SM  
85   //
86   // for a given tower index absId returns eta and phi of gravity center of tower.
87   void    EtaPhiFromIndex(Int_t absId, Double_t &eta, Double_t &phi) const;
88   void    EtaPhiFromIndex(Int_t absId, Float_t &eta, Float_t &phi) const;
89
90   Bool_t  GetAbsCellIdFromEtaPhi(Double_t eta,Double_t phi, Int_t &absId) const;
91   Bool_t  SuperModuleNumberFromEtaPhi(Double_t eta, Double_t phi, Int_t &nSupMod) const;
92   Int_t   GetAbsCellId(Int_t nSupMod, Int_t nModule, Int_t nIphi, Int_t nIeta) const;
93   Bool_t  CheckAbsCellId(Int_t absId) const;
94   Bool_t  GetCellIndex(Int_t absId, Int_t &nSupMod, Int_t &nModule, Int_t &nIphi, 
95                        Int_t &nIeta) const;
96   // Local coordinate of Super Module 
97   void    GetModulePhiEtaIndexInSModule(Int_t nSupMod, Int_t nModule, Int_t &iphim, 
98                                         Int_t &ietam) const;
99   void    GetCellPhiEtaIndexInSModule(Int_t nSupMod, Int_t nModule, Int_t nIphi, Int_t nIeta,
100                                       Int_t &iphi, Int_t &ieta) const ;
101   Int_t   GetSuperModuleNumber(Int_t absId)  const;
102   Int_t   GetNumberOfModuleInPhiDirection(Int_t nSupMod)  const
103   { 
104     if(fKey110DEG == 1 && nSupMod>=10) return fNPhi/2;
105     else                               return fNPhi;
106   } 
107   // From cell indexes to abs cell id
108   void    GetModuleIndexesFromCellIndexesInSModule(Int_t nSupMod, Int_t iphi, Int_t ieta, 
109                                               Int_t &iphim, Int_t &ietam, Int_t &nModule) const;
110   Int_t   GetAbsCellIdFromCellIndexes(Int_t nSupMod, Int_t iphi, Int_t ieta) const;
111
112   // Methods for AliEMCALRecPoint - Feb 19, 2006
113   Bool_t  RelPosCellInSModule(Int_t absId, Double_t &xr, Double_t &yr, Double_t &zr) const;
114   Bool_t  RelPosCellInSModule(Int_t absId, Double_t loc[3]) const;
115   Bool_t  RelPosCellInSModule(Int_t absId, TVector3 &vloc) const;
116
117   // Local Coordinates of SM
118   TArrayD  GetCentersOfCellsEtaDir() const {return fCentersOfCellsEtaDir;}        // size fNEta*fNETAdiv (for TRD1 only) (eta or z in SM, in cm)
119   TArrayD  GetCentersOfCellsXDir()   const {return fCentersOfCellsXDir;}          // size fNEta*fNETAdiv (for TRD1 only) (       x in SM, in cm)
120   TArrayD  GetCentersOfCellsPhiDir() const {return fCentersOfCellsPhiDir;}        // size fNPhi*fNPHIdiv (for TRD1 only) (phi or y in SM, in cm)
121   //
122   TArrayD  GetEtaCentersOfCells() const {return fEtaCentersOfCells;}           // [fNEta*fNETAdiv*fNPhi*fNPHIdiv], positive direction (eta>0); eta depend from phi position; 
123   TArrayD  GetPhiCentersOfCells() const {return fPhiCentersOfCells;}           // [fNPhi*fNPHIdiv] from center of SM (-10. < phi < +10.)
124
125   //
126   // Tranforms Eta-Phi Module index in TRU into Eta-Phi index in Super Module
127   void     GetModulePhiEtaIndexInSModuleFromTRUIndex(
128                Int_t itru, Int_t iphitru, Int_t ietatru, Int_t &ietaSM, Int_t &iphiSM) const;
129   Int_t   GetAbsTRUNumberFromNumberInSm(const Int_t row, const Int_t col, const Int_t sm) const ;
130
131         
132   void     BuildFastOR2DMap();
133   Bool_t   GetAbsFastORIndexFromTRU(const Int_t iTRU, const Int_t iADC, Int_t& id) const;
134   Bool_t                    GetAbsFastORIndexFromPositionInTRU(const Int_t iTRU, const Int_t iEta, const Int_t iPhi, Int_t& id) const;  
135   Bool_t                    GetAbsFastORIndexFromPositionInSM( const Int_t  iSM, const Int_t iEta, const Int_t iPhi, Int_t& id) const;  
136   Bool_t                    GetAbsFastORIndexFromPositionInEMCAL(                const Int_t iEta, const Int_t iPhi, Int_t& id) const;
137   Bool_t             GetTRUFromAbsFastORIndex(const Int_t id, Int_t& iTRU, Int_t& iADC) const;
138   Bool_t   GetPositionInTRUFromAbsFastORIndex(const Int_t id, Int_t& iTRU, Int_t& iEta, Int_t& iPhi) const;
139   Bool_t    GetPositionInSMFromAbsFastORIndex(const Int_t id, Int_t& iSM, Int_t& iEta, Int_t& iPhi) const;
140   Bool_t GetPositionInEMCALFromAbsFastORIndex(const Int_t id, Int_t& iEta, Int_t& iPhi) const;
141   Bool_t          GetFastORIndexFromCellIndex(const Int_t id, Int_t& idx) const;
142   Bool_t          GetCellIndexFromFastORIndex(const Int_t id, Int_t idx[4]) const;
143   Bool_t              GetTRUIndexFromSTUIndex(const Int_t id, Int_t& idx) const;
144   Int_t               GetTRUIndexFromSTUIndex(const Int_t id) const;
145   Bool_t            GetFastORIndexFromL0Index(const Int_t iTRU, const Int_t id, Int_t idx[], const Int_t size) const;
146         
147   ///////////////////
148   // useful utilities
149   //
150   Float_t AngleFromEta(Float_t eta) const { // returns theta in radians for a given pseudorapidity
151     return 2.0*TMath::ATan(TMath::Exp(-eta));
152   }
153   Float_t ZFromEtaR(Float_t r,Float_t eta) const { // returns z in for a given
154     // pseudorapidity and r=sqrt(x*x+y*y).
155     return r/TMath::Tan(AngleFromEta(eta));
156   }
157
158   //Method to set shift-rotational matrixes from ESDHeader
159   void SetMisalMatrix(const TGeoHMatrix * m, Int_t smod) {
160           if (smod >= 0 && smod < fEMCGeometry->GetNumberOfSuperModules()){
161             if(!fkSModuleMatrix[smod]) fkSModuleMatrix[smod] = new TGeoHMatrix(*m) ; //Set only if not set yet
162           }
163           else AliFatal(Form("Wrong supermodule index -> %d",smod));
164   }
165         
166   //Alternate geometry that allows to calculate tower position for different particles and different alignments
167   void RecalculateTowerPosition(Float_t drow, Float_t dcol, const Int_t sm, const Float_t depth,
168                                      const Float_t misaligTransShifts[15], const Float_t misaligRotShifts[15],Float_t global[3]) const;
169   
170   //Returns shift-rotational matrixes for different volumes
171   const TGeoHMatrix * GetMatrixForSuperModule(Int_t smod)const ;
172         
173 protected:
174
175   // ctor only for internal usage (singleton)
176   //  AliEMCALGeoUtils(const Text_t* name, const Text_t* title);
177   AliEMCALEMCGeometry     *fEMCGeometry;   // Geometry object for Electromagnetic calorimeter
178
179   void Init(void);                   // initializes the parameters of EMCAL
180
181   TString  fGeoName;                     //geometry name
182
183   Int_t    fKey110DEG;               // for calculation abs cell id; 19-oct-05 
184   Int_t    fNCellsInSupMod;          // number cell in super module
185   Int_t    fNETAdiv;                 // number eta divizion of module
186   Int_t    fNPHIdiv;                 // number phi divizion of module
187   Int_t    fNCellsInModule;          // number cell in module
188   TArrayD  fPhiBoundariesOfSM;       // phi boundaries of SM in rad; size is fNumberOfSuperModules;
189   TArrayD  fPhiCentersOfSM;          // phi of centers of SMl size is fNumberOfSuperModules/2
190   // Local Coordinates of SM
191   TArrayD  fPhiCentersOfCells;       // [fNPhi*fNPHIdiv] from center of SM (-10. < phi < +10.)
192   TArrayD  fCentersOfCellsEtaDir;    // size fNEta*fNETAdiv (for TRD1 only) (eta or z in SM, in cm)
193   TArrayD  fCentersOfCellsPhiDir;    // size fNPhi*fNPHIdiv (for TRD1 only) (phi or y in SM, in cm)
194   TArrayD  fEtaCentersOfCells;       // [fNEta*fNETAdiv*fNPhi*fNPHIdiv], positive direction (eta>0); eta depend from phi position; 
195   Int_t    fNCells;                  // number of cells in calo
196   Int_t    fNPhi;                            // Number of Towers in the PHI direction
197   TArrayD  fCentersOfCellsXDir;      // size fNEta*fNETAdiv (for TRD1 only) (       x in SM, in cm)
198   Float_t  fEnvelop[3];              // the GEANT TUB for the detector 
199   Float_t  fArm1EtaMin;              // Minimum pseudorapidity position of EMCAL in Eta
200   Float_t  fArm1EtaMax;              // Maximum pseudorapidity position of EMCAL in Eta
201   Float_t  fArm1PhiMin;              // Minimum angular position of EMCAL in Phi (degrees)
202   Float_t  fArm1PhiMax;              // Maximum angular position of EMCAL in Phi (degrees)
203   Float_t  fEtaMaxOfTRD1;            // Max eta in case of TRD1 geometry (see AliEMCALShishKebabTrd1Module)
204   TList    *fShishKebabTrd1Modules;  //! list of modules
205   Float_t  *fParSM;                  // SM sizes as in GEANT (TRD1)
206   Float_t  fPhiModuleSize;           // Phi -> X 
207   Float_t  fEtaModuleSize;           // Eta -> Y 
208   Float_t  fPhiTileSize;             // Size of phi tile
209   Float_t  fEtaTileSize;             // Size of eta tile
210   Int_t    fNZ;                      // Number of Towers in the Z direction
211   Float_t  fIPDistance;                  // Radial Distance of the inner surface of the EMCAL
212   Float_t  fLongModuleSize;          // Size of long module
213   // Geometry Parameters
214   Float_t  fShellThickness;                  // Total thickness in (x,y) direction
215   Float_t  fZLength;                         // Total length in z direction
216   Float_t  fSampling;                        // Sampling factor
217
218   Int_t    fFastOR2DMap[48][64];         // FastOR 2D Map over full EMCal
219         
220   TGeoHMatrix* fkSModuleMatrix[AliEMCALGeoParams::fgkEMCALModules] ; //Orientations of EMCAL super modules
221
222         
223   ClassDef(AliEMCALGeoUtils,1)       // EMCAL geometry class 
224
225 } ;
226
227 #endif // AliEMCALGEOUTILS_H
228