TList replaced by TObjArray as QA data container. Introducing OCDB for the reference...
[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::fkgRefOCDBDirName = "QA/Ref"  ; 
68 //____________________________________________________________________________
69 AliQA::AliQA() : 
70   TNamed("", ""), 
71   fNdet(kNDET), 
72   fQA(new ULong_t[fNdet]), 
73   fDet(kNULLDET),
74   fTask(kNULLTASK)
75         
76 {
77   // default constructor
78   // beware singleton: not to be used
79   
80   for (Int_t index = 0 ; index < fNdet ; index++) 
81         fQA[index] = 0 ; 
82 }
83
84 //____________________________________________________________________________
85 AliQA::AliQA(const AliQA& qa) :
86   TNamed(qa),
87   fNdet(qa.fNdet), 
88   fQA(qa.fQA), 
89   fDet(qa.fDet),
90   fTask(qa.fTask)
91
92   // cpy ctor
93 }
94
95 //_____________________________________________________________________________
96 AliQA& AliQA::operator = (const AliQA& qa)
97 {
98 // assignment operator
99
100   this->~AliQA();
101   new(this) AliQA(qa);
102   return *this;
103 }
104
105 //_______________________________________________________________
106 AliQA::AliQA(const DETECTORINDEX det) :
107   TNamed("QA", "Quality Assurance status"),
108   fNdet(kNDET),  
109   fQA(new ULong_t[fNdet]), 
110   fDet(det),
111   fTask(kNULLTASK) 
112 {
113   // constructor to be used
114   if (! CheckRange(det) ) {
115     fDet = kNULLDET ; 
116     return ;
117   } 
118   Int_t index ; 
119   for (index = 0; index < fNdet; index++) 
120     fQA[index] = 0 ; 
121 }
122   
123 //_______________________________________________________________
124 AliQA::AliQA(const ALITASK tsk) :
125   TNamed("QA", "Quality Assurance status"), 
126   fNdet(kNDET),
127   fQA(new ULong_t[fNdet]), 
128   fDet(kNULLDET),
129   fTask(tsk)
130 {
131   // constructor to be used in the AliRoot module (SIM, REC, ESD or ANA)
132   if (! CheckRange(tsk) ) {
133     fTask = kNULLTASK ; 
134     return ;
135   } 
136   Int_t index ; 
137   for (index = 0; index < fNdet; index++) 
138     fQA[index] = 0 ; 
139 }
140
141 //____________________________________________________________________________
142 AliQA::~AliQA() 
143 {
144   // dtor  
145   delete[] fQA ;
146 }
147
148 //_______________________________________________________________
149 const Bool_t AliQA::AddQAData2CDB(const char * defSto) const 
150 {
151         // loads the QA data into the OCDB
152         Bool_t rv = kTRUE ; 
153         AliCDBManager* man = AliCDBManager::Instance() ;
154         man->SetDefaultStorage(defSto) ;
155         AliCDBMetaData md ; 
156         // loop over detectors  
157         AliCDBId id("QA/Ref/PHOS",0,999999999) ;
158
159         
160         return rv ; 
161 }  
162
163 //_______________________________________________________________
164 void AliQA::Close() 
165 {
166         // close the open files
167         if (fgQADataFile) 
168                 if (fgQADataFile->IsOpen())
169                         fgQADataFile->Close() ; 
170         if (fgQAResultFile) 
171                 if (fgQAResultFile->IsOpen()) 
172                         fgQAResultFile->Close() ;
173         if (fgQARefFile)
174                 if (fgQARefFile->IsOpen())
175                         fgQARefFile->Close() ; 
176
177
178 //_______________________________________________________________
179 const Bool_t AliQA::CheckFatal() const
180 {
181   // check if any FATAL status is set
182   Bool_t rv = kFALSE ;
183   Int_t index ;
184   for (index = 0; index < kNDET ; index++)
185     rv = rv || IsSet(DETECTORINDEX(index), fTask, kFATAL) ;
186   return rv ;
187 }
188
189 //_______________________________________________________________
190 const Bool_t AliQA::CheckRange(DETECTORINDEX det) const
191
192   // check if detector is in given detector range: 0-kNDET
193
194   Bool_t rv = ( det < 0 || det > kNDET )  ? kFALSE : kTRUE ;
195   if (!rv)
196     AliFatal(Form("Detector index %d is out of range: 0 <= index <= %d", det, kNDET)) ;
197   return rv ;
198 }
199
200 //_______________________________________________________________
201 const Bool_t AliQA::CheckRange(ALITASK task) const
202
203   // check if task is given taskk range: 0:kNTASK
204   Bool_t rv = ( task < kRAW || task > kNTASK )  ? kFALSE : kTRUE ;
205   if (!rv)
206     AliFatal(Form("Module index %d is out of range: 0 <= index <= %d", task, kNTASK)) ;
207   return rv ;
208 }
209
210 //_______________________________________________________________
211 const Bool_t AliQA::CheckRange(QABIT bit) const
212
213   // check if bit is in given bit range: 0-kNBit
214
215   Bool_t rv = ( bit < 0 || bit > kNBIT )  ? kFALSE : kTRUE ;
216   if (!rv)
217     AliFatal(Form("Status bit %d is out of range: 0 <= bit <= %d", bit, kNBIT)) ;
218   return rv ;
219 }
220
221
222
223 //_______________________________________________________________
224 const char * AliQA::GetAliTaskName(ALITASK tsk)
225 {
226   // returns the char name corresponding to module index
227   TString tskName ;
228   switch (tsk) {
229   case kNULLTASK:
230     break ; 
231   case kRAW:
232     tskName = "RAW" ;
233     break ;  
234   case kSIM:
235     tskName = "SIM" ;
236     break ;
237   case kREC:
238     tskName = "REC" ;
239     break ;
240   case kESD:
241     tskName = "ESD" ;
242     break ;
243   case kANA:
244     tskName = "ANA" ;
245     break ;
246   default:
247     tsk = kNULLTASK ; 
248     break ;
249   }
250   return tskName.Data() ;
251 }
252
253 //_______________________________________________________________
254 const char * AliQA::GetDetName(Int_t det) 
255 {
256         // returns the detector name corresponding to a given index (needed in a loop)
257
258         if ( det >= 0 &&  det < kNDET) 
259                 return (fgDetNames[det]).Data() ; 
260         else 
261                 return NULL ; 
262 }
263
264 //_______________________________________________________________
265 TFile * AliQA::GetQADataFile(const char * name, const Int_t run, const Int_t cycle) 
266 {
267   // opens the file to store the detectors Quality Assurance Data Maker results
268   char temp[20] ; 
269   sprintf(temp, "%s.%s.%d.%d.root", name, fgQADataFileName.Data(), run, cycle) ; 
270   TString opt ; 
271   if (! fgQADataFile ) {     
272     if  (gSystem->AccessPathName(temp))
273       opt = "NEW" ;
274     else 
275       opt = "UPDATE" ; 
276     fgQADataFile = TFile::Open(temp, opt.Data()) ;
277   } else {
278           if ( strcmp(temp, fgQADataFile->GetName()) != 0 ) {
279                   fgQADataFile = dynamic_cast<TFile *>(gROOT->FindObject(temp)) ; 
280                   if ( !fgQADataFile ) {
281                           if  (gSystem->AccessPathName(temp))
282                                   opt = "NEW" ;
283                           else 
284                                   opt = "UPDATE" ; 
285                           fgQADataFile = TFile::Open(temp, opt.Data()) ;
286                   }
287           }
288   }
289   return fgQADataFile ; 
290
291
292 //_____________________________________________________________________________
293 TFile * AliQA::GetQADataFile(const char * fileName)
294 {
295   // Open if necessary the Data file and return its pointer
296
297   if (!fgQADataFile) 
298         if (!fileName) 
299                 fileName = AliQA::GetQADataFileName() ; 
300         if  (!gSystem->AccessPathName(fileName)) {
301                 fgQADataFile =  TFile::Open(fileName) ;
302         } else {
303                 printf("File %s not found", fileName) ;
304                 exit(1) ;  
305         }
306   return fgQADataFile ; 
307 }
308
309 //_______________________________________________________________
310 TFile * AliQA::GetQAResultFile() 
311 {
312   // opens the file to store the  Quality Assurance Data Checker results
313    
314         if (!fgQAResultFile) { 
315                 TString dirName(fgQAResultDirName) ; 
316                 if ( dirName.Contains(fkgLabLocalFile)) 
317                         dirName.ReplaceAll(fkgLabLocalFile, "") ;
318                 TString fileName(dirName + fgQAResultFileName) ; 
319                 TString opt("") ; 
320                 if ( !gSystem->AccessPathName(fileName) )
321                         opt = "UPDATE" ; 
322                 else { 
323                         if ( gSystem->AccessPathName(dirName) )
324                                 gSystem->mkdir(dirName) ; 
325                         opt = "NEW" ; 
326                 }
327                 fgQAResultFile = TFile::Open(fileName, opt) ;   
328         }
329         
330         return fgQAResultFile ;
331 }
332
333 //_______________________________________________________________
334 const Bool_t AliQA::IsSet(DETECTORINDEX det, ALITASK tsk, QABIT bit) const
335 {
336   // Checks is the requested bit is set
337
338   CheckRange(det) ; 
339   CheckRange(tsk) ;
340   CheckRange(bit) ;
341
342   ULong_t offset = Offset(tsk) ;
343   ULong_t status = GetStatus(det) ;
344   offset+= bit ;
345   status = (status & 1 << offset) != 0 ;
346   return status ;
347 }
348
349 //_______________________________________________________________
350 AliQA * AliQA::Instance()
351 {
352   // Get an instance of the singleton.
353   // Object must have been instantiated with Instance(ALITASK) first
354
355   return fgQA ;
356 }
357
358 //_______________________________________________________________
359 AliQA * AliQA::Instance(const DETECTORINDEX det)
360 {
361   // Get an instance of the singleton. The only authorized way to call the ctor
362   
363   if ( ! fgQA) {
364     TFile * f = GetQAResultFile() ; 
365         fgQA = dynamic_cast<AliQA *>(f->Get("QA")) ; 
366     if ( ! fgQA ) 
367                 fgQA = new AliQA(det) ;
368   }             
369   fgQA->Set(det) ;
370   return fgQA ;
371 }
372
373 //_______________________________________________________________
374 AliQA * AliQA::Instance(const ALITASK tsk)
375 {
376   // get an instance of the singleton.
377
378   if ( ! fgQA)
379     switch (tsk) {
380     case kNULLTASK:
381       break ;
382         case kRAW:
383       fgQA = new AliQA(tsk) ;
384       break ;
385         case kSIM:
386       fgQA = new AliQA(tsk) ;
387       break ;
388     case kREC:
389       printf("fgQA = gAlice->GetQA()") ;
390       break ;
391     case kESD:
392       printf("fgQA = dynamic_cast<AliQA *> (esdFile->Get(\"QA\")") ;
393       break ;
394     case kANA:
395       printf("fgQA = dynamic_cast<AliQA *> (esdFile->Get(\"QA\")") ;
396       break ;
397     case kNTASK:
398       break ;
399     }
400   if (fgQA) 
401     fgQA->Set(tsk) ;
402   return fgQA ;
403 }
404
405 //_______________________________________________________________
406 const ULong_t AliQA::Offset(ALITASK tsk) const
407 {
408   // Calculates the bit offset for a given module (SIM, REC, ESD, ANA)
409
410   CheckRange(tsk) ; 
411
412   ULong_t offset = 0 ;
413   switch (tsk) {
414   case kNULLTASK:
415     break ;
416   case kRAW:
417     offset+= 0 ;
418     break ;
419   case kSIM:
420     offset+= 4 ;
421     break ;
422   case kREC:
423     offset+= 8 ;
424     break ;
425   case kESD:
426     offset+= 12 ;
427     break ;
428   case kANA:
429     offset+= 16 ;
430     break ;
431   case kNTASK:
432     break ;
433   }
434
435   return offset ;
436 }
437
438 //_______________________________________________________________
439 void AliQA::Set(QABIT bit)
440 {
441   // Set the status bit of the current detector in the current module
442   
443   SetStatusBit(fDet, fTask, bit) ;
444 }
445
446 //_____________________________________________________________________________
447 void AliQA::SetQARefStorage(const char * name)
448 {
449   // Set the root directory where the QA reference data are stored
450
451   fgQARefDirName = name ; 
452   if (  fgQARefDirName.Contains(fkgLabLocalFile) )
453          fgQARefFileName =  fkgRefFileName ; 
454   else if (     fgQARefDirName.Contains(fkgLabLocalOCDB) )
455           fgQARefFileName =  fkgRefOCDBDirName ; 
456   else {
457           printf("ERROR: %s is an invalid storage definition\n", name) ; 
458           fgQARefDirName  = "" ; 
459           fgQARefFileName = "" ; 
460   }     
461         TString tmp(fgQARefDirName + fgQARefFileName) ;
462         printf("AliQA::SetQARefDir: QA references are in  %s\n", tmp.Data() ) ;
463 }
464
465 //_____________________________________________________________________________
466 void AliQA::SetQAResultDirName(const char * name)
467 {
468   // Set the root directory where to store the QA status object
469
470   fgQAResultDirName.Prepend(name) ; 
471   printf("AliQA::SetQAResultDirName: QA results are in  %s\n", fgQAResultDirName.Data()) ;
472   if ( fgQAResultDirName.Contains(fkgLabLocalFile)) 
473     fgQAResultDirName.ReplaceAll(fkgLabLocalFile, "") ;
474   fgQAResultFileName.Prepend(fgQAResultDirName) ;
475 }
476
477 //_______________________________________________________________
478 void AliQA::SetStatusBit(DETECTORINDEX det, ALITASK tsk, QABIT bit)
479 {
480  // Set the status bit for a given detector and a given task
481
482   CheckRange(det) ;
483   CheckRange(tsk) ;
484   CheckRange(bit) ;
485
486   ULong_t offset = Offset(tsk) ;
487   ULong_t status = GetStatus(det) ;
488   offset+= bit ;
489   status = status | 1 << offset ;
490   SetStatus(det, status) ;
491 }
492
493 //_______________________________________________________________
494 void AliQA::ShowAll() const
495 {
496   // dispplay the QA status word
497   Int_t index ;
498   for (index = 0 ; index < kNDET ; index++)
499     ShowStatus(DETECTORINDEX(index)) ;
500 }
501
502 //_______________________________________________________________
503 void AliQA::ShowStatus(DETECTORINDEX det) const
504 {
505   // Prints the full QA status of a given detector
506   CheckRange(det) ;
507   ULong_t status = GetStatus(det) ;
508   ULong_t rawStatus = status & 0x0000f ;
509   ULong_t simStatus = status & 0x000f0 ;
510   ULong_t recStatus = status & 0x00f00 ;
511   ULong_t esdStatus = status & 0x0f000 ;
512   ULong_t anaStatus = status & 0xf0000 ;
513
514   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 )) ;
515 }
516