cleanup
[u/mrichter/AliRoot.git] / PHOS / AliPHOSv1.cxx
1 /**************************************************************************
2  * Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
3  *                                                                        *
4  * Author: The ALICE Off-line Project.                                    *
5  * Contributors are mentioned in the code where appropriate.              *
6  *                                                                        *
7  * Permission to use, copy, modify and distribute this software and its   *
8  * documentation strictly for non-commercial purposes is hereby granted   *
9  * without fee, provided that the above copyright notice appears in all   *
10  * copies and that both the copyright notice and this permission notice   *
11  * appear in the supporting documentation. The authors make no claims     *
12  * about the suitability of this software for any purpose. It is          *
13  * provided "as is" without express or implied warranty.                  *
14  **************************************************************************/
15
16 /* $Id$ */
17
18 //_________________________________________________________________________
19 // Implementation version v1 of PHOS Manager class 
20 //---
21 // Layout EMC + PPSD has name GPS2:
22 // Produces cumulated hits
23 //---
24 // Layout EMC + CPV  has name IHEP:
25 // Produces hits for CPV, cumulated hits
26 //---
27 // Layout EMC + CPV + PPSD has name GPS:
28 // Produces hits for CPV, cumulated hits
29 //---
30 //*-- Author: Yves Schutz (SUBATECH)
31
32
33 // --- ROOT system ---
34
35 #include "TBRIK.h"
36 #include "TNode.h"
37 #include "TRandom.h"
38 #include "TTree.h"
39
40
41 // --- Standard library ---
42
43 #include <stdio.h>
44 #include <string.h>
45 #include <stdlib.h>
46 #include <strstream.h>
47
48 // --- AliRoot header files ---
49
50 #include "AliPHOSv1.h"
51 #include "AliPHOSHit.h"
52 #include "AliPHOSCPVDigit.h"
53 #include "AliRun.h"
54 #include "AliConst.h"
55 #include "AliMC.h"
56 #include "AliPHOSGeometry.h"
57
58 ClassImp(AliPHOSv1)
59
60 //____________________________________________________________________________
61 AliPHOSv1::AliPHOSv1():
62 AliPHOSv0()
63 {
64   // ctor
65  
66 }
67
68 //____________________________________________________________________________
69 AliPHOSv1::AliPHOSv1(const char *name, const char *title):
70 AliPHOSv0(name,title) 
71 {
72   // ctor : title is used to identify the layout
73   //        GPS2 = 5 modules (EMC + PPSD)
74   //        IHEP = 5 modules (EMC + CPV )
75   //        MIXT = 4 modules (EMC + CPV ) and 1 module (EMC + PPSD)
76   //
77   // We store hits :
78   //   - fHits (the "normal" one), which retains the hits associated with
79   //     the current primary particle being tracked
80   //     (this array is reset after each primary has been tracked).
81   //
82
83
84
85   // We do not want to save in TreeH the raw hits
86   // But save the cumulated hits instead (need to create the branch myself)
87   // It is put in the Digit Tree because the TreeH is filled after each primary
88   // and the TreeD at the end of the event (branch is set in FinishEvent() ).
89   
90   fHits= new TClonesArray("AliPHOSHit",1000) ;
91
92   fNhits = 0 ;
93
94   fIshunt     =  1 ; // All hits are associated with primary particles
95   
96 }
97
98 //____________________________________________________________________________
99 AliPHOSv1::~AliPHOSv1()
100 {
101   // dtor
102
103   if ( fHits) {
104     fHits->Delete() ; 
105     delete fHits ;
106     fHits = 0 ; 
107   }
108 }
109
110 //____________________________________________________________________________
111 void AliPHOSv1::AddHit(Int_t shunt, Int_t primary, Int_t tracknumber, Int_t Id, Float_t * hits)
112 {
113   // Add a hit to the hit list.
114   // A PHOS hit is the sum of all hits in a single crystal
115   //   or in a single PPSD gas cell
116
117   Int_t hitCounter ;
118   AliPHOSHit *newHit ;
119   AliPHOSHit *curHit ;
120   Bool_t deja = kFALSE ;
121
122   newHit = new AliPHOSHit(shunt, primary, tracknumber, Id, hits) ;
123
124   for ( hitCounter = fNhits-1 ; hitCounter >= 0 && !deja ; hitCounter-- ) {
125     curHit = (AliPHOSHit*) (*fHits)[hitCounter] ;
126     if(curHit->GetPrimary() != primary) break ; // We add hits with the same primary, while GEANT treats primaries consequently 
127     if( *curHit == *newHit ) {
128       *curHit = *curHit + *newHit ;
129       deja = kTRUE ;
130     }
131   }
132          
133   if ( !deja ) {
134     new((*fHits)[fNhits]) AliPHOSHit(*newHit) ;
135     fNhits++ ;
136   }
137
138   delete newHit;
139 }
140
141 //____________________________________________________________________________
142 void AliPHOSv1::StepManager(void)
143 {
144   // Accumulates hits as long as the track stays in a single crystal or PPSD gas Cell
145
146   Int_t          relid[4] ;           // (box, layer, row, column) indices
147   Int_t          absid    ;           // absolute cell ID number
148   Float_t        xyze[4]={0,0,0,0}  ; // position wrt MRS and energy deposited
149   TLorentzVector pos      ;           // Lorentz vector of the track current position
150   Int_t          copy     ;
151
152   Int_t tracknumber =  gAlice->CurrentTrack() ; 
153   Int_t primary     =  gAlice->GetPrimary( gAlice->CurrentTrack() ); 
154   TString name      =  fGeom->GetName() ; 
155
156
157   if ( name == "GPS2" || name == "MIXT" ) {            // ======> CPV is a GPS' PPSD
158
159     if( gMC->CurrentVolID(copy) == gMC->VolId("PCEL") ) // We are inside a gas cell 
160     {
161       gMC->TrackPosition(pos) ;
162       xyze[0] = pos[0] ;
163       xyze[1] = pos[1] ;
164       xyze[2] = pos[2] ;
165       xyze[3] = gMC->Edep() ; 
166
167       if ( xyze[3] != 0 ) { // there is deposited energy 
168         gMC->CurrentVolOffID(5, relid[0]) ;  // get the PHOS Module number
169         if ( name == "MIXT" && strcmp(gMC->CurrentVolOffName(5),"PHO1") == 0 ){
170           relid[0] += fGeom->GetNModules() - fGeom->GetNPPSDModules();
171         }
172         gMC->CurrentVolOffID(3, relid[1]) ;  // get the Micromegas Module number 
173       // 1-> fGeom->GetNumberOfModulesPhi() * fGeom->GetNumberOfModulesZ() upper
174       //   > fGeom->GetNumberOfModulesPhi() * fGeom->GetNumberOfModulesZ() lower
175         gMC->CurrentVolOffID(1, relid[2]) ;  // get the row number of the cell
176         gMC->CurrentVolID(relid[3]) ;        // get the column number 
177
178         // get the absolute Id number
179
180         fGeom->RelToAbsNumbering(relid, absid) ; 
181
182         // add current hit to the hit list      
183           AddHit(fIshunt, primary, tracknumber, absid, xyze);
184
185
186       } // there is deposited energy 
187     } // We are inside the gas of the CPV  
188   } // GPS2 configuration
189
190   if ( name == "IHEP" || name == "MIXT" ) {       // ======> CPV is a IHEP's one
191
192     // Yuri Kharlov, 28 September 2000
193
194     if( gMC->CurrentVolID(copy) == gMC->VolId("PCPQ") &&
195         (gMC->IsTrackEntering() ) &&
196         gMC->TrackCharge() != 0) {      
197       
198       gMC -> TrackPosition(pos);
199       Float_t xyzm[3], xyzd[3] ;
200       Int_t i;
201       for (i=0; i<3; i++) xyzm[i] = pos[i];
202       gMC -> Gmtod (xyzm, xyzd, 1);    // transform coordinate from master to daughter system
203
204       Float_t        xyd[3]={0,0,0}   ;   //local posiiton of the entering
205       xyd[0]  = xyzd[0];
206       xyd[1]  =-xyzd[1];
207       xyd[2]  =-xyzd[2];
208
209       
210       // Current momentum of the hit's track in the local ref. system
211         TLorentzVector pmom     ;        //momentum of the particle initiated hit
212       gMC -> TrackMomentum(pmom);
213       Float_t pm[3], pd[3];
214       for (i=0; i<3; i++) pm[i]   = pmom[i];
215       gMC -> Gmtod (pm, pd, 2);        // transform 3-momentum from master to daughter system
216       pmom[0] = pd[0];
217       pmom[1] =-pd[1];
218       pmom[2] =-pd[2];
219
220       // Digitize the current CPV hit:
221
222       // 1. find pad response and
223       
224       Int_t moduleNumber;
225       gMC->CurrentVolOffID(3,moduleNumber);
226       moduleNumber--;
227
228
229       TClonesArray *cpvDigits = new TClonesArray("AliPHOSCPVDigit",0);   // array of digits for current hit
230       CPVDigitize(pmom,xyd,moduleNumber,cpvDigits);
231       
232       Float_t xmean = 0;
233       Float_t zmean = 0;
234       Float_t qsum  = 0;
235       Int_t   idigit,ndigits;
236
237       // 2. go through the current digit list and sum digits in pads
238
239       ndigits = cpvDigits->GetEntriesFast();
240       for (idigit=0; idigit<ndigits-1; idigit++) {
241         AliPHOSCPVDigit  *cpvDigit1 = (AliPHOSCPVDigit*) cpvDigits->UncheckedAt(idigit);
242         Float_t x1 = cpvDigit1->GetXpad() ;
243         Float_t z1 = cpvDigit1->GetYpad() ;
244         for (Int_t jdigit=idigit+1; jdigit<ndigits; jdigit++) {
245           AliPHOSCPVDigit  *cpvDigit2 = (AliPHOSCPVDigit*) cpvDigits->UncheckedAt(jdigit);
246           Float_t x2 = cpvDigit2->GetXpad() ;
247           Float_t z2 = cpvDigit2->GetYpad() ;
248           if (x1==x2 && z1==z2) {
249             Float_t qsum = cpvDigit1->GetQpad() + cpvDigit2->GetQpad() ;
250             cpvDigit2->SetQpad(qsum) ;
251             cpvDigits->RemoveAt(idigit) ;
252           }
253         }
254       }
255       cpvDigits->Compress() ;
256
257       // 3. add digits to temporary hit list fTmpHits
258
259       ndigits = cpvDigits->GetEntriesFast();
260       for (idigit=0; idigit<ndigits; idigit++) {
261         AliPHOSCPVDigit  *cpvDigit = (AliPHOSCPVDigit*) cpvDigits->UncheckedAt(idigit);
262         relid[0] = moduleNumber + 1 ;                             // CPV (or PHOS) module number
263         relid[1] =-1 ;                                            // means CPV
264         relid[2] = cpvDigit->GetXpad() ;                          // column number of a pad
265         relid[3] = cpvDigit->GetYpad() ;                          // row    number of a pad
266         
267         // get the absolute Id number
268         fGeom->RelToAbsNumbering(relid, absid) ; 
269
270         // add current digit to the temporary hit list
271         xyze[0] = 0. ;
272         xyze[1] = 0. ;
273         xyze[2] = 0. ;
274         xyze[3] = cpvDigit->GetQpad() ;                           // amplitude in a pad
275         primary = -1;                                             // No need in primary for CPV
276         AddHit(fIshunt, primary, tracknumber, absid, xyze);
277
278         if (cpvDigit->GetQpad() > 0.02) {
279           xmean += cpvDigit->GetQpad() * (cpvDigit->GetXpad() + 0.5);
280           zmean += cpvDigit->GetQpad() * (cpvDigit->GetYpad() + 0.5);
281           qsum  += cpvDigit->GetQpad();
282         }
283       }
284       delete cpvDigits;
285     }
286   } // end of IHEP configuration
287   
288
289   if(gMC->CurrentVolID(copy) == gMC->VolId("PXTL") ) { //  We are inside a PBWO crystal
290     gMC->TrackPosition(pos) ;
291     xyze[0] = pos[0] ;
292     xyze[1] = pos[1] ;
293     xyze[2] = pos[2] ;
294     xyze[3] = gMC->Edep() ;
295
296   
297     if ( xyze[3] != 0 ) {  // Track is inside the crystal and deposits some energy 
298
299       gMC->CurrentVolOffID(10, relid[0]) ; // get the PHOS module number ;
300
301       if ( name == "MIXT" && strcmp(gMC->CurrentVolOffName(10),"PHO1") == 0 )
302         relid[0] += fGeom->GetNModules() - fGeom->GetNPPSDModules();      
303
304       relid[1] = 0   ;                    // means PBW04
305       gMC->CurrentVolOffID(4, relid[2]) ; // get the row number inside the module
306       gMC->CurrentVolOffID(3, relid[3]) ; // get the cell number inside the module
307       
308       // get the absolute Id number
309       fGeom->RelToAbsNumbering(relid, absid) ; 
310
311       // add current hit to the hit list
312         AddHit(fIshunt, primary,tracknumber, absid, xyze);
313
314
315     } // there is deposited energy
316   } // we are inside a PHOS Xtal
317 }
318
319 //____________________________________________________________________________
320 void AliPHOSv1::CPVDigitize (TLorentzVector p, Float_t *zxhit, Int_t moduleNumber, TClonesArray *cpvDigits)
321 {
322   // ------------------------------------------------------------------------
323   // Digitize one CPV hit:
324   // On input take exact 4-momentum p and position zxhit of the hit,
325   // find the pad response around this hit and
326   // put the amplitudes in the pads into array digits
327   //
328   // Author: Yuri Kharlov (after Serguei Sadovsky)
329   // 2 October 2000
330   // ------------------------------------------------------------------------
331
332   const Float_t kCelWr  = fGeom->GetPadSizePhi()/2;  // Distance between wires (2 wires above 1 pad)
333   const Float_t kDetR   = 0.1;     // Relative energy fluctuation in track for 100 e-
334   const Float_t kdEdx   = 4.0;     // Average energy loss in CPV;
335   const Int_t   kNgamz  = 5;       // Ionization size in Z
336   const Int_t   kNgamx  = 9;       // Ionization size in Phi
337   const Float_t kNoise = 0.03;    // charge noise in one pad
338
339   Float_t rnor1,rnor2;
340
341   // Just a reminder on axes notation in the CPV module:
342   // axis Z goes along the beam
343   // axis X goes across the beam in the module plane
344   // axis Y is a normal to the module plane showing from the IP
345
346   Float_t hitX  = zxhit[0];
347   Float_t hitZ  =-zxhit[1];
348   Float_t pX    = p.Px();
349   Float_t pZ    =-p.Pz();
350   Float_t pNorm = p.Py();
351   Float_t eloss = kdEdx;
352
353 //    cout << "CPVDigitize: YVK : "<<hitX<<" "<<hitZ<<" | "<<pX<<" "<<pZ<<" "<<pNorm<<endl;
354
355   Float_t dZY   = pZ/pNorm * fGeom->GetCPVGasThickness();
356   Float_t dXY   = pX/pNorm * fGeom->GetCPVGasThickness();
357   gRandom->Rannor(rnor1,rnor2);
358   eloss *= (1 + kDetR*rnor1) *
359            TMath::Sqrt((1 + ( pow(dZY,2) + pow(dXY,2) ) / pow(fGeom->GetCPVGasThickness(),2)));
360   Float_t zhit1 = hitZ + fGeom->GetCPVActiveSize(1)/2 - dZY/2;
361   Float_t xhit1 = hitX + fGeom->GetCPVActiveSize(0)/2 - dXY/2;
362   Float_t zhit2 = zhit1 + dZY;
363   Float_t xhit2 = xhit1 + dXY;
364
365   Int_t   iwht1 = (Int_t) (xhit1 / kCelWr);           // wire (x) coordinate "in"
366   Int_t   iwht2 = (Int_t) (xhit2 / kCelWr);           // wire (x) coordinate "out"
367
368   Int_t   nIter;
369   Float_t zxe[3][5];
370   if (iwht1==iwht2) {                      // incline 1-wire hit
371     nIter = 2;
372     zxe[0][0] = (zhit1 + zhit2 - dZY*0.57735) / 2;
373     zxe[1][0] = (iwht1 + 0.5) * kCelWr;
374     zxe[2][0] =  eloss/2;
375     zxe[0][1] = (zhit1 + zhit2 + dZY*0.57735) / 2;
376     zxe[1][1] = (iwht1 + 0.5) * kCelWr;
377     zxe[2][1] =  eloss/2;
378   }
379   else if (TMath::Abs(iwht1-iwht2) != 1) { // incline 3-wire hit
380     nIter = 3;
381     Int_t iwht3 = (iwht1 + iwht2) / 2;
382     Float_t xwht1 = (iwht1 + 0.5) * kCelWr; // wire 1
383     Float_t xwht2 = (iwht2 + 0.5) * kCelWr; // wire 2
384     Float_t xwht3 = (iwht3 + 0.5) * kCelWr; // wire 3
385     Float_t xwr13 = (xwht1 + xwht3) / 2;   // center 13
386     Float_t xwr23 = (xwht2 + xwht3) / 2;   // center 23
387     Float_t dxw1  = xhit1 - xwr13;
388     Float_t dxw2  = xhit2 - xwr23;
389     Float_t egm1  = TMath::Abs(dxw1) / ( TMath::Abs(dxw1) + TMath::Abs(dxw2) + kCelWr );
390     Float_t egm2  = TMath::Abs(dxw2) / ( TMath::Abs(dxw1) + TMath::Abs(dxw2) + kCelWr );
391     Float_t egm3  =           kCelWr / ( TMath::Abs(dxw1) + TMath::Abs(dxw2) + kCelWr );
392     zxe[0][0] = (dXY*(xwr13-xwht1)/dXY + zhit1 + zhit1) / 2;
393     zxe[1][0] =  xwht1;
394     zxe[2][0] =  eloss * egm1;
395     zxe[0][1] = (dXY*(xwr23-xwht1)/dXY + zhit1 + zhit2) / 2;
396     zxe[1][1] =  xwht2;
397     zxe[2][1] =  eloss * egm2;
398     zxe[0][2] =  dXY*(xwht3-xwht1)/dXY + zhit1;
399     zxe[1][2] =  xwht3;
400     zxe[2][2] =  eloss * egm3;
401   }
402   else {                                   // incline 2-wire hit
403     nIter = 2;
404     Float_t xwht1 = (iwht1 + 0.5) * kCelWr;
405     Float_t xwht2 = (iwht2 + 0.5) * kCelWr;
406     Float_t xwr12 = (xwht1 + xwht2) / 2;
407     Float_t dxw1  = xhit1 - xwr12;
408     Float_t dxw2  = xhit2 - xwr12;
409     Float_t egm1  = TMath::Abs(dxw1) / ( TMath::Abs(dxw1) + TMath::Abs(dxw2) );
410     Float_t egm2  = TMath::Abs(dxw2) / ( TMath::Abs(dxw1) + TMath::Abs(dxw2) );
411     zxe[0][0] = (zhit1 + zhit2 - dZY*egm1) / 2;
412     zxe[1][0] =  xwht1;
413     zxe[2][0] =  eloss * egm1;
414     zxe[0][1] = (zhit1 + zhit2 + dZY*egm2) / 2;
415     zxe[1][1] =  xwht2;
416     zxe[2][1] =  eloss * egm2;
417   }
418
419   // Finite size of ionization region
420
421   Int_t nCellZ  = fGeom->GetNumberOfCPVPadsZ();
422   Int_t nCellX  = fGeom->GetNumberOfCPVPadsPhi();
423   Int_t nz3     = (kNgamz+1)/2;
424   Int_t nx3     = (kNgamx+1)/2;
425   cpvDigits->Expand(nIter*kNgamx*kNgamz);
426   TClonesArray &ldigits = *(TClonesArray *)cpvDigits;
427
428   for (Int_t iter=0; iter<nIter; iter++) {
429
430     Float_t zhit = zxe[0][iter];
431     Float_t xhit = zxe[1][iter];
432     Float_t qhit = zxe[2][iter];
433     Float_t zcell = zhit / fGeom->GetPadSizeZ();
434     Float_t xcell = xhit / fGeom->GetPadSizePhi();
435     if ( zcell<=0      || xcell<=0 ||
436          zcell>=nCellZ || xcell>=nCellX) return;
437     Int_t izcell = (Int_t) zcell;
438     Int_t ixcell = (Int_t) xcell;
439     Float_t zc = zcell - izcell - 0.5;
440     Float_t xc = xcell - ixcell - 0.5;
441     for (Int_t iz=1; iz<=kNgamz; iz++) {
442       Int_t kzg = izcell + iz - nz3;
443       if (kzg<=0 || kzg>nCellZ) continue;
444       Float_t zg = (Float_t)(iz-nz3) - zc;
445       for (Int_t ix=1; ix<=kNgamx; ix++) {
446         Int_t kxg = ixcell + ix - nx3;
447         if (kxg<=0 || kxg>nCellX) continue;
448         Float_t xg = (Float_t)(ix-nx3) - xc;
449         
450         // Now calculate pad response
451         Float_t qpad = CPVPadResponseFunction(qhit,zg,xg);
452         qpad += kNoise*rnor2;
453         if (qpad<0) continue;
454         
455         // Fill the array with pad response ID and amplitude
456         new(ldigits[cpvDigits->GetEntriesFast()]) AliPHOSCPVDigit(kxg,kzg,qpad);
457       }
458     }
459   }
460 }
461
462 //____________________________________________________________________________
463 Float_t AliPHOSv1::CPVPadResponseFunction(Float_t qhit, Float_t zhit, Float_t xhit) {
464   // ------------------------------------------------------------------------
465   // Calculate the amplitude in one CPV pad using the
466   // cumulative pad response function
467   // Author: Yuri Kharlov (after Serguei Sadovski)
468   // 3 October 2000
469   // ------------------------------------------------------------------------
470
471   Double_t dz = fGeom->GetPadSizeZ()   / 2;
472   Double_t dx = fGeom->GetPadSizePhi() / 2;
473   Double_t z  = zhit * fGeom->GetPadSizeZ();
474   Double_t x  = xhit * fGeom->GetPadSizePhi();
475   Double_t amplitude = qhit *
476     (CPVCumulPadResponse(z+dz,x+dx) - CPVCumulPadResponse(z+dz,x-dx) -
477      CPVCumulPadResponse(z-dz,x+dx) + CPVCumulPadResponse(z-dz,x-dx));
478   return (Float_t)amplitude;
479 }
480
481 //____________________________________________________________________________
482 Double_t AliPHOSv1::CPVCumulPadResponse(Double_t x, Double_t y) {
483   // ------------------------------------------------------------------------
484   // Cumulative pad response function
485   // It includes several terms from the CF decomposition in electrostatics
486   // Note: this cumulative function is wrong since omits some terms
487   //       but the cell amplitude obtained with it is correct because
488   //       these omitting terms cancel
489   // Author: Yuri Kharlov (after Serguei Sadovski)
490   // 3 October 2000
491   // ------------------------------------------------------------------------
492
493   const Double_t kA=1.0;
494   const Double_t kB=0.7;
495
496   Double_t r2       = x*x + y*y;
497   Double_t xy       = x*y;
498   Double_t cumulPRF = 0;
499   for (Int_t i=0; i<=4; i++) {
500     Double_t b1 = (2*i + 1) * kB;
501     cumulPRF += TMath::Power(-1,i) * TMath::ATan( xy / (b1*TMath::Sqrt(b1*b1 + r2)) );
502   }
503   cumulPRF *= kA/(2*TMath::Pi());
504   return cumulPRF;
505 }
506