Added the option to write objects into separate files and improved the cleaning
[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   InitParameters() ; 
79 }
80
81 //____________________________________________________________________________ 
82 AliEMCALSDigitizer::AliEMCALSDigitizer(const char* headerFile, const char *sDigitsTitle):TTask(sDigitsTitle, headerFile)
83 {
84   // ctor
85   InitParameters() ; 
86   Init();
87 }
88
89 //____________________________________________________________________________ 
90 AliEMCALSDigitizer::~AliEMCALSDigitizer()
91 {
92   // dtor
93   
94   AliEMCALGetter * gime = AliEMCALGetter::GetInstance() ; 
95   if (gime) {
96     // remove the task from the folder list
97     gime->RemoveTask("S",GetName()) ;
98     
99     TString name(GetName()) ; 
100     if (! name.IsNull() ) 
101       if (name.Index(":") > 0)  
102         name.Remove(name.Index(":")) ; 
103     
104     // remove the Hits from the folder list
105     gime->RemoveObjects("H",name) ;
106     
107     // remove the SDigits from the folder list
108     gime->RemoveObjects("S", name) ;
109     
110     // Close the root file
111     gime->CloseFile() ; 
112     
113   }
114   fSplitFile = 0 ; 
115 }
116
117 //____________________________________________________________________________ 
118 void AliEMCALSDigitizer::Init(){
119
120   // Initialization: open root-file, allocate arrays for hits and sdigits,
121   // attach task SDigitizer to the list of EMCAL tasks
122   // 
123   // Initialization can not be done in the default constructor
124   //============================================================= YS
125   //  The initialisation is now done by the getter
126
127   if( strcmp(GetTitle(), "") == 0 )
128     SetTitle("galice.root") ;
129     
130   AliEMCALGetter * gime = AliEMCALGetter::GetInstance(GetTitle(), GetName(), "update") ;     
131   if ( gime == 0 ) {
132     cerr << "ERROR: AliEMCALSDigitizer::Init -> Could not obtain the Getter object !" << endl ; 
133     return ;
134   } 
135   
136   gime->PostSDigits( GetName(), GetTitle() ) ; 
137
138   TString sdname(GetName() );
139   sdname.Append(":") ;
140   sdname.Append(GetTitle() ) ;
141   SetName(sdname.Data()) ;
142   gime->PostSDigitizer(this) ;
143  
144  
145 }
146
147 //____________________________________________________________________________ 
148 void AliEMCALSDigitizer::InitParameters(){
149   fA = 0;
150   fB = 10000000.;
151   fTowerPrimThreshold = 0.01 ;
152   fPreShowerPrimThreshold = 0.0001 ; 
153   fNevents = 0 ; 
154   fPhotonElectronFactor = 5000. ; // photoelectrons per GeV 
155   fSplitFile = 0 ; 
156
157 }
158
159 //____________________________________________________________________________
160 void AliEMCALSDigitizer::Exec(Option_t *option) { 
161
162 // Collects all hits in the same active volume into digit
163  
164   if( strcmp(GetName(), "") == 0 )
165     Init() ;
166   
167   if (strstr(option, "print") ) {
168     Print("") ; 
169     return ; 
170   }
171   
172   if(strstr(option,"tim"))
173     gBenchmark->Start("EMCALSDigitizer");
174
175
176   //Check, if this branch already exits
177   gAlice->GetEvent(0) ;
178  
179   TString sdname(GetName()) ;
180   sdname.Remove(sdname.Index(GetTitle())-1) ;
181
182   if(gAlice->TreeS() ) {
183     TObjArray * lob = static_cast<TObjArray*>(gAlice->TreeS()->GetListOfBranches()) ;
184     TIter next(lob) ; 
185     TBranch * branch = 0 ;  
186     Bool_t emcalfound = kFALSE, sdigitizerfound = kFALSE ; 
187     
188      while ( (branch = (static_cast<TBranch*>(next()))) && (!emcalfound || !sdigitizerfound) ) {
189       TString thisName( GetName() ) ; 
190       TString branchName( branch->GetTitle() ) ; 
191       branchName.Append(":") ; 
192       if ( (strcmp(branch->GetName(), "EMCAL")==0) && thisName.BeginsWith(branchName) )  
193         emcalfound = kTRUE ;
194       
195       else if ( (strcmp(branch->GetName(), "AliEMCALSDigitizer")==0) && thisName.BeginsWith(branchName) )  
196         sdigitizerfound = kTRUE ; 
197     }
198     
199     if ( emcalfound || sdigitizerfound ) {
200       cerr << "WARNING: AliEMCALSDigitizer::Exec -> SDigits and/or SDigitizer branch with name " << GetName() 
201            << " already exits" << endl ;
202       return ; 
203     }   
204   }  
205
206   AliEMCALGetter * gime = AliEMCALGetter::GetInstance() ;  
207   Int_t nevents = (Int_t) gAlice->TreeE()->GetEntries() ; 
208   
209   Int_t ievent ;
210   for(ievent = 0; ievent < nevents; ievent++){
211     gime->Event(ievent,"H") ;
212     const TClonesArray * fHits = gime->Hits() ;
213     TClonesArray * sdigits = gime->SDigits(sdname.Data()) ;
214     sdigits->Clear();
215     Int_t nSdigits = 0 ;
216
217   //Collects all hits in the same active volume into digit
218   
219   
220     
221     
222     //Now made SDigits from hits, for EMCAL it is the same, so just copy    
223     //  Int_t itrack ;
224     // for (itrack=0; itrack < gAlice->GetNtrack(); itrack++){
225     //gime->Track(itrack);  
226       //=========== Get the EMCAL branch from Hits Tree for the Primary track itrack
227      
228       Int_t i;
229       for ( i = 0 ; i < fHits->GetEntries() ; i++ ) { // loop over all hits (hit = deposited energy/layer/entering particle)
230         AliEMCALHit * hit = dynamic_cast<AliEMCALHit*>(fHits->At(i)) ;
231         AliEMCALDigit * curSDigit = 0 ;
232         AliEMCALDigit * sdigit = 0 ;
233         Bool_t newsdigit = kTRUE; 
234
235         
236
237         // Assign primary number only if deposited energy is significant
238           
239         if( (!hit->IsInPreShower() && hit->GetEnergy() > fTowerPrimThreshold) || 
240             (hit->IsInPreShower() && hit->GetEnergy() > fPreShowerPrimThreshold)) {
241           curSDigit =  new AliEMCALDigit( hit->GetPrimary(),
242                                           hit->GetIparent(),Layer2TowerID(hit->GetId(),hit->IsInPreShower()), 
243                                           Digitize(hit->GetEnergy()), 
244                                           hit->GetTime()) ;
245         } else {
246           curSDigit =  new AliEMCALDigit( -1               , 
247                                           -1               ,
248                                           Layer2TowerID(hit->GetId(),hit->IsInPreShower()), 
249                                           Digitize(hit->GetEnergy()), 
250                                           hit->GetTime() ) ;    
251         }
252         Int_t check = 0 ;
253         for(check= 0; check < nSdigits ; check++) {
254           sdigit = (AliEMCALDigit *)sdigits->At(check);
255           if( sdigit->GetId() == curSDigit->GetId()) { // Are we in the same tower or the same preshower ?              
256               *sdigit = *sdigit + *curSDigit;
257    
258               newsdigit = kFALSE;
259           }
260         }
261         if (newsdigit) { 
262           new((*sdigits)[nSdigits])  AliEMCALDigit(*curSDigit);
263           nSdigits++ ;  
264         }
265       }  // loop over all hits (hit = deposited energy/layer/entering particle)
266       //    } // loop over tracks
267       
268       sdigits->Sort() ;
269       
270       nSdigits = sdigits->GetEntriesFast() ;
271       if (nSdigits > 0) { 
272         sdigits->Expand(nSdigits) ;
273         
274         //  Int_t i ;
275         const AliEMCALGeometry * geom = gime->EMCALGeometry() ; 
276         
277         Int_t lastPreShowerIndex = nSdigits - 1 ;
278         if (!(dynamic_cast<AliEMCALDigit *>(sdigits->At(lastPreShowerIndex))->IsInPreShower()))
279           lastPreShowerIndex = -2; 
280         Int_t firstPreShowerIndex = 100000 ; 
281         Int_t index ; 
282         AliEMCALDigit * sdigit = 0 ;
283         for ( index = 0; index < nSdigits ; index++) {
284           sdigit = dynamic_cast<AliEMCALDigit *>(sdigits->At(index) ) ;
285           if (sdigit->IsInPreShower() ){ 
286             firstPreShowerIndex = index ;
287             break ;
288           }
289         }
290         
291         AliEMCALDigit * preshower ;
292         AliEMCALDigit * tower ;
293         Int_t lastIndex = lastPreShowerIndex +1 ; 
294         
295         
296         for (index = firstPreShowerIndex ; index <= lastPreShowerIndex; index++) {
297           preshower = dynamic_cast<AliEMCALDigit *>(sdigits->At(index) ); 
298           Bool_t towerFound = kFALSE ;
299           Int_t jndex ; 
300           for (jndex = 0; jndex < firstPreShowerIndex; jndex++) {
301             tower  = dynamic_cast<AliEMCALDigit *>(sdigits->At(jndex) ); 
302             if ( (preshower->GetId() - (geom->GetNZ() * geom->GetNPhi()) ) == tower->GetId() ) {          
303               Float_t towerEnergy  = static_cast<Float_t>(tower->GetAmp()) ; 
304               Float_t preshoEnergy = static_cast<Float_t>(preshower->GetAmp()) ; 
305               towerEnergy +=preshoEnergy ; 
306               *tower = *tower + *preshower    ; // and add preshower multiplied by layer ratio to tower
307               tower->SetAmp(static_cast<Int_t>(TMath::Ceil(towerEnergy))) ; 
308               towerFound = kTRUE ;
309             }
310           }
311           if ( !towerFound ) { 
312             
313             new((*sdigits)[lastIndex])  AliEMCALDigit(*preshower);
314             AliEMCALDigit * temp = dynamic_cast<AliEMCALDigit *>(sdigits->At(lastIndex)) ;
315             temp->SetId(temp->GetId() - (geom->GetNZ() * geom->GetNPhi()) ) ;
316             lastIndex++ ; 
317           }
318         }
319         
320         sdigits->Sort() ;
321         Int_t NPrimarymax = -1 ; 
322         for (i = 0 ; i < sdigits->GetEntriesFast() ; i++) { 
323           sdigit = dynamic_cast<AliEMCALDigit *>(sdigits->At(i)) ;
324           sdigit->SetIndexInList(i) ;
325         }
326         
327         for (i = 0 ; i < sdigits->GetEntriesFast() ; i++) { 
328           if (((dynamic_cast<AliEMCALDigit *>(sdigits->At(i)))->GetNprimary()) > NPrimarymax)
329             NPrimarymax = ((dynamic_cast<AliEMCALDigit *>(sdigits->At(i)))->GetNprimary()) ;
330         }
331       }
332         if(gAlice->TreeS() == 0)
333           gAlice->MakeTree("S",fSplitFile);
334
335       //First list of sdigits
336       Int_t bufferSize = 32000 ;    
337       TBranch * sdigitsBranch = gAlice->TreeS()->Branch("EMCAL",&sdigits,bufferSize);
338       sdigitsBranch->SetTitle(sdname);
339       
340       //second - SDigitizer
341       Int_t splitlevel = 0 ;
342       AliEMCALSDigitizer * sd = this ;
343       TBranch * sdigitizerBranch = gAlice->TreeS()->Branch("AliEMCALSDigitizer","AliEMCALSDigitizer",
344                                                            &sd,bufferSize,splitlevel); 
345       sdigitizerBranch->SetTitle(sdname);
346       
347       sdigitsBranch->Fill() ; 
348       sdigitizerBranch->Fill() ; 
349       gAlice->TreeS()->AutoSave() ;
350            
351       if(strstr(option,"deb"))
352         PrintSDigits(option) ;
353       
354   }
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   gAlice->Write(0, TObject::kOverwrite);
411  
412   TTree *treeE  = gAlice->TreeE();
413   if (!treeE) {
414     cerr << "ERROR: AliEMCALSDigitizer::SetSPlitFile -> No TreeE found "<<endl;
415    abort() ;
416   }      
417   
418   // copy TreeE
419   
420   AliHeader *header = new AliHeader();
421   treeE->SetBranchAddress("Header", &header);
422   treeE->SetBranchStatus("*",1);
423   TTree *treeENew =  treeE->CloneTree();
424   treeENew->Write(0, TObject::kOverwrite);
425   
426   // copy AliceGeom
427   TGeometry *AliceGeom = static_cast<TGeometry*>(cwd->Get("AliceGeom"));
428   if (!AliceGeom) {
429     cerr << "ERROR: AliEMCALSDigitizer::SetSPlitFile -> AliceGeom was not found in the input file "<<endl;
430     abort() ;
431   }
432   AliceGeom->Write(0, TObject::kOverwrite) ;
433   
434   gAlice->MakeTree("S",fSplitFile);
435   cwd->cd() ; 
436   cout << "INFO: AliEMCALSDigitizer::SetSPlitFile -> SDigits will be stored in " << splitFileName.Data() << endl ; 
437 }
438
439 //__________________________________________________________________
440 void AliEMCALSDigitizer::Print(Option_t* option)const{
441   cout << "------------------- "<< GetName() << " -------------" << endl ;
442   cout << "   Writing SDigitis to branch with title  " << GetName() << endl ;
443   cout << "   with digitization parameters  A               = " << fA << endl ;
444   cout << "                                 B               = " << fB << endl ;
445   cout << "   Threshold for Primary assignment in Tower     = " << fTowerPrimThreshold << endl ; 
446   cout << "   Threshold for Primary assignment in PreShower = " << fPreShowerPrimThreshold << endl ; 
447   cout << "---------------------------------------------------"<<endl ;
448   
449 }
450 //__________________________________________________________________
451 Bool_t AliEMCALSDigitizer::operator==( AliEMCALSDigitizer const &sd )const{
452   if( (fA==sd.fA)&&(fB==sd.fB)&&
453       (fTowerPrimThreshold==sd.fTowerPrimThreshold) &&
454       (fPreShowerPrimThreshold==sd.fPreShowerPrimThreshold))
455     return kTRUE ;
456   else
457     return kFALSE ;
458 }
459 //__________________________________________________________________
460 void AliEMCALSDigitizer::PrintSDigits(Option_t * option){
461   //Prints list of digits produced at the current pass of AliEMCALDigitizer
462   
463   AliEMCALGetter * gime = AliEMCALGetter::GetInstance() ; 
464   TString sdname(GetName()) ;
465   sdname.Remove(sdname.Index(GetTitle())-1) ;
466   const TClonesArray * sdigits = gime->SDigits(sdname.Data()) ; 
467   
468   cout << "AliEMCALSDigitiser: event " << gAlice->GetEvNumber() << endl ;
469   cout << "      Number of entries in SDigits list " << sdigits->GetEntriesFast() << endl ;
470   cout << endl ;
471   if(strstr(option,"all")||strstr(option,"EMC")){
472
473     //loop over digits
474     AliEMCALDigit * digit;
475     cout << "SDigit Id " << " Amplitude " <<  "     Time " << "     Index "  <<  " Nprim " << " Primaries list " <<  endl;    
476     Int_t index ;
477     for (index = 0 ; index < sdigits->GetEntries() ; index++) {
478       digit = (AliEMCALDigit * )  sdigits->At(index) ;
479       cout << setw(6)  <<  digit->GetId() << "   "  <<  setw(10)  <<  digit->GetAmp() <<   "    "  << digit->GetTime()
480            << setw(6)  <<  digit->GetIndexInList() << "    "   
481            << setw(5)  <<  digit->GetNprimary() <<"    ";
482       
483       Int_t iprimary;
484       for (iprimary=0; iprimary<digit->GetNprimary(); iprimary++)
485         cout << " "  <<  digit->GetPrimary(iprimary+1) << "  ";
486       cout << endl;      
487     }
488     cout <<endl;
489   }
490 }
491 //________________________________________________________________________
492 Int_t AliEMCALSDigitizer::Layer2TowerID(Int_t ihit, Bool_t preshower){
493   // Method to Transform from Hit Id to Digit Id
494   // This function should be one to one
495   AliEMCALGetter * gime = AliEMCALGetter::GetInstance() ;
496   const AliEMCALGeometry * geom = gime->EMCALGeometry();
497   Int_t ieta  = ((ihit-1)/geom->GetNPhi())%geom->GetNZ(); // eta Tower Index
498   Int_t iphi = (ihit-1)%(geom->GetNPhi())+1; //phi Tower Index
499   Int_t it = -10;
500   Int_t ipre = 0;
501
502   if (preshower)ipre = 1;
503   if (iphi > 0 && ieta >= 0){
504     it = iphi+ieta*geom->GetNPhi() + ipre*geom->GetNPhi()*geom->GetNZ();
505     return it;
506   }else{
507     cerr << " AliEMCALSDigitizer::Layer2TowerID() -- there is an error "<< endl << "Eta number = "
508          << ieta << "Phi number = " << iphi << endl ;
509     return it;
510   } // end if iphi>0 && ieta>0
511 }
512 //_______________________________________________________________________________________
513 // void AliEMCALSDigitizer::TestTowerID(void)
514 // {
515 //   Int_t j;
516
517 //   Bool_t preshower = kFALSE;
518 //   for (j = 0 ; j < 10 ; j++){  // loop over hit id
519 //     Int_t i;
520 //    for (i = 0 ; i <= 2 ; i++){  // loop over 
521 //      Int_t k = i*96*144+j*144+1;
522 //       cout << " Hit Index = " << k << "   " << j*10 << "   TOWERID = " <<  Layer2TowerID(k, preshower) << endl ;
523 //     }
524 //   }
525 // }