2eb4b9b41f086f5b35df7dc3b079483364210725
[u/mrichter/AliRoot.git] / EMCAL / AliEMCALSDigitizer.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 // This is a TTask that makes SDigits out of Hits
20 // A Summable Digits is the sum of all hits originating 
21 // from one in one tower of the EMCAL 
22 // A threshold for assignment of the primary to SDigit is applied 
23 // SDigits are written to TreeS, branch "EMCAL"
24 // AliEMCALSDigitizer with all current parameters is written 
25 // to TreeS branch "AliEMCALSDigitizer".
26 // Both branches have the same title. If necessary one can produce 
27 // another set of SDigits with different parameters. Two versions
28 // can be distunguished using titles of the branches.
29 // User case:
30 // root [0] AliEMCALSDigitizer * s = new AliEMCALSDigitizer("galice.root")
31 // Warning in <TDatabasePDG::TDatabasePDG>: object already instantiated
32 // root [1] s->ExecuteTask()
33 //             // Makes SDigitis for all events stored in galice.root
34 // root [2] s->SetPedestalParameter(0.001)
35 //             // One can change parameters of digitization
36 // root [3] s->SetSDigitsBranch("Redestal 0.001")
37 //             // and write them into the new branch
38 // root [4] s->ExeciteTask("deb all tim")
39 //             // available parameters:
40 //             deb - print # of produced SDigitis
41 //             deb all  - print # and list of produced SDigits
42 //             tim - print benchmarking information
43 //
44 //*-- Author : Sahal Yacoob (LBL)
45 // based on  : AliPHOSSDigitzer 
46 //////////////////////////////////////////////////////////////////////////////
47
48
49 // --- ROOT system ---
50 #include "TFile.h"
51 #include "TTask.h"
52 #include "TTree.h"
53 #include "TSystem.h"
54 #include "TROOT.h"
55 #include "TFolder.h"
56 #include "TGeometry.h"
57 #include "TBenchmark.h"
58 // --- Standard library ---
59 #include <iomanip.h>
60
61 // --- AliRoot header files ---
62 #include "AliRun.h"
63 #include "AliHeader.h"
64 #include "AliEMCALDigit.h"
65 #include "AliEMCALHit.h"
66 #include "AliEMCALSDigitizer.h"
67 #include "AliEMCALGeometry.h"
68 #include "AliEMCALv1.h"
69 #include "AliEMCALGetter.h"
70
71 ClassImp(AliEMCALSDigitizer)
72
73            
74 //____________________________________________________________________________ 
75   AliEMCALSDigitizer::AliEMCALSDigitizer():TTask("AliEMCALSDigitizer","") 
76 {
77   // ctor
78   fA = fB =  fNevents = 0 ; 
79   fTowerPrimThreshold = fPreShowerPrimThreshold = fPhotonElectronFactor  = 0. ;
80   fHits = fSDigits = fSDigits = 0 ;
81   fSplitFile = 0 ; 
82   fIsInitialized = kFALSE ;
83
84
85 }
86
87 //____________________________________________________________________________ 
88 AliEMCALSDigitizer::AliEMCALSDigitizer(const char* headerFile, const char *sDigitsTitle):TTask(sDigitsTitle, headerFile)
89 {
90   // ctor
91   fA = 0;
92   fB = 10000000.;
93   fTowerPrimThreshold = 0.01 ;
94   fPreShowerPrimThreshold = 0.0001 ; 
95   fNevents = 0 ; 
96   fPhotonElectronFactor = 5000. ; // photoelectrons per GeV 
97   fSplitFile = 0 ; 
98   Init();
99 }
100
101 //____________________________________________________________________________ 
102 AliEMCALSDigitizer::~AliEMCALSDigitizer()
103 {
104   // dtor
105
106   if (fSplitFile) 
107     if ( fSplitFile->IsOpen() ) 
108       fSplitFile->Close() ; 
109   // Close the root file
110   AliEMCALGetter * gime = AliEMCALGetter::GetInstance() ; 
111   gime->CloseFile() ; 
112
113   // remove the task from the folder list
114   gime->RemoveTask("S",GetName()) ;
115
116   TString name(GetName()) ; 
117   name.Remove(name.Index(":")) ; 
118
119  // remove the Hits from the folder list
120   gime->RemoveObjects("H",name) ;
121
122  // remove the SDigits from the folder list
123   gime->RemoveObjects("S", name) ;
124 }
125
126 //____________________________________________________________________________ 
127 void AliEMCALSDigitizer::Init(){
128
129   // Initialization: open root-file, allocate arrays for hits and sdigits,
130   // attach task SDigitizer to the list of EMCAL tasks
131   // 
132   // Initialization can not be done in the default constructor
133   //============================================================= YS
134   //  The initialisation is now done by the getter
135
136   if( strcmp(GetTitle(), "") == 0 )
137     SetTitle("galice.root") ;
138     
139   AliEMCALGetter * gime = AliEMCALGetter::GetInstance(GetTitle(), GetName(), "update") ;     
140   if ( gime == 0 ) {
141     cerr << "ERROR: AliEMCALSDigitizer::Init -> Could not obtain the Getter object !" << endl ; 
142     return ;
143   } 
144   
145   gime->PostSDigits( GetName(), GetTitle() ) ; 
146
147   TString sdname(GetName() );
148   sdname.Append(":") ;
149   sdname.Append(GetTitle() ) ;
150   SetName(sdname.Data()) ;
151   gime->PostSDigitizer(this) ;
152  
153  
154  }
155 //____________________________________________________________________________
156 void AliEMCALSDigitizer::Exec(Option_t *option) { 
157
158 // Collects all hits in the same active volume into digit
159  
160   if( strcmp(GetName(), "") == 0 )
161     Init() ;
162   
163   if (strstr(option, "print") ) {
164     Print("") ; 
165     return ; 
166   }
167   
168   if(strstr(option,"tim"))
169     gBenchmark->Start("EMCALSDigitizer");
170
171
172   //Check, if this branch already exits
173   gAlice->GetEvent(0) ;
174  
175   TString sdname(GetName()) ;
176   sdname.Remove(sdname.Index(GetTitle())-1) ;
177
178   if(gAlice->TreeS() ) {
179     TObjArray * lob = static_cast<TObjArray*>(gAlice->TreeS()->GetListOfBranches()) ;
180     TIter next(lob) ; 
181     TBranch * branch = 0 ;  
182     Bool_t emcalfound = kFALSE, sdigitizerfound = kFALSE ; 
183     
184      while ( (branch = (static_cast<TBranch*>(next()))) && (!emcalfound || !sdigitizerfound) ) {
185       TString thisName( GetName() ) ; 
186       TString branchName( branch->GetTitle() ) ; 
187       branchName.Append(":") ; 
188       if ( (strcmp(branch->GetName(), "EMCAL")==0) && thisName.BeginsWith(branchName) )  
189         emcalfound = kTRUE ;
190       
191       else if ( (strcmp(branch->GetName(), "AliEMCALSDigitizer")==0) && thisName.BeginsWith(branchName) )  
192         sdigitizerfound = kTRUE ; 
193     }
194     
195     if ( emcalfound || sdigitizerfound ) {
196       cerr << "WARNING: AliEMCALSDigitizer::Exec -> SDigits and/or SDigitizer branch with name " << GetName() 
197            << " already exits" << endl ;
198       return ; 
199     }   
200   }  
201
202   AliEMCALGetter * gime = AliEMCALGetter::GetInstance() ;  
203   Int_t nevents = (Int_t) gAlice->TreeE()->GetEntries() ; 
204   
205   Int_t ievent ;
206   for(ievent = 0; ievent < nevents; ievent++){
207     gime->Event(ievent,"H") ;
208     const TClonesArray * fHits = gime->Hits() ;
209     TClonesArray * sdigits = gime->SDigits(sdname.Data()) ;
210     sdigits->Clear();
211     Int_t nSdigits = 0 ;
212
213   //Collects all hits in the same active volume into digit
214   
215   
216     
217     
218     //Now made SDigits from hits, for EMCAL it is the same, so just copy    
219     //  Int_t itrack ;
220     // for (itrack=0; itrack < gAlice->GetNtrack(); itrack++){
221     //gime->Track(itrack);  
222       //=========== Get the EMCAL branch from Hits Tree for the Primary track itrack
223      
224       Int_t i;
225       for ( i = 0 ; i < fHits->GetEntries() ; i++ ) { // loop over all hits (hit = deposited energy/layer/entering particle)
226         AliEMCALHit * hit = dynamic_cast<AliEMCALHit*>(fHits->At(i)) ;
227         AliEMCALDigit * curSDigit = 0 ;
228         AliEMCALDigit * sdigit = 0 ;
229         Bool_t newsdigit = kTRUE; 
230
231         
232
233         // Assign primary number only if deposited energy is significant
234           
235         if( (!hit->IsInPreShower() && hit->GetEnergy() > fTowerPrimThreshold) || 
236             (hit->IsInPreShower() && hit->GetEnergy() > fPreShowerPrimThreshold)) {
237           curSDigit =  new AliEMCALDigit( hit->GetPrimary(),
238                                           hit->GetIparent(),Layer2TowerID(hit->GetId(),hit->IsInPreShower()), 
239                                           Digitize(hit->GetEnergy()), 
240                                           hit->GetTime()) ;
241         } else {
242           curSDigit =  new AliEMCALDigit( -1               , 
243                                           -1               ,
244                                           Layer2TowerID(hit->GetId(),hit->IsInPreShower()), 
245                                           Digitize(hit->GetEnergy()), 
246                                           hit->GetTime() ) ;    
247         }
248         Int_t check = 0 ;
249         for(check= 0; check < nSdigits ; check++) {
250           sdigit = (AliEMCALDigit *)sdigits->At(check);
251           if( sdigit->GetId() == curSDigit->GetId()) { // Are we in the same tower or the same preshower ?              
252               *sdigit = *sdigit + *curSDigit;
253    
254               newsdigit = kFALSE;
255           }
256         }
257         if (newsdigit) { 
258           new((*sdigits)[nSdigits])  AliEMCALDigit(*curSDigit);
259           nSdigits++ ;  
260         }
261       }  // loop over all hits (hit = deposited energy/layer/entering particle)
262       //    } // loop over tracks
263       
264       sdigits->Sort() ;
265       
266       nSdigits = sdigits->GetEntriesFast() ;
267       if (nSdigits > 0) { 
268         sdigits->Expand(nSdigits) ;
269         
270         //  Int_t i ;
271         const AliEMCALGeometry * geom = gime->EMCALGeometry() ; 
272         
273         Int_t lastPreShowerIndex = nSdigits - 1 ;
274         if (!(dynamic_cast<AliEMCALDigit *>(sdigits->At(lastPreShowerIndex))->IsInPreShower()))
275           lastPreShowerIndex = -2; 
276         Int_t firstPreShowerIndex = 100000 ; 
277         Int_t index ; 
278         AliEMCALDigit * sdigit = 0 ;
279         for ( index = 0; index < nSdigits ; index++) {
280           sdigit = dynamic_cast<AliEMCALDigit *>(sdigits->At(index) ) ;
281           if (sdigit->IsInPreShower() ){ 
282             firstPreShowerIndex = index ;
283             break ;
284           }
285         }
286         
287         AliEMCALDigit * preshower ;
288         AliEMCALDigit * tower ;
289         Int_t lastIndex = lastPreShowerIndex +1 ; 
290         
291         
292         for (index = firstPreShowerIndex ; index <= lastPreShowerIndex; index++) {
293           preshower = dynamic_cast<AliEMCALDigit *>(sdigits->At(index) ); 
294           Bool_t towerFound = kFALSE ;
295           Int_t jndex ; 
296           for (jndex = 0; jndex < firstPreShowerIndex; jndex++) {
297             tower  = dynamic_cast<AliEMCALDigit *>(sdigits->At(jndex) ); 
298             if ( (preshower->GetId() - (geom->GetNZ() * geom->GetNPhi()) ) == tower->GetId() ) {          
299               Float_t towerEnergy  = static_cast<Float_t>(tower->GetAmp()) ; 
300               Float_t preshoEnergy = static_cast<Float_t>(preshower->GetAmp()) ; 
301               towerEnergy +=preshoEnergy ; 
302               *tower = *tower + *preshower    ; // and add preshower multiplied by layer ratio to tower
303               tower->SetAmp(static_cast<Int_t>(TMath::Ceil(towerEnergy))) ; 
304               towerFound = kTRUE ;
305             }
306           }
307           if ( !towerFound ) { 
308             
309             new((*sdigits)[lastIndex])  AliEMCALDigit(*preshower);
310             AliEMCALDigit * temp = dynamic_cast<AliEMCALDigit *>(sdigits->At(lastIndex)) ;
311             temp->SetId(temp->GetId() - (geom->GetNZ() * geom->GetNPhi()) ) ;
312             lastIndex++ ; 
313           }
314         }
315         
316         sdigits->Sort() ;
317         Int_t NPrimarymax = -1 ; 
318         for (i = 0 ; i < sdigits->GetEntriesFast() ; i++) { 
319           sdigit = dynamic_cast<AliEMCALDigit *>(sdigits->At(i)) ;
320           sdigit->SetIndexInList(i) ;
321         }
322         
323         for (i = 0 ; i < sdigits->GetEntriesFast() ; i++) { 
324           if (((dynamic_cast<AliEMCALDigit *>(sdigits->At(i)))->GetNprimary()) > NPrimarymax)
325             NPrimarymax = ((dynamic_cast<AliEMCALDigit *>(sdigits->At(i)))->GetNprimary()) ;
326         }
327       }
328         if(gAlice->TreeS() == 0)
329           gAlice->MakeTree("S",fSplitFile);
330
331       //First list of sdigits
332       Int_t bufferSize = 32000 ;    
333       TBranch * sdigitsBranch = gAlice->TreeS()->Branch("EMCAL",&sdigits,bufferSize);
334       sdigitsBranch->SetTitle(sdname);
335       
336       //second - SDigitizer
337       Int_t splitlevel = 0 ;
338       AliEMCALSDigitizer * sd = this ;
339       TBranch * sdigitizerBranch = gAlice->TreeS()->Branch("AliEMCALSDigitizer","AliEMCALSDigitizer",
340                                                            &sd,bufferSize,splitlevel); 
341       sdigitizerBranch->SetTitle(sdname);
342       
343       sdigitsBranch->Fill() ; 
344       sdigitizerBranch->Fill() ; 
345       gAlice->TreeS()->AutoSave() ;
346            
347       if(strstr(option,"deb"))
348         PrintSDigits(option) ;
349       
350   }
351   
352   if (fSplitFile) 
353     if ( fSplitFile->IsOpen() ) 
354       fSplitFile->Close() ; 
355   
356   if(strstr(option,"tim")){
357     gBenchmark->Stop("EMCALSDigitizer");
358     cout << "AliEMCALSDigitizer:" << endl ;
359     cout << "   took " << gBenchmark->GetCpuTime("EMCALSDigitizer") << " seconds for SDigitizing " 
360          <<  gBenchmark->GetCpuTime("EMCALSDigitizer")/fNevents << " seconds per event " << endl ;
361     cout << endl ;
362   }
363   
364   
365 }
366 //__________________________________________________________________
367 void AliEMCALSDigitizer::SetSDigitsBranch(const char * title ){
368  
369   // Setting title to branch SDigits 
370
371   TString stitle(title) ;
372
373   // check if branch with title already exists
374   TBranch * sdigitsBranch    = 
375     static_cast<TBranch*>(gAlice->TreeS()->GetListOfBranches()->FindObject("EMCAL")) ; 
376   TBranch * sdigitizerBranch =  
377     static_cast<TBranch*>(gAlice->TreeS()->GetListOfBranches()->FindObject("AliEMCALSDigitizer")) ;
378   const char * sdigitsTitle    = sdigitsBranch ->GetTitle() ;  
379   const char * sdigitizerTitle = sdigitizerBranch ->GetTitle() ;
380   if ( stitle.CompareTo(sdigitsTitle)==0 || stitle.CompareTo(sdigitizerTitle)==0 ){
381     cerr << "ERROR: AliEMCALSdigitizer::SetSDigitsBranch -> Cannot overwrite existing branch with title " << title << endl ;
382     return ;
383   }
384   
385   cout << "AliEMCALSdigitizer::SetSDigitsBranch -> Changing SDigits file from " << GetName() << " to " << title << endl ;
386
387   SetName(title) ; 
388     
389   // Post to the WhiteBoard
390   AliEMCALGetter * gime = AliEMCALGetter::GetInstance() ; 
391   gime->PostSDigits( title, GetTitle()) ; 
392
393
394 }
395
396 //__________________________________________________________________
397 void AliEMCALSDigitizer::SetSplitFile(const TString splitFileName) 
398 {
399   // Diverts the SDigits in a file separate from the hits file
400   
401   TDirectory * cwd = gDirectory ;
402
403   if ( !(gAlice->GetTreeSFileName() == splitFileName) ) {
404     if (gAlice->GetTreeSFile() )  
405       gAlice->GetTreeSFile()->Close() ; 
406   }
407
408   fSplitFile = gAlice->InitTreeFile("S",splitFileName.Data());
409   fSplitFile->cd() ; 
410   if ( !fSplitFile->Get("gAlice") ) 
411     gAlice->Write();
412   
413   TTree *treeE  = gAlice->TreeE();
414   if (!treeE) {
415     cerr << "ERROR: AliEMCALSDigitizer::SetSPlitFile -> No TreeE found "<<endl;
416    abort() ;
417   }      
418   
419   // copy TreeE
420   if ( !fSplitFile->Get("TreeE") ) {
421     AliHeader *header = new AliHeader();
422     treeE->SetBranchAddress("Header", &header);
423     treeE->SetBranchStatus("*",1);
424     TTree *treeENew =  treeE->CloneTree();
425     treeENew->Write();
426   }
427   
428   // copy AliceGeom
429   if ( !fSplitFile->Get("AliceGeom") ) {
430     TGeometry *AliceGeom = static_cast<TGeometry*>(cwd->Get("AliceGeom"));
431     if (!AliceGeom) {
432       cerr << "ERROR: AliEMCALSDigitizer::SetSPlitFile -> AliceGeom was not found in the input file "<<endl;
433       abort() ;
434     }
435     AliceGeom->Write();
436   }
437   
438   gAlice->MakeTree("S",fSplitFile);
439   cwd->cd() ; 
440   cout << "INFO: AliEMCALSDigitizer::SetSPlitFile -> SDigits will be stored in " << splitFileName.Data() << endl ; 
441 }
442
443 //__________________________________________________________________
444 void AliEMCALSDigitizer::Print(Option_t* option)const{
445   cout << "------------------- "<< GetName() << " -------------" << endl ;
446   cout << "   Writing SDigitis to branch with title  " << GetName() << endl ;
447   cout << "   with digitization parameters  A               = " << fA << endl ;
448   cout << "                                 B               = " << fB << endl ;
449   cout << "   Threshold for Primary assignment in Tower     = " << fTowerPrimThreshold << endl ; 
450   cout << "   Threshold for Primary assignment in PreShower = " << fPreShowerPrimThreshold << endl ; 
451   cout << "---------------------------------------------------"<<endl ;
452   
453 }
454 //__________________________________________________________________
455 Bool_t AliEMCALSDigitizer::operator==( AliEMCALSDigitizer const &sd )const{
456   if( (fA==sd.fA)&&(fB==sd.fB)&&
457       (fTowerPrimThreshold==sd.fTowerPrimThreshold) &&
458       (fPreShowerPrimThreshold==sd.fPreShowerPrimThreshold))
459     return kTRUE ;
460   else
461     return kFALSE ;
462 }
463 //__________________________________________________________________
464 void AliEMCALSDigitizer::PrintSDigits(Option_t * option){
465   //Prints list of digits produced at the current pass of AliEMCALDigitizer
466   
467   AliEMCALGetter * gime = AliEMCALGetter::GetInstance() ; 
468   TString sdname(GetName()) ;
469   sdname.Remove(sdname.Index(GetTitle())-1) ;
470   const TClonesArray * sdigits = gime->SDigits(sdname.Data()) ; 
471   
472   cout << "AliEMCALSDigitiser: event " << gAlice->GetEvNumber() << endl ;
473   cout << "      Number of entries in SDigits list " << sdigits->GetEntriesFast() << endl ;
474   cout << endl ;
475   if(strstr(option,"all")||strstr(option,"EMC")){
476
477     //loop over digits
478     AliEMCALDigit * digit;
479     cout << "SDigit Id " << " Amplitude " <<  "     Time " << "     Index "  <<  " Nprim " << " Primaries list " <<  endl;    
480     Int_t index ;
481     for (index = 0 ; index < sdigits->GetEntries() ; index++) {
482       digit = (AliEMCALDigit * )  sdigits->At(index) ;
483       cout << setw(6)  <<  digit->GetId() << "   "  <<  setw(10)  <<  digit->GetAmp() <<   "    "  << digit->GetTime()
484            << setw(6)  <<  digit->GetIndexInList() << "    "   
485            << setw(5)  <<  digit->GetNprimary() <<"    ";
486       
487       Int_t iprimary;
488       for (iprimary=0; iprimary<digit->GetNprimary(); iprimary++)
489         cout << " "  <<  digit->GetPrimary(iprimary+1) << "  ";
490       cout << endl;      
491     }
492     cout <<endl;
493   }
494 }
495 //________________________________________________________________________
496 Int_t AliEMCALSDigitizer::Layer2TowerID(Int_t ihit, Bool_t preshower){
497   // Method to Transform from Hit Id to Digit Id
498   // This function should be one to one
499   AliEMCALGetter * gime = AliEMCALGetter::GetInstance() ;
500   const AliEMCALGeometry * geom = gime->EMCALGeometry();
501   Int_t ieta  = ((ihit-1)/geom->GetNPhi())%geom->GetNZ(); // eta Tower Index
502   Int_t iphi = (ihit-1)%(geom->GetNPhi())+1; //phi Tower Index
503   Int_t it = -10;
504   Int_t ipre = 0;
505
506   if (preshower)ipre = 1;
507   if (iphi > 0 && ieta >= 0){
508     it = iphi+ieta*geom->GetNPhi() + ipre*geom->GetNPhi()*geom->GetNZ();
509     return it;
510   }else{
511     cerr << " AliEMCALSDigitizer::Layer2TowerID() -- there is an error "<< endl << "Eta number = "
512          << ieta << "Phi number = " << iphi << endl ;
513     return it;
514   } // end if iphi>0 && ieta>0
515 }
516 //_______________________________________________________________________________________
517 // void AliEMCALSDigitizer::TestTowerID(void)
518 // {
519 //   Int_t j;
520
521 //   Bool_t preshower = kFALSE;
522 //   for (j = 0 ; j < 10 ; j++){  // loop over hit id
523 //     Int_t i;
524 //    for (i = 0 ; i <= 2 ; i++){  // loop over 
525 //      Int_t k = i*96*144+j*144+1;
526 //       cout << " Hit Index = " << k << "   " << j*10 << "   TOWERID = " <<  Layer2TowerID(k, preshower) << endl ;
527 //     }
528 //   }
529 // }