remove empty method GetTransformationForSM() - should have been done with previous...
[u/mrichter/AliRoot.git] / EMCAL / AliEMCALGeometry.h
CommitLineData
2012850d 1#ifndef ALIEMCALGEOMETRY_H
2#define ALIEMCALGEOMETRY_H
1963b290 3/* Copyright(c) 1998-2004, ALICE Experiment at CERN, All rights reserved. *
2012850d 4 * See cxx source for full Copyright notice */
5
6/* $Id$ */
7
8//_________________________________________________________________________
9// Geometry class for EMCAL : singleton
b13bbe81 10// EMCAL consists of a layers of scintillator, and lead.
2012850d 11//
b13bbe81 12//*-- Author: Sahal Yacoob (LBL / UCT)
13//*-- and : Yves Schutz (Subatech)
c63c3c5d 14//*-- and : Aleksei Pavlinov (WSU) - shashlyk staff
f0377b23 15//*-- and : Gustavo Conesa: Add TRU mapping. TRU parameters still not fixed.
2012850d 16
17// --- ROOT system ---
d64c959b 18class TString ;
c63c3c5d 19class TObjArray;
e52475ed 20class TVector3;
21class TGeoMatrix;
cad18b88 22class TParticle ;
9946f2fe 23class AliEMCALGeometry;
e52475ed 24class AliEMCALShishKebabTrd1Module;
25class AliEMCALRecPoint;
f0377b23 26class TClonesArray ;
2012850d 27
2012850d 28// --- AliRoot header files ---
090026bf 29#include <TArrayD.h>
30#include <TMath.h>
31
2012850d 32#include "AliGeometry.h"
33
2012850d 34class AliEMCALGeometry : public AliGeometry {
a97849a9 35public:
0a4cb131 36 AliEMCALGeometry(const AliEMCALGeometry& geom);
d434833b 37 virtual ~AliEMCALGeometry(void);
38
a97849a9 39 static AliEMCALGeometry * GetInstance(const Text_t* name,
40 const Text_t* title="") ;
89557f6d 41 static AliEMCALGeometry * GetInstance();
9cff4509 42 AliEMCALGeometry & operator = (const AliEMCALGeometry & /*rvalue*/) {
a97849a9 43 // assignement operator requested by coding convention but not needed
fdebddeb 44 Fatal("operator =", "not implemented");
9cff4509 45 return *this;
a97849a9 46 };
89557f6d 47 static Char_t* GetDefaulGeometryName() {return fgDefaultGeometryName;}
1d46d1f6 48 void PrintGeometry(); //*MENU*
49 void PrintCellIndexes(Int_t absId=0, int pri=0, char *tit=""); //*MENU*
50 virtual void Browse(TBrowser* b);
51 virtual Bool_t IsFolder() const;
52
03ecfe88 53 void GetCellPhiEtaIndexInSModuleFromTRUIndex(Int_t itru, Int_t iphitru, Int_t ietatru, Int_t &ietaSM, Int_t &iphiSM) const ; // Tranforms Eta-Phi Cell index in TRU into Eta-Phi index in Super Module
356fd0a9 54
14e75ea7 55 void GetGlobal(const Double_t *loc, Double_t *glob, int ind) const;
56 void GetGlobal(const TVector3 &vloc, TVector3 &vglob, int ind) const;
57 void GetGlobal(Int_t absId, Double_t glob[3]) const;
21cf2b24 58 void GetGlobal(Int_t absId, TVector3 &vglob) const;
1d46d1f6 59 // for a given tower index absId returns eta and phi of gravity center of tower.
60 void EtaPhiFromIndex(Int_t absId, Double_t &eta, Double_t &phi) const;
61 void EtaPhiFromIndex(Int_t absId, Float_t &eta, Float_t &phi) const;
62 //
63 Bool_t GetPhiBoundariesOfSM (Int_t nSupMod, Double_t &phiMin, Double_t &phiMax) const;
64 Bool_t GetPhiBoundariesOfSMGap(Int_t nPhiSec, Double_t &phiMin, Double_t &phiMax) const;
65 Bool_t SuperModuleNumberFromEtaPhi(Double_t eta, Double_t phi, Int_t &nSupMod) const;
66
67 Bool_t GetAbsCellIdFromEtaPhi(Double_t eta,Double_t phi, Int_t &absId) const;
e52475ed 68
69 // virtual void GetGlobal(const AliEMCALRecPoint *rp, TVector3 &vglob) const;
70
71 virtual void GetGlobal(const AliRecPoint *rp, TVector3 &vglob) const;
72 // Bool_t AreInSameTower(Int_t id1, Int_t id2) const ;
f0377b23 73
e8d02863 74 virtual void GetGlobal(const AliRecPoint *, TVector3 &, TMatrixF &) const {}
e52475ed 75
9e5d2067 76 virtual Bool_t Impact(const TParticle *) const {return kTRUE;}
ab37d09c 77
78 Bool_t IsInEMCAL(Double_t x, Double_t y, Double_t z) const;
a97849a9 79 // General
80 Bool_t IsInitialized(void) const { return fgInit ; }
c63c3c5d 81 // Return EMCAL geometrical parameters
a97849a9 82 // geometry
e52475ed 83 Char_t* GetNameOfEMCALEnvelope() const {return "XEN1";}
09884213 84 Float_t GetAlFrontThickness() const { return fAlFrontThick;}
85 Float_t GetArm1PhiMin() const { return fArm1PhiMin ; }
86 Float_t GetArm1PhiMax() const { return fArm1PhiMax ; }
87 Float_t GetArm1EtaMin() const { return fArm1EtaMin;}
88 Float_t GetArm1EtaMax() const { return fArm1EtaMax;}
89 Float_t GetIPDistance() const { return fIPDistance;}
90 Float_t GetIP2ECASection() const { return ( GetIPDistance() + GetAlFrontThickness() + GetGap2Active() ) ; }
91 Float_t GetEnvelop(Int_t index) const { return fEnvelop[index] ; }
92 Float_t GetShellThickness() const { return fShellThickness ; }
93 Float_t GetZLength() const { return fZLength ; }
c63c3c5d 94 Float_t GetGap2Active() const {return fGap2Active ;}
09884213 95 Float_t GetDeltaEta() const {return (fArm1EtaMax-fArm1EtaMin)/
a97849a9 96 ((Float_t)fNZ);}
09884213 97 Float_t GetDeltaPhi() const {return (fArm1PhiMax-fArm1PhiMin)/
a97849a9 98 ((Float_t)fNPhi);}
09884213 99 Int_t GetNECLayers() const {return fNECLayers ;}
100 Int_t GetNZ() const {return fNZ ;}
101 Int_t GetNEta() const {return fNZ ;}
102 Int_t GetNPhi() const {return fNPhi ;}
103 Int_t GetNTowers() const {return fNPhi * fNZ ;}
104 Float_t GetECPbRadThick()const {return fECPbRadThickness;}
105 Float_t GetECScintThick() const {return fECScintThick;}
106 Float_t GetSampling() const {return fSampling ; }
dc7da436 107 // Bool_t IsInECA(Int_t index) const { if ( (index > 0 && (index <= GetNZ() * GetNPhi()))) return kTRUE; else return kFALSE ;}
1963b290 108
e52475ed 109 Int_t GetNumberOfSuperModules() const {return fNumberOfSuperModules;}
110 Float_t GetfPhiGapForSuperModules() const {return fPhiGapForSM;}
1963b290 111 Float_t GetPhiModuleSize() const {return fPhiModuleSize;}
112 Float_t GetEtaModuleSize() const {return fEtaModuleSize;}
113 Float_t GetFrontSteelStrip() const {return fFrontSteelStrip;}
114 Float_t GetLateralSteelStrip() const {return fLateralSteelStrip;}
115 Float_t GetPassiveScintThick() const {return fPassiveScintThick;}
116 Float_t GetPhiTileSize() const {return fPhiTileSize;}
117 Float_t GetEtaTileSize() const {return fEtaTileSize;}
118 Int_t GetNPhiSuperModule() const {return fNPhiSuperModule;}
119 Int_t GetNPHIdiv() const {return fNPHIdiv ;}
120 Int_t GetNETAdiv() const {return fNETAdiv ;}
121 Int_t GetNCells() const {return fNCells;}
f0377b23 122
9946f2fe 123 Int_t GetNTRU() const {return fNTRUEta*fNTRUPhi ; }
f0377b23 124 Int_t GetNTRUEta() const {return fNTRUEta ; }
125 Int_t GetNTRUPhi() const {return fNTRUPhi ; }
126
9946f2fe 127 Int_t GetNCellsInTRU() const {return fNCellsInTRUEta*fNCellsInTRUPhi; }
128 Int_t GetNCellsInTRUEta() const {return fNCellsInTRUEta ; }
129 Int_t GetNCellsInTRUPhi() const {return fNCellsInTRUPhi ; }
130
1963b290 131 Float_t GetSteelFrontThickness() const { return fSteelFrontThick;}
132 Float_t GetLongModuleSize() const {return fLongModuleSize;}
133
134 Float_t GetTrd1Angle() const {return fTrd1Angle;}
135 Float_t Get2Trd1Dx2() const {return f2Trd1Dx2;}
136 Float_t GetTrd2AngleY()const {return fTrd2AngleY;}
137 Float_t Get2Trd2Dy2() const {return f2Trd2Dy2;}
138 Float_t GetTubsR() const {return fTubsR;}
139 Float_t GetTubsTurnAngle() const {return fTubsTurnAngle;}
e52475ed 140
141 // TRD1 staff
142 void CreateListOfTrd1Modules();
143 TList *GetShishKebabTrd1Modules() const {return fShishKebabTrd1Modules;}
1ae500a2 144 AliEMCALShishKebabTrd1Module *GetShishKebabModule(Int_t neta) const;
fc575e27 145
e52475ed 146 Float_t *GetSuperModulesPars() {return fParSM;}
b8b0f8c2 147
dc7da436 148 // May 31, 2006; ALICE numbering scheme:
149 // see ALICE-INT-2003-038: ALICE Coordinate System and Software Numbering Convention
150 // All indexes are stared from zero now.
2bb3725c 151 //
152 // abs id <-> indexes; Shish-kebab case, only TRD1 now.
153 // EMCAL -> Super Module -> module -> tower(or cell) - logic tree of EMCAL
154 //
155 //** Usual name of variable - Dec 18,2006 **
156 // nSupMod - index of super module (SM)
157 // nModule - index of module in SM
158 // nIphi - phi index of tower(cell) in module
159 // nIeta - eta index of tower(cell) in module
160 //
161 // Inside SM
162 // iphim - phi index of module in SM
163 // ietam - eta index of module in SM
164 //
165 // iphi - phi index of tower(cell) in SM
166 // ieta - eta index of tower(cell) in SM
167 Int_t GetAbsCellId(Int_t nSupMod, Int_t nModule, Int_t nIphi, Int_t nIeta) const;
dc7da436 168 Bool_t CheckAbsCellId(Int_t absId) const;
2bb3725c 169 Bool_t GetCellIndex(Int_t absId, Int_t &nSupMod, Int_t &nModule, Int_t &nIphi, Int_t &nIeta) const;
dc7da436 170 // Local coordinate of Super Module
2bb3725c 171 void GetModulePhiEtaIndexInSModule(Int_t nSupMod, Int_t nModule, Int_t &iphim, Int_t &ietam) const;
172 void GetCellPhiEtaIndexInSModule(Int_t nSupMod, Int_t nModule, Int_t nIphi, Int_t nIeta,
e52475ed 173 Int_t &iphi, Int_t &ieta) const ;
1d46d1f6 174 Int_t GetSuperModuleNumber(Int_t absId) const;
175 Int_t GetNumberOfModuleInPhiDirection(Int_t nSupMod) const
176 {
177 // inline function
178 if(fKey110DEG == 1 && nSupMod>=10) return fNPhi/2;
179 else return fNPhi;
180 }
181 // From cell indexes to abs cell id
182 void GetModuleIndexesFromCellIndexesInSModule(Int_t nSupMod, Int_t iphi, Int_t ieta,
2bb3725c 183 Int_t &iphim, Int_t &ietam, Int_t &nModule) const;
1d46d1f6 184 Int_t GetAbsCellIdFromCellIndexes(Int_t nSupMod, Int_t iphi, Int_t ieta) const;
14e75ea7 185 // Methods for AliEMCALRecPoint - Feb 19, 2006
186 Bool_t RelPosCellInSModule(Int_t absId, Double_t &xr, Double_t &yr, Double_t &zr) const;
187 Bool_t RelPosCellInSModule(Int_t absId, Double_t loc[3]) const;
188 Bool_t RelPosCellInSModule(Int_t absId, TVector3 &vloc) const;
1ae500a2 189 // Methods for AliEMCALRecPoint with taking into account energy of rec.point - Jul 30. 2007
190 Bool_t RelPosCellInSModule(Int_t absId,Double_t distEff,Double_t &xr,Double_t &yr,Double_t & zr) const;
191 Bool_t RelPosCellInSModule(Int_t absId,Int_t maxAbsId,Double_t distEff,Double_t &xr,Double_t &yr,Double_t &zr) const;
192
1963b290 193 // ---
e52475ed 194 Float_t AngleFromEta(Float_t eta) const { // returns theta in radians for a given pseudorapidity
a97849a9 195 return 2.0*TMath::ATan(TMath::Exp(-eta));
196 }
e52475ed 197 Float_t ZFromEtaR(Float_t r,Float_t eta) const { // returns z in for a given
a97849a9 198 // pseudorapidity and r=sqrt(x*x+y*y).
199 return r/TMath::Tan(AngleFromEta(eta));
200 }
fdebddeb 201 void SetNZ(Int_t nz) { fNZ= nz ; printf("SetNZ: Number of modules in Z set to %d", fNZ) ; }
202 void SetNPhi(Int_t nphi) { fNPhi= nphi ; printf("SetNPhi: Number of modules in Phi set to %d", fNPhi) ; }
f0377b23 203
f0377b23 204 void SetNTRUEta(Int_t ntru) {fNTRUEta = ntru; ; printf("SetNTRU: Number of TRUs per SuperModule in Etaset to %d", fNTRUEta) ;}
205 void SetNTRUPhi(Int_t ntru) {fNTRUPhi = ntru; ; printf("SetNTRU: Number of TRUs per SuperModule in Phi set to %d", fNTRUPhi) ;}
206
fdebddeb 207 void SetSampling(Float_t samp) { fSampling = samp; printf("SetSampling: Sampling factor set to %f", fSampling) ; }
395c7ba2 208
4c431bcc 209 Int_t GetNCellsInSupMod() const {return fNCellsInSupMod;}
2bb3725c 210 Int_t GetNCellsInModule() const {return fNCellsInModule; }
1d46d1f6 211 Int_t GetKey110DEG() const {return fKey110DEG;}
89557f6d 212 Int_t GetILOSS() const {return fILOSS;}
213 Int_t GetIHADR() const {return fIHADR;}
4c431bcc 214
dc7da436 215 AliEMCALGeometry(); // default ctor only for internal usage (singleton)
d434833b 216
a97849a9 217protected:
dc7da436 218 AliEMCALGeometry(const Text_t* name, const Text_t* title);// ctor only for internal usage (singleton)
d434833b 219
fdebddeb 220 void Init(void); // initializes the parameters of EMCAL
25b033cf 221 void CheckAdditionalOptions(); //
222 void DefineSamplingFraction(); // Jun 5, 2006
a97849a9 223
224private:
fdebddeb 225 static AliEMCALGeometry * fgGeom; // pointer to the unique instance of the singleton
89557f6d 226 static Bool_t fgInit; // Tells if geometry has been succesfully set up.
227 static Char_t* fgDefaultGeometryName; // Default name of geometry
fc575e27 228
229 TString fGeoName; //geometry name
d434833b 230
c63c3c5d 231 TObjArray *fArrayOpts; //! array of geometry options
232
233 Float_t fAlFrontThick; // Thickness of the front Al face of the support box
fdebddeb 234 Float_t fECPbRadThickness; // cm, Thickness of the Pb radiators
235 Float_t fECScintThick; // cm, Thickness of the scintillators
236 Int_t fNECLayers; // number of scintillator layers
395c7ba2 237
fdebddeb 238 Float_t fArm1PhiMin; // Minimum angular position of EMCAL in Phi (degrees)
239 Float_t fArm1PhiMax; // Maximum angular position of EMCAL in Phi (degrees)
240 Float_t fArm1EtaMin; // Minimum pseudorapidity position of EMCAL in Eta
241 Float_t fArm1EtaMax; // Maximum pseudorapidity position of EMCAL in Eta
a97849a9 242
fdebddeb 243 // Geometry Parameters
244 Float_t fEnvelop[3]; // the GEANT TUB for the detector
245 Float_t fIPDistance; // Radial Distance of the inner surface of the EMCAL
246 Float_t fShellThickness; // Total thickness in (x,y) direction
247 Float_t fZLength; // Total length in z direction
248 Float_t fGap2Active; // Gap between the envelop and the active material
249 Int_t fNZ; // Number of Towers in the Z direction
1963b290 250 Int_t fNPhi; // Number of Towers in the PHI direction
fdebddeb 251 Float_t fSampling; // Sampling factor
1963b290 252
253 // Shish-kebab option - 23-aug-04 by PAI; COMPACT, TWIST, TRD1 and TRD2
254 Int_t fNumberOfSuperModules; // default is 12 = 6 * 2
255 Float_t fSteelFrontThick; // Thickness of the front stell face of the support box - 9-sep-04
256 Float_t fFrontSteelStrip; // 13-may-05
257 Float_t fLateralSteelStrip; // 13-may-05
258 Float_t fPassiveScintThick; // 13-may-05
259 Float_t fPhiModuleSize; // Phi -> X
260 Float_t fEtaModuleSize; // Eta -> Y
fc575e27 261 Float_t fPhiTileSize; // Size of phi tile
262 Float_t fEtaTileSize; // Size of eta tile
263 Float_t fLongModuleSize; // Size of long module
1963b290 264 Int_t fNPhiSuperModule; // 6 - number supermodule in phi direction
d87bd045 265 Int_t fNPHIdiv; // number phi divizion of module
266 Int_t fNETAdiv; // number eta divizion of module
1963b290 267 //
268 Int_t fNCells; // number of cells in calo
269 Int_t fNCellsInSupMod; // number cell in super module
2bb3725c 270 Int_t fNCellsInModule; // number cell in module)
f0377b23 271 //TRU parameters
9946f2fe 272 Int_t fNTRUEta ; // Number of TRUs per module in eta
273 Int_t fNTRUPhi ; // Number of TRUs per module in phi
274 Int_t fNCellsInTRUEta; // Number of cells per TRU in eta
275 Int_t fNCellsInTRUPhi; // Number of cells per TRU in phi
276
1963b290 277 // TRD1 options - 30-sep-04
278 Float_t fTrd1Angle; // angle in x-z plane (in degree)
279 Float_t f2Trd1Dx2; // 2*dx2 for TRD1
905263da 280 Float_t fPhiGapForSM; // Gap betweeen supermodules in phi direction
d87bd045 281 Int_t fKey110DEG; // for calculation abs cell id; 19-oct-05
1d46d1f6 282 TArrayD fPhiBoundariesOfSM; // phi boundaries of SM in rad; size is fNumberOfSuperModules;
283 TArrayD fPhiCentersOfSM; // phi of centers of SMl size is fNumberOfSuperModules/2
284 Float_t fEtaMaxOfTRD1; // max eta in case of TRD1 geometry (see AliEMCALShishKebabTrd1Module)
1963b290 285 // TRD2 options - 27-jan-07
286 Float_t fTrd2AngleY; // angle in y-z plane (in degree)
287 Float_t f2Trd2Dy2; // 2*dy2 for TRD2
288 Float_t fEmptySpace; // 2mm om fred drawing
d87bd045 289 // Super module as TUBS
1963b290 290 Float_t fTubsR; // radius of tubs
291 Float_t fTubsTurnAngle; // turn angle of tubs in degree
e52475ed 292 // Local Coordinates of SM
1d46d1f6 293 TArrayD fCentersOfCellsEtaDir; // size fNEta*fNETAdiv (for TRD1 only) (eta or z in SM, in cm)
294 TArrayD fCentersOfCellsXDir; // size fNEta*fNETAdiv (for TRD1 only) ( x in SM, in cm)
295 TArrayD fCentersOfCellsPhiDir; // size fNPhi*fNPHIdiv (for TRD1 only) (phi or y in SM, in cm)
296 //
297 TArrayD fEtaCentersOfCells; // [fNEta*fNETAdiv*fNPhi*fNPHIdiv], positive direction (eta>0); eta depend from phi position;
298 TArrayD fPhiCentersOfCells; // [fNPhi*fNPHIdiv] from center of SM (-10. < phi < +10.)
e52475ed 299 // Move from AliEMCALv0 - Feb 19, 2006
300 TList *fShishKebabTrd1Modules; //! list of modules
301 // Local coordinates of SM for TRD1
302 Float_t fParSM[3]; // SM sizes as in GEANT (TRD1)
1963b290 303
89557f6d 304 char *fAdditionalOpts[6]; //! some additional options for the geometry type and name
305 int fNAdditionalOpts; //! size of additional options parameter
306
307 // Options for Geant (MIP business) - will call in AliEMCAL
308 Int_t fILOSS;
309 Int_t fIHADR;
fc575e27 310
b8b0f8c2 311 ClassDef(AliEMCALGeometry, 13) // EMCAL geometry class
9946f2fe 312};
2012850d 313
314#endif // AliEMCALGEOMETRY_H