2 /**************************************************************************
3 * Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
5 * Author: The ALICE Off-line Project. *
6 * Contributors are mentioned in the code where appropriate. *
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 **************************************************************************/
18 //////////////////////////////////////////////////////////////////////////////
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 (RAW)
24 // bit 4-7 : QA raised during simulation (SIM)
25 // bit 8-11 : QA raised during reconstruction (REC)
26 // bit 12-15 : QA raised during ESD checking (ESD)
27 // bit 16-19 : QA raised during analysis (ANA)
28 // Each of the 4 bits corresponds to a severity level of increasing importance
29 // from lower to higher bit (INFO, WARNING, ERROR, FATAL)
31 //*-- Yves Schutz CERN, July 2007
32 //////////////////////////////////////////////////////////////////////////////
36 // --- ROOT system ---
41 // --- Standard library ---
43 // --- AliRoot header files ---
49 AliQA * AliQA::fgQA = 0x0 ;
50 TFile * AliQA::fgQADataFile = 0x0 ;
51 TString AliQA::fgQADataFileName = "QA" ; // will transform into Det.QA.run.cycle.root
52 TFile * AliQA::fgQARefFile = 0x0 ;
53 TString AliQA::fgQARefDirName = "" ;
54 TString AliQA::fgQARefFileName = "QA.root" ;
55 TFile * AliQA::fgQAResultFile = 0x0 ;
56 TString AliQA::fgQAResultDirName = "" ;
57 TString AliQA::fgQAResultFileName = "QA.root" ;
58 TString AliQA::fgDetNames[] = {"ITS", "TPC", "TRD", "TOF", "PHOS", "HMPID", "EMCAL", "MUON", "FMD",
59 "ZDC", "PMD", "T0", "VZERO", "ACORDE", "HLT", "Global"} ;
60 TString AliQA::fgGRPPath = "GRP/GRP/Data" ;
61 TString AliQA::fgRTNames[] = {"UNKNOWN", "AUTO_TEST", "CALIBRATION", "CALIBRATION_PULSER", "CHANNEL_DELAY_TUNING", "COSMIC",
62 "COSMICS", "DAQ_FO_UNIF_SCAN", "DAQ_GEN_DAC_SCAN", "DAQ_MEAN_TH_SCAN", "DAQ_MIN_TH_SCAN",
63 "DAQ_NOISY_PIX_SCAN", "DAQ_PIX_DELAY_SCAN", "DAQ_UNIFORMITY_SCAN", "DCS_FO_UNIF_SCAN",
64 "DCS_MEAN_TH_SCAN", "DCS_MIN_TH_SCAN", "DCS_PIX_DELAY_SCAN", "DCS_UNIFORMITY_SCAN",
65 "DDL_TEST", "GAIN", "PEDESTAL", "INJECTOR", "LASER", "MONTECARLO", "NOISE", "NOISY_PIX_SCAN",
66 "PHYSICS", "PULSER", "STANDALONE", "STANDALONE_BC", "STANDALONE_CENTRAL", "STANDALONE_COSMIC",
67 "STANDALONE_EMD", "STANDALONE_LASER", "STANDALONE_MB", "STANDALONE_PEDESTAL",
68 "STANDALONE_SEMICENTRAL", "STANDALONE_PULSER" } ;
69 TString AliQA::fgTaskNames[] = {"Raws", "Hits", "SDigits", "Digits", "RecPoints", "TrackSegments", "RecParticles", "ESDs"} ;
70 const TString AliQA::fkgLabLocalFile = "file://" ;
71 const TString AliQA::fkgLabLocalOCDB = "local://" ;
72 const TString AliQA::fkgLabAliEnOCDB = "alien://" ;
73 const TString AliQA::fkgRefFileName = "QA.root" ;
74 const TString AliQA::fkgQAName = "QA" ;
75 const TString AliQA::fkgRefOCDBDirName = "Ref" ;
76 TString AliQA::fkgRefDataDirName = "" ;
77 const TString AliQA::fkgQARefOCDBDefault = "alien://folder=/alice/QA/20" ;
78 //____________________________________________________________________________
82 fQA(new ULong_t[fNdet]),
87 // default constructor
88 // beware singleton: not to be used
90 for (Int_t index = 0 ; index < fNdet ; index++)
94 //____________________________________________________________________________
95 AliQA::AliQA(const AliQA& qa) :
105 //_____________________________________________________________________________
106 AliQA& AliQA::operator = (const AliQA& qa)
108 // assignment operator
115 //_______________________________________________________________
116 AliQA::AliQA(const DETECTORINDEX_t det) :
117 TNamed("QA", "Quality Assurance status"),
119 fQA(new ULong_t[fNdet]),
123 // constructor to be used
124 if (! CheckRange(det) ) {
129 for (index = 0; index < fNdet; index++)
133 //_______________________________________________________________
134 AliQA::AliQA(const ALITASK_t tsk) :
135 TNamed("QA", "Quality Assurance status"),
137 fQA(new ULong_t[fNdet]),
141 // constructor to be used in the AliRoot module (SIM, REC, ESD or ANA)
142 if (! CheckRange(tsk) ) {
147 for (index = 0; index < fNdet; index++)
151 //____________________________________________________________________________
158 //_______________________________________________________________
161 // close the open files
163 if (fgQADataFile->IsOpen())
164 fgQADataFile->Close() ;
166 if (fgQAResultFile->IsOpen())
167 fgQAResultFile->Close() ;
169 if (fgQARefFile->IsOpen())
170 fgQARefFile->Close() ;
173 //_______________________________________________________________
174 const Bool_t AliQA::CheckFatal() const
176 // check if any FATAL status is set
179 for (index = 0; index < kNDET ; index++)
180 rv = rv || IsSet(DETECTORINDEX_t(index), fTask, kFATAL) ;
184 //_______________________________________________________________
185 const Bool_t AliQA::CheckRange(DETECTORINDEX_t det) const
187 // check if detector is in given detector range: 0-kNDET
189 Bool_t rv = ( det < 0 || det > kNDET ) ? kFALSE : kTRUE ;
191 AliFatal(Form("Detector index %d is out of range: 0 <= index <= %d", det, kNDET)) ;
195 //_______________________________________________________________
196 const Bool_t AliQA::CheckRange(ALITASK_t task) const
198 // check if task is given taskk range: 0:kNTASK
199 Bool_t rv = ( task < kRAW || task > kNTASK ) ? kFALSE : kTRUE ;
201 AliFatal(Form("Module index %d is out of range: 0 <= index <= %d", task, kNTASK)) ;
205 //_______________________________________________________________
206 const Bool_t AliQA::CheckRange(QABIT_t bit) const
208 // check if bit is in given bit range: 0-kNBit
210 Bool_t rv = ( bit < 0 || bit > kNBIT ) ? kFALSE : kTRUE ;
212 AliFatal(Form("Status bit %d is out of range: 0 <= bit <= %d", bit, kNBIT)) ;
218 //_______________________________________________________________
219 const char * AliQA::GetAliTaskName(ALITASK_t tsk)
221 // returns the char name corresponding to module index
245 return tskName.Data() ;
247 //_______________________________________________________________
248 const char * AliQA::GetBitName(QABIT_t bit) const
250 // returns the char name corresponding to bit
259 bitName = "WARNING" ;
271 return bitName.Data() ;
274 //_______________________________________________________________
275 const AliQA::DETECTORINDEX_t AliQA::GetDetIndex(const char * name)
277 // returns the detector index corresponding to a given name
278 TString sname(name) ;
279 DETECTORINDEX_t rv = kNULLDET ;
280 for (Int_t det = 0; det < kNDET ; det++) {
281 if ( GetDetName(det) == sname ) {
282 rv = DETECTORINDEX_t(det) ;
289 //_______________________________________________________________
290 const char * AliQA::GetDetName(Int_t det)
292 // returns the detector name corresponding to a given index (needed in a loop)
294 if ( det >= 0 && det < kNDET)
295 return (fgDetNames[det]).Data() ;
300 //_______________________________________________________________
301 TFile * AliQA::GetQADataFile(const char * name, const Int_t run, const Int_t cycle)
303 // opens the file to store the detectors Quality Assurance Data Maker results
304 const char * temp = Form("%s.%s.%d.%d.root", name, fgQADataFileName.Data(), run, cycle) ;
306 if (! fgQADataFile ) {
307 if (gSystem->AccessPathName(temp))
311 fgQADataFile = TFile::Open(temp, opt.Data()) ;
313 if ( strcmp(temp, fgQADataFile->GetName()) != 0 ) {
314 fgQADataFile = dynamic_cast<TFile *>(gROOT->FindObject(temp)) ;
315 if ( !fgQADataFile ) {
316 if (gSystem->AccessPathName(temp))
320 fgQADataFile = TFile::Open(temp, opt.Data()) ;
324 return fgQADataFile ;
327 //_____________________________________________________________________________
328 TFile * AliQA::GetQADataFile(const char * fileName)
330 // Open if necessary the Data file and return its pointer
334 fileName = AliQA::GetQADataFileName() ;
335 if (!gSystem->AccessPathName(fileName)) {
336 fgQADataFile = TFile::Open(fileName) ;
338 printf("File %s not found", fileName) ;
341 return fgQADataFile ;
344 //_______________________________________________________________
345 TFile * AliQA::GetQAResultFile()
347 // opens the file to store the Quality Assurance Data Checker results
349 fgQAResultFile->Close() ;
350 fgQAResultFile = 0x0 ;
351 // if (!fgQAResultFile) {
352 TString dirName(fgQAResultDirName) ;
353 if ( dirName.Contains(fkgLabLocalFile))
354 dirName.ReplaceAll(fkgLabLocalFile, "") ;
355 TString fileName(dirName + fgQAResultFileName) ;
357 if ( !gSystem->AccessPathName(fileName) )
360 if ( gSystem->AccessPathName(dirName) )
361 gSystem->mkdir(dirName) ;
364 fgQAResultFile = TFile::Open(fileName, opt) ;
367 return fgQAResultFile ;
370 //_______________________________________________________________
371 const TString AliQA::GetRunTypeName(RUNTYPE_t rt)
373 TString rv("Invalid Run Type") ;
374 if ( rt == kNULLTYPE ) {
375 rv = "Known RUN_TYPE are: \n" ;
376 for (Int_t index = 0 ; index < kNTYPE; index++) {
377 rv += Form("%2d -- %s\n", index, fgRTNames[index].Data()) ;
379 printf("%s", rv.Data()) ;
383 if ( rt > kNULLTYPE && rt < kNTYPE )
389 //_______________________________________________________________
390 const AliQA::TASKINDEX_t AliQA::GetTaskIndex(const char * name)
392 // returns the detector index corresponding to a given name
393 TString sname(name) ;
395 for (Int_t tsk = 0; tsk < kNTASKINDEX ; tsk++) {
396 if ( GetTaskName(tsk) == sname ) {
397 rv = TASKINDEX_t(tsk) ;
404 //_______________________________________________________________
405 const Bool_t AliQA::IsSet(DETECTORINDEX_t det, ALITASK_t tsk, QABIT_t bit) const
407 // Checks is the requested bit is set
413 ULong_t offset = Offset(tsk) ;
414 ULong_t status = GetStatus(det) ;
416 status = (status & 1 << offset) != 0 ;
420 //_______________________________________________________________
421 AliQA * AliQA::Instance()
423 // Get an instance of the singleton.
424 // Object must have been instantiated with Instance(ALITASK) first
429 //_______________________________________________________________
430 AliQA * AliQA::Instance(const DETECTORINDEX_t det)
432 // Get an instance of the singleton. The only authorized way to call the ctor
435 TFile * f = GetQAResultFile() ;
436 fgQA = dynamic_cast<AliQA *>(f->Get("QA")) ;
438 fgQA = new AliQA(det) ;
444 //_______________________________________________________________
445 AliQA * AliQA::Instance(const ALITASK_t tsk)
447 // get an instance of the singleton.
454 fgQA = new AliQA(tsk) ;
457 fgQA = new AliQA(tsk) ;
460 printf("fgQA = gAlice->GetQA()") ;
463 printf("fgQA = dynamic_cast<AliQA *> (esdFile->Get(\"QA\")") ;
466 printf("fgQA = dynamic_cast<AliQA *> (esdFile->Get(\"QA\")") ;
476 //_______________________________________________________________
477 AliQA * AliQA::Instance(const TASKINDEX_t tsk)
479 // get an instance of the singleton.
481 ALITASK_t index = kNULLTASK ;
485 else if (tsk < kDIGITS)
487 else if (tsk < kRECPARTICLES)
489 else if (tsk == kESDS)
492 return Instance(index) ;
495 //_______________________________________________________________
496 const ULong_t AliQA::Offset(ALITASK_t tsk) const
498 // Calculates the bit offset for a given module (SIM, REC, ESD, ANA)
528 //_______________________________________________________________
529 void AliQA::Set(QABIT_t bit)
531 // Set the status bit of the current detector in the current module
533 SetStatusBit(fDet, fTask, bit) ;
536 //_____________________________________________________________________________
537 void AliQA::SetQARefStorage(const char * name)
539 // Set the root directory where the QA reference data are stored
541 fgQARefDirName = name ;
542 if ( fgQARefDirName.Contains(fkgLabLocalFile) )
543 fgQARefFileName = fkgRefFileName ;
544 else if ( fgQARefDirName.Contains(fkgLabLocalOCDB) )
545 fgQARefFileName = fkgQAName ;
546 else if ( fgQARefDirName.Contains(fkgLabAliEnOCDB) )
547 fgQARefFileName = fkgQAName ;
550 printf("ERROR: %s is an invalid storage definition\n", name) ;
551 fgQARefDirName = "" ;
552 fgQARefFileName = "" ;
554 TString tmp(fgQARefDirName) ; // + fgQARefFileName) ;
555 printf("AliQA::SetQARefDir: QA references are in %s\n", tmp.Data() ) ;
558 //_____________________________________________________________________________
559 void AliQA::SetQARefDataDirName(const char * name)
561 // Set the lower level directory name where reference data are found
563 RUNTYPE_t rt = kNULLTYPE ;
564 for (Int_t index = 0; index < kNTYPE; index++) {
565 if (test.CompareTo(fgRTNames[index]) == 0) {
566 rt = (RUNTYPE_t) index ;
571 if (rt == kNULLTYPE) {
572 printf("AliQA::SetQARefDataDirName: %s is an unknown RUN TYPE name\n", name) ;
576 SetQARefDataDirName(rt) ;
579 //_____________________________________________________________________________
580 void AliQA::SetQAResultDirName(const char * name)
582 // Set the root directory where to store the QA status object
584 fgQAResultDirName.Prepend(name) ;
585 printf("AliQA::SetQAResultDirName: QA results are in %s\n", fgQAResultDirName.Data()) ;
586 if ( fgQAResultDirName.Contains(fkgLabLocalFile))
587 fgQAResultDirName.ReplaceAll(fkgLabLocalFile, "") ;
588 fgQAResultFileName.Prepend(fgQAResultDirName) ;
591 //_______________________________________________________________
592 void AliQA::SetStatusBit(DETECTORINDEX_t det, ALITASK_t tsk, QABIT_t bit)
594 // Set the status bit for a given detector and a given task
600 ULong_t offset = Offset(tsk) ;
601 ULong_t status = GetStatus(det) ;
603 status = status | 1 << offset ;
604 SetStatus(det, status) ;
607 //_______________________________________________________________
608 void AliQA::ShowAll() const
610 // dispplay the QA status word
612 for (index = 0 ; index < kNDET ; index++) {
613 for (Int_t tsk = kRAW ; tsk < kNTASK ; tsk++) {
614 ShowStatus(DETECTORINDEX_t(index), ALITASK_t(tsk)) ;
619 //_______________________________________________________________
620 void AliQA::ShowStatus(DETECTORINDEX_t det, ALITASK_t tsk) const
622 // Prints the full QA status of a given detector
624 ULong_t status = GetStatus(det) ;
625 ULong_t tskStatus[kNTASK] ;
626 tskStatus[kRAW] = status & 0x0000f ;
627 tskStatus[kSIM] = status & 0x000f0 ;
628 tskStatus[kREC] = status & 0x00f00 ;
629 tskStatus[kESD] = status & 0x0f000 ;
630 tskStatus[kANA] = status & 0xf0000 ;
632 AliInfo(Form("====> QA Status for %8s raw =0x%x, sim=0x%x, rec=0x%x, esd=0x%x, ana=0x%x", GetDetName(det).Data(),
633 tskStatus[kRAW], tskStatus[kSIM], tskStatus[kREC], tskStatus[kESD], tskStatus[kANA] )) ;
634 if (tsk == kNULLTASK) {
635 for (Int_t itsk = kRAW ; itsk < kNTASK ; itsk++) {
636 ShowASCIIStatus(det, ALITASK_t(itsk), tskStatus[itsk]) ;
639 ShowASCIIStatus(det, tsk, tskStatus[tsk]) ;
643 //_______________________________________________________________
644 void AliQA::ShowASCIIStatus(DETECTORINDEX_t det, ALITASK_t tsk, const ULong_t status) const
646 // print the QA status in human readable format
648 for (Int_t bit = kINFO ; bit < kNBIT ; bit++) {
649 if (IsSet(det, tsk, QABIT_t(bit))) {
650 text = GetBitName(QABIT_t(bit)) ;
655 printf(" %8s %4s 0x%4x, Problem signalled: %8s \n", GetDetName(det).Data(), GetAliTaskName(tsk), status, text.Data()) ;
658 //_______________________________________________________________
659 void AliQA::UnSet(QABIT_t bit)
661 // UnSet the status bit of the current detector in the current module
663 UnSetStatusBit(fDet, fTask, bit) ;
666 //_______________________________________________________________
667 void AliQA::UnSetStatusBit(DETECTORINDEX_t det, ALITASK_t tsk, QABIT_t bit)
669 // UnSet the status bit for a given detector and a given task
675 ULong_t offset = Offset(tsk) ;
676 ULong_t status = GetStatus(det) ;
678 status = status & 0 << offset ;
679 SetStatus(det, status) ;