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"} ;
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 for (Int_t index = 0 ; index < fNdet ; index++)
110 fQA[index] = qa.fQA[index] ;
113 //_____________________________________________________________________________
114 AliQA& AliQA::operator = (const AliQA& qa)
116 // assignment operator
123 //_______________________________________________________________
124 AliQA::AliQA(const DETECTORINDEX_t det) :
125 TNamed("QA", "Quality Assurance status"),
127 fQA(new ULong_t[fNdet]),
131 // constructor to be used
132 if (! CheckRange(det) ) {
137 for (index = 0; index < fNdet; index++)
141 //_______________________________________________________________
142 AliQA::AliQA(const ALITASK_t tsk) :
143 TNamed("QA", "Quality Assurance status"),
145 fQA(new ULong_t[fNdet]),
149 // constructor to be used in the AliRoot module (SIM, REC, ESD or ANA)
150 if (! CheckRange(tsk) ) {
155 for (index = 0; index < fNdet; index++)
159 //____________________________________________________________________________
166 //_______________________________________________________________
169 // close the open files
171 if (fgQADataFile->IsOpen())
172 fgQADataFile->Close() ;
174 if (fgQAResultFile->IsOpen())
175 fgQAResultFile->Close() ;
177 if (fgQARefFile->IsOpen())
178 fgQARefFile->Close() ;
181 //_______________________________________________________________
182 Bool_t AliQA::CheckFatal() const
184 // check if any FATAL status is set
187 for (index = 0; index < kNDET ; index++)
188 rv = rv || IsSet(DETECTORINDEX_t(index), fTask, kFATAL) ;
192 //_______________________________________________________________
193 Bool_t AliQA::CheckRange(DETECTORINDEX_t det) const
195 // check if detector is in given detector range: 0-kNDET
197 Bool_t rv = ( det < 0 || det > kNDET ) ? kFALSE : kTRUE ;
199 AliFatal(Form("Detector index %d is out of range: 0 <= index <= %d", det, kNDET)) ;
203 //_______________________________________________________________
204 Bool_t AliQA::CheckRange(ALITASK_t task) const
206 // check if task is given taskk range: 0:kNTASK
207 Bool_t rv = ( task < kRAW || task > kNTASK ) ? kFALSE : kTRUE ;
209 AliFatal(Form("Module index %d is out of range: 0 <= index <= %d", task, kNTASK)) ;
213 //_______________________________________________________________
214 Bool_t AliQA::CheckRange(QABIT_t bit) const
216 // check if bit is in given bit range: 0-kNBit
218 Bool_t rv = ( bit < 0 || bit > kNBIT ) ? kFALSE : kTRUE ;
220 AliFatal(Form("Status bit %d is out of range: 0 <= bit <= %d", bit, kNBIT)) ;
226 //_______________________________________________________________
227 char * AliQA::GetAliTaskName(ALITASK_t tsk)
229 // returns the char name corresponding to module index
253 return Form("%s", tskName.Data()) ;
256 //_______________________________________________________________
257 char * AliQA::GetBitName(QABIT_t bit) const
259 // returns the char name corresponding to bit
268 bitName = "WARNING" ;
280 return Form("%s", bitName.Data()) ;
283 //_______________________________________________________________
284 AliQA::DETECTORINDEX_t AliQA::GetDetIndex(const char * name)
286 // returns the detector index corresponding to a given name
287 TString sname(name) ;
288 DETECTORINDEX_t rv = kNULLDET ;
289 for (Int_t det = 0; det < kNDET ; det++) {
290 if ( GetDetName(det) == sname ) {
291 rv = DETECTORINDEX_t(det) ;
298 //_______________________________________________________________
299 const char * AliQA::GetDetName(Int_t det)
301 // returns the detector name corresponding to a given index (needed in a loop)
303 if ( det >= 0 && det < kNDET)
304 return (fgDetNames[det]).Data() ;
309 //_______________________________________________________________
310 TFile * AliQA::GetQADataFile(const char * name, const Int_t run)
312 // opens the file to store the detectors Quality Assurance Data Maker results
313 const char * temp = Form("%s.%s.%d.root", name, fgQADataFileName.Data(), run) ;
315 if (! fgQADataFile ) {
316 if (gSystem->AccessPathName(temp))
320 fgQADataFile = TFile::Open(temp, opt.Data()) ;
322 if ( strcmp(temp, fgQADataFile->GetName()) != 0 ) {
323 fgQADataFile = dynamic_cast<TFile *>(gROOT->FindObject(temp)) ;
324 if ( !fgQADataFile ) {
325 if (gSystem->AccessPathName(temp))
329 fgQADataFile = TFile::Open(temp, opt.Data()) ;
333 return fgQADataFile ;
336 //_____________________________________________________________________________
337 TFile * AliQA::GetQADataFile(const char * fileName)
339 // Open if necessary the Data file and return its pointer
343 fileName = AliQA::GetQADataFileName() ;
344 if (!gSystem->AccessPathName(fileName)) {
345 fgQADataFile = TFile::Open(fileName) ;
347 AliFatalClass(Form("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(fgkLabLocalFile))
362 dirName.ReplaceAll(fgkLabLocalFile, "") ;
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 // returns the name of a run type
382 TString rv("Invalid Run Type") ;
383 if ( rt == kNULLTYPE ) {
384 rv = "Known RUN_TYPE are: \n" ;
385 for (Int_t index = 0 ; index < kNTYPE; index++) {
386 rv += Form("%2d -- %s\n", index, fgRTNames[index].Data()) ;
388 AliErrorClass(Form("%s", rv.Data())) ;
392 if ( rt > kNULLTYPE && rt < kNTYPE )
398 //_______________________________________________________________
399 AliQA::TASKINDEX_t AliQA::GetTaskIndex(const char * name)
401 // returns the detector index corresponding to a given name
402 TString sname(name) ;
403 TASKINDEX_t rv = kNULLTASKINDEX ;
404 for (Int_t tsk = 0; tsk < kNTASKINDEX ; tsk++) {
405 if ( GetTaskName(tsk) == sname ) {
406 rv = TASKINDEX_t(tsk) ;
413 //_______________________________________________________________
414 Bool_t AliQA::IsSet(DETECTORINDEX_t det, ALITASK_t tsk, QABIT_t bit) const
416 // Checks is the requested bit is set
422 ULong_t offset = Offset(tsk) ;
423 ULong_t status = GetStatus(det) ;
425 status = (status & 1 << offset) != 0 ;
429 //_______________________________________________________________
430 Bool_t AliQA::IsSetAny(DETECTORINDEX_t det, ALITASK_t tsk) const
432 // Checks is the requested bit is set
437 ULong_t offset = Offset(tsk) ;
438 ULong_t status = GetStatus(det) ;
440 for ( Int_t bit = 0 ; bit < kNBIT ; bit++) {
442 st += (status & 1 << offset) != 0 ;
449 //_______________________________________________________________
450 Bool_t AliQA::IsSetAny(DETECTORINDEX_t det) const
452 // Checks is the requested bit is set
456 ULong_t status = GetStatus(det) ;
458 for ( Int_t tsk = 0 ; tsk < kNTASK ; tsk++) {
459 ULong_t offset = Offset(ALITASK_t(tsk)) ;
460 for ( Int_t bit = 0 ; bit < kNBIT ; bit++) {
462 st += (status & 1 << offset) != 0 ;
471 //_______________________________________________________________
472 AliQA * AliQA::Instance()
474 // Get an instance of the singleton.
475 // Object must have been instantiated with Instance(ALITASK) first
480 //_______________________________________________________________
481 AliQA * AliQA::Instance(const DETECTORINDEX_t det)
483 // Get an instance of the singleton. The only authorized way to call the ctor
486 TFile * f = GetQAResultFile() ;
487 fgQA = dynamic_cast<AliQA *>(f->Get("QA")) ;
489 fgQA = new AliQA(det) ;
495 //_______________________________________________________________
496 AliQA * AliQA::Instance(const ALITASK_t tsk)
498 // get an instance of the singleton.
505 fgQA = new AliQA(tsk) ;
508 fgQA = new AliQA(tsk) ;
511 AliInfoClass("fgQA = gAlice->GetQA()") ;
514 AliInfoClass("fgQA = dynamic_cast<AliQA *> (esdFile->Get(\"QA\")") ;
517 AliInfoClass("fgQA = dynamic_cast<AliQA *> (esdFile->Get(\"QA\")") ;
527 //_______________________________________________________________
528 AliQA * AliQA::Instance(const TASKINDEX_t tsk)
530 // get an instance of the singleton.
532 ALITASK_t index = kNULLTASK ;
536 else if (tsk < kDIGITS)
538 else if (tsk < kRECPARTICLES)
540 else if (tsk == kESDS)
543 return Instance(index) ;
546 //_______________________________________________________________
547 void AliQA::Merge(TCollection * list) {
548 // Merge the QA resuls in the list into this single AliQA object
550 for (Int_t det = 0 ; det < kNDET ; det++) {
551 Set(DETECTORINDEX_t(det)) ;
552 for (Int_t task = 0 ; task < kNTASK ; task++) {
553 Set(ALITASK_t(task)) ;
554 for (Int_t bit = 0 ; bit < kNBIT ; bit++) {
557 while ( (qa = (AliQA*)next() ) ) {
558 qa->IsSet(DETECTORINDEX_t(det), ALITASK_t(task), QABIT_t(bit)) ;
566 //_______________________________________________________________
567 ULong_t AliQA::Offset(ALITASK_t tsk) const
569 // Calculates the bit offset for a given module (SIM, REC, ESD, ANA)
599 //_______________________________________________________________
600 void AliQA::Set(QABIT_t bit)
602 // Set the status bit of the current detector in the current module
604 SetStatusBit(fDet, fTask, bit) ;
607 //_____________________________________________________________________________
608 void AliQA::SetQARefStorage(const char * name)
610 // Set the root directory where the QA reference data are stored
612 fgQARefDirName = name ;
613 if ( fgQARefDirName.Contains(fgkLabLocalFile) )
614 fgQARefFileName = fgkRefFileName ;
615 else if ( fgQARefDirName.Contains(fgkLabLocalOCDB) )
616 fgQARefFileName = fgkQAName ;
617 else if ( fgQARefDirName.Contains(fgkLabAliEnOCDB) )
618 fgQARefFileName = fgkQAName ;
621 AliErrorClass(Form("%s is an invalid storage definition\n", name)) ;
622 fgQARefDirName = "" ;
623 fgQARefFileName = "" ;
625 TString tmp(fgQARefDirName) ; // + fgQARefFileName) ;
626 AliInfoClass(Form("AliQA::SetQARefDir: QA references are in %s\n", tmp.Data()) ) ;
629 //_____________________________________________________________________________
630 void AliQA::SetQARefDataDirName(const char * name)
632 // Set the lower level directory name where reference data are found
634 RUNTYPE_t rt = kNULLTYPE ;
635 for (Int_t index = 0; index < kNTYPE; index++) {
636 if (test.CompareTo(fgRTNames[index]) == 0) {
637 rt = (RUNTYPE_t) index ;
642 if (rt == kNULLTYPE) {
643 AliWarningClass(Form("AliQA::SetQARefDataDirName: %s is an unknown RUN TYPE name\n", name)) ;
647 SetQARefDataDirName(rt) ;
650 //_____________________________________________________________________________
651 void AliQA::SetQAResultDirName(const char * name)
653 // Set the root directory where to store the QA status object
655 fgQAResultDirName.Prepend(name) ;
656 AliInfoClass(Form("AliQA::SetQAResultDirName: QA results are in %s\n", fgQAResultDirName.Data())) ;
657 if ( fgQAResultDirName.Contains(fgkLabLocalFile))
658 fgQAResultDirName.ReplaceAll(fgkLabLocalFile, "") ;
659 fgQAResultFileName.Prepend(fgQAResultDirName) ;
662 //_______________________________________________________________
663 void AliQA::SetStatusBit(DETECTORINDEX_t det, ALITASK_t tsk, QABIT_t bit)
665 // Set the status bit for a given detector and a given task
671 ULong_t offset = Offset(tsk) ;
672 ULong_t status = GetStatus(det) ;
674 status = status | 1 << offset ;
675 SetStatus(det, status) ;
678 //_______________________________________________________________
679 void AliQA::ShowAll() const
681 // dispplay the QA status word
683 for (index = 0 ; index < kNDET ; index++) {
684 for (Int_t tsk = kRAW ; tsk < kNTASK ; tsk++) {
685 ShowStatus(DETECTORINDEX_t(index), ALITASK_t(tsk)) ;
690 //_______________________________________________________________
691 void AliQA::ShowStatus(DETECTORINDEX_t det, ALITASK_t tsk) const
693 // Prints the full QA status of a given detector
695 ULong_t status = GetStatus(det) ;
696 ULong_t tskStatus[kNTASK] ;
697 tskStatus[kRAW] = status & 0x0000f ;
698 tskStatus[kSIM] = status & 0x000f0 ;
699 tskStatus[kREC] = status & 0x00f00 ;
700 tskStatus[kESD] = status & 0x0f000 ;
701 tskStatus[kANA] = status & 0xf0000 ;
703 AliInfo(Form("====> QA Status for %8s raw =0x%lx, sim=0x%lx, rec=0x%lx, esd=0x%lx, ana=0x%lx", GetDetName(det).Data(),
704 tskStatus[kRAW], tskStatus[kSIM], tskStatus[kREC], tskStatus[kESD], tskStatus[kANA] )) ;
705 if (tsk == kNULLTASK) {
706 for (Int_t itsk = kRAW ; itsk < kNTASK ; itsk++) {
707 ShowASCIIStatus(det, ALITASK_t(itsk), tskStatus[itsk]) ;
710 ShowASCIIStatus(det, tsk, tskStatus[tsk]) ;
714 //_______________________________________________________________
715 void AliQA::ShowASCIIStatus(DETECTORINDEX_t det, ALITASK_t tsk, const ULong_t status) const
717 // print the QA status in human readable format
719 for (Int_t bit = kINFO ; bit < kNBIT ; bit++) {
720 if (IsSet(det, tsk, QABIT_t(bit))) {
721 text = GetBitName(QABIT_t(bit)) ;
726 AliWarningClass(Form(" %8s %4s 0x%4lx, Problem signalled: %8s \n", GetDetName(det).Data(), GetAliTaskName(tsk), status, text.Data())) ;
729 //_______________________________________________________________
730 void AliQA::UnSet(QABIT_t bit)
732 // UnSet the status bit of the current detector in the current module
734 UnSetStatusBit(fDet, fTask, bit) ;
737 //_______________________________________________________________
738 void AliQA::UnSetStatusBit(DETECTORINDEX_t det, ALITASK_t tsk, QABIT_t bit)
740 // UnSet the status bit for a given detector and a given task
746 ULong_t offset = Offset(tsk) ;
747 ULong_t status = GetStatus(det) ;
749 status = status & 0 << offset ;
750 SetStatus(det, status) ;