d86e4b8abb75485567a539139e92623019ef876c
[u/mrichter/AliRoot.git] / PHOS / AliPHOSSDigitizer.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
17 /* $Id$ */
18
19 /* History of cvs commits:
20  *
21  * $Log$
22  * Revision 1.56  2007/10/19 18:04:29  schutz
23  * The standalone QA data maker is called from AliSimulation and AliReconstruction outside the event loop; i.e. re-reading the data. The QA data making in the event loop has been commented out.
24  *
25  * Revision 1.55  2007/10/14 21:08:10  schutz
26  * Introduced the checking of QA results from previous step before entering the event loop
27  *
28  * Revision 1.54  2007/10/10 09:05:10  schutz
29  * Changing name QualAss to QA
30  *
31  * Revision 1.53  2007/09/30 17:08:20  schutz
32  * Introducing the notion of QA data acquisition cycle (needed by online)
33  *
34  * Revision 1.52  2007/09/26 14:22:18  cvetan
35  * Important changes to the reconstructor classes. Complete elimination of the run-loaders, which are now steered only from AliReconstruction. Removal of the corresponding Reconstruct() and FillESD() methods.
36  *
37  * Revision 1.51  2007/08/07 14:12:03  kharlov
38  * Quality assurance added (Yves Schutz)
39  */
40
41 //_________________________________________________________________________
42 // This is a TTask that makes SDigits out of Hits
43 // The name of the TTask is also the title of the branch that will contain 
44 // the created SDigits
45 // The title of the TTAsk is the name of the file that contains the hits from
46 // which the SDigits are created
47 // A Summable Digits is the sum of all hits originating 
48 // from one primary in one active cell
49 // A threshold for assignment of the primary to SDigit is applied 
50 // SDigits are written to TreeS, branch "PHOS"
51 // AliPHOSSDigitizer with all current parameters is written 
52 // to TreeS branch "AliPHOSSDigitizer".
53 // Both branches have the same title. If necessary one can produce 
54 // another set of SDigits with different parameters. Two versions
55 // can be distunguished using titles of the branches.
56 // User case:
57 //  root [0] AliPHOSSDigitizer * s = new AliPHOSSDigitizer("galice.root")
58 //  Warning in <TDatabasePDG::TDatabasePDG>: object already instantiated
59 //  root [1] s->ExecuteTask()
60 //             // Makes SDigitis for all events stored in galice.root
61 //  root [2] s->SetPedestalParameter(0.001)
62 //             // One can change parameters of digitization
63 // root [3] s->SetSDigitsBranch("Pedestal 0.001")
64 //             // and write them into the new branch
65 // root [4] s->ExecuteTask("deb all tim")
66 //             // available parameters:
67 //             deb - print # of produced SDigitis
68 //             deb all  - print # and list of produced SDigits
69 //             tim - print benchmarking information
70 //
71 //-- Author :  Dmitri Peressounko (SUBATECH & KI) 
72 //////////////////////////////////////////////////////////////////////////////
73
74
75 // --- ROOT system ---
76 #include "TBenchmark.h"
77                 //#include "TObjectTable.h"
78
79 // --- Standard library ---
80
81 // --- AliRoot header files ---
82 #include "AliLog.h"
83 #include "AliPHOSGeometry.h" 
84 #include "AliPHOSDigit.h"
85 #include "AliPHOSGetter.h"
86 #include "AliPHOSHit.h"
87 #include "AliPHOSSDigitizer.h"
88
89 ClassImp(AliPHOSSDigitizer)
90
91            
92 //____________________________________________________________________________ 
93 AliPHOSSDigitizer::AliPHOSSDigitizer() : 
94   TTask("",""),
95   fPrimThreshold(0.f),
96   fDefaultInit(kTRUE),
97   fEventFolderName(""),
98   fInit(kFALSE),
99   fSDigitsInRun(0),
100   fFirstEvent(0),
101   fLastEvent(0)
102 {
103   // ctor
104   // Intialize the quality assurance data maker         
105 }
106
107 //____________________________________________________________________________ 
108 AliPHOSSDigitizer::AliPHOSSDigitizer(const char * alirunFileName, 
109                                      const char * eventFolderName):
110   TTask("PHOS"+AliConfig::Instance()->GetSDigitizerTaskName(), alirunFileName),
111   fPrimThreshold(0.f),
112   fDefaultInit(kFALSE),
113   fEventFolderName(eventFolderName),
114   fInit(kFALSE),
115   fSDigitsInRun(0),
116   fFirstEvent(0),
117   fLastEvent(0)
118 {
119   // ctor
120   InitParameters() ; 
121   Init();
122   fDefaultInit = kFALSE ; 
123 }
124
125 //____________________________________________________________________________
126 AliPHOSSDigitizer::AliPHOSSDigitizer(const AliPHOSSDigitizer& sd) :
127   TTask(sd.GetName(), sd.GetTitle()),
128   fPrimThreshold(sd.fPrimThreshold),
129   fDefaultInit(kFALSE),
130   fEventFolderName(sd.fEventFolderName),
131   fInit(kFALSE),
132   fSDigitsInRun(sd.fSDigitsInRun),
133   fFirstEvent(sd.fFirstEvent),
134   fLastEvent(sd.fLastEvent)
135
136   // cpy ctor
137 }
138
139 //_____________________________________________________________________________
140 AliPHOSSDigitizer& AliPHOSSDigitizer::operator = (const AliPHOSSDigitizer& qa)
141 {
142 // assignment operator
143
144   this->~AliPHOSSDigitizer();
145   new(this) AliPHOSSDigitizer(qa);
146   return *this;
147 }
148
149 //____________________________________________________________________________ 
150 AliPHOSSDigitizer::~AliPHOSSDigitizer() {
151   //dtor
152   AliPHOSGetter * gime =
153     AliPHOSGetter::Instance();  
154   gime->PhosLoader()->CleanSDigitizer();
155 }
156
157 //____________________________________________________________________________ 
158 void AliPHOSSDigitizer::Init()
159 {
160   // Uses the getter to access the required files
161   
162   fInit = kTRUE ; 
163   
164   AliPHOSGetter * gime = AliPHOSGetter::Instance(GetTitle(), fEventFolderName.Data());  
165   if ( gime == 0 ) {
166     Fatal("Init" ,"Could not obtain the Getter object for file %s and event %s !", GetTitle(), fEventFolderName.Data()) ;  
167     return ;
168   } 
169   
170   TString opt("SDigits") ; 
171   if(gime->VersionExists(opt) ) { 
172     Error( "Init", "Give a version name different from %s", fEventFolderName.Data() ) ;
173     fInit = kFALSE ; 
174   }
175
176   gime->PostSDigitizer(this);
177   gime->PhosLoader()->GetSDigitsDataLoader()->GetBaseTaskLoader()->SetDoNotReload(kTRUE);
178  
179 }
180
181 //____________________________________________________________________________ 
182 void AliPHOSSDigitizer::InitParameters()
183
184   // initializes the parameters for digitization
185   fPrimThreshold = 0.01 ;
186   fSDigitsInRun  = 0 ;
187 }
188
189 //____________________________________________________________________________
190 void AliPHOSSDigitizer::Exec(Option_t *option) 
191
192   // Steering method to produce summable digits for events
193   // in the range from fFirstEvent to fLastEvent.
194   // This range is optionally set by SetEventRange().
195   // if fLastEvent=-1 (by default), then process events until the end.
196   //
197   // Summable digit is a sum of all hits in the same active
198   // volume into digit
199   
200   if (strstr(option, "print") ) {
201     Print() ; 
202     return ; 
203   }
204
205   if(strstr(option,"tim"))
206     gBenchmark->Start("PHOSSDigitizer");
207   
208 /*
209         // check the QA result for RAWS
210   AliQA * qa = AliQA::Instance(AliQA::kPHOS) ; 
211   if ( qa->IsSet(AliQA::kPHOS, AliQA::kRAW, AliQA::kFATAL)) {
212         AliFatal("QA status in RAW was Fatal") ;
213   } else if ( qa->IsSet(AliQA::kPHOS, AliQA::kRAW, AliQA::kERROR)) {
214         AliError("QA status in RAW was Error") ;
215   } else if ( qa->IsSet(AliQA::kPHOS, AliQA::kRAW, AliQA::kWARNING) ) {
216         AliWarning("QA status in RAW was Warning") ;
217   } else if ( qa->IsSet(AliQA::kPHOS, AliQA::kRAW, AliQA::kINFO) ) {
218         AliInfo("QA status in RAW was Info") ;
219   }
220 */
221   AliPHOSGetter * gime = AliPHOSGetter::Instance() ;
222
223   //switch off reloading of this task while getting event
224   if (!fInit) { // to prevent overwrite existing file
225     AliError( Form("Give a version name different from %s", fEventFolderName.Data()) ) ;
226     return ;
227   }
228
229   if (fLastEvent == -1) 
230     fLastEvent = gime->MaxEvent() - 1 ;
231   else 
232     fLastEvent = TMath::Min(fFirstEvent, gime->MaxEvent()); // only ine event at the time 
233   Int_t nEvents   = fLastEvent - fFirstEvent + 1;
234   
235   Int_t ievent, i;
236
237   for (ievent = fFirstEvent; ievent <= fLastEvent; ievent++) {    
238     gime->Event(ievent,"H") ;   
239     TTree * treeS = gime->TreeS(); 
240     TClonesArray * hits = gime->Hits() ;
241     TClonesArray * sdigits = gime->SDigits() ;
242     sdigits->Clear();
243     Int_t nSdigits = 0 ;
244     //Now make SDigits from hits, for PHOS it is the same, so just copy    
245     for ( i = 0 ; i < hits->GetEntries() ; i++ ) {
246       AliPHOSHit * hit = dynamic_cast<AliPHOSHit *>(hits->At(i)) ;
247       // Assign primary number only if contribution is significant
248       
249       if( hit->GetEnergy() > fPrimThreshold)
250         new((*sdigits)[nSdigits]) AliPHOSDigit(hit->GetPrimary(),hit->GetId(),
251                                                hit->GetEnergy() ,hit->GetTime()) ;
252       else
253         new((*sdigits)[nSdigits]) AliPHOSDigit(-1               ,hit->GetId(), 
254                                                hit->GetEnergy() ,hit->GetTime()) ;
255       nSdigits++ ;      
256       
257     }
258  
259     sdigits->Sort() ;
260
261     nSdigits = sdigits->GetEntriesFast() ;
262
263     fSDigitsInRun += nSdigits ;  
264     sdigits->Expand(nSdigits) ;
265
266     for (i = 0 ; i < nSdigits ; i++) { 
267       AliPHOSDigit * digit = dynamic_cast<AliPHOSDigit *>(sdigits->At(i)) ; 
268       digit->SetIndexInList(i) ;     
269     }
270
271 //    // make Quality Assurance data
272 //
273 //    if (GetQADataMaker()->IsCycleDone() ) {
274 //      GetQADataMaker()->EndOfCycle(AliQA::kHITS) ; 
275 //        GetQADataMaker()->EndOfCycle(AliQA::kSDIGITS) ; 
276 //      GetQADataMaker()->StartOfCycle(AliQA::kHITS) ; 
277 //        GetQADataMaker()->StartOfCycle(AliQA::kSDIGITS, kTRUE) ; 
278 //   }
279 //    GetQADataMaker()->Exec(AliQA::kHITS, hits) ; 
280 //    GetQADataMaker()->Exec(AliQA::kSDIGITS, sdigits) ; 
281 //    GetQADataMaker()->Increment() ;
282         
283     //Now write SDigits
284
285     
286     //First list of sdigits
287
288     Int_t bufferSize = 32000 ;
289     TBranch * sdigitsBranch = treeS->Branch("PHOS",&sdigits,bufferSize);
290
291     sdigitsBranch->Fill() ;
292
293     gime->WriteSDigits("OVERWRITE");
294
295     //Next - SDigitizer
296
297     gime->WriteSDigitizer("OVERWRITE");
298     //gObjectTable->Print() ; 
299   
300     if(strstr(option,"deb"))
301       PrintSDigits(option) ;
302       
303   }// event loop
304   
305 //  //Write the quality assurance data 
306 //  GetQADataMaker()->EndOfCycle(AliQA::kHITS) ;    
307 //  GetQADataMaker()->EndOfCycle(AliQA::kSDIGITS) ;    
308 //  GetQADataMaker()->Finish() ;
309
310   Unload();
311
312   //  gime->PhosLoader()->GetSDigitsDataLoader()->GetBaseTaskLoader()->SetDoNotReload(kTRUE);
313   
314   if(strstr(option,"tim")){
315     gBenchmark->Stop("PHOSSDigitizer");
316     Info("Exec","   took %f seconds for SDigitizing  %f seconds per event",
317          gBenchmark->GetCpuTime("PHOSSDigitizer"), gBenchmark->GetCpuTime("PHOSSDigitizer")/nEvents) ;
318   }
319   
320 }
321
322 //__________________________________________________________________
323 void AliPHOSSDigitizer::Print(const Option_t *)const
324 {
325   // Prints parameters of SDigitizer
326   Info("Print", "\n------------------- %s -------------", GetName() ) ; 
327   printf("   Writing SDigits to branch with title  %s\n", fEventFolderName.Data()) ;
328   printf("   Threshold for Primary assignment= %f\n", fPrimThreshold)  ; 
329   printf("---------------------------------------------------\n") ;
330   
331 }
332
333 //__________________________________________________________________
334 Bool_t AliPHOSSDigitizer::operator==( AliPHOSSDigitizer const &sd )const
335 {
336   // Equal operator.
337   // SDititizers are equal if their pedestal, slope and threshold are equal
338
339   if(fPrimThreshold==sd.fPrimThreshold)
340     return kTRUE ;
341   else
342     return kFALSE ;
343 }
344
345 //__________________________________________________________________
346 void AliPHOSSDigitizer::PrintSDigits(Option_t * option)
347 {
348   // Prints list of digits produced in the current pass of AliPHOSDigitizer
349
350
351   AliPHOSGetter * gime = AliPHOSGetter::Instance() ; 
352
353   // Get PHOS Geometry object
354   AliPHOSGeometry *geom;
355   if (!(geom = AliPHOSGeometry::GetInstance())) 
356         geom = AliPHOSGeometry::GetInstance("IHEP","");
357
358   const TClonesArray * sdigits = gime->SDigits() ;
359   
360   Info( "\nPrintSDigits", "event # %d %d sdigits", gAlice->GetEvNumber(), sdigits->GetEntriesFast() ) ; 
361
362   if(strstr(option,"all")||strstr(option,"EMC")){
363     
364     //loop over digits
365     AliPHOSDigit * digit;
366     printf("\nEMC sdigits\n") ; 
367     Int_t maxEmc = geom->GetNModules() * geom->GetNCristalsInModule() ;
368     Int_t index ;
369     for (index = 0 ; (index < sdigits->GetEntriesFast()) && 
370          ((dynamic_cast<AliPHOSDigit *> (sdigits->At(index)))->GetId() <= maxEmc) ; index++) {
371       digit = dynamic_cast<AliPHOSDigit *>( sdigits->At(index) ) ;
372       //  if(digit->GetNprimary() == 0) 
373       //        continue;
374 //       printf("%6d  %8d    %6.5e %4d      %2d :\n", // YVK
375       printf("%6d  %.4f    %6.5e %4d      %2d :\n",
376               digit->GetId(), digit->GetEnergy(), digit->GetTime(), digit->GetIndexInList(), digit->GetNprimary()) ;  
377       Int_t iprimary;
378       for (iprimary=0; iprimary<digit->GetNprimary(); iprimary++) {
379         printf("%d ",digit->GetPrimary(iprimary+1) ) ; 
380       }  
381     }    
382   }
383
384   if(strstr(option,"all")||strstr(option,"CPV")){
385     
386     //loop over CPV digits
387     AliPHOSDigit * digit;
388     printf("\nCPV sdigits\n") ; 
389     Int_t maxEmc = geom->GetNModules() * geom->GetNCristalsInModule() ;
390     Int_t index ;
391     for (index = 0 ; index < sdigits->GetEntriesFast(); index++) {
392       digit = dynamic_cast<AliPHOSDigit *>( sdigits->At(index) ) ;
393       if(digit->GetId() > maxEmc){
394         printf("\n%6d  %8d    %4d      %2d :",
395                 digit->GetId(), digit->GetAmp(), digit->GetIndexInList(), digit->GetNprimary()) ;  
396         Int_t iprimary;
397         for (iprimary=0; iprimary<digit->GetNprimary(); iprimary++) {
398           printf("%d ",digit->GetPrimary(iprimary+1) ) ; 
399         }
400       }    
401     }
402   }
403 }
404
405 //____________________________________________________________________________ 
406 void AliPHOSSDigitizer::Unload() const
407 {
408   // Unloads the objects from the folder
409   AliPHOSGetter * gime = AliPHOSGetter::Instance() ; 
410   AliPHOSLoader * loader = gime->PhosLoader() ; 
411   loader->UnloadHits() ; 
412   loader->UnloadSDigits() ; 
413 }