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", "CORR"} ;
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::fkgQACorrNtName = "CorrQA" ;
76 const TString AliQA::fkgRefOCDBDirName = "Ref" ;
77 TString AliQA::fkgRefDataDirName = "" ;
78 const TString AliQA::fkgQARefOCDBDefault = "alien://folder=/alice/QA/20" ;
79 const TString AliQA::fkgExpert = "Expert" ;
80 const UInt_t AliQA::fkgExpertBit = 16 ;
81 const UInt_t AliQA::fkgQABit = 17 ;
83 //____________________________________________________________________________
87 fQA(new ULong_t[fNdet]),
92 // default constructor
93 // beware singleton: not to be used
95 for (Int_t index = 0 ; index < fNdet ; index++)
99 //____________________________________________________________________________
100 AliQA::AliQA(const AliQA& qa) :
110 //_____________________________________________________________________________
111 AliQA& AliQA::operator = (const AliQA& qa)
113 // assignment operator
114 if(&qa == this) return *this;
117 for (Int_t index = 0 ; index < fNdet ; index++)
118 fQA[index] = qa.fQA[index];
122 //_______________________________________________________________
123 AliQA::AliQA(const DETECTORINDEX_t det) :
124 TNamed("QA", "Quality Assurance status"),
126 fQA(new ULong_t[fNdet]),
130 // constructor to be used
131 if (! CheckRange(det) ) {
136 for (index = 0; index < fNdet; index++)
140 //_______________________________________________________________
141 AliQA::AliQA(const ALITASK_t tsk) :
142 TNamed("QA", "Quality Assurance status"),
144 fQA(new ULong_t[fNdet]),
148 // constructor to be used in the AliRoot module (SIM, REC, ESD or ANA)
149 if (! CheckRange(tsk) ) {
154 for (index = 0; index < fNdet; index++)
158 //____________________________________________________________________________
165 //_______________________________________________________________
168 // close the open files
170 if (fgQADataFile->IsOpen())
171 fgQADataFile->Close() ;
173 if (fgQAResultFile->IsOpen())
174 fgQAResultFile->Close() ;
176 if (fgQARefFile->IsOpen())
177 fgQARefFile->Close() ;
180 //_______________________________________________________________
181 const Bool_t AliQA::CheckFatal() const
183 // check if any FATAL status is set
186 for (index = 0; index < kNDET ; index++)
187 rv = rv || IsSet(DETECTORINDEX_t(index), fTask, kFATAL) ;
191 //_______________________________________________________________
192 const Bool_t AliQA::CheckRange(DETECTORINDEX_t det) const
194 // check if detector is in given detector range: 0-kNDET
196 Bool_t rv = ( det < 0 || det > kNDET ) ? kFALSE : kTRUE ;
198 AliFatal(Form("Detector index %d is out of range: 0 <= index <= %d", det, kNDET)) ;
202 //_______________________________________________________________
203 const Bool_t AliQA::CheckRange(ALITASK_t task) const
205 // check if task is given taskk range: 0:kNTASK
206 Bool_t rv = ( task < kRAW || task > kNTASK ) ? kFALSE : kTRUE ;
208 AliFatal(Form("Module index %d is out of range: 0 <= index <= %d", task, kNTASK)) ;
212 //_______________________________________________________________
213 const Bool_t AliQA::CheckRange(QABIT_t bit) const
215 // check if bit is in given bit range: 0-kNBit
217 Bool_t rv = ( bit < 0 || bit > kNBIT ) ? kFALSE : kTRUE ;
219 AliFatal(Form("Status bit %d is out of range: 0 <= bit <= %d", bit, kNBIT)) ;
225 //_______________________________________________________________
226 const char * AliQA::GetAliTaskName(ALITASK_t tsk)
228 // returns the char name corresponding to module index
252 return tskName.Data() ;
255 //_______________________________________________________________
256 const char * AliQA::GetBitName(QABIT_t bit) const
258 // returns the char name corresponding to bit
267 bitName = "WARNING" ;
279 return bitName.Data() ;
282 //_______________________________________________________________
283 const AliQA::DETECTORINDEX_t AliQA::GetDetIndex(const char * name)
285 // returns the detector index corresponding to a given name
286 TString sname(name) ;
287 DETECTORINDEX_t rv = kNULLDET ;
288 for (Int_t det = 0; det < kNDET ; det++) {
289 if ( GetDetName(det) == sname ) {
290 rv = DETECTORINDEX_t(det) ;
297 //_______________________________________________________________
298 const char * AliQA::GetDetName(Int_t det)
300 // returns the detector name corresponding to a given index (needed in a loop)
302 if ( det >= 0 && det < kNDET)
303 return (fgDetNames[det]).Data() ;
308 //_______________________________________________________________
309 TFile * AliQA::GetQADataFile(const char * name, const Int_t run)
311 // opens the file to store the detectors Quality Assurance Data Maker results
312 const char * temp = Form("%s.%s.%d.root", name, fgQADataFileName.Data(), run) ;
314 if (! fgQADataFile ) {
315 if (gSystem->AccessPathName(temp))
319 fgQADataFile = TFile::Open(temp, opt.Data()) ;
321 if ( strcmp(temp, fgQADataFile->GetName()) != 0 ) {
322 fgQADataFile = dynamic_cast<TFile *>(gROOT->FindObject(temp)) ;
323 if ( !fgQADataFile ) {
324 if (gSystem->AccessPathName(temp))
328 fgQADataFile = TFile::Open(temp, opt.Data()) ;
332 return fgQADataFile ;
335 //_____________________________________________________________________________
336 TFile * AliQA::GetQADataFile(const char * fileName)
338 // Open if necessary the Data file and return its pointer
342 fileName = AliQA::GetQADataFileName() ;
343 if (!gSystem->AccessPathName(fileName)) {
344 fgQADataFile = TFile::Open(fileName) ;
346 printf("File %s not found", fileName) ;
349 return fgQADataFile ;
352 //_______________________________________________________________
353 TFile * AliQA::GetQAResultFile()
355 // opens the file to store the Quality Assurance Data Checker results
357 fgQAResultFile->Close() ;
358 fgQAResultFile = 0x0 ;
359 // if (!fgQAResultFile) {
360 TString dirName(fgQAResultDirName) ;
361 if ( dirName.Contains(fkgLabLocalFile))
362 dirName.ReplaceAll(fkgLabLocalFile, "") ;
363 TString fileName(dirName + fgQAResultFileName) ;
365 if ( !gSystem->AccessPathName(fileName) )
368 if ( gSystem->AccessPathName(dirName) )
369 gSystem->mkdir(dirName) ;
372 fgQAResultFile = TFile::Open(fileName, opt) ;
375 return fgQAResultFile ;
378 //_______________________________________________________________
379 const TString AliQA::GetRunTypeName(RUNTYPE_t rt)
381 TString rv("Invalid Run Type") ;
382 if ( rt == kNULLTYPE ) {
383 rv = "Known RUN_TYPE are: \n" ;
384 for (Int_t index = 0 ; index < kNTYPE; index++) {
385 rv += Form("%2d -- %s\n", index, fgRTNames[index].Data()) ;
387 printf("%s", rv.Data()) ;
391 if ( rt > kNULLTYPE && rt < kNTYPE )
397 //_______________________________________________________________
398 const AliQA::TASKINDEX_t AliQA::GetTaskIndex(const char * name)
400 // returns the detector index corresponding to a given name
401 TString sname(name) ;
402 TASKINDEX_t rv = kNULLTASKINDEX ;
403 for (Int_t tsk = 0; tsk < kNTASKINDEX ; tsk++) {
404 if ( GetTaskName(tsk) == sname ) {
405 rv = TASKINDEX_t(tsk) ;
412 //_______________________________________________________________
413 const Bool_t AliQA::IsSet(DETECTORINDEX_t det, ALITASK_t tsk, QABIT_t bit) const
415 // Checks is the requested bit is set
421 ULong_t offset = Offset(tsk) ;
422 ULong_t status = GetStatus(det) ;
424 status = (status & 1 << offset) != 0 ;
428 //_______________________________________________________________
429 const Bool_t AliQA::IsSetAny(DETECTORINDEX_t det, ALITASK_t tsk) const
431 // Checks is the requested bit is set
436 ULong_t offset = Offset(tsk) ;
437 ULong_t status = GetStatus(det) ;
439 for ( Int_t bit = 0 ; bit < kNBIT ; bit++) {
441 st += (status & 1 << offset) != 0 ;
448 //_______________________________________________________________
449 const Bool_t AliQA::IsSetAny(DETECTORINDEX_t det) const
451 // Checks is the requested bit is set
455 ULong_t status = GetStatus(det) ;
457 for ( Int_t tsk = 0 ; tsk < kNTASK ; tsk++) {
458 ULong_t offset = Offset(ALITASK_t(tsk)) ;
459 for ( Int_t bit = 0 ; bit < kNBIT ; bit++) {
461 st += (status & 1 << offset) != 0 ;
470 //_______________________________________________________________
471 AliQA * AliQA::Instance()
473 // Get an instance of the singleton.
474 // Object must have been instantiated with Instance(ALITASK) first
479 //_______________________________________________________________
480 AliQA * AliQA::Instance(const DETECTORINDEX_t det)
482 // Get an instance of the singleton. The only authorized way to call the ctor
485 TFile * f = GetQAResultFile() ;
486 fgQA = dynamic_cast<AliQA *>(f->Get("QA")) ;
488 fgQA = new AliQA(det) ;
494 //_______________________________________________________________
495 AliQA * AliQA::Instance(const ALITASK_t tsk)
497 // get an instance of the singleton.
504 fgQA = new AliQA(tsk) ;
507 fgQA = new AliQA(tsk) ;
510 printf("fgQA = gAlice->GetQA()") ;
513 printf("fgQA = dynamic_cast<AliQA *> (esdFile->Get(\"QA\")") ;
516 printf("fgQA = dynamic_cast<AliQA *> (esdFile->Get(\"QA\")") ;
526 //_______________________________________________________________
527 AliQA * AliQA::Instance(const TASKINDEX_t tsk)
529 // get an instance of the singleton.
531 ALITASK_t index = kNULLTASK ;
535 else if (tsk < kDIGITS)
537 else if (tsk < kRECPARTICLES)
539 else if (tsk == kESDS)
542 return Instance(index) ;
545 //_______________________________________________________________
546 void AliQA::Merge(TCollection * list) {
547 // Merge the QA resuls in the list into this single AliQA object
549 for (Int_t det = 0 ; det < kNDET ; det++) {
550 Set(DETECTORINDEX_t(det)) ;
551 for (Int_t task = 0 ; task < kNTASK ; task++) {
552 Set(ALITASK_t(task)) ;
553 for (Int_t bit = 0 ; bit < kNBIT ; bit++) {
556 while ( (qa = (AliQA*)next() ) ) {
557 qa->IsSet(DETECTORINDEX_t(det), ALITASK_t(task), QABIT_t(bit)) ;
565 //_______________________________________________________________
566 const ULong_t AliQA::Offset(ALITASK_t tsk) const
568 // Calculates the bit offset for a given module (SIM, REC, ESD, ANA)
598 //_______________________________________________________________
599 void AliQA::Set(QABIT_t bit)
601 // Set the status bit of the current detector in the current module
603 SetStatusBit(fDet, fTask, bit) ;
606 //_____________________________________________________________________________
607 void AliQA::SetQARefStorage(const char * name)
609 // Set the root directory where the QA reference data are stored
611 fgQARefDirName = name ;
612 if ( fgQARefDirName.Contains(fkgLabLocalFile) )
613 fgQARefFileName = fkgRefFileName ;
614 else if ( fgQARefDirName.Contains(fkgLabLocalOCDB) )
615 fgQARefFileName = fkgQAName ;
616 else if ( fgQARefDirName.Contains(fkgLabAliEnOCDB) )
617 fgQARefFileName = fkgQAName ;
620 printf("ERROR: %s is an invalid storage definition\n", name) ;
621 fgQARefDirName = "" ;
622 fgQARefFileName = "" ;
624 TString tmp(fgQARefDirName) ; // + fgQARefFileName) ;
625 printf("AliQA::SetQARefDir: QA references are in %s\n", tmp.Data() ) ;
628 //_____________________________________________________________________________
629 void AliQA::SetQARefDataDirName(const char * name)
631 // Set the lower level directory name where reference data are found
633 RUNTYPE_t rt = kNULLTYPE ;
634 for (Int_t index = 0; index < kNTYPE; index++) {
635 if (test.CompareTo(fgRTNames[index]) == 0) {
636 rt = (RUNTYPE_t) index ;
641 if (rt == kNULLTYPE) {
642 printf("AliQA::SetQARefDataDirName: %s is an unknown RUN TYPE name\n", name) ;
646 SetQARefDataDirName(rt) ;
649 //_____________________________________________________________________________
650 void AliQA::SetQAResultDirName(const char * name)
652 // Set the root directory where to store the QA status object
654 fgQAResultDirName.Prepend(name) ;
655 printf("AliQA::SetQAResultDirName: QA results are in %s\n", fgQAResultDirName.Data()) ;
656 if ( fgQAResultDirName.Contains(fkgLabLocalFile))
657 fgQAResultDirName.ReplaceAll(fkgLabLocalFile, "") ;
658 fgQAResultFileName.Prepend(fgQAResultDirName) ;
661 //_______________________________________________________________
662 void AliQA::SetStatusBit(DETECTORINDEX_t det, ALITASK_t tsk, QABIT_t bit)
664 // Set the status bit for a given detector and a given task
670 ULong_t offset = Offset(tsk) ;
671 ULong_t status = GetStatus(det) ;
673 status = status | 1 << offset ;
674 SetStatus(det, status) ;
677 //_______________________________________________________________
678 void AliQA::ShowAll() const
680 // dispplay the QA status word
682 for (index = 0 ; index < kNDET ; index++) {
683 for (Int_t tsk = kRAW ; tsk < kNTASK ; tsk++) {
684 ShowStatus(DETECTORINDEX_t(index), ALITASK_t(tsk)) ;
689 //_______________________________________________________________
690 void AliQA::ShowStatus(DETECTORINDEX_t det, ALITASK_t tsk) const
692 // Prints the full QA status of a given detector
694 ULong_t status = GetStatus(det) ;
695 ULong_t tskStatus[kNTASK] ;
696 tskStatus[kRAW] = status & 0x0000f ;
697 tskStatus[kSIM] = status & 0x000f0 ;
698 tskStatus[kREC] = status & 0x00f00 ;
699 tskStatus[kESD] = status & 0x0f000 ;
700 tskStatus[kANA] = status & 0xf0000 ;
702 AliInfo(Form("====> QA Status for %8s raw =0x%x, sim=0x%x, rec=0x%x, esd=0x%x, ana=0x%x", GetDetName(det).Data(),
703 tskStatus[kRAW], tskStatus[kSIM], tskStatus[kREC], tskStatus[kESD], tskStatus[kANA] )) ;
704 if (tsk == kNULLTASK) {
705 for (Int_t itsk = kRAW ; itsk < kNTASK ; itsk++) {
706 ShowASCIIStatus(det, ALITASK_t(itsk), tskStatus[itsk]) ;
709 ShowASCIIStatus(det, tsk, tskStatus[tsk]) ;
713 //_______________________________________________________________
714 void AliQA::ShowASCIIStatus(DETECTORINDEX_t det, ALITASK_t tsk, const ULong_t status) const
716 // print the QA status in human readable format
718 for (Int_t bit = kINFO ; bit < kNBIT ; bit++) {
719 if (IsSet(det, tsk, QABIT_t(bit))) {
720 text = GetBitName(QABIT_t(bit)) ;
725 printf(" %8s %4s 0x%4lx, Problem signalled: %8s \n", GetDetName(det).Data(), GetAliTaskName(tsk), status, text.Data()) ;
728 //_______________________________________________________________
729 void AliQA::UnSet(QABIT_t bit)
731 // UnSet the status bit of the current detector in the current module
733 UnSetStatusBit(fDet, fTask, bit) ;
736 //_______________________________________________________________
737 void AliQA::UnSetStatusBit(DETECTORINDEX_t det, ALITASK_t tsk, QABIT_t bit)
739 // UnSet the status bit for a given detector and a given task
745 ULong_t offset = Offset(tsk) ;
746 ULong_t status = GetStatus(det) ;
748 status = status & 0 << offset ;
749 SetStatus(det, status) ;