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 = "QAExpErT" ;
81 //____________________________________________________________________________
85 fQA(new ULong_t[fNdet]),
90 // default constructor
91 // beware singleton: not to be used
93 for (Int_t index = 0 ; index < fNdet ; index++)
97 //____________________________________________________________________________
98 AliQA::AliQA(const AliQA& qa) :
108 //_____________________________________________________________________________
109 AliQA& AliQA::operator = (const AliQA& qa)
111 // assignment operator
118 //_______________________________________________________________
119 AliQA::AliQA(const DETECTORINDEX_t det) :
120 TNamed("QA", "Quality Assurance status"),
122 fQA(new ULong_t[fNdet]),
126 // constructor to be used
127 if (! CheckRange(det) ) {
132 for (index = 0; index < fNdet; index++)
136 //_______________________________________________________________
137 AliQA::AliQA(const ALITASK_t tsk) :
138 TNamed("QA", "Quality Assurance status"),
140 fQA(new ULong_t[fNdet]),
144 // constructor to be used in the AliRoot module (SIM, REC, ESD or ANA)
145 if (! CheckRange(tsk) ) {
150 for (index = 0; index < fNdet; index++)
154 //____________________________________________________________________________
161 //_______________________________________________________________
164 // close the open files
166 if (fgQADataFile->IsOpen())
167 fgQADataFile->Close() ;
169 if (fgQAResultFile->IsOpen())
170 fgQAResultFile->Close() ;
172 if (fgQARefFile->IsOpen())
173 fgQARefFile->Close() ;
176 //_______________________________________________________________
177 const Bool_t AliQA::CheckFatal() const
179 // check if any FATAL status is set
182 for (index = 0; index < kNDET ; index++)
183 rv = rv || IsSet(DETECTORINDEX_t(index), fTask, kFATAL) ;
187 //_______________________________________________________________
188 const Bool_t AliQA::CheckRange(DETECTORINDEX_t det) const
190 // check if detector is in given detector range: 0-kNDET
192 Bool_t rv = ( det < 0 || det > kNDET ) ? kFALSE : kTRUE ;
194 AliFatal(Form("Detector index %d is out of range: 0 <= index <= %d", det, kNDET)) ;
198 //_______________________________________________________________
199 const Bool_t AliQA::CheckRange(ALITASK_t task) const
201 // check if task is given taskk range: 0:kNTASK
202 Bool_t rv = ( task < kRAW || task > kNTASK ) ? kFALSE : kTRUE ;
204 AliFatal(Form("Module index %d is out of range: 0 <= index <= %d", task, kNTASK)) ;
208 //_______________________________________________________________
209 const Bool_t AliQA::CheckRange(QABIT_t bit) const
211 // check if bit is in given bit range: 0-kNBit
213 Bool_t rv = ( bit < 0 || bit > kNBIT ) ? kFALSE : kTRUE ;
215 AliFatal(Form("Status bit %d is out of range: 0 <= bit <= %d", bit, kNBIT)) ;
221 //_______________________________________________________________
222 const char * AliQA::GetAliTaskName(ALITASK_t tsk)
224 // returns the char name corresponding to module index
248 return tskName.Data() ;
251 //_______________________________________________________________
252 const char * AliQA::GetBitName(QABIT_t bit) const
254 // returns the char name corresponding to bit
263 bitName = "WARNING" ;
275 return bitName.Data() ;
278 //_______________________________________________________________
279 const AliQA::DETECTORINDEX_t AliQA::GetDetIndex(const char * name)
281 // returns the detector index corresponding to a given name
282 TString sname(name) ;
283 DETECTORINDEX_t rv = kNULLDET ;
284 for (Int_t det = 0; det < kNDET ; det++) {
285 if ( GetDetName(det) == sname ) {
286 rv = DETECTORINDEX_t(det) ;
293 //_______________________________________________________________
294 const char * AliQA::GetDetName(Int_t det)
296 // returns the detector name corresponding to a given index (needed in a loop)
298 if ( det >= 0 && det < kNDET)
299 return (fgDetNames[det]).Data() ;
304 //_______________________________________________________________
305 TFile * AliQA::GetQADataFile(const char * name, const Int_t run)
307 // opens the file to store the detectors Quality Assurance Data Maker results
308 const char * temp = Form("%s.%s.%d.root", name, fgQADataFileName.Data(), run) ;
310 if (! fgQADataFile ) {
311 if (gSystem->AccessPathName(temp))
315 fgQADataFile = TFile::Open(temp, opt.Data()) ;
317 if ( strcmp(temp, fgQADataFile->GetName()) != 0 ) {
318 fgQADataFile = dynamic_cast<TFile *>(gROOT->FindObject(temp)) ;
319 if ( !fgQADataFile ) {
320 if (gSystem->AccessPathName(temp))
324 fgQADataFile = TFile::Open(temp, opt.Data()) ;
328 return fgQADataFile ;
331 //_____________________________________________________________________________
332 TFile * AliQA::GetQADataFile(const char * fileName)
334 // Open if necessary the Data file and return its pointer
338 fileName = AliQA::GetQADataFileName() ;
339 if (!gSystem->AccessPathName(fileName)) {
340 fgQADataFile = TFile::Open(fileName) ;
342 printf("File %s not found", fileName) ;
345 return fgQADataFile ;
348 //_______________________________________________________________
349 TFile * AliQA::GetQAResultFile()
351 // opens the file to store the Quality Assurance Data Checker results
353 fgQAResultFile->Close() ;
354 fgQAResultFile = 0x0 ;
355 // if (!fgQAResultFile) {
356 TString dirName(fgQAResultDirName) ;
357 if ( dirName.Contains(fkgLabLocalFile))
358 dirName.ReplaceAll(fkgLabLocalFile, "") ;
359 TString fileName(dirName + fgQAResultFileName) ;
361 if ( !gSystem->AccessPathName(fileName) )
364 if ( gSystem->AccessPathName(dirName) )
365 gSystem->mkdir(dirName) ;
368 fgQAResultFile = TFile::Open(fileName, opt) ;
371 return fgQAResultFile ;
374 //_______________________________________________________________
375 const TString AliQA::GetRunTypeName(RUNTYPE_t rt)
377 TString rv("Invalid Run Type") ;
378 if ( rt == kNULLTYPE ) {
379 rv = "Known RUN_TYPE are: \n" ;
380 for (Int_t index = 0 ; index < kNTYPE; index++) {
381 rv += Form("%2d -- %s\n", index, fgRTNames[index].Data()) ;
383 printf("%s", rv.Data()) ;
387 if ( rt > kNULLTYPE && rt < kNTYPE )
393 //_______________________________________________________________
394 const AliQA::TASKINDEX_t AliQA::GetTaskIndex(const char * name)
396 // returns the detector index corresponding to a given name
397 TString sname(name) ;
399 for (Int_t tsk = 0; tsk < kNTASKINDEX ; tsk++) {
400 if ( GetTaskName(tsk) == sname ) {
401 rv = TASKINDEX_t(tsk) ;
408 //_______________________________________________________________
409 const Bool_t AliQA::IsSet(DETECTORINDEX_t det, ALITASK_t tsk, QABIT_t bit) const
411 // Checks is the requested bit is set
417 ULong_t offset = Offset(tsk) ;
418 ULong_t status = GetStatus(det) ;
420 status = (status & 1 << offset) != 0 ;
424 //_______________________________________________________________
425 const Bool_t AliQA::IsSetAny(DETECTORINDEX_t det, ALITASK_t tsk) const
427 // Checks is the requested bit is set
432 ULong_t offset = Offset(tsk) ;
433 ULong_t status = GetStatus(det) ;
435 for ( Int_t bit = 0 ; bit < kNBIT ; bit++) {
437 st += (status & 1 << offset) != 0 ;
444 //_______________________________________________________________
445 const Bool_t AliQA::IsSetAny(DETECTORINDEX_t det) const
447 // Checks is the requested bit is set
451 ULong_t status = GetStatus(det) ;
453 for ( Int_t tsk = 0 ; tsk < kNTASK ; tsk++) {
454 ULong_t offset = Offset(ALITASK_t(tsk)) ;
455 for ( Int_t bit = 0 ; bit < kNBIT ; bit++) {
457 st += (status & 1 << offset) != 0 ;
466 //_______________________________________________________________
467 AliQA * AliQA::Instance()
469 // Get an instance of the singleton.
470 // Object must have been instantiated with Instance(ALITASK) first
475 //_______________________________________________________________
476 AliQA * AliQA::Instance(const DETECTORINDEX_t det)
478 // Get an instance of the singleton. The only authorized way to call the ctor
481 TFile * f = GetQAResultFile() ;
482 fgQA = dynamic_cast<AliQA *>(f->Get("QA")) ;
484 fgQA = new AliQA(det) ;
490 //_______________________________________________________________
491 AliQA * AliQA::Instance(const ALITASK_t tsk)
493 // get an instance of the singleton.
500 fgQA = new AliQA(tsk) ;
503 fgQA = new AliQA(tsk) ;
506 printf("fgQA = gAlice->GetQA()") ;
509 printf("fgQA = dynamic_cast<AliQA *> (esdFile->Get(\"QA\")") ;
512 printf("fgQA = dynamic_cast<AliQA *> (esdFile->Get(\"QA\")") ;
522 //_______________________________________________________________
523 AliQA * AliQA::Instance(const TASKINDEX_t tsk)
525 // get an instance of the singleton.
527 ALITASK_t index = kNULLTASK ;
531 else if (tsk < kDIGITS)
533 else if (tsk < kRECPARTICLES)
535 else if (tsk == kESDS)
538 return Instance(index) ;
541 //_______________________________________________________________
542 void AliQA::Merge(TCollection * list) {
543 // Merge the QA resuls in the list into this single AliQA object
545 for (Int_t det = 0 ; det < kNDET ; det++) {
546 Set(DETECTORINDEX_t(det)) ;
547 for (Int_t task = 0 ; task < kNTASK ; task++) {
548 Set(ALITASK_t(task)) ;
549 for (Int_t bit = 0 ; bit < kNBIT ; bit++) {
552 while ( (qa = (AliQA*)next() ) ) {
553 qa->IsSet(DETECTORINDEX_t(det), ALITASK_t(task), QABIT_t(bit)) ;
561 //_______________________________________________________________
562 const ULong_t AliQA::Offset(ALITASK_t tsk) const
564 // Calculates the bit offset for a given module (SIM, REC, ESD, ANA)
594 //_______________________________________________________________
595 void AliQA::Set(QABIT_t bit)
597 // Set the status bit of the current detector in the current module
599 SetStatusBit(fDet, fTask, bit) ;
602 //_____________________________________________________________________________
603 void AliQA::SetQARefStorage(const char * name)
605 // Set the root directory where the QA reference data are stored
607 fgQARefDirName = name ;
608 if ( fgQARefDirName.Contains(fkgLabLocalFile) )
609 fgQARefFileName = fkgRefFileName ;
610 else if ( fgQARefDirName.Contains(fkgLabLocalOCDB) )
611 fgQARefFileName = fkgQAName ;
612 else if ( fgQARefDirName.Contains(fkgLabAliEnOCDB) )
613 fgQARefFileName = fkgQAName ;
616 printf("ERROR: %s is an invalid storage definition\n", name) ;
617 fgQARefDirName = "" ;
618 fgQARefFileName = "" ;
620 TString tmp(fgQARefDirName) ; // + fgQARefFileName) ;
621 printf("AliQA::SetQARefDir: QA references are in %s\n", tmp.Data() ) ;
624 //_____________________________________________________________________________
625 void AliQA::SetQARefDataDirName(const char * name)
627 // Set the lower level directory name where reference data are found
629 RUNTYPE_t rt = kNULLTYPE ;
630 for (Int_t index = 0; index < kNTYPE; index++) {
631 if (test.CompareTo(fgRTNames[index]) == 0) {
632 rt = (RUNTYPE_t) index ;
637 if (rt == kNULLTYPE) {
638 printf("AliQA::SetQARefDataDirName: %s is an unknown RUN TYPE name\n", name) ;
642 SetQARefDataDirName(rt) ;
645 //_____________________________________________________________________________
646 void AliQA::SetQAResultDirName(const char * name)
648 // Set the root directory where to store the QA status object
650 fgQAResultDirName.Prepend(name) ;
651 printf("AliQA::SetQAResultDirName: QA results are in %s\n", fgQAResultDirName.Data()) ;
652 if ( fgQAResultDirName.Contains(fkgLabLocalFile))
653 fgQAResultDirName.ReplaceAll(fkgLabLocalFile, "") ;
654 fgQAResultFileName.Prepend(fgQAResultDirName) ;
657 //_______________________________________________________________
658 void AliQA::SetStatusBit(DETECTORINDEX_t det, ALITASK_t tsk, QABIT_t bit)
660 // Set the status bit for a given detector and a given task
666 ULong_t offset = Offset(tsk) ;
667 ULong_t status = GetStatus(det) ;
669 status = status | 1 << offset ;
670 SetStatus(det, status) ;
673 //_______________________________________________________________
674 void AliQA::ShowAll() const
676 // dispplay the QA status word
678 for (index = 0 ; index < kNDET ; index++) {
679 for (Int_t tsk = kRAW ; tsk < kNTASK ; tsk++) {
680 ShowStatus(DETECTORINDEX_t(index), ALITASK_t(tsk)) ;
685 //_______________________________________________________________
686 void AliQA::ShowStatus(DETECTORINDEX_t det, ALITASK_t tsk) const
688 // Prints the full QA status of a given detector
690 ULong_t status = GetStatus(det) ;
691 ULong_t tskStatus[kNTASK] ;
692 tskStatus[kRAW] = status & 0x0000f ;
693 tskStatus[kSIM] = status & 0x000f0 ;
694 tskStatus[kREC] = status & 0x00f00 ;
695 tskStatus[kESD] = status & 0x0f000 ;
696 tskStatus[kANA] = status & 0xf0000 ;
698 AliInfo(Form("====> QA Status for %8s raw =0x%x, sim=0x%x, rec=0x%x, esd=0x%x, ana=0x%x", GetDetName(det).Data(),
699 tskStatus[kRAW], tskStatus[kSIM], tskStatus[kREC], tskStatus[kESD], tskStatus[kANA] )) ;
700 if (tsk == kNULLTASK) {
701 for (Int_t itsk = kRAW ; itsk < kNTASK ; itsk++) {
702 ShowASCIIStatus(det, ALITASK_t(itsk), tskStatus[itsk]) ;
705 ShowASCIIStatus(det, tsk, tskStatus[tsk]) ;
709 //_______________________________________________________________
710 void AliQA::ShowASCIIStatus(DETECTORINDEX_t det, ALITASK_t tsk, const ULong_t status) const
712 // print the QA status in human readable format
714 for (Int_t bit = kINFO ; bit < kNBIT ; bit++) {
715 if (IsSet(det, tsk, QABIT_t(bit))) {
716 text = GetBitName(QABIT_t(bit)) ;
721 printf(" %8s %4s 0x%4x, Problem signalled: %8s \n", GetDetName(det).Data(), GetAliTaskName(tsk), status, text.Data()) ;
724 //_______________________________________________________________
725 void AliQA::UnSet(QABIT_t bit)
727 // UnSet the status bit of the current detector in the current module
729 UnSetStatusBit(fDet, fTask, bit) ;
732 //_______________________________________________________________
733 void AliQA::UnSetStatusBit(DETECTORINDEX_t det, ALITASK_t tsk, QABIT_t bit)
735 // UnSet the status bit for a given detector and a given task
741 ULong_t offset = Offset(tsk) ;
742 ULong_t status = GetStatus(det) ;
744 status = status & 0 << offset ;
745 SetStatus(det, status) ;