Corrected protection.
[u/mrichter/AliRoot.git] / STEER / AliQA.cxx
index 8a752ac..544b539 100644 (file)
 // Quality Assurance Object//_________________________________________________________________________
 // Quality Assurance object. The QA status is held in one word per detector,
 // each bit corresponds to a different status.
-// bit 0-3  : QA raised during simulation      (SIM)
-// bit 4-7  : QA raised during reconstruction  (REC)
-// bit 8-11 : QA raised during ESD checking    (ESD)
-// bit 12-15: QA raised during analysis        (ANA)
+// bit 0-3   : QA raised during simulation      (RAW)
+// bit 4-7   : QA raised during simulation      (SIM)
+// bit 8-11  : QA raised during reconstruction  (REC)
+// bit 12-15 : QA raised during ESD checking    (ESD)
+// bit 16-19 : QA raised during analysis        (ANA)
 // Each of the 4 bits corresponds to a severity level of increasing importance
 // from lower to higher bit (INFO, WARNING, ERROR, FATAL)
 //
@@ -33,6 +34,7 @@
 
 #include <cstdlib>
 // --- ROOT system ---
+#include <TClass.h>
 #include <TFile.h>
 #include <TSystem.h>
 #include <TROOT.h>
@@ -49,22 +51,36 @@ AliQA    * AliQA::fgQA                   = 0x0 ;
 TFile    * AliQA::fgQADataFile           = 0x0 ;   
 TString    AliQA::fgQADataFileName       = "QA" ;  // will transform into Det.QA.run.cycle.root  
 TFile    * AliQA::fgQARefFile            = 0x0 ;   
-TString    AliQA::fgQARefDirName            = "" ; 
+TString    AliQA::fgQARefDirName              = "" ; 
 TString    AliQA::fgQARefFileName        = "QA.root" ;
 TFile    * AliQA::fgQAResultFile         = 0x0 ;  
 TString    AliQA::fgQAResultDirName      = "" ;  
 TString    AliQA::fgQAResultFileName     = "QA.root" ; 
 TString    AliQA::fgDetNames[]           = {"ITS", "TPC", "TRD", "TOF", "PHOS", "HMPID", "EMCAL", "MUON", "FMD",
-                                                                                   "ZDC", "PMD", "T0", "VZERO", "ACORDE", "HLT", "Global"} ;   
+                                            "ZDC", "PMD", "T0", "VZERO", "ACORDE", "HLT", "Global", "CORR"} ;   
+TString    AliQA::fgGRPPath              = "GRP/GRP/Data" ; 
+TString    AliQA::fgRTNames[]            = {"UNKNOWN", "AUTO_TEST", "CALIBRATION", "CALIBRATION_PULSER", "CHANNEL_DELAY_TUNING", "COSMIC", 
+                                                                                                                                                                               "COSMICS", "DAQ_FO_UNIF_SCAN", "DAQ_GEN_DAC_SCAN", "DAQ_MEAN_TH_SCAN", "DAQ_MIN_TH_SCAN", 
+                                                                                                                                                                               "DAQ_NOISY_PIX_SCAN", "DAQ_PIX_DELAY_SCAN", "DAQ_UNIFORMITY_SCAN", "DCS_FO_UNIF_SCAN", 
+                                                                                                                                                                               "DCS_MEAN_TH_SCAN", "DCS_MIN_TH_SCAN", "DCS_PIX_DELAY_SCAN", "DCS_UNIFORMITY_SCAN", 
+                                                                                                                                                                               "DDL_TEST", "GAIN", "PEDESTAL", "INJECTOR",  "LASER", "MONTECARLO", "NOISE", "NOISY_PIX_SCAN", 
+                                                                                                                                                                               "PHYSICS", "PULSER", "STANDALONE", "STANDALONE_BC", "STANDALONE_CENTRAL", "STANDALONE_COSMIC", 
+                                                                                                                                                                               "STANDALONE_EMD", "STANDALONE_LASER", "STANDALONE_MB", "STANDALONE_PEDESTAL", 
+                                                                                                                                                                               "STANDALONE_SEMICENTRAL", "STANDALONE_PULSER" } ;   
 TString       AliQA::fgTaskNames[]       = {"Raws", "Hits", "SDigits", "Digits", "RecPoints", "TrackSegments", "RecParticles", "ESDs"} ;   
-const TString AliQA::fkgLabLocalFile     = "file://"  ; 
-const TString AliQA::fkgLabLocalOCDB     = "local://" ;  
-const TString AliQA::fkgLabAliEnOCDB     = "alien://" ;  
-const TString AliQA::fkgRefFileName      = "QA.root" ; 
-const TString AliQA::fkgQAName           = "QA"  ; 
-const TString AliQA::fkgRefOCDBDirName   = "Ref"  ; 
-TString AliQA::fkgRefDataDirName   = "Data"  ; 
-const TString AliQA::fkgQARefOCDBDefault = "alien://folder=/alice/QA/20"  ; 
+const TString AliQA::fgkLabLocalFile     = "file://"  ; 
+const TString AliQA::fgkLabLocalOCDB     = "local://" ;  
+const TString AliQA::fgkLabAliEnOCDB     = "alien://" ;  
+const TString AliQA::fgkRefFileName      = "QA.root" ; 
+const TString AliQA::fgkQAName           = "QA"  ; 
+const TString AliQA::fgkQACorrNtName     = "CorrQA" ;  
+const TString AliQA::fgkRefOCDBDirName   = "Ref"  ; 
+TString AliQA::fgkRefDataDirName              = ""  ; 
+const TString AliQA::fgkQARefOCDBDefault = "alien://folder=/alice/QA/20"  ; 
+const TString AliQA::fgkExpert           = "Expert" ; 
+const UInt_t  AliQA::fgkExpertBit        = 16 ; 
+const UInt_t  AliQA::fgkQABit            = 17 ; 
+
 //____________________________________________________________________________
 AliQA::AliQA() : 
   TNamed("", ""), 
@@ -85,11 +101,13 @@ AliQA::AliQA() :
 AliQA::AliQA(const AliQA& qa) :
   TNamed(qa),
   fNdet(qa.fNdet), 
-  fQA(qa.fQA), 
+  fQA(new ULong_t[qa.fNdet]), 
   fDet(qa.fDet),
   fTask(qa.fTask)
 { 
   // cpy ctor
+  for (Int_t index = 0 ; index < fNdet ; index++) 
+       fQA[index] = qa.fQA[index] ; 
 }
 
 //_____________________________________________________________________________
@@ -161,7 +179,7 @@ void AliQA::Close()
 } 
 
 //_______________________________________________________________
-const Bool_t AliQA::CheckFatal() const
+Bool_t AliQA::CheckFatal() const
 {
   // check if any FATAL status is set
   Bool_t rv = kFALSE ;
@@ -172,7 +190,7 @@ const Bool_t AliQA::CheckFatal() const
 }
 
 //_______________________________________________________________
-const Bool_t AliQA::CheckRange(DETECTORINDEX_t det) const
+Bool_t AliQA::CheckRange(DETECTORINDEX_t det) const
 { 
   // check if detector is in given detector range: 0-kNDET
 
@@ -183,7 +201,7 @@ const Bool_t AliQA::CheckRange(DETECTORINDEX_t det) const
 }
 
 //_______________________________________________________________
-const Bool_t AliQA::CheckRange(ALITASK_t task) const
+Bool_t AliQA::CheckRange(ALITASK_t task) const
 { 
   // check if task is given taskk range: 0:kNTASK
   Bool_t rv = ( task < kRAW || task > kNTASK )  ? kFALSE : kTRUE ;
@@ -193,7 +211,7 @@ const Bool_t AliQA::CheckRange(ALITASK_t task) const
 }
 
 //_______________________________________________________________
-const Bool_t AliQA::CheckRange(QABIT_t bit) const
+Bool_t AliQA::CheckRange(QABIT_t bit) const
 { 
   // check if bit is in given bit range: 0-kNBit
 
@@ -206,37 +224,64 @@ const Bool_t AliQA::CheckRange(QABIT_t bit) const
 
 
 //_______________________________________________________________
-const char * AliQA::GetAliTaskName(ALITASK_t tsk)
+char * AliQA::GetAliTaskName(ALITASK_t tsk)
 {
-  // returns the char name corresponding to module index
-  TString tskName ;
-  switch (tsk) {
-  case kNULLTASK:
-    break ; 
-  case kRAW:
-    tskName = "RAW" ;
-    break ;  
-  case kSIM:
-    tskName = "SIM" ;
-    break ;
-  case kREC:
-    tskName = "REC" ;
-    break ;
-  case kESD:
-    tskName = "ESD" ;
-    break ;
-  case kANA:
-    tskName = "ANA" ;
-    break ;
-  default:
-    tsk = kNULLTASK ; 
-    break ;
-  }
-  return tskName.Data() ;
+       // returns the char name corresponding to module index
+       TString tskName ;
+       switch (tsk) {
+               case kNULLTASK:
+                       break ; 
+               case kRAW:
+                       tskName = "RAW" ;
+                       break ;  
+               case kSIM:
+                       tskName = "SIM" ;
+                       break ;
+               case kREC:
+                       tskName = "REC" ;
+                       break ;
+               case kESD:
+                       tskName = "ESD" ;
+                       break ;
+               case kANA:
+                       tskName = "ANA" ;
+                       break ;
+               default:
+                       tsk = kNULLTASK ; 
+                       break ;
+       }
+       return Form("%s", tskName.Data()) ;
+}
+
+//_______________________________________________________________
+char * AliQA::GetBitName(QABIT_t bit) const
+{
+       // returns the char name corresponding to bit 
+       TString bitName ;
+       switch (bit) {
+               case kNULLBit:
+                       break ; 
+               case kINFO:
+                       bitName = "INFO" ;
+                       break ;  
+               case kWARNING:
+                       bitName = "WARNING" ;
+                       break ;
+               case kERROR:
+                       bitName = "ERROR" ;
+                       break ;
+               case kFATAL:
+                       bitName = "FATAL" ;
+                       break ;
+               default:
+                       bit = kNULLBit ; 
+                       break ;
+       }
+       return Form("%s", bitName.Data()) ; 
 }
 
 //_______________________________________________________________
-const AliQA::DETECTORINDEX_t AliQA::GetDetIndex(const char * name) 
+AliQA::DETECTORINDEX_t AliQA::GetDetIndex(const char * name) 
 {
        // returns the detector index corresponding to a given name
        TString sname(name) ; 
@@ -262,10 +307,10 @@ const char * AliQA::GetDetName(Int_t det)
 }
 
 //_______________________________________________________________
-TFile * AliQA::GetQADataFile(const char * name, const Int_t run, const Int_t cycle) 
+TFile * AliQA::GetQADataFile(const char * name, const Int_t run) 
 {
   // opens the file to store the detectors Quality Assurance Data Maker results
-       const char * temp = Form("%s.%s.%d.%d.root", name, fgQADataFileName.Data(), run, cycle) ; 
+       const char * temp = Form("%s.%s.%d.root", name, fgQADataFileName.Data(), run) ; 
        TString opt ; 
        if (! fgQADataFile ) {     
                if  (gSystem->AccessPathName(temp))
@@ -299,8 +344,7 @@ TFile * AliQA::GetQADataFile(const char * fileName)
        if  (!gSystem->AccessPathName(fileName)) {
                fgQADataFile =  TFile::Open(fileName) ;
        } else {
-               printf("File %s not found", fileName) ;
-               exit(1) ;  
+               AliFatalClass(Form("File %s not found", fileName)) ;
        }
   return fgQADataFile ; 
 }
@@ -314,8 +358,8 @@ TFile * AliQA::GetQAResultFile()
        fgQAResultFile = 0x0 ; 
 //     if (!fgQAResultFile) { 
                TString dirName(fgQAResultDirName) ; 
-               if ( dirName.Contains(fkgLabLocalFile)) 
-                       dirName.ReplaceAll(fkgLabLocalFile, "") ;
+               if ( dirName.Contains(fgkLabLocalFile)) 
+                       dirName.ReplaceAll(fgkLabLocalFile, "") ;
                TString fileName(dirName + fgQAResultFileName) ; 
                TString opt("") ; 
                if ( !gSystem->AccessPathName(fileName) )
@@ -332,14 +376,49 @@ TFile * AliQA::GetQAResultFile()
 }
 
 //_______________________________________________________________
-const Bool_t AliQA::IsSet(DETECTORINDEX_t det, ALITASK_t tsk, QABIT_t bit) const
+const TString AliQA::GetRunTypeName(RUNTYPE_t rt) 
+{ 
+  // returns the name of a run type
+       TString rv("Invalid Run Type") ;        
+       if ( rt == kNULLTYPE ) {
+               rv = "Known RUN_TYPE are: \n" ; 
+               for (Int_t index = 0 ; index < kNTYPE; index++) {
+                       rv += Form("%2d -- %s\n", index, fgRTNames[index].Data()) ;  
+               }
+               AliErrorClass(Form("%s", rv.Data())) ; 
+               return "" ; 
+       }
+       else {
+               if ( rt > kNULLTYPE && rt < kNTYPE )
+                       rv = fgRTNames[rt] ; 
+       }
+       return rv ; 
+}
+
+//_______________________________________________________________
+AliQA::TASKINDEX_t AliQA::GetTaskIndex(const char * name) 
 {
-  // Checks is the requested bit is set
+       // returns the detector index corresponding to a given name
+       TString sname(name) ; 
+       TASKINDEX_t rv = kNULLTASKINDEX ; 
+       for (Int_t tsk = 0; tsk < kNTASKINDEX ; tsk++) {
+               if ( GetTaskName(tsk) == sname ) {
+                       rv = TASKINDEX_t(tsk) ; 
+                       break ; 
+               }
+       }
+       return rv ;             
+}
 
+//_______________________________________________________________
+Bool_t AliQA::IsSet(DETECTORINDEX_t det, ALITASK_t tsk, QABIT_t bit) const
+{
+  // Checks is the requested bit is set
+       
   CheckRange(det) ; 
   CheckRange(tsk) ;
   CheckRange(bit) ;
-
+       
   ULong_t offset = Offset(tsk) ;
   ULong_t status = GetStatus(det) ;
   offset+= bit ;
@@ -348,6 +427,48 @@ const Bool_t AliQA::IsSet(DETECTORINDEX_t det, ALITASK_t tsk, QABIT_t bit) const
 }
 
 //_______________________________________________________________
+Bool_t AliQA::IsSetAny(DETECTORINDEX_t det, ALITASK_t tsk) const
+{
+  // Checks is the requested bit is set
+       
+  CheckRange(det) ; 
+  CheckRange(tsk) ;
+       
+  ULong_t offset = Offset(tsk) ;
+  ULong_t status = GetStatus(det) ;
+       UShort_t st = 0 ; 
+       for ( Int_t bit = 0 ; bit < kNBIT ; bit++) {
+               offset+= bit ;
+               st += (status & 1 << offset) != 0 ;             
+       }
+       if ( st == 0 ) 
+               return kFALSE ; 
+       else 
+               return kTRUE ;
+}
+//_______________________________________________________________
+Bool_t AliQA::IsSetAny(DETECTORINDEX_t det) const
+{
+  // Checks is the requested bit is set
+       
+  CheckRange(det) ; 
+       
+       ULong_t status = GetStatus(det) ;
+       UShort_t st = 0 ; 
+       for ( Int_t tsk = 0 ; tsk < kNTASK ; tsk++) {
+               ULong_t offset = Offset(ALITASK_t(tsk)) ;
+               for ( Int_t bit = 0 ; bit < kNBIT ; bit++) {
+                       offset+= bit ;
+                       st += (status & 1 << offset) != 0 ;             
+               }
+       }
+       if ( st == 0 ) 
+               return kFALSE ; 
+       else 
+               return kTRUE ;
+}
+
+//_______________________________________________________________
 AliQA * AliQA::Instance()
 {
   // Get an instance of the singleton.
@@ -387,13 +508,13 @@ AliQA * AliQA::Instance(const ALITASK_t tsk)
       fgQA = new AliQA(tsk) ;
       break ;
     case kREC:
-      printf("fgQA = gAlice->GetQA()") ;
+      AliInfoClass("fgQA = gAlice->GetQA()") ;
       break ;
     case kESD:
-      printf("fgQA = dynamic_cast<AliQA *> (esdFile->Get(\"QA\")") ;
+      AliInfoClass("fgQA = dynamic_cast<AliQA *> (esdFile->Get(\"QA\")") ;
       break ;
     case kANA:
-      printf("fgQA = dynamic_cast<AliQA *> (esdFile->Get(\"QA\")") ;
+      AliInfoClass("fgQA = dynamic_cast<AliQA *> (esdFile->Get(\"QA\")") ;
       break ;
     case kNTASK:
       break ;
@@ -423,7 +544,27 @@ AliQA *  AliQA::Instance(const TASKINDEX_t tsk)
 }
 
 //_______________________________________________________________
-const ULong_t AliQA::Offset(ALITASK_t tsk) const
+void AliQA::Merge(TCollection * list) {
+       // Merge the QA resuls in the list into this single AliQA object
+       
+       for (Int_t det = 0 ; det < kNDET ; det++) {
+               Set(DETECTORINDEX_t(det)) ; 
+               for (Int_t task = 0 ; task < kNTASK ; task++) {
+                       Set(ALITASK_t(task)) ; 
+                       for (Int_t bit = 0 ; bit < kNBIT ; bit++) {
+                               TIter next(list) ;
+                               AliQA * qa ; 
+                               while ( (qa = (AliQA*)next() ) ) {
+                                       qa->IsSet(DETECTORINDEX_t(det), ALITASK_t(task), QABIT_t(bit)) ;
+                                       Set(QABIT_t(bit)) ; 
+                               } // qa list
+                       } // bit
+               } // task
+       } // detector
+}
+
+//_______________________________________________________________
+ULong_t AliQA::Offset(ALITASK_t tsk) const
 {
   // Calculates the bit offset for a given module (SIM, REC, ESD, ANA)
 
@@ -469,20 +610,41 @@ void AliQA::SetQARefStorage(const char * name)
        // Set the root directory where the QA reference data are stored
 
        fgQARefDirName = name ; 
-       if ( fgQARefDirName.Contains(fkgLabLocalFile) )
-               fgQARefFileName =  fkgRefFileName ; 
-       else if ( fgQARefDirName.Contains(fkgLabLocalOCDB) )
-               fgQARefFileName =  fkgQAName ; 
-       else if ( fgQARefDirName.Contains(fkgLabAliEnOCDB) )
-               fgQARefFileName =  fkgQAName ; 
+       if ( fgQARefDirName.Contains(fgkLabLocalFile) )
+               fgQARefFileName =  fgkRefFileName ; 
+       else if ( fgQARefDirName.Contains(fgkLabLocalOCDB) )
+               fgQARefFileName =  fgkQAName ; 
+       else if ( fgQARefDirName.Contains(fgkLabAliEnOCDB) )
+               fgQARefFileName =  fgkQAName ; 
 
   else {
-         printf("ERROR: %s is an invalid storage definition\n", name) ; 
+         AliErrorClass(Form("%s is an invalid storage definition\n", name)) ; 
          fgQARefDirName  = "" ; 
          fgQARefFileName = "" ; 
   }    
        TString tmp(fgQARefDirName) ; // + fgQARefFileName) ;
-       printf("AliQA::SetQARefDir: QA references are in  %s\n", tmp.Data() ) ;
+       AliInfoClass(Form("AliQA::SetQARefDir: QA references are in  %s\n", tmp.Data()) ) ;
+}
+
+//_____________________________________________________________________________
+void AliQA::SetQARefDataDirName(const char * name) 
+{
+  // Set the lower level directory name where reference data are found
+  TString test(name) ; 
+  RUNTYPE_t rt = kNULLTYPE ; 
+  for (Int_t index = 0; index < kNTYPE; index++) {
+    if (test.CompareTo(fgRTNames[index]) == 0) {
+      rt = (RUNTYPE_t) index ; 
+      break ; 
+    } 
+       }
+       
+       if (rt == kNULLTYPE) {
+      AliWarningClass(Form("AliQA::SetQARefDataDirName: %s is an unknown RUN TYPE name\n", name)) ; 
+      return ; 
+       }
+       SetQARefDataDirName(rt) ; 
 }
 
 //_____________________________________________________________________________
@@ -491,9 +653,9 @@ void AliQA::SetQAResultDirName(const char * name)
   // Set the root directory where to store the QA status object
 
   fgQAResultDirName.Prepend(name) ; 
-  printf("AliQA::SetQAResultDirName: QA results are in  %s\n", fgQAResultDirName.Data()) ;
-  if ( fgQAResultDirName.Contains(fkgLabLocalFile)) 
-    fgQAResultDirName.ReplaceAll(fkgLabLocalFile, "") ;
+  AliInfoClass(Form("AliQA::SetQAResultDirName: QA results are in  %s\n", fgQAResultDirName.Data())) ;
+  if ( fgQAResultDirName.Contains(fgkLabLocalFile)) 
+    fgQAResultDirName.ReplaceAll(fgkLabLocalFile, "") ;
   fgQAResultFileName.Prepend(fgQAResultDirName) ;
 }
 
@@ -518,23 +680,50 @@ void AliQA::ShowAll() const
 {
   // dispplay the QA status word
   Int_t index ;
-  for (index = 0 ; index < kNDET ; index++)
-    ShowStatus(DETECTORINDEX_t(index)) ;
+  for (index = 0 ; index < kNDET ; index++) {
+               for (Int_t tsk = kRAW ; tsk < kNTASK ; tsk++) {
+                       ShowStatus(DETECTORINDEX_t(index), ALITASK_t(tsk)) ;
+               }
+       }
 }
 
 //_______________________________________________________________
-void AliQA::ShowStatus(DETECTORINDEX_t det) const
+void AliQA::ShowStatus(DETECTORINDEX_t det, ALITASK_t tsk) const
 {
-  // Prints the full QA status of a given detector
-  CheckRange(det) ;
-  ULong_t status = GetStatus(det) ;
-  ULong_t rawStatus = status & 0x0000f ;
-  ULong_t simStatus = status & 0x000f0 ;
-  ULong_t recStatus = status & 0x00f00 ;
-  ULong_t esdStatus = status & 0x0f000 ;
-  ULong_t anaStatus = status & 0xf0000 ;
+       // Prints the full QA status of a given detector
+       CheckRange(det) ;
+       ULong_t status = GetStatus(det) ;
+       ULong_t tskStatus[kNTASK] ; 
+       tskStatus[kRAW] = status & 0x0000f ;
+       tskStatus[kSIM] = status & 0x000f0 ;
+       tskStatus[kREC] = status & 0x00f00 ;
+       tskStatus[kESD] = status & 0x0f000 ;
+       tskStatus[kANA] = status & 0xf0000 ;
+
+       AliInfo(Form("====> QA Status for %8s raw =0x%lx, sim=0x%lx, rec=0x%lx, esd=0x%lx, ana=0x%lx", GetDetName(det).Data(), 
+                                tskStatus[kRAW], tskStatus[kSIM], tskStatus[kREC], tskStatus[kESD], tskStatus[kANA] )) ;
+       if (tsk == kNULLTASK) {
+               for (Int_t itsk = kRAW ; itsk < kNTASK ; itsk++) {
+                       ShowASCIIStatus(det, ALITASK_t(itsk), tskStatus[itsk]) ; 
+               } 
+       } else {
+                       ShowASCIIStatus(det, tsk, tskStatus[tsk]) ; 
+       }
+}
 
-  AliInfo(Form("QA Status for %8s raw =0x%x, sim=0x%x, rec=0x%x, esd=0x%x, ana=0x%x\n", GetDetName(det).Data(), rawStatus, simStatus, recStatus, esdStatus, anaStatus )) ;
+//_______________________________________________________________
+void AliQA::ShowASCIIStatus(DETECTORINDEX_t det, ALITASK_t tsk, const ULong_t status) const 
+{
+       // print the QA status in human readable format
+       TString text; 
+       for (Int_t bit = kINFO ; bit < kNBIT ; bit++) {
+               if (IsSet(det, tsk, QABIT_t(bit))) {
+                       text = GetBitName(QABIT_t(bit)) ; 
+                       text += " " ; 
+               }
+       }
+       if (! text.IsNull())
+               AliWarningClass(Form("           %8s %4s 0x%4lx, Problem signalled: %8s \n", GetDetName(det).Data(), GetAliTaskName(tsk), status, text.Data())) ; 
 }
 
 //_______________________________________________________________