QA works during reconstruction in and outside the event loop
[u/mrichter/AliRoot.git] / STEER / AliQA.cxx
CommitLineData
8661738e 1
421ab0fb 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>
0d13dd63 37#include <TROOT.h>
421ab0fb 38
39// --- Standard library ---
40
41// --- AliRoot header files ---
42#include "AliLog.h"
2e42b4d4 43#include "AliQA.h"
421ab0fb 44
45
2e42b4d4 46ClassImp(AliQA)
f73f556a 47AliQA * AliQA::fgQA = 0x0 ;
48TFile * AliQA::fgQADataFile = 0x0 ;
49TString AliQA::fgQADataFileName = "QA" ; // will transform into Det.QA.run.cycle.root
50TFile * AliQA::fgQARefFile = 0x0 ;
51TString AliQA::fgQARefDirName = "" ;
52TString AliQA::fgQARefFileName = "QA.root" ;
53TFile * AliQA::fgQAResultFile = 0x0 ;
54TString AliQA::fgQAResultDirName = "" ;
55TString AliQA::fgQAResultFileName = "QA.root" ;
56TString AliQA::fgDetNames[] = {"ITS", "TPC", "TRD", "TOF", "PHOS", "HMPID", "EMCAL", "MUON", "FMD",
7c002d48 57 "ZDC", "PMD", "T0", "VZERO", "ACORDE", "HLT", "Global"} ;
f73f556a 58TString AliQA::fgTaskNames[] = {"Raws", "Hits", "SDigits", "Digits", "RecPoints", "TrackSegments", "RecParticles", "ESDs"} ;
59const TString AliQA::fkgLabLocalFile = "file://" ;
60const TString AliQA::fkgLabLocalOCDB = "local://" ;
61const TString AliQA::fkgLabAliEnOCDB = "alien://" ;
62const TString AliQA::fkgRefFileName = "QA.root" ;
96d67a8d 63const TString AliQA::fkgQAName = "QA" ;
f73f556a 64const TString AliQA::fkgRefOCDBDirName = "Ref" ;
96d67a8d 65TString AliQA::fkgRefDataDirName = "Data" ;
13c8b505 66const TString AliQA::fkgQARefOCDBDefault = "alien://folder=/alice/QA/20" ;
421ab0fb 67//____________________________________________________________________________
2e42b4d4 68AliQA::AliQA() :
421ab0fb 69 TNamed("", ""),
9a223722 70 fNdet(kNDET),
71 fQA(new ULong_t[fNdet]),
421ab0fb 72 fDet(kNULLDET),
73 fTask(kNULLTASK)
4edbc5bc 74
421ab0fb 75{
76 // default constructor
77 // beware singleton: not to be used
4ecde5fc 78
9a223722 79 for (Int_t index = 0 ; index < fNdet ; index++)
80 fQA[index] = 0 ;
421ab0fb 81}
82
83//____________________________________________________________________________
2e42b4d4 84AliQA::AliQA(const AliQA& qa) :
421ab0fb 85 TNamed(qa),
9a223722 86 fNdet(qa.fNdet),
421ab0fb 87 fQA(qa.fQA),
88 fDet(qa.fDet),
89 fTask(qa.fTask)
90{
91 // cpy ctor
92}
93
94//_____________________________________________________________________________
2e42b4d4 95AliQA& AliQA::operator = (const AliQA& qa)
421ab0fb 96{
97// assignment operator
98
2e42b4d4 99 this->~AliQA();
100 new(this) AliQA(qa);
421ab0fb 101 return *this;
102}
103
104//_______________________________________________________________
96d67a8d 105AliQA::AliQA(const DETECTORINDEX_t det) :
9a223722 106 TNamed("QA", "Quality Assurance status"),
107 fNdet(kNDET),
108 fQA(new ULong_t[fNdet]),
a5fa6165 109 fDet(det),
4edbc5bc 110 fTask(kNULLTASK)
a5fa6165 111{
112 // constructor to be used
113 if (! CheckRange(det) ) {
114 fDet = kNULLDET ;
115 return ;
a4976ef3 116 }
a5fa6165 117 Int_t index ;
9a223722 118 for (index = 0; index < fNdet; index++)
a5fa6165 119 fQA[index] = 0 ;
120}
121
122//_______________________________________________________________
96d67a8d 123AliQA::AliQA(const ALITASK_t tsk) :
421ab0fb 124 TNamed("QA", "Quality Assurance status"),
9a223722 125 fNdet(kNDET),
126 fQA(new ULong_t[fNdet]),
421ab0fb 127 fDet(kNULLDET),
128 fTask(tsk)
129{
130 // constructor to be used in the AliRoot module (SIM, REC, ESD or ANA)
131 if (! CheckRange(tsk) ) {
132 fTask = kNULLTASK ;
133 return ;
a4976ef3 134 }
a5fa6165 135 Int_t index ;
9a223722 136 for (index = 0; index < fNdet; index++)
a5fa6165 137 fQA[index] = 0 ;
421ab0fb 138}
139
140//____________________________________________________________________________
2e42b4d4 141AliQA::~AliQA()
421ab0fb 142{
143 // dtor
144 delete[] fQA ;
145}
146
46ca5304 147//_______________________________________________________________
148void AliQA::Close()
149{
150 // close the open files
151 if (fgQADataFile)
152 if (fgQADataFile->IsOpen())
153 fgQADataFile->Close() ;
154 if (fgQAResultFile)
155 if (fgQAResultFile->IsOpen())
156 fgQAResultFile->Close() ;
157 if (fgQARefFile)
158 if (fgQARefFile->IsOpen())
159 fgQARefFile->Close() ;
160}
161
4ecde5fc 162//_______________________________________________________________
163const Bool_t AliQA::CheckFatal() const
164{
165 // check if any FATAL status is set
166 Bool_t rv = kFALSE ;
167 Int_t index ;
168 for (index = 0; index < kNDET ; index++)
96d67a8d 169 rv = rv || IsSet(DETECTORINDEX_t(index), fTask, kFATAL) ;
4ecde5fc 170 return rv ;
171}
172
421ab0fb 173//_______________________________________________________________
96d67a8d 174const Bool_t AliQA::CheckRange(DETECTORINDEX_t det) const
421ab0fb 175{
a4976ef3 176 // check if detector is in given detector range: 0-kNDET
421ab0fb 177
a5fa6165 178 Bool_t rv = ( det < 0 || det > kNDET ) ? kFALSE : kTRUE ;
421ab0fb 179 if (!rv)
180 AliFatal(Form("Detector index %d is out of range: 0 <= index <= %d", det, kNDET)) ;
181 return rv ;
182}
183
184//_______________________________________________________________
96d67a8d 185const Bool_t AliQA::CheckRange(ALITASK_t task) const
421ab0fb 186{
187 // check if task is given taskk range: 0:kNTASK
6c18591a 188 Bool_t rv = ( task < kRAW || task > kNTASK ) ? kFALSE : kTRUE ;
421ab0fb 189 if (!rv)
190 AliFatal(Form("Module index %d is out of range: 0 <= index <= %d", task, kNTASK)) ;
191 return rv ;
192}
193
194//_______________________________________________________________
96d67a8d 195const Bool_t AliQA::CheckRange(QABIT_t bit) const
421ab0fb 196{
197 // check if bit is in given bit range: 0-kNBit
198
199 Bool_t rv = ( bit < 0 || bit > kNBIT ) ? kFALSE : kTRUE ;
200 if (!rv)
201 AliFatal(Form("Status bit %d is out of range: 0 <= bit <= %d", bit, kNBIT)) ;
202 return rv ;
203}
204
421ab0fb 205
4ecde5fc 206
a5fa6165 207//_______________________________________________________________
96d67a8d 208const char * AliQA::GetAliTaskName(ALITASK_t tsk)
421ab0fb 209{
210 // returns the char name corresponding to module index
a5fa6165 211 TString tskName ;
421ab0fb 212 switch (tsk) {
213 case kNULLTASK:
214 break ;
6c18591a 215 case kRAW:
216 tskName = "RAW" ;
217 break ;
421ab0fb 218 case kSIM:
219 tskName = "SIM" ;
220 break ;
221 case kREC:
222 tskName = "REC" ;
223 break ;
224 case kESD:
225 tskName = "ESD" ;
226 break ;
227 case kANA:
228 tskName = "ANA" ;
229 break ;
230 default:
a5fa6165 231 tsk = kNULLTASK ;
421ab0fb 232 break ;
233 }
a5fa6165 234 return tskName.Data() ;
421ab0fb 235}
236
46ca5304 237//_______________________________________________________________
7c002d48 238const AliQA::DETECTORINDEX_t AliQA::GetDetIndex(const char * name)
96d67a8d 239{
240 // returns the detector index corresponding to a given name
241 TString sname(name) ;
242 DETECTORINDEX_t rv = kNULLDET ;
243 for (Int_t det = 0; det < kNDET ; det++) {
244 if ( GetDetName(det) == sname ) {
245 rv = DETECTORINDEX_t(det) ;
246 break ;
247 }
248 }
249 return rv ;
250}
251
7c002d48 252//_______________________________________________________________
253const char * AliQA::GetDetName(Int_t det)
254{
255 // returns the detector name corresponding to a given index (needed in a loop)
256
257 if ( det >= 0 && det < kNDET)
258 return (fgDetNames[det]).Data() ;
259 else
260 return NULL ;
261}
262
46ca5304 263//_______________________________________________________________
264TFile * AliQA::GetQADataFile(const char * name, const Int_t run, const Int_t cycle)
265{
266 // opens the file to store the detectors Quality Assurance Data Maker results
96d67a8d 267 const char * temp = Form("%s.%s.%d.%d.root", name, fgQADataFileName.Data(), run, cycle) ;
268 TString opt ;
269 if (! fgQADataFile ) {
270 if (gSystem->AccessPathName(temp))
271 opt = "NEW" ;
272 else
273 opt = "UPDATE" ;
274 fgQADataFile = TFile::Open(temp, opt.Data()) ;
275 } else {
276 if ( strcmp(temp, fgQADataFile->GetName()) != 0 ) {
277 fgQADataFile = dynamic_cast<TFile *>(gROOT->FindObject(temp)) ;
278 if ( !fgQADataFile ) {
279 if (gSystem->AccessPathName(temp))
280 opt = "NEW" ;
281 else
282 opt = "UPDATE" ;
283 fgQADataFile = TFile::Open(temp, opt.Data()) ;
284 }
285 }
46ca5304 286 }
96d67a8d 287 return fgQADataFile ;
46ca5304 288}
289
290//_____________________________________________________________________________
291TFile * AliQA::GetQADataFile(const char * fileName)
292{
293 // Open if necessary the Data file and return its pointer
294
295 if (!fgQADataFile)
296 if (!fileName)
297 fileName = AliQA::GetQADataFileName() ;
298 if (!gSystem->AccessPathName(fileName)) {
299 fgQADataFile = TFile::Open(fileName) ;
300 } else {
301 printf("File %s not found", fileName) ;
302 exit(1) ;
303 }
304 return fgQADataFile ;
305}
306
4ecde5fc 307//_______________________________________________________________
308TFile * AliQA::GetQAResultFile()
309{
310 // opens the file to store the Quality Assurance Data Checker results
2ba0b5f5 311 if (fgQAResultFile)
312 fgQAResultFile->Close() ;
313 fgQAResultFile = 0x0 ;
314// if (!fgQAResultFile) {
1c0190ec 315 TString dirName(fgQAResultDirName) ;
4edbc5bc 316 if ( dirName.Contains(fkgLabLocalFile))
317 dirName.ReplaceAll(fkgLabLocalFile, "") ;
1c0190ec 318 TString fileName(dirName + fgQAResultFileName) ;
46ca5304 319 TString opt("") ;
320 if ( !gSystem->AccessPathName(fileName) )
321 opt = "UPDATE" ;
5bd22145 322 else {
1c0190ec 323 if ( gSystem->AccessPathName(dirName) )
324 gSystem->mkdir(dirName) ;
46ca5304 325 opt = "NEW" ;
5bd22145 326 }
46ca5304 327 fgQAResultFile = TFile::Open(fileName, opt) ;
2ba0b5f5 328// }
46ca5304 329
330 return fgQAResultFile ;
421ab0fb 331}
332
333//_______________________________________________________________
96d67a8d 334const Bool_t AliQA::IsSet(DETECTORINDEX_t det, ALITASK_t tsk, QABIT_t bit) const
421ab0fb 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//_______________________________________________________________
2e42b4d4 350AliQA * AliQA::Instance()
421ab0fb 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//_______________________________________________________________
96d67a8d 359AliQA * AliQA::Instance(const DETECTORINDEX_t det)
421ab0fb 360{
361 // Get an instance of the singleton. The only authorized way to call the ctor
362
9a223722 363 if ( ! fgQA) {
46ca5304 364 TFile * f = GetQAResultFile() ;
9a223722 365 fgQA = dynamic_cast<AliQA *>(f->Get("QA")) ;
366 if ( ! fgQA )
367 fgQA = new AliQA(det) ;
368 }
421ab0fb 369 fgQA->Set(det) ;
370 return fgQA ;
371}
372
373//_______________________________________________________________
96d67a8d 374AliQA * AliQA::Instance(const ALITASK_t tsk)
421ab0fb 375{
376 // get an instance of the singleton.
377
378 if ( ! fgQA)
379 switch (tsk) {
380 case kNULLTASK:
381 break ;
6c18591a 382 case kRAW:
2e42b4d4 383 fgQA = new AliQA(tsk) ;
6c18591a 384 break ;
385 case kSIM:
2e42b4d4 386 fgQA = new AliQA(tsk) ;
421ab0fb 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//_______________________________________________________________
96d67a8d 406AliQA * AliQA::Instance(const TASKINDEX_t tsk)
407{
408 // get an instance of the singleton.
409
410 ALITASK_t index = kNULLTASK ;
411
412 if ( tsk == kRAWS )
413 index = kRAW ;
414 else if (tsk < kDIGITS)
415 index = kSIM ;
416 else if (tsk < kRECPARTICLES)
417 index = kREC ;
418 else if (tsk == kESDS)
419 index = kESD ;
420
421 return Instance(index) ;
422}
423
424//_______________________________________________________________
425const ULong_t AliQA::Offset(ALITASK_t tsk) const
421ab0fb 426{
427 // Calculates the bit offset for a given module (SIM, REC, ESD, ANA)
428
429 CheckRange(tsk) ;
430
431 ULong_t offset = 0 ;
432 switch (tsk) {
433 case kNULLTASK:
434 break ;
6c18591a 435 case kRAW:
421ab0fb 436 offset+= 0 ;
437 break ;
6c18591a 438 case kSIM:
421ab0fb 439 offset+= 4 ;
440 break ;
6c18591a 441 case kREC:
421ab0fb 442 offset+= 8 ;
443 break ;
6c18591a 444 case kESD:
421ab0fb 445 offset+= 12 ;
446 break ;
6c18591a 447 case kANA:
448 offset+= 16 ;
449 break ;
421ab0fb 450 case kNTASK:
451 break ;
452 }
453
454 return offset ;
455}
456
457//_______________________________________________________________
96d67a8d 458void AliQA::Set(QABIT_t bit)
421ab0fb 459{
460 // Set the status bit of the current detector in the current module
461
462 SetStatusBit(fDet, fTask, bit) ;
463}
464
4ecde5fc 465//_____________________________________________________________________________
4edbc5bc 466void AliQA::SetQARefStorage(const char * name)
4ecde5fc 467{
72c25501 468 // Set the root directory where the QA reference data are stored
469
470 fgQARefDirName = name ;
471 if ( fgQARefDirName.Contains(fkgLabLocalFile) )
472 fgQARefFileName = fkgRefFileName ;
473 else if ( fgQARefDirName.Contains(fkgLabLocalOCDB) )
96d67a8d 474 fgQARefFileName = fkgQAName ;
72c25501 475 else if ( fgQARefDirName.Contains(fkgLabAliEnOCDB) )
96d67a8d 476 fgQARefFileName = fkgQAName ;
4ecde5fc 477
4edbc5bc 478 else {
479 printf("ERROR: %s is an invalid storage definition\n", name) ;
480 fgQARefDirName = "" ;
481 fgQARefFileName = "" ;
482 }
72c25501 483 TString tmp(fgQARefDirName) ; // + fgQARefFileName) ;
4edbc5bc 484 printf("AliQA::SetQARefDir: QA references are in %s\n", tmp.Data() ) ;
4ecde5fc 485}
486
487//_____________________________________________________________________________
488void AliQA::SetQAResultDirName(const char * name)
489{
490 // Set the root directory where to store the QA status object
491
492 fgQAResultDirName.Prepend(name) ;
493 printf("AliQA::SetQAResultDirName: QA results are in %s\n", fgQAResultDirName.Data()) ;
4edbc5bc 494 if ( fgQAResultDirName.Contains(fkgLabLocalFile))
495 fgQAResultDirName.ReplaceAll(fkgLabLocalFile, "") ;
4ecde5fc 496 fgQAResultFileName.Prepend(fgQAResultDirName) ;
497}
498
421ab0fb 499//_______________________________________________________________
96d67a8d 500void AliQA::SetStatusBit(DETECTORINDEX_t det, ALITASK_t tsk, QABIT_t bit)
421ab0fb 501{
502 // Set the status bit for a given detector and a given task
503
504 CheckRange(det) ;
505 CheckRange(tsk) ;
506 CheckRange(bit) ;
507
508 ULong_t offset = Offset(tsk) ;
509 ULong_t status = GetStatus(det) ;
510 offset+= bit ;
511 status = status | 1 << offset ;
512 SetStatus(det, status) ;
513}
514
515//_______________________________________________________________
2e42b4d4 516void AliQA::ShowAll() const
421ab0fb 517{
518 // dispplay the QA status word
519 Int_t index ;
520 for (index = 0 ; index < kNDET ; index++)
96d67a8d 521 ShowStatus(DETECTORINDEX_t(index)) ;
421ab0fb 522}
523
524//_______________________________________________________________
96d67a8d 525void AliQA::ShowStatus(DETECTORINDEX_t det) const
421ab0fb 526{
527 // Prints the full QA status of a given detector
528 CheckRange(det) ;
529 ULong_t status = GetStatus(det) ;
a4976ef3 530 ULong_t rawStatus = status & 0x0000f ;
531 ULong_t simStatus = status & 0x000f0 ;
532 ULong_t recStatus = status & 0x00f00 ;
533 ULong_t esdStatus = status & 0x0f000 ;
534 ULong_t anaStatus = status & 0xf0000 ;
421ab0fb 535
2ba0b5f5 536 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 )) ;
421ab0fb 537}
538
96d67a8d 539//_______________________________________________________________
540void AliQA::UnSet(QABIT_t bit)
541{
542 // UnSet the status bit of the current detector in the current module
543
544 UnSetStatusBit(fDet, fTask, bit) ;
545}
546
547//_______________________________________________________________
548void AliQA::UnSetStatusBit(DETECTORINDEX_t det, ALITASK_t tsk, QABIT_t bit)
549{
550 // UnSet the status bit for a given detector and a given task
551
552 CheckRange(det) ;
553 CheckRange(tsk) ;
554 CheckRange(bit) ;
555
556 ULong_t offset = Offset(tsk) ;
557 ULong_t status = GetStatus(det) ;
558 offset+= bit ;
559 status = status & 0 << offset ;
560 SetStatus(det, status) ;
92a357bf 561}