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 ---
42 // --- Standard library ---
44 // --- AliRoot header files ---
50 AliQA * AliQA::fgQA = 0x0 ;
51 TFile * AliQA::fgQADataFile = 0x0 ;
52 TString AliQA::fgQADataFileName = "QA" ; // will transform into Det.QA.run.cycle.root
53 TFile * AliQA::fgQARefFile = 0x0 ;
54 TString AliQA::fgQARefDirName = "" ;
55 TString AliQA::fgQARefFileName = "QA.root" ;
56 TFile * AliQA::fgQAResultFile = 0x0 ;
57 TString AliQA::fgQAResultDirName = "" ;
58 TString AliQA::fgQAResultFileName = "QA.root" ;
59 TString AliQA::fgDetNames[] = {"ITS", "TPC", "TRD", "TOF", "PHOS", "HMPID", "EMCAL", "MUON", "FMD",
60 "ZDC", "PMD", "T0", "VZERO", "ACORDE", "HLT", "Global", "CORR","MFT"};
61 TString AliQA::fgGRPPath = "GRP/GRP/Data" ;
62 TString AliQA::fgRTNames[] = {"UNKNOWN", "AUTO_TEST", "CALIBRATION", "CALIBRATION_PULSER", "CHANNEL_DELAY_TUNING", "COSMIC",
63 "COSMICS", "DAQ_FO_UNIF_SCAN", "DAQ_GEN_DAC_SCAN", "DAQ_MEAN_TH_SCAN", "DAQ_MIN_TH_SCAN",
64 "DAQ_NOISY_PIX_SCAN", "DAQ_PIX_DELAY_SCAN", "DAQ_UNIFORMITY_SCAN", "DCS_FO_UNIF_SCAN",
65 "DCS_MEAN_TH_SCAN", "DCS_MIN_TH_SCAN", "DCS_PIX_DELAY_SCAN", "DCS_UNIFORMITY_SCAN",
66 "DDL_TEST", "GAIN", "PEDESTAL", "INJECTOR", "LASER", "MONTECARLO", "NOISE", "NOISY_PIX_SCAN",
67 "PHYSICS", "PULSER", "STANDALONE", "STANDALONE_BC", "STANDALONE_CENTRAL", "STANDALONE_COSMIC",
68 "STANDALONE_EMD", "STANDALONE_LASER", "STANDALONE_MB", "STANDALONE_PEDESTAL",
69 "STANDALONE_SEMICENTRAL", "STANDALONE_PULSER" } ;
70 TString AliQA::fgTaskNames[] = {"Raws", "Hits", "SDigits", "Digits", "RecPoints", "TrackSegments", "RecParticles", "ESDs"} ;
71 const TString AliQA::fgkLabLocalFile = "file://" ;
72 const TString AliQA::fgkLabLocalOCDB = "local://" ;
73 const TString AliQA::fgkLabAliEnOCDB = "alien://" ;
74 const TString AliQA::fgkRefFileName = "QA.root" ;
75 const TString AliQA::fgkQAName = "QA" ;
76 const TString AliQA::fgkQACorrNtName = "CorrQA" ;
77 const TString AliQA::fgkRefOCDBDirName = "Ref" ;
78 TString AliQA::fgkRefDataDirName = "" ;
79 const TString AliQA::fgkQARefOCDBDefault = "alien://folder=/alice/QA/20" ;
80 const TString AliQA::fgkExpert = "Expert" ;
81 const UInt_t AliQA::fgkExpertBit = 16 ;
82 const UInt_t AliQA::fgkQABit = 17 ;
84 //____________________________________________________________________________
88 fQA(new ULong_t[fNdet]),
93 // default constructor
94 // beware singleton: not to be used
96 for (Int_t index = 0 ; index < fNdet ; index++)
100 //____________________________________________________________________________
101 AliQA::AliQA(const AliQA& qa) :
104 fQA(new ULong_t[qa.fNdet]),
109 memcpy(fQA, qa.fQA, sizeof(ULong_t)*fNdet);
112 //_____________________________________________________________________________
113 AliQA& AliQA::operator = (const AliQA& qa)
116 // Assignment operator
118 TNamed::operator=(qa);
121 fQA = new ULong_t[fNdet];
122 memcpy(fQA, qa.fQA, sizeof(ULong_t)*fNdet);
129 //_______________________________________________________________
130 AliQA::AliQA(const DETECTORINDEX_t det) :
131 TNamed("QA", "Quality Assurance status"),
133 fQA(new ULong_t[fNdet]),
137 // constructor to be used
138 if (! CheckRange(det) ) {
143 for (index = 0; index < fNdet; index++)
147 //_______________________________________________________________
148 AliQA::AliQA(const ALITASK_t tsk) :
149 TNamed("QA", "Quality Assurance status"),
151 fQA(new ULong_t[fNdet]),
155 // constructor to be used in the AliRoot module (SIM, REC, ESD or ANA)
156 if (! CheckRange(tsk) ) {
161 for (index = 0; index < fNdet; index++)
165 //____________________________________________________________________________
172 //_______________________________________________________________
175 // close the open files
177 if (fgQADataFile->IsOpen())
178 fgQADataFile->Close() ;
180 if (fgQAResultFile->IsOpen())
181 fgQAResultFile->Close() ;
183 if (fgQARefFile->IsOpen())
184 fgQARefFile->Close() ;
187 //_______________________________________________________________
188 Bool_t AliQA::CheckFatal() const
190 // check if any FATAL status is set
193 for (index = 0; index < kNDET ; index++)
194 rv = rv || IsSet(DETECTORINDEX_t(index), fTask, kFATAL) ;
198 //_______________________________________________________________
199 Bool_t AliQA::CheckRange(DETECTORINDEX_t det) const
201 // check if detector is in given detector range: 0-kNDET
203 Bool_t rv = ( det < 0 || det > kNDET ) ? kFALSE : kTRUE ;
205 AliFatal(Form("Detector index %d is out of range: 0 <= index <= %d", det, kNDET)) ;
209 //_______________________________________________________________
210 Bool_t AliQA::CheckRange(ALITASK_t task) const
212 // check if task is given taskk range: 0:kNTASK
213 Bool_t rv = ( task < kRAW || task > kNTASK ) ? kFALSE : kTRUE ;
215 AliFatal(Form("Module index %d is out of range: 0 <= index <= %d", task, kNTASK)) ;
219 //_______________________________________________________________
220 Bool_t AliQA::CheckRange(QABIT_t bit) const
222 // check if bit is in given bit range: 0-kNBit
224 Bool_t rv = ( bit < 0 || bit > kNBIT ) ? kFALSE : kTRUE ;
226 AliFatal(Form("Status bit %d is out of range: 0 <= bit <= %d", bit, kNBIT)) ;
232 //_______________________________________________________________
233 char * AliQA::GetAliTaskName(ALITASK_t tsk)
235 // returns the char name corresponding to module index
259 return Form("%s", tskName.Data()) ;
262 //_______________________________________________________________
263 char * AliQA::GetBitName(QABIT_t bit) const
265 // returns the char name corresponding to bit
274 bitName = "WARNING" ;
286 return Form("%s", bitName.Data()) ;
289 //_______________________________________________________________
290 AliQA::DETECTORINDEX_t AliQA::GetDetIndex(const char * name)
292 // returns the detector index corresponding to a given name
293 TString sname(name) ;
294 DETECTORINDEX_t rv = kNULLDET ;
295 for (Int_t det = 0; det < kNDET ; det++) {
296 if ( GetDetName(det) == sname ) {
297 rv = DETECTORINDEX_t(det) ;
304 //_______________________________________________________________
305 const char * AliQA::GetDetName(Int_t det)
307 // returns the detector name corresponding to a given index (needed in a loop)
309 if ( det >= 0 && det < kNDET)
310 return (fgDetNames[det]).Data() ;
315 //_______________________________________________________________
316 TFile * AliQA::GetQADataFile(const char * name, const Int_t run)
318 // opens the file to store the detectors Quality Assurance Data Maker results
319 const char * temp = Form("%s.%s.%d.root", name, fgQADataFileName.Data(), run) ;
321 if (! fgQADataFile ) {
322 if (gSystem->AccessPathName(temp))
326 fgQADataFile = TFile::Open(temp, opt.Data()) ;
328 if ( strcmp(temp, fgQADataFile->GetName()) != 0 ) {
329 fgQADataFile = dynamic_cast<TFile *>(gROOT->FindObject(temp)) ;
330 if ( !fgQADataFile ) {
331 if (gSystem->AccessPathName(temp))
335 fgQADataFile = TFile::Open(temp, opt.Data()) ;
339 return fgQADataFile ;
342 //_____________________________________________________________________________
343 TFile * AliQA::GetQADataFile(const char * fileName)
345 // Open if necessary the Data file and return its pointer
349 fileName = AliQA::GetQADataFileName() ;
350 if (!gSystem->AccessPathName(fileName)) {
351 fgQADataFile = TFile::Open(fileName) ;
353 AliFatalClass(Form("File %s not found", fileName)) ;
355 return fgQADataFile ;
358 //_______________________________________________________________
359 TFile * AliQA::GetQAResultFile()
361 // opens the file to store the Quality Assurance Data Checker results
363 fgQAResultFile->Close() ;
364 fgQAResultFile = 0x0 ;
365 // if (!fgQAResultFile) {
366 TString dirName(fgQAResultDirName) ;
367 if ( dirName.Contains(fgkLabLocalFile))
368 dirName.ReplaceAll(fgkLabLocalFile, "") ;
369 TString fileName(dirName + fgQAResultFileName) ;
371 if ( !gSystem->AccessPathName(fileName) )
374 if ( gSystem->AccessPathName(dirName) )
375 gSystem->mkdir(dirName) ;
378 fgQAResultFile = TFile::Open(fileName, opt) ;
381 return fgQAResultFile ;
384 //_______________________________________________________________
385 const TString AliQA::GetRunTypeName(RUNTYPE_t rt)
387 // returns the name of a run type
388 TString rv("Invalid Run Type") ;
389 if ( rt == kNULLTYPE ) {
390 rv = "Known RUN_TYPE are: \n" ;
391 for (Int_t index = 0 ; index < kNTYPE; index++) {
392 rv += Form("%2d -- %s\n", index, fgRTNames[index].Data()) ;
394 AliErrorClass(Form("%s", rv.Data())) ;
398 if ( rt > kNULLTYPE && rt < kNTYPE )
404 //_______________________________________________________________
405 AliQA::TASKINDEX_t AliQA::GetTaskIndex(const char * name)
407 // returns the detector index corresponding to a given name
408 TString sname(name) ;
409 TASKINDEX_t rv = kNULLTASKINDEX ;
410 for (Int_t tsk = 0; tsk < kNTASKINDEX ; tsk++) {
411 if ( GetTaskName(tsk) == sname ) {
412 rv = TASKINDEX_t(tsk) ;
419 //_______________________________________________________________
420 Bool_t AliQA::IsSet(DETECTORINDEX_t det, ALITASK_t tsk, QABIT_t bit) const
422 // Checks is the requested bit is set
428 ULong_t offset = Offset(tsk) ;
429 ULong_t status = GetStatus(det) ;
431 status = (status & 1 << offset) != 0 ;
435 //_______________________________________________________________
436 Bool_t AliQA::IsSetAny(DETECTORINDEX_t det, ALITASK_t tsk) const
438 // Checks is the requested bit is set
443 ULong_t offset = Offset(tsk) ;
444 ULong_t status = GetStatus(det) ;
446 for ( Int_t bit = 0 ; bit < kNBIT ; bit++) {
448 st += (status & 1 << offset) != 0 ;
455 //_______________________________________________________________
456 Bool_t AliQA::IsSetAny(DETECTORINDEX_t det) const
458 // Checks is the requested bit is set
462 ULong_t status = GetStatus(det) ;
464 for ( Int_t tsk = 0 ; tsk < kNTASK ; tsk++) {
465 ULong_t offset = Offset(ALITASK_t(tsk)) ;
466 for ( Int_t bit = 0 ; bit < kNBIT ; bit++) {
468 st += (status & 1 << offset) != 0 ;
477 //_______________________________________________________________
478 AliQA * AliQA::Instance()
480 // Get an instance of the singleton.
481 // Object must have been instantiated with Instance(ALITASK) first
486 //_______________________________________________________________
487 AliQA * AliQA::Instance(const DETECTORINDEX_t det)
489 // Get an instance of the singleton. The only authorized way to call the ctor
492 TFile * f = GetQAResultFile() ;
493 fgQA = dynamic_cast<AliQA *>(f->Get("QA")) ;
495 fgQA = new AliQA(det) ;
501 //_______________________________________________________________
502 AliQA * AliQA::Instance(const ALITASK_t tsk)
504 // get an instance of the singleton.
511 fgQA = new AliQA(tsk) ;
514 fgQA = new AliQA(tsk) ;
517 AliInfoClass("fgQA = gAlice->GetQA()") ;
520 AliInfoClass("fgQA = dynamic_cast<AliQA *> (esdFile->Get(\"QA\")") ;
523 AliInfoClass("fgQA = dynamic_cast<AliQA *> (esdFile->Get(\"QA\")") ;
533 //_______________________________________________________________
534 AliQA * AliQA::Instance(const TASKINDEX_t tsk)
536 // get an instance of the singleton.
538 ALITASK_t index = kNULLTASK ;
542 else if (tsk < kDIGITS)
544 else if (tsk < kRECPARTICLES)
546 else if (tsk == kESDS)
549 return Instance(index) ;
552 //_______________________________________________________________
553 Long64_t AliQA::Merge(const TCollection * list) {
554 // Merge the QA resuls in the list into this single AliQA object
557 for (Int_t det = 0 ; det < kNDET ; det++) {
558 Set(DETECTORINDEX_t(det)) ;
559 for (Int_t task = 0 ; task < kNTASK ; task++) {
560 Set(ALITASK_t(task)) ;
561 for (Int_t bit = 0 ; bit < kNBIT ; bit++) {
564 while ( (qa = (AliQA*)next() ) ) {
566 qa->IsSet(DETECTORINDEX_t(det), ALITASK_t(task), QABIT_t(bit)) ;
575 //_______________________________________________________________
576 ULong_t AliQA::Offset(ALITASK_t tsk) const
578 // Calculates the bit offset for a given module (SIM, REC, ESD, ANA)
608 //_______________________________________________________________
609 void AliQA::Set(QABIT_t bit)
611 // Set the status bit of the current detector in the current module
613 SetStatusBit(fDet, fTask, bit) ;
616 //_____________________________________________________________________________
617 void AliQA::SetQARefStorage(const char * name)
619 // Set the root directory where the QA reference data are stored
621 fgQARefDirName = name ;
622 if ( fgQARefDirName.Contains(fgkLabLocalFile) )
623 fgQARefFileName = fgkRefFileName ;
624 else if ( fgQARefDirName.Contains(fgkLabLocalOCDB) )
625 fgQARefFileName = fgkQAName ;
626 else if ( fgQARefDirName.Contains(fgkLabAliEnOCDB) )
627 fgQARefFileName = fgkQAName ;
630 AliErrorClass(Form("%s is an invalid storage definition\n", name)) ;
631 fgQARefDirName = "" ;
632 fgQARefFileName = "" ;
634 TString tmp(fgQARefDirName) ; // + fgQARefFileName) ;
635 AliInfoClass(Form("AliQA::SetQARefDir: QA references are in %s\n", tmp.Data()) ) ;
638 //_____________________________________________________________________________
639 void AliQA::SetQARefDataDirName(const char * name)
641 // Set the lower level directory name where reference data are found
643 RUNTYPE_t rt = kNULLTYPE ;
644 for (Int_t index = 0; index < kNTYPE; index++) {
645 if (test.CompareTo(fgRTNames[index]) == 0) {
646 rt = (RUNTYPE_t) index ;
651 if (rt == kNULLTYPE) {
652 AliWarningClass(Form("AliQA::SetQARefDataDirName: %s is an unknown RUN TYPE name\n", name)) ;
656 SetQARefDataDirName(rt) ;
659 //_____________________________________________________________________________
660 void AliQA::SetQAResultDirName(const char * name)
662 // Set the root directory where to store the QA status object
664 fgQAResultDirName.Prepend(name) ;
665 AliInfoClass(Form("AliQA::SetQAResultDirName: QA results are in %s\n", fgQAResultDirName.Data())) ;
666 if ( fgQAResultDirName.Contains(fgkLabLocalFile))
667 fgQAResultDirName.ReplaceAll(fgkLabLocalFile, "") ;
668 fgQAResultFileName.Prepend(fgQAResultDirName) ;
671 //_______________________________________________________________
672 void AliQA::SetStatusBit(DETECTORINDEX_t det, ALITASK_t tsk, QABIT_t bit)
674 // Set the status bit for a given detector and a given task
680 ULong_t offset = Offset(tsk) ;
681 ULong_t status = GetStatus(det) ;
683 status = status | 1 << offset ;
684 SetStatus(det, status) ;
687 //_______________________________________________________________
688 void AliQA::ShowAll() const
690 // dispplay the QA status word
692 for (index = 0 ; index < kNDET ; index++) {
693 for (Int_t tsk = kRAW ; tsk < kNTASK ; tsk++) {
694 ShowStatus(DETECTORINDEX_t(index), ALITASK_t(tsk)) ;
699 //_______________________________________________________________
700 void AliQA::ShowStatus(DETECTORINDEX_t det, ALITASK_t tsk) const
702 // Prints the full QA status of a given detector
704 ULong_t status = GetStatus(det) ;
705 ULong_t tskStatus[kNTASK] ;
706 tskStatus[kRAW] = status & 0x0000f ;
707 tskStatus[kSIM] = status & 0x000f0 ;
708 tskStatus[kREC] = status & 0x00f00 ;
709 tskStatus[kESD] = status & 0x0f000 ;
710 tskStatus[kANA] = status & 0xf0000 ;
712 AliInfo(Form("====> QA Status for %8s raw =0x%lx, sim=0x%lx, rec=0x%lx, esd=0x%lx, ana=0x%lx", GetDetName(det).Data(),
713 tskStatus[kRAW], tskStatus[kSIM], tskStatus[kREC], tskStatus[kESD], tskStatus[kANA] )) ;
714 if (tsk == kNULLTASK) {
715 for (Int_t itsk = kRAW ; itsk < kNTASK ; itsk++) {
716 ShowASCIIStatus(det, ALITASK_t(itsk), tskStatus[itsk]) ;
719 ShowASCIIStatus(det, tsk, tskStatus[tsk]) ;
723 //_______________________________________________________________
724 void AliQA::ShowASCIIStatus(DETECTORINDEX_t det, ALITASK_t tsk, const ULong_t status) const
726 // print the QA status in human readable format
728 for (Int_t bit = kINFO ; bit < kNBIT ; bit++) {
729 if (IsSet(det, tsk, QABIT_t(bit))) {
730 text = GetBitName(QABIT_t(bit)) ;
735 AliWarningClass(Form(" %8s %4s 0x%4lx, Problem signalled: %8s \n", GetDetName(det).Data(), GetAliTaskName(tsk), status, text.Data())) ;
738 //_______________________________________________________________
739 void AliQA::UnSet(QABIT_t bit)
741 // UnSet the status bit of the current detector in the current module
743 UnSetStatusBit(fDet, fTask, bit) ;
746 //_______________________________________________________________
747 void AliQA::UnSetStatusBit(DETECTORINDEX_t det, ALITASK_t tsk, QABIT_t bit)
749 // UnSet the status bit for a given detector and a given task
755 ULong_t offset = Offset(tsk) ;
756 ULong_t status = GetStatus(det) ;
758 status = status & 0 << offset ;
759 SetStatus(det, status) ;