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"
65 TString AliQA::fgGRPPath = "GRP/GRP/Data" ;
66 TString AliQA::fgRTNames[] = {"UNKNOWN", "AUTO_TEST", "CALIBRATION", "CALIBRATION_PULSER", "CHANNEL_DELAY_TUNING", "COSMIC",
67 "COSMICS", "DAQ_FO_UNIF_SCAN", "DAQ_GEN_DAC_SCAN", "DAQ_MEAN_TH_SCAN", "DAQ_MIN_TH_SCAN",
68 "DAQ_NOISY_PIX_SCAN", "DAQ_PIX_DELAY_SCAN", "DAQ_UNIFORMITY_SCAN", "DCS_FO_UNIF_SCAN",
69 "DCS_MEAN_TH_SCAN", "DCS_MIN_TH_SCAN", "DCS_PIX_DELAY_SCAN", "DCS_UNIFORMITY_SCAN",
70 "DDL_TEST", "GAIN", "PEDESTAL", "INJECTOR", "LASER", "MONTECARLO", "NOISE", "NOISY_PIX_SCAN",
71 "PHYSICS", "PULSER", "STANDALONE", "STANDALONE_BC", "STANDALONE_CENTRAL", "STANDALONE_COSMIC",
72 "STANDALONE_EMD", "STANDALONE_LASER", "STANDALONE_MB", "STANDALONE_PEDESTAL",
73 "STANDALONE_SEMICENTRAL", "STANDALONE_PULSER" } ;
74 TString AliQA::fgTaskNames[] = {"Raws", "Hits", "SDigits", "Digits", "RecPoints", "TrackSegments", "RecParticles", "ESDs"} ;
75 const TString AliQA::fgkLabLocalFile = "file://" ;
76 const TString AliQA::fgkLabLocalOCDB = "local://" ;
77 const TString AliQA::fgkLabAliEnOCDB = "alien://" ;
78 const TString AliQA::fgkRefFileName = "QA.root" ;
79 const TString AliQA::fgkQAName = "QA" ;
80 const TString AliQA::fgkQACorrNtName = "CorrQA" ;
81 const TString AliQA::fgkRefOCDBDirName = "Ref" ;
82 TString AliQA::fgkRefDataDirName = "" ;
83 const TString AliQA::fgkQARefOCDBDefault = "alien://folder=/alice/QA/20" ;
84 const TString AliQA::fgkExpert = "Expert" ;
85 const UInt_t AliQA::fgkExpertBit = 16 ;
86 const UInt_t AliQA::fgkQABit = 17 ;
88 //____________________________________________________________________________
92 fQA(new ULong_t[fNdet]),
97 // default constructor
98 // beware singleton: not to be used
100 for (Int_t index = 0 ; index < fNdet ; index++)
104 //____________________________________________________________________________
105 AliQA::AliQA(const AliQA& qa) :
108 fQA(new ULong_t[qa.fNdet]),
113 memcpy(fQA, qa.fQA, sizeof(ULong_t)*fNdet);
116 //_____________________________________________________________________________
117 AliQA& AliQA::operator = (const AliQA& qa)
120 // Assignment operator
122 TNamed::operator=(qa);
125 fQA = new ULong_t[fNdet];
126 memcpy(fQA, qa.fQA, sizeof(ULong_t)*fNdet);
133 //_______________________________________________________________
134 AliQA::AliQA(const DETECTORINDEX_t det) :
135 TNamed("QA", "Quality Assurance status"),
137 fQA(new ULong_t[fNdet]),
141 // constructor to be used
142 if (! CheckRange(det) ) {
147 for (index = 0; index < fNdet; index++)
151 //_______________________________________________________________
152 AliQA::AliQA(const ALITASK_t tsk) :
153 TNamed("QA", "Quality Assurance status"),
155 fQA(new ULong_t[fNdet]),
159 // constructor to be used in the AliRoot module (SIM, REC, ESD or ANA)
160 if (! CheckRange(tsk) ) {
165 for (index = 0; index < fNdet; index++)
169 //____________________________________________________________________________
176 //_______________________________________________________________
179 // close the open files
181 if (fgQADataFile->IsOpen())
182 fgQADataFile->Close() ;
184 if (fgQAResultFile->IsOpen())
185 fgQAResultFile->Close() ;
187 if (fgQARefFile->IsOpen())
188 fgQARefFile->Close() ;
191 //_______________________________________________________________
192 Bool_t AliQA::CheckFatal() const
194 // check if any FATAL status is set
197 for (index = 0; index < kNDET ; index++)
198 rv = rv || IsSet(DETECTORINDEX_t(index), fTask, kFATAL) ;
202 //_______________________________________________________________
203 Bool_t AliQA::CheckRange(DETECTORINDEX_t det) const
205 // check if detector is in given detector range: 0-kNDET
207 Bool_t rv = ( det < 0 || det > kNDET ) ? kFALSE : kTRUE ;
209 AliFatal(Form("Detector index %d is out of range: 0 <= index <= %d", det, kNDET)) ;
213 //_______________________________________________________________
214 Bool_t AliQA::CheckRange(ALITASK_t task) const
216 // check if task is given taskk range: 0:kNTASK
217 Bool_t rv = ( task < kRAW || task > kNTASK ) ? kFALSE : kTRUE ;
219 AliFatal(Form("Module index %d is out of range: 0 <= index <= %d", task, kNTASK)) ;
223 //_______________________________________________________________
224 Bool_t AliQA::CheckRange(QABIT_t bit) const
226 // check if bit is in given bit range: 0-kNBit
228 Bool_t rv = ( bit < 0 || bit > kNBIT ) ? kFALSE : kTRUE ;
230 AliFatal(Form("Status bit %d is out of range: 0 <= bit <= %d", bit, kNBIT)) ;
236 //_______________________________________________________________
237 char * AliQA::GetAliTaskName(ALITASK_t tsk)
239 // returns the char name corresponding to module index
263 return Form("%s", tskName.Data()) ;
266 //_______________________________________________________________
267 char * AliQA::GetBitName(QABIT_t bit) const
269 // returns the char name corresponding to bit
278 bitName = "WARNING" ;
290 return Form("%s", bitName.Data()) ;
293 //_______________________________________________________________
294 AliQA::DETECTORINDEX_t AliQA::GetDetIndex(const char * name)
296 // returns the detector index corresponding to a given name
297 TString sname(name) ;
298 DETECTORINDEX_t rv = kNULLDET ;
299 for (Int_t det = 0; det < kNDET ; det++) {
300 if ( GetDetName(det) == sname ) {
301 rv = DETECTORINDEX_t(det) ;
308 //_______________________________________________________________
309 const char * AliQA::GetDetName(Int_t det)
311 // returns the detector name corresponding to a given index (needed in a loop)
313 if ( det >= 0 && det < kNDET)
314 return (fgDetNames[det]).Data() ;
319 //_______________________________________________________________
320 TFile * AliQA::GetQADataFile(const char * name, const Int_t run)
322 // opens the file to store the detectors Quality Assurance Data Maker results
323 const char * temp = Form("%s.%s.%d.root", name, fgQADataFileName.Data(), run) ;
325 if (! fgQADataFile ) {
326 if (gSystem->AccessPathName(temp))
330 fgQADataFile = TFile::Open(temp, opt.Data()) ;
332 if ( strcmp(temp, fgQADataFile->GetName()) != 0 ) {
333 fgQADataFile = dynamic_cast<TFile *>(gROOT->FindObject(temp)) ;
334 if ( !fgQADataFile ) {
335 if (gSystem->AccessPathName(temp))
339 fgQADataFile = TFile::Open(temp, opt.Data()) ;
343 return fgQADataFile ;
346 //_____________________________________________________________________________
347 TFile * AliQA::GetQADataFile(const char * fileName)
349 // Open if necessary the Data file and return its pointer
353 fileName = AliQA::GetQADataFileName() ;
354 if (!gSystem->AccessPathName(fileName)) {
355 fgQADataFile = TFile::Open(fileName) ;
357 AliFatalClass(Form("File %s not found", fileName)) ;
359 return fgQADataFile ;
362 //_______________________________________________________________
363 TFile * AliQA::GetQAResultFile()
365 // opens the file to store the Quality Assurance Data Checker results
367 fgQAResultFile->Close() ;
368 fgQAResultFile = 0x0 ;
369 // if (!fgQAResultFile) {
370 TString dirName(fgQAResultDirName) ;
371 if ( dirName.Contains(fgkLabLocalFile))
372 dirName.ReplaceAll(fgkLabLocalFile, "") ;
373 TString fileName(dirName + fgQAResultFileName) ;
375 if ( !gSystem->AccessPathName(fileName) )
378 if ( gSystem->AccessPathName(dirName) )
379 gSystem->mkdir(dirName) ;
382 fgQAResultFile = TFile::Open(fileName, opt) ;
385 return fgQAResultFile ;
388 //_______________________________________________________________
389 const TString AliQA::GetRunTypeName(RUNTYPE_t rt)
391 // returns the name of a run type
392 TString rv("Invalid Run Type") ;
393 if ( rt == kNULLTYPE ) {
394 rv = "Known RUN_TYPE are: \n" ;
395 for (Int_t index = 0 ; index < kNTYPE; index++) {
396 rv += Form("%2d -- %s\n", index, fgRTNames[index].Data()) ;
398 AliErrorClass(Form("%s", rv.Data())) ;
402 if ( rt > kNULLTYPE && rt < kNTYPE )
408 //_______________________________________________________________
409 AliQA::TASKINDEX_t AliQA::GetTaskIndex(const char * name)
411 // returns the detector index corresponding to a given name
412 TString sname(name) ;
413 TASKINDEX_t rv = kNULLTASKINDEX ;
414 for (Int_t tsk = 0; tsk < kNTASKINDEX ; tsk++) {
415 if ( GetTaskName(tsk) == sname ) {
416 rv = TASKINDEX_t(tsk) ;
423 //_______________________________________________________________
424 Bool_t AliQA::IsSet(DETECTORINDEX_t det, ALITASK_t tsk, QABIT_t bit) const
426 // Checks is the requested bit is set
432 ULong_t offset = Offset(tsk) ;
433 ULong_t status = GetStatus(det) ;
435 status = (status & 1 << offset) != 0 ;
439 //_______________________________________________________________
440 Bool_t AliQA::IsSetAny(DETECTORINDEX_t det, ALITASK_t tsk) const
442 // Checks is the requested bit is set
447 ULong_t offset = Offset(tsk) ;
448 ULong_t status = GetStatus(det) ;
450 for ( Int_t bit = 0 ; bit < kNBIT ; bit++) {
452 st += (status & 1 << offset) != 0 ;
459 //_______________________________________________________________
460 Bool_t AliQA::IsSetAny(DETECTORINDEX_t det) const
462 // Checks is the requested bit is set
466 ULong_t status = GetStatus(det) ;
468 for ( Int_t tsk = 0 ; tsk < kNTASK ; tsk++) {
469 ULong_t offset = Offset(ALITASK_t(tsk)) ;
470 for ( Int_t bit = 0 ; bit < kNBIT ; bit++) {
472 st += (status & 1 << offset) != 0 ;
481 //_______________________________________________________________
482 AliQA * AliQA::Instance()
484 // Get an instance of the singleton.
485 // Object must have been instantiated with Instance(ALITASK) first
490 //_______________________________________________________________
491 AliQA * AliQA::Instance(const DETECTORINDEX_t det)
493 // Get an instance of the singleton. The only authorized way to call the ctor
496 TFile * f = GetQAResultFile() ;
497 fgQA = dynamic_cast<AliQA *>(f->Get("QA")) ;
499 fgQA = new AliQA(det) ;
505 //_______________________________________________________________
506 AliQA * AliQA::Instance(const ALITASK_t tsk)
508 // get an instance of the singleton.
515 fgQA = new AliQA(tsk) ;
518 fgQA = new AliQA(tsk) ;
521 AliInfoClass("fgQA = gAlice->GetQA()") ;
524 AliInfoClass("fgQA = dynamic_cast<AliQA *> (esdFile->Get(\"QA\")") ;
527 AliInfoClass("fgQA = dynamic_cast<AliQA *> (esdFile->Get(\"QA\")") ;
537 //_______________________________________________________________
538 AliQA * AliQA::Instance(const TASKINDEX_t tsk)
540 // get an instance of the singleton.
542 ALITASK_t index = kNULLTASK ;
546 else if (tsk < kDIGITS)
548 else if (tsk < kRECPARTICLES)
550 else if (tsk == kESDS)
553 return Instance(index) ;
556 //_______________________________________________________________
557 Long64_t AliQA::Merge(const TCollection * list) {
558 // Merge the QA resuls in the list into this single AliQA object
561 for (Int_t det = 0 ; det < kNDET ; det++) {
562 Set(DETECTORINDEX_t(det)) ;
563 for (Int_t task = 0 ; task < kNTASK ; task++) {
564 Set(ALITASK_t(task)) ;
565 for (Int_t bit = 0 ; bit < kNBIT ; bit++) {
568 while ( (qa = (AliQA*)next() ) ) {
570 qa->IsSet(DETECTORINDEX_t(det), ALITASK_t(task), QABIT_t(bit)) ;
579 //_______________________________________________________________
580 ULong_t AliQA::Offset(ALITASK_t tsk) const
582 // Calculates the bit offset for a given module (SIM, REC, ESD, ANA)
612 //_______________________________________________________________
613 void AliQA::Set(QABIT_t bit)
615 // Set the status bit of the current detector in the current module
617 SetStatusBit(fDet, fTask, bit) ;
620 //_____________________________________________________________________________
621 void AliQA::SetQARefStorage(const char * name)
623 // Set the root directory where the QA reference data are stored
625 fgQARefDirName = name ;
626 if ( fgQARefDirName.Contains(fgkLabLocalFile) )
627 fgQARefFileName = fgkRefFileName ;
628 else if ( fgQARefDirName.Contains(fgkLabLocalOCDB) )
629 fgQARefFileName = fgkQAName ;
630 else if ( fgQARefDirName.Contains(fgkLabAliEnOCDB) )
631 fgQARefFileName = fgkQAName ;
634 AliErrorClass(Form("%s is an invalid storage definition\n", name)) ;
635 fgQARefDirName = "" ;
636 fgQARefFileName = "" ;
638 TString tmp(fgQARefDirName) ; // + fgQARefFileName) ;
639 AliInfoClass(Form("AliQA::SetQARefDir: QA references are in %s\n", tmp.Data()) ) ;
642 //_____________________________________________________________________________
643 void AliQA::SetQARefDataDirName(const char * name)
645 // Set the lower level directory name where reference data are found
647 RUNTYPE_t rt = kNULLTYPE ;
648 for (Int_t index = 0; index < kNTYPE; index++) {
649 if (test.CompareTo(fgRTNames[index]) == 0) {
650 rt = (RUNTYPE_t) index ;
655 if (rt == kNULLTYPE) {
656 AliWarningClass(Form("AliQA::SetQARefDataDirName: %s is an unknown RUN TYPE name\n", name)) ;
660 SetQARefDataDirName(rt) ;
663 //_____________________________________________________________________________
664 void AliQA::SetQAResultDirName(const char * name)
666 // Set the root directory where to store the QA status object
668 fgQAResultDirName.Prepend(name) ;
669 AliInfoClass(Form("AliQA::SetQAResultDirName: QA results are in %s\n", fgQAResultDirName.Data())) ;
670 if ( fgQAResultDirName.Contains(fgkLabLocalFile))
671 fgQAResultDirName.ReplaceAll(fgkLabLocalFile, "") ;
672 fgQAResultFileName.Prepend(fgQAResultDirName) ;
675 //_______________________________________________________________
676 void AliQA::SetStatusBit(DETECTORINDEX_t det, ALITASK_t tsk, QABIT_t bit)
678 // Set the status bit for a given detector and a given task
684 ULong_t offset = Offset(tsk) ;
685 ULong_t status = GetStatus(det) ;
687 status = status | 1 << offset ;
688 SetStatus(det, status) ;
691 //_______________________________________________________________
692 void AliQA::ShowAll() const
694 // dispplay the QA status word
696 for (index = 0 ; index < kNDET ; index++) {
697 for (Int_t tsk = kRAW ; tsk < kNTASK ; tsk++) {
698 ShowStatus(DETECTORINDEX_t(index), ALITASK_t(tsk)) ;
703 //_______________________________________________________________
704 void AliQA::ShowStatus(DETECTORINDEX_t det, ALITASK_t tsk) const
706 // Prints the full QA status of a given detector
708 ULong_t status = GetStatus(det) ;
709 ULong_t tskStatus[kNTASK] ;
710 tskStatus[kRAW] = status & 0x0000f ;
711 tskStatus[kSIM] = status & 0x000f0 ;
712 tskStatus[kREC] = status & 0x00f00 ;
713 tskStatus[kESD] = status & 0x0f000 ;
714 tskStatus[kANA] = status & 0xf0000 ;
716 AliInfo(Form("====> QA Status for %8s raw =0x%lx, sim=0x%lx, rec=0x%lx, esd=0x%lx, ana=0x%lx", GetDetName(det).Data(),
717 tskStatus[kRAW], tskStatus[kSIM], tskStatus[kREC], tskStatus[kESD], tskStatus[kANA] )) ;
718 if (tsk == kNULLTASK) {
719 for (Int_t itsk = kRAW ; itsk < kNTASK ; itsk++) {
720 ShowASCIIStatus(det, ALITASK_t(itsk), tskStatus[itsk]) ;
723 ShowASCIIStatus(det, tsk, tskStatus[tsk]) ;
727 //_______________________________________________________________
728 void AliQA::ShowASCIIStatus(DETECTORINDEX_t det, ALITASK_t tsk, const ULong_t status) const
730 // print the QA status in human readable format
732 for (Int_t bit = kINFO ; bit < kNBIT ; bit++) {
733 if (IsSet(det, tsk, QABIT_t(bit))) {
734 text = GetBitName(QABIT_t(bit)) ;
739 AliWarningClass(Form(" %8s %4s 0x%4lx, Problem signalled: %8s \n", GetDetName(det).Data(), GetAliTaskName(tsk), status, text.Data())) ;
742 //_______________________________________________________________
743 void AliQA::UnSet(QABIT_t bit)
745 // UnSet the status bit of the current detector in the current module
747 UnSetStatusBit(fDet, fTask, bit) ;
750 //_______________________________________________________________
751 void AliQA::UnSetStatusBit(DETECTORINDEX_t det, ALITASK_t tsk, QABIT_t bit)
753 // UnSet the status bit for a given detector and a given task
759 ULong_t offset = Offset(tsk) ;
760 ULong_t status = GetStatus(det) ;
762 status = status & 0 << offset ;
763 SetStatus(det, status) ;