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