The changes to perform the trigger chamber efficiency determination from ESD
[u/mrichter/AliRoot.git] / STEER / AliQA.cxx
1
2 /**************************************************************************
3  * Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
4  *                                                                        *
5  * Author: The ALICE Off-line Project.                                    *
6  * Contributors are mentioned in the code where appropriate.              *
7  *                                                                        *
8  * Permission to use, copy, modify and distribute this software and its   *
9  * documentation strictly for non-commercial purposes is hereby granted   *
10  * without fee, provided that the above copyright notice appears in all   *
11  * copies and that both the copyright notice and this permission notice   *
12  * appear in the supporting documentation. The authors make no claims     *
13  * about the suitability of this software for any purpose. It is          *
14  * provided "as is" without express or implied warranty.                  *
15  **************************************************************************/
16 /* $Id$ */
17
18 //////////////////////////////////////////////////////////////////////////////
19 //
20 // Quality Assurance Object//_________________________________________________________________________
21 // Quality Assurance object. The QA status is held in one word per detector,
22 // each bit corresponds to a different status.
23 // bit 0-3  : QA raised during simulation      (SIM)
24 // bit 4-7  : QA raised during reconstruction  (REC)
25 // bit 8-11 : QA raised during ESD checking    (ESD)
26 // bit 12-15: QA raised during analysis        (ANA)
27 // Each of the 4 bits corresponds to a severity level of increasing importance
28 // from lower to higher bit (INFO, WARNING, ERROR, FATAL)
29 //
30 //*-- Yves Schutz CERN, July 2007 
31 //////////////////////////////////////////////////////////////////////////////
32
33
34 // --- ROOT system ---
35 #include <TFile.h>
36 #include <TSystem.h>
37 #include <TROOT.h>
38
39 // --- Standard library ---
40
41 // --- AliRoot header files ---
42 #include "AliCDBManager.h"
43 #include "AliCDBMetaData.h"
44 #include "AliCDBEntry.h"
45 #include "AliLog.h"
46 #include "AliQA.h"
47 #include "AliQAChecker.h"
48
49
50 ClassImp(AliQA)
51 AliQA    * AliQA::fgQA                   = 0x0 ;
52 TFile    * AliQA::fgQADataFile           = 0x0 ;   
53 TString    AliQA::fgQADataFileName       = "QA" ;  // will transform into Det.QA.run.cycle.root  
54 TFile    * AliQA::fgQARefFile            = 0x0 ;   
55 TString    AliQA::fgQARefDirName             = "" ; 
56 TString    AliQA::fgQARefFileName        = "QA.root" ;
57 TFile    * AliQA::fgQAResultFile         = 0x0 ;  
58 TString    AliQA::fgQAResultDirName      = "" ;  
59 TString    AliQA::fgQAResultFileName     = "QA.root" ; 
60 TString    AliQA::fgDetNames[]           = {"ITS", "TPC", "TRD", "TOF", "PHOS", "HMPID", "EMCAL", "MUON", "FMD",
61                                                                                     "ZDC", "PMD", "T0", "VZERO", "ACORDE", "HLT"} ;   
62 TString       AliQA::fgTaskNames[]       = {"Raws", "Hits", "SDigits", "Digits", "RecPoints", "TrackSegments", "RecParticles", "ESDs"} ;   
63 const TString AliQA::fkgLabLocalFile     = "file://"  ; 
64 const TString AliQA::fkgLabLocalOCDB     = "local://" ;  
65 const TString AliQA::fkgLabAliEnOCDB     = "alien://" ;  
66 const TString AliQA::fkgRefFileName      = "QA.root" ; 
67 const TString AliQA::fkgQAOCDBDirName    = "QA"  ; 
68 const TString AliQA::fkgRefOCDBDirName   = "Ref"  ; 
69 const TString AliQA::fkgQARefOCDBDefault = "local://$ALICE_ROOT"  ; 
70 //____________________________________________________________________________
71 AliQA::AliQA() : 
72   TNamed("", ""), 
73   fNdet(kNDET), 
74   fQA(new ULong_t[fNdet]), 
75   fDet(kNULLDET),
76   fTask(kNULLTASK)
77         
78 {
79   // default constructor
80   // beware singleton: not to be used
81   
82   for (Int_t index = 0 ; index < fNdet ; index++) 
83         fQA[index] = 0 ; 
84 }
85
86 //____________________________________________________________________________
87 AliQA::AliQA(const AliQA& qa) :
88   TNamed(qa),
89   fNdet(qa.fNdet), 
90   fQA(qa.fQA), 
91   fDet(qa.fDet),
92   fTask(qa.fTask)
93
94   // cpy ctor
95 }
96
97 //_____________________________________________________________________________
98 AliQA& AliQA::operator = (const AliQA& qa)
99 {
100 // assignment operator
101
102   this->~AliQA();
103   new(this) AliQA(qa);
104   return *this;
105 }
106
107 //_______________________________________________________________
108 AliQA::AliQA(const DETECTORINDEX det) :
109   TNamed("QA", "Quality Assurance status"),
110   fNdet(kNDET),  
111   fQA(new ULong_t[fNdet]), 
112   fDet(det),
113   fTask(kNULLTASK) 
114 {
115   // constructor to be used
116   if (! CheckRange(det) ) {
117     fDet = kNULLDET ; 
118     return ;
119   } 
120   Int_t index ; 
121   for (index = 0; index < fNdet; index++) 
122     fQA[index] = 0 ; 
123 }
124   
125 //_______________________________________________________________
126 AliQA::AliQA(const ALITASK tsk) :
127   TNamed("QA", "Quality Assurance status"), 
128   fNdet(kNDET),
129   fQA(new ULong_t[fNdet]), 
130   fDet(kNULLDET),
131   fTask(tsk)
132 {
133   // constructor to be used in the AliRoot module (SIM, REC, ESD or ANA)
134   if (! CheckRange(tsk) ) {
135     fTask = kNULLTASK ; 
136     return ;
137   } 
138   Int_t index ; 
139   for (index = 0; index < fNdet; index++) 
140     fQA[index] = 0 ; 
141 }
142
143 //____________________________________________________________________________
144 AliQA::~AliQA() 
145 {
146   // dtor  
147   delete[] fQA ;
148 }
149
150 //_______________________________________________________________
151 const Bool_t AliQA::AddQAData2CDB(const char * defSto) const 
152 {
153         // loads the QA data into the OCDB
154         Bool_t rv = kTRUE ; 
155         AliCDBManager* man = AliCDBManager::Instance() ;
156         man->SetDefaultStorage(defSto) ;
157         AliCDBMetaData md ; 
158         // loop over detectors  
159         AliCDBId id("QA/Ref/PHOS",0,999999999) ;
160
161         
162         return rv ; 
163 }  
164
165 //_______________________________________________________________
166 void AliQA::Close() 
167 {
168         // close the open files
169         if (fgQADataFile) 
170                 if (fgQADataFile->IsOpen())
171                         fgQADataFile->Close() ; 
172         if (fgQAResultFile) 
173                 if (fgQAResultFile->IsOpen()) 
174                         fgQAResultFile->Close() ;
175         if (fgQARefFile)
176                 if (fgQARefFile->IsOpen())
177                         fgQARefFile->Close() ; 
178
179
180 //_______________________________________________________________
181 const Bool_t AliQA::CheckFatal() const
182 {
183   // check if any FATAL status is set
184   Bool_t rv = kFALSE ;
185   Int_t index ;
186   for (index = 0; index < kNDET ; index++)
187     rv = rv || IsSet(DETECTORINDEX(index), fTask, kFATAL) ;
188   return rv ;
189 }
190
191 //_______________________________________________________________
192 const Bool_t AliQA::CheckRange(DETECTORINDEX det) const
193
194   // check if detector is in given detector range: 0-kNDET
195
196   Bool_t rv = ( det < 0 || det > kNDET )  ? kFALSE : kTRUE ;
197   if (!rv)
198     AliFatal(Form("Detector index %d is out of range: 0 <= index <= %d", det, kNDET)) ;
199   return rv ;
200 }
201
202 //_______________________________________________________________
203 const Bool_t AliQA::CheckRange(ALITASK task) const
204
205   // check if task is given taskk range: 0:kNTASK
206   Bool_t rv = ( task < kRAW || task > kNTASK )  ? kFALSE : kTRUE ;
207   if (!rv)
208     AliFatal(Form("Module index %d is out of range: 0 <= index <= %d", task, kNTASK)) ;
209   return rv ;
210 }
211
212 //_______________________________________________________________
213 const Bool_t AliQA::CheckRange(QABIT bit) const
214
215   // check if bit is in given bit range: 0-kNBit
216
217   Bool_t rv = ( bit < 0 || bit > kNBIT )  ? kFALSE : kTRUE ;
218   if (!rv)
219     AliFatal(Form("Status bit %d is out of range: 0 <= bit <= %d", bit, kNBIT)) ;
220   return rv ;
221 }
222
223
224
225 //_______________________________________________________________
226 const char * AliQA::GetAliTaskName(ALITASK tsk)
227 {
228   // returns the char name corresponding to module index
229   TString tskName ;
230   switch (tsk) {
231   case kNULLTASK:
232     break ; 
233   case kRAW:
234     tskName = "RAW" ;
235     break ;  
236   case kSIM:
237     tskName = "SIM" ;
238     break ;
239   case kREC:
240     tskName = "REC" ;
241     break ;
242   case kESD:
243     tskName = "ESD" ;
244     break ;
245   case kANA:
246     tskName = "ANA" ;
247     break ;
248   default:
249     tsk = kNULLTASK ; 
250     break ;
251   }
252   return tskName.Data() ;
253 }
254
255 //_______________________________________________________________
256 const char * AliQA::GetDetName(Int_t det) 
257 {
258         // returns the detector name corresponding to a given index (needed in a loop)
259
260         if ( det >= 0 &&  det < kNDET) 
261                 return (fgDetNames[det]).Data() ; 
262         else 
263                 return NULL ; 
264 }
265
266 //_______________________________________________________________
267 TFile * AliQA::GetQADataFile(const char * name, const Int_t run, const Int_t cycle) 
268 {
269   // opens the file to store the detectors Quality Assurance Data Maker results
270   char temp[20] ; 
271   sprintf(temp, "%s.%s.%d.%d.root", name, fgQADataFileName.Data(), run, cycle) ; 
272   TString opt ; 
273   if (! fgQADataFile ) {     
274     if  (gSystem->AccessPathName(temp))
275       opt = "NEW" ;
276     else 
277       opt = "UPDATE" ; 
278     fgQADataFile = TFile::Open(temp, opt.Data()) ;
279   } else {
280           if ( strcmp(temp, fgQADataFile->GetName()) != 0 ) {
281                   fgQADataFile = dynamic_cast<TFile *>(gROOT->FindObject(temp)) ; 
282                   if ( !fgQADataFile ) {
283                           if  (gSystem->AccessPathName(temp))
284                                   opt = "NEW" ;
285                           else 
286                                   opt = "UPDATE" ; 
287                           fgQADataFile = TFile::Open(temp, opt.Data()) ;
288                   }
289           }
290   }
291   return fgQADataFile ; 
292
293
294 //_____________________________________________________________________________
295 TFile * AliQA::GetQADataFile(const char * fileName)
296 {
297   // Open if necessary the Data file and return its pointer
298
299   if (!fgQADataFile) 
300         if (!fileName) 
301                 fileName = AliQA::GetQADataFileName() ; 
302         if  (!gSystem->AccessPathName(fileName)) {
303                 fgQADataFile =  TFile::Open(fileName) ;
304         } else {
305                 printf("File %s not found", fileName) ;
306                 exit(1) ;  
307         }
308   return fgQADataFile ; 
309 }
310
311 //_______________________________________________________________
312 TFile * AliQA::GetQAResultFile() 
313 {
314   // opens the file to store the  Quality Assurance Data Checker results
315    
316         if (!fgQAResultFile) { 
317                 TString dirName(fgQAResultDirName) ; 
318                 if ( dirName.Contains(fkgLabLocalFile)) 
319                         dirName.ReplaceAll(fkgLabLocalFile, "") ;
320                 TString fileName(dirName + fgQAResultFileName) ; 
321                 TString opt("") ; 
322                 if ( !gSystem->AccessPathName(fileName) )
323                         opt = "UPDATE" ; 
324                 else { 
325                         if ( gSystem->AccessPathName(dirName) )
326                                 gSystem->mkdir(dirName) ; 
327                         opt = "NEW" ; 
328                 }
329                 fgQAResultFile = TFile::Open(fileName, opt) ;   
330         }
331         
332         return fgQAResultFile ;
333 }
334
335 //_______________________________________________________________
336 const Bool_t AliQA::IsSet(DETECTORINDEX det, ALITASK tsk, QABIT bit) const
337 {
338   // Checks is the requested bit is set
339
340   CheckRange(det) ; 
341   CheckRange(tsk) ;
342   CheckRange(bit) ;
343
344   ULong_t offset = Offset(tsk) ;
345   ULong_t status = GetStatus(det) ;
346   offset+= bit ;
347   status = (status & 1 << offset) != 0 ;
348   return status ;
349 }
350
351 //_______________________________________________________________
352 AliQA * AliQA::Instance()
353 {
354   // Get an instance of the singleton.
355   // Object must have been instantiated with Instance(ALITASK) first
356
357   return fgQA ;
358 }
359
360 //_______________________________________________________________
361 AliQA * AliQA::Instance(const DETECTORINDEX det)
362 {
363   // Get an instance of the singleton. The only authorized way to call the ctor
364   
365   if ( ! fgQA) {
366     TFile * f = GetQAResultFile() ; 
367         fgQA = dynamic_cast<AliQA *>(f->Get("QA")) ; 
368     if ( ! fgQA ) 
369                 fgQA = new AliQA(det) ;
370   }             
371   fgQA->Set(det) ;
372   return fgQA ;
373 }
374
375 //_______________________________________________________________
376 AliQA * AliQA::Instance(const ALITASK tsk)
377 {
378   // get an instance of the singleton.
379
380   if ( ! fgQA)
381     switch (tsk) {
382     case kNULLTASK:
383       break ;
384         case kRAW:
385       fgQA = new AliQA(tsk) ;
386       break ;
387         case kSIM:
388       fgQA = new AliQA(tsk) ;
389       break ;
390     case kREC:
391       printf("fgQA = gAlice->GetQA()") ;
392       break ;
393     case kESD:
394       printf("fgQA = dynamic_cast<AliQA *> (esdFile->Get(\"QA\")") ;
395       break ;
396     case kANA:
397       printf("fgQA = dynamic_cast<AliQA *> (esdFile->Get(\"QA\")") ;
398       break ;
399     case kNTASK:
400       break ;
401     }
402   if (fgQA) 
403     fgQA->Set(tsk) ;
404   return fgQA ;
405 }
406
407 //_______________________________________________________________
408 const ULong_t AliQA::Offset(ALITASK tsk) const
409 {
410   // Calculates the bit offset for a given module (SIM, REC, ESD, ANA)
411
412   CheckRange(tsk) ; 
413
414   ULong_t offset = 0 ;
415   switch (tsk) {
416   case kNULLTASK:
417     break ;
418   case kRAW:
419     offset+= 0 ;
420     break ;
421   case kSIM:
422     offset+= 4 ;
423     break ;
424   case kREC:
425     offset+= 8 ;
426     break ;
427   case kESD:
428     offset+= 12 ;
429     break ;
430   case kANA:
431     offset+= 16 ;
432     break ;
433   case kNTASK:
434     break ;
435   }
436
437   return offset ;
438 }
439
440 //_______________________________________________________________
441 void AliQA::Set(QABIT bit)
442 {
443   // Set the status bit of the current detector in the current module
444   
445   SetStatusBit(fDet, fTask, bit) ;
446 }
447
448 //_____________________________________________________________________________
449 void AliQA::SetQARefStorage(const char * name)
450 {
451   // Set the root directory where the QA reference data are stored
452
453   fgQARefDirName = name ; 
454   if (  fgQARefDirName.Contains(fkgLabLocalFile) )
455          fgQARefFileName =  fkgRefFileName ; 
456   else if (     fgQARefDirName.Contains(fkgLabLocalOCDB) )
457           fgQARefFileName =  fkgQAOCDBDirName ; 
458   else {
459           printf("ERROR: %s is an invalid storage definition\n", name) ; 
460           fgQARefDirName  = "" ; 
461           fgQARefFileName = "" ; 
462   }     
463         TString tmp(fgQARefDirName + fgQARefFileName) ;
464         printf("AliQA::SetQARefDir: QA references are in  %s\n", tmp.Data() ) ;
465 }
466
467 //_____________________________________________________________________________
468 void AliQA::SetQAResultDirName(const char * name)
469 {
470   // Set the root directory where to store the QA status object
471
472   fgQAResultDirName.Prepend(name) ; 
473   printf("AliQA::SetQAResultDirName: QA results are in  %s\n", fgQAResultDirName.Data()) ;
474   if ( fgQAResultDirName.Contains(fkgLabLocalFile)) 
475     fgQAResultDirName.ReplaceAll(fkgLabLocalFile, "") ;
476   fgQAResultFileName.Prepend(fgQAResultDirName) ;
477 }
478
479 //_______________________________________________________________
480 void AliQA::SetStatusBit(DETECTORINDEX det, ALITASK tsk, QABIT bit)
481 {
482  // Set the status bit for a given detector and a given task
483
484   CheckRange(det) ;
485   CheckRange(tsk) ;
486   CheckRange(bit) ;
487
488   ULong_t offset = Offset(tsk) ;
489   ULong_t status = GetStatus(det) ;
490   offset+= bit ;
491   status = status | 1 << offset ;
492   SetStatus(det, status) ;
493 }
494
495 //_______________________________________________________________
496 void AliQA::ShowAll() const
497 {
498   // dispplay the QA status word
499   Int_t index ;
500   for (index = 0 ; index < kNDET ; index++)
501     ShowStatus(DETECTORINDEX(index)) ;
502 }
503
504 //_______________________________________________________________
505 void AliQA::ShowStatus(DETECTORINDEX det) const
506 {
507   // Prints the full QA status of a given detector
508   CheckRange(det) ;
509   ULong_t status = GetStatus(det) ;
510   ULong_t rawStatus = status & 0x0000f ;
511   ULong_t simStatus = status & 0x000f0 ;
512   ULong_t recStatus = status & 0x00f00 ;
513   ULong_t esdStatus = status & 0x0f000 ;
514   ULong_t anaStatus = status & 0xf0000 ;
515
516   AliInfo(Form("QA Status for %s raw =0x%x, sim=0x%x, rec=0x%x, esd=0x%x, ana=0x%x\n", GetDetName(det).Data(), rawStatus, simStatus, recStatus, esdStatus, anaStatus )) ;
517 }
518