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 for (Int_t index = 0 ; index < fNdet ; index++)
114 fQA[index] = qa.fQA[index] ;
117 //_____________________________________________________________________________
118 AliQA& AliQA::operator = (const AliQA& qa)
120 // assignment operator
127 //_______________________________________________________________
128 AliQA::AliQA(const DETECTORINDEX_t det) :
129 TNamed("QA", "Quality Assurance status"),
131 fQA(new ULong_t[fNdet]),
135 // constructor to be used
136 if (! CheckRange(det) ) {
141 for (index = 0; index < fNdet; index++)
145 //_______________________________________________________________
146 AliQA::AliQA(const ALITASK_t tsk) :
147 TNamed("QA", "Quality Assurance status"),
149 fQA(new ULong_t[fNdet]),
153 // constructor to be used in the AliRoot module (SIM, REC, ESD or ANA)
154 if (! CheckRange(tsk) ) {
159 for (index = 0; index < fNdet; index++)
163 //____________________________________________________________________________
170 //_______________________________________________________________
173 // close the open files
175 if (fgQADataFile->IsOpen())
176 fgQADataFile->Close() ;
178 if (fgQAResultFile->IsOpen())
179 fgQAResultFile->Close() ;
181 if (fgQARefFile->IsOpen())
182 fgQARefFile->Close() ;
185 //_______________________________________________________________
186 Bool_t AliQA::CheckFatal() const
188 // check if any FATAL status is set
191 for (index = 0; index < kNDET ; index++)
192 rv = rv || IsSet(DETECTORINDEX_t(index), fTask, kFATAL) ;
196 //_______________________________________________________________
197 Bool_t AliQA::CheckRange(DETECTORINDEX_t det) const
199 // check if detector is in given detector range: 0-kNDET
201 Bool_t rv = ( det < 0 || det > kNDET ) ? kFALSE : kTRUE ;
203 AliFatal(Form("Detector index %d is out of range: 0 <= index <= %d", det, kNDET)) ;
207 //_______________________________________________________________
208 Bool_t AliQA::CheckRange(ALITASK_t task) const
210 // check if task is given taskk range: 0:kNTASK
211 Bool_t rv = ( task < kRAW || task > kNTASK ) ? kFALSE : kTRUE ;
213 AliFatal(Form("Module index %d is out of range: 0 <= index <= %d", task, kNTASK)) ;
217 //_______________________________________________________________
218 Bool_t AliQA::CheckRange(QABIT_t bit) const
220 // check if bit is in given bit range: 0-kNBit
222 Bool_t rv = ( bit < 0 || bit > kNBIT ) ? kFALSE : kTRUE ;
224 AliFatal(Form("Status bit %d is out of range: 0 <= bit <= %d", bit, kNBIT)) ;
230 //_______________________________________________________________
231 char * AliQA::GetAliTaskName(ALITASK_t tsk)
233 // returns the char name corresponding to module index
257 return Form("%s", tskName.Data()) ;
260 //_______________________________________________________________
261 char * AliQA::GetBitName(QABIT_t bit) const
263 // returns the char name corresponding to bit
272 bitName = "WARNING" ;
284 return Form("%s", bitName.Data()) ;
287 //_______________________________________________________________
288 AliQA::DETECTORINDEX_t AliQA::GetDetIndex(const char * name)
290 // returns the detector index corresponding to a given name
291 TString sname(name) ;
292 DETECTORINDEX_t rv = kNULLDET ;
293 for (Int_t det = 0; det < kNDET ; det++) {
294 if ( GetDetName(det) == sname ) {
295 rv = DETECTORINDEX_t(det) ;
302 //_______________________________________________________________
303 const char * AliQA::GetDetName(Int_t det)
305 // returns the detector name corresponding to a given index (needed in a loop)
307 if ( det >= 0 && det < kNDET)
308 return (fgDetNames[det]).Data() ;
313 //_______________________________________________________________
314 TFile * AliQA::GetQADataFile(const char * name, const Int_t run)
316 // opens the file to store the detectors Quality Assurance Data Maker results
317 const char * temp = Form("%s.%s.%d.root", name, fgQADataFileName.Data(), run) ;
319 if (! fgQADataFile ) {
320 if (gSystem->AccessPathName(temp))
324 fgQADataFile = TFile::Open(temp, opt.Data()) ;
326 if ( strcmp(temp, fgQADataFile->GetName()) != 0 ) {
327 fgQADataFile = dynamic_cast<TFile *>(gROOT->FindObject(temp)) ;
328 if ( !fgQADataFile ) {
329 if (gSystem->AccessPathName(temp))
333 fgQADataFile = TFile::Open(temp, opt.Data()) ;
337 return fgQADataFile ;
340 //_____________________________________________________________________________
341 TFile * AliQA::GetQADataFile(const char * fileName)
343 // Open if necessary the Data file and return its pointer
347 fileName = AliQA::GetQADataFileName() ;
348 if (!gSystem->AccessPathName(fileName)) {
349 fgQADataFile = TFile::Open(fileName) ;
351 AliFatalClass(Form("File %s not found", fileName)) ;
353 return fgQADataFile ;
356 //_______________________________________________________________
357 TFile * AliQA::GetQAResultFile()
359 // opens the file to store the Quality Assurance Data Checker results
361 fgQAResultFile->Close() ;
362 fgQAResultFile = 0x0 ;
363 // if (!fgQAResultFile) {
364 TString dirName(fgQAResultDirName) ;
365 if ( dirName.Contains(fgkLabLocalFile))
366 dirName.ReplaceAll(fgkLabLocalFile, "") ;
367 TString fileName(dirName + fgQAResultFileName) ;
369 if ( !gSystem->AccessPathName(fileName) )
372 if ( gSystem->AccessPathName(dirName) )
373 gSystem->mkdir(dirName) ;
376 fgQAResultFile = TFile::Open(fileName, opt) ;
379 return fgQAResultFile ;
382 //_______________________________________________________________
383 const TString AliQA::GetRunTypeName(RUNTYPE_t rt)
385 // returns the name of a run type
386 TString rv("Invalid Run Type") ;
387 if ( rt == kNULLTYPE ) {
388 rv = "Known RUN_TYPE are: \n" ;
389 for (Int_t index = 0 ; index < kNTYPE; index++) {
390 rv += Form("%2d -- %s\n", index, fgRTNames[index].Data()) ;
392 AliErrorClass(Form("%s", rv.Data())) ;
396 if ( rt > kNULLTYPE && rt < kNTYPE )
402 //_______________________________________________________________
403 AliQA::TASKINDEX_t AliQA::GetTaskIndex(const char * name)
405 // returns the detector index corresponding to a given name
406 TString sname(name) ;
407 TASKINDEX_t rv = kNULLTASKINDEX ;
408 for (Int_t tsk = 0; tsk < kNTASKINDEX ; tsk++) {
409 if ( GetTaskName(tsk) == sname ) {
410 rv = TASKINDEX_t(tsk) ;
417 //_______________________________________________________________
418 Bool_t AliQA::IsSet(DETECTORINDEX_t det, ALITASK_t tsk, QABIT_t bit) const
420 // Checks is the requested bit is set
426 ULong_t offset = Offset(tsk) ;
427 ULong_t status = GetStatus(det) ;
429 status = (status & 1 << offset) != 0 ;
433 //_______________________________________________________________
434 Bool_t AliQA::IsSetAny(DETECTORINDEX_t det, ALITASK_t tsk) const
436 // Checks is the requested bit is set
441 ULong_t offset = Offset(tsk) ;
442 ULong_t status = GetStatus(det) ;
444 for ( Int_t bit = 0 ; bit < kNBIT ; bit++) {
446 st += (status & 1 << offset) != 0 ;
453 //_______________________________________________________________
454 Bool_t AliQA::IsSetAny(DETECTORINDEX_t det) const
456 // Checks is the requested bit is set
460 ULong_t status = GetStatus(det) ;
462 for ( Int_t tsk = 0 ; tsk < kNTASK ; tsk++) {
463 ULong_t offset = Offset(ALITASK_t(tsk)) ;
464 for ( Int_t bit = 0 ; bit < kNBIT ; bit++) {
466 st += (status & 1 << offset) != 0 ;
475 //_______________________________________________________________
476 AliQA * AliQA::Instance()
478 // Get an instance of the singleton.
479 // Object must have been instantiated with Instance(ALITASK) first
484 //_______________________________________________________________
485 AliQA * AliQA::Instance(const DETECTORINDEX_t det)
487 // Get an instance of the singleton. The only authorized way to call the ctor
490 TFile * f = GetQAResultFile() ;
491 fgQA = dynamic_cast<AliQA *>(f->Get("QA")) ;
493 fgQA = new AliQA(det) ;
499 //_______________________________________________________________
500 AliQA * AliQA::Instance(const ALITASK_t tsk)
502 // get an instance of the singleton.
509 fgQA = new AliQA(tsk) ;
512 fgQA = new AliQA(tsk) ;
515 AliInfoClass("fgQA = gAlice->GetQA()") ;
518 AliInfoClass("fgQA = dynamic_cast<AliQA *> (esdFile->Get(\"QA\")") ;
521 AliInfoClass("fgQA = dynamic_cast<AliQA *> (esdFile->Get(\"QA\")") ;
531 //_______________________________________________________________
532 AliQA * AliQA::Instance(const TASKINDEX_t tsk)
534 // get an instance of the singleton.
536 ALITASK_t index = kNULLTASK ;
540 else if (tsk < kDIGITS)
542 else if (tsk < kRECPARTICLES)
544 else if (tsk == kESDS)
547 return Instance(index) ;
550 //_______________________________________________________________
551 Long64_t AliQA::Merge(TCollection * list) {
552 // Merge the QA resuls in the list into this single AliQA object
555 for (Int_t det = 0 ; det < kNDET ; det++) {
556 Set(DETECTORINDEX_t(det)) ;
557 for (Int_t task = 0 ; task < kNTASK ; task++) {
558 Set(ALITASK_t(task)) ;
559 for (Int_t bit = 0 ; bit < kNBIT ; bit++) {
562 while ( (qa = (AliQA*)next() ) ) {
564 qa->IsSet(DETECTORINDEX_t(det), ALITASK_t(task), QABIT_t(bit)) ;
573 //_______________________________________________________________
574 ULong_t AliQA::Offset(ALITASK_t tsk) const
576 // Calculates the bit offset for a given module (SIM, REC, ESD, ANA)
606 //_______________________________________________________________
607 void AliQA::Set(QABIT_t bit)
609 // Set the status bit of the current detector in the current module
611 SetStatusBit(fDet, fTask, bit) ;
614 //_____________________________________________________________________________
615 void AliQA::SetQARefStorage(const char * name)
617 // Set the root directory where the QA reference data are stored
619 fgQARefDirName = name ;
620 if ( fgQARefDirName.Contains(fgkLabLocalFile) )
621 fgQARefFileName = fgkRefFileName ;
622 else if ( fgQARefDirName.Contains(fgkLabLocalOCDB) )
623 fgQARefFileName = fgkQAName ;
624 else if ( fgQARefDirName.Contains(fgkLabAliEnOCDB) )
625 fgQARefFileName = fgkQAName ;
628 AliErrorClass(Form("%s is an invalid storage definition\n", name)) ;
629 fgQARefDirName = "" ;
630 fgQARefFileName = "" ;
632 TString tmp(fgQARefDirName) ; // + fgQARefFileName) ;
633 AliInfoClass(Form("AliQA::SetQARefDir: QA references are in %s\n", tmp.Data()) ) ;
636 //_____________________________________________________________________________
637 void AliQA::SetQARefDataDirName(const char * name)
639 // Set the lower level directory name where reference data are found
641 RUNTYPE_t rt = kNULLTYPE ;
642 for (Int_t index = 0; index < kNTYPE; index++) {
643 if (test.CompareTo(fgRTNames[index]) == 0) {
644 rt = (RUNTYPE_t) index ;
649 if (rt == kNULLTYPE) {
650 AliWarningClass(Form("AliQA::SetQARefDataDirName: %s is an unknown RUN TYPE name\n", name)) ;
654 SetQARefDataDirName(rt) ;
657 //_____________________________________________________________________________
658 void AliQA::SetQAResultDirName(const char * name)
660 // Set the root directory where to store the QA status object
662 fgQAResultDirName.Prepend(name) ;
663 AliInfoClass(Form("AliQA::SetQAResultDirName: QA results are in %s\n", fgQAResultDirName.Data())) ;
664 if ( fgQAResultDirName.Contains(fgkLabLocalFile))
665 fgQAResultDirName.ReplaceAll(fgkLabLocalFile, "") ;
666 fgQAResultFileName.Prepend(fgQAResultDirName) ;
669 //_______________________________________________________________
670 void AliQA::SetStatusBit(DETECTORINDEX_t det, ALITASK_t tsk, QABIT_t bit)
672 // Set the status bit for a given detector and a given task
678 ULong_t offset = Offset(tsk) ;
679 ULong_t status = GetStatus(det) ;
681 status = status | 1 << offset ;
682 SetStatus(det, status) ;
685 //_______________________________________________________________
686 void AliQA::ShowAll() const
688 // dispplay the QA status word
690 for (index = 0 ; index < kNDET ; index++) {
691 for (Int_t tsk = kRAW ; tsk < kNTASK ; tsk++) {
692 ShowStatus(DETECTORINDEX_t(index), ALITASK_t(tsk)) ;
697 //_______________________________________________________________
698 void AliQA::ShowStatus(DETECTORINDEX_t det, ALITASK_t tsk) const
700 // Prints the full QA status of a given detector
702 ULong_t status = GetStatus(det) ;
703 ULong_t tskStatus[kNTASK] ;
704 tskStatus[kRAW] = status & 0x0000f ;
705 tskStatus[kSIM] = status & 0x000f0 ;
706 tskStatus[kREC] = status & 0x00f00 ;
707 tskStatus[kESD] = status & 0x0f000 ;
708 tskStatus[kANA] = status & 0xf0000 ;
710 AliInfo(Form("====> QA Status for %8s raw =0x%lx, sim=0x%lx, rec=0x%lx, esd=0x%lx, ana=0x%lx", GetDetName(det).Data(),
711 tskStatus[kRAW], tskStatus[kSIM], tskStatus[kREC], tskStatus[kESD], tskStatus[kANA] )) ;
712 if (tsk == kNULLTASK) {
713 for (Int_t itsk = kRAW ; itsk < kNTASK ; itsk++) {
714 ShowASCIIStatus(det, ALITASK_t(itsk), tskStatus[itsk]) ;
717 ShowASCIIStatus(det, tsk, tskStatus[tsk]) ;
721 //_______________________________________________________________
722 void AliQA::ShowASCIIStatus(DETECTORINDEX_t det, ALITASK_t tsk, const ULong_t status) const
724 // print the QA status in human readable format
726 for (Int_t bit = kINFO ; bit < kNBIT ; bit++) {
727 if (IsSet(det, tsk, QABIT_t(bit))) {
728 text = GetBitName(QABIT_t(bit)) ;
733 AliWarningClass(Form(" %8s %4s 0x%4lx, Problem signalled: %8s \n", GetDetName(det).Data(), GetAliTaskName(tsk), status, text.Data())) ;
736 //_______________________________________________________________
737 void AliQA::UnSet(QABIT_t bit)
739 // UnSet the status bit of the current detector in the current module
741 UnSetStatusBit(fDet, fTask, bit) ;
744 //_______________________________________________________________
745 void AliQA::UnSetStatusBit(DETECTORINDEX_t det, ALITASK_t tsk, QABIT_t bit)
747 // UnSet the status bit for a given detector and a given task
753 ULong_t offset = Offset(tsk) ;
754 ULong_t status = GetStatus(det) ;
756 status = status & 0 << offset ;
757 SetStatus(det, status) ;