]> git.uio.no Git - u/mrichter/AliRoot.git/blobdiff - STEER/AliQA.cxx
formatting
[u/mrichter/AliRoot.git] / STEER / AliQA.cxx
index 6ea84d8b68e0b60355eebebfc83fe2f51eafd276..0387d823e03092674e0fc70f1515ef15e4c6b03f 100644 (file)
 //////////////////////////////////////////////////////////////////////////////
 
 
+#include <cstdlib>
 // --- ROOT system ---
 #include <TFile.h>
 #include <TSystem.h>
+#include <TROOT.h>
 
 // --- Standard library ---
 
 // --- AliRoot header files ---
 #include "AliLog.h"
 #include "AliQA.h"
-#include "AliQAChecker.h"
 
 
 ClassImp(AliQA)
-  AliQA * AliQA::fgQA        = 0x0 ;
-  TFile      * AliQA::fgDataFile  = 0x0 ;   
-  TString      AliQA::fgDataName  = "QA" ;   
-  TString      AliQA::fgDetNames[]  = {"ITS", "TPC", "TRD", "TOF", "PHOS", "HMPID", "EMCAL", "MUON", "FMD",
-                                       "ZDC", "PMD", "T0", "VZERO", "ACORDE", "HLT"} ;   
-  TString      AliQA::fgTaskNames[]  = {"Raws", "Hits", "SDigits", "Digits", "RecPoints", "TrackSegments", "RecParticles", "ESDs"} ;   
-
+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::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"} ;   
+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        = ""  ; 
+const TString AliQA::fkgQARefOCDBDefault = "alien://folder=/alice/QA/20"  ; 
 //____________________________________________________________________________
 AliQA::AliQA() : 
   TNamed("", ""), 
@@ -58,9 +81,11 @@ AliQA::AliQA() :
   fQA(new ULong_t[fNdet]), 
   fDet(kNULLDET),
   fTask(kNULLTASK)
+       
 {
   // default constructor
   // beware singleton: not to be used
+  
   for (Int_t index = 0 ; index < fNdet ; index++) 
        fQA[index] = 0 ; 
 }
@@ -87,12 +112,12 @@ AliQA& AliQA::operator = (const AliQA& qa)
 }
 
 //_______________________________________________________________
-AliQA::AliQA(const DETECTORINDEX det) :
+AliQA::AliQA(const DETECTORINDEX_t det) :
   TNamed("QA", "Quality Assurance status"),
   fNdet(kNDET),  
   fQA(new ULong_t[fNdet]), 
   fDet(det),
-  fTask(kNULLTASK)
+  fTask(kNULLTASK) 
 {
   // constructor to be used
   if (! CheckRange(det) ) {
@@ -105,7 +130,7 @@ AliQA::AliQA(const DETECTORINDEX det) :
 }
   
 //_______________________________________________________________
-AliQA::AliQA(const ALITASK tsk) :
+AliQA::AliQA(const ALITASK_t tsk) :
   TNamed("QA", "Quality Assurance status"), 
   fNdet(kNDET),
   fQA(new ULong_t[fNdet]), 
@@ -130,7 +155,33 @@ AliQA::~AliQA()
 }
 
 //_______________________________________________________________
-const Bool_t AliQA::CheckRange(DETECTORINDEX det) const
+void AliQA::Close() 
+{
+       // close the open files
+       if (fgQADataFile) 
+               if (fgQADataFile->IsOpen())
+                       fgQADataFile->Close() ; 
+       if (fgQAResultFile) 
+               if (fgQAResultFile->IsOpen()) 
+                       fgQAResultFile->Close() ;
+       if (fgQARefFile)
+               if (fgQARefFile->IsOpen())
+                       fgQARefFile->Close() ; 
+} 
+
+//_______________________________________________________________
+const Bool_t AliQA::CheckFatal() const
+{
+  // check if any FATAL status is set
+  Bool_t rv = kFALSE ;
+  Int_t index ;
+  for (index = 0; index < kNDET ; index++)
+    rv = rv || IsSet(DETECTORINDEX_t(index), fTask, kFATAL) ;
+  return rv ;
+}
+
+//_______________________________________________________________
+const Bool_t AliQA::CheckRange(DETECTORINDEX_t det) const
 { 
   // check if detector is in given detector range: 0-kNDET
 
@@ -141,7 +192,7 @@ const Bool_t AliQA::CheckRange(DETECTORINDEX det) const
 }
 
 //_______________________________________________________________
-const Bool_t AliQA::CheckRange(ALITASK task) const
+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 ;
@@ -151,7 +202,7 @@ const Bool_t AliQA::CheckRange(ALITASK task) const
 }
 
 //_______________________________________________________________
-const Bool_t AliQA::CheckRange(QABIT bit) const
+const Bool_t AliQA::CheckRange(QABIT_t bit) const
 { 
   // check if bit is in given bit range: 0-kNBit
 
@@ -162,36 +213,83 @@ const Bool_t AliQA::CheckRange(QABIT bit) const
 }
 
 
+
 //_______________________________________________________________
-TFile * AliQA::GetQADMOutFile(const char * name, const Int_t run, const Int_t cycle) 
+const char * AliQA::GetAliTaskName(ALITASK_t tsk)
 {
-  // opens the file to store the detectors Quality Assurance Data Maker results
-  char temp[100] ; 
-  sprintf(temp, "%s.%s.%d.%d.root", name, fgDataName.Data(), run, cycle) ; 
-  TString opt ; 
-  if (! fgDataFile ) {     
-    if  (gSystem->AccessPathName(temp))
-      opt = "NEW" ;
-    else 
-      opt = "UPDATE" ; 
-    fgDataFile = TFile::Open(temp, opt.Data()) ;
-  } else {
-   if ( (strcmp(temp, fgDataFile->GetName()) != 0) ) {
-     if  (gSystem->AccessPathName(temp))
-      opt = "NEW" ;
-    else 
-      opt = "UPDATE" ; 
-    fgDataFile = TFile::Open(temp, opt.Data()) ;
-   }
-  }
-  return fgDataFile ; 
-} 
+       // 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() ;
+}
+//_______________________________________________________________
+const 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 bitName.Data() ;
+}
+
+//_______________________________________________________________
+const AliQA::DETECTORINDEX_t AliQA::GetDetIndex(const char * name) 
+{
+       // returns the detector index corresponding to a given name
+       TString sname(name) ; 
+       DETECTORINDEX_t rv = kNULLDET ; 
+       for (Int_t det = 0; det < kNDET ; det++) {
+               if ( GetDetName(det) == sname ) {
+                       rv = DETECTORINDEX_t(det) ; 
+                       break ; 
+               }
+       }
+       return rv ;             
+}
 
 //_______________________________________________________________
 const char * AliQA::GetDetName(Int_t det) 
 {
        // returns the detector name corresponding to a given index (needed in a loop)
-
+       
        if ( det >= 0 &&  det < kNDET) 
                return (fgDetNames[det]).Data() ; 
        else 
@@ -199,48 +297,96 @@ const char * AliQA::GetDetName(Int_t det)
 }
 
 //_______________________________________________________________
-const char * AliQA::GetAliTaskName(ALITASK tsk)
+TFile * AliQA::GetQADataFile(const char * name, const Int_t run, const Int_t cycle) 
 {
-  // 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 ;
+  // 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) ; 
+       TString opt ; 
+       if (! fgQADataFile ) {     
+               if  (gSystem->AccessPathName(temp))
+                       opt = "NEW" ;
+               else 
+                       opt = "UPDATE" ; 
+               fgQADataFile = TFile::Open(temp, opt.Data()) ;
+       } else {
+               if ( strcmp(temp, fgQADataFile->GetName()) != 0 ) {
+                       fgQADataFile = dynamic_cast<TFile *>(gROOT->FindObject(temp)) ; 
+                       if ( !fgQADataFile ) {
+                               if  (gSystem->AccessPathName(temp))
+                                       opt = "NEW" ;
+                               else 
+                                       opt = "UPDATE" ; 
+                               fgQADataFile = TFile::Open(temp, opt.Data()) ;
+                       }
+               }
   }
-  return tskName.Data() ;
+       return fgQADataFile ;
+} 
+
+//_____________________________________________________________________________
+TFile * AliQA::GetQADataFile(const char * fileName)
+{
+  // Open if necessary the Data file and return its pointer
+
+  if (!fgQADataFile) 
+       if (!fileName) 
+               fileName = AliQA::GetQADataFileName() ; 
+       if  (!gSystem->AccessPathName(fileName)) {
+               fgQADataFile =  TFile::Open(fileName) ;
+       } else {
+               printf("File %s not found", fileName) ;
+               exit(1) ;  
+       }
+  return fgQADataFile ; 
 }
 
 //_______________________________________________________________
-const Bool_t AliQA::CheckFatal() const
+TFile * AliQA::GetQAResultFile() 
 {
-  // check if any FATAL status is set
-  Bool_t rv = kFALSE ;
-  Int_t index ;
-  for (index = 0; index < kNDET ; index++)
-    rv = rv || IsSet(DETECTORINDEX(index), fTask, kFATAL) ;
-  return rv ;
+  // opens the file to store the  Quality Assurance Data Checker results
+       if (fgQAResultFile) 
+               fgQAResultFile->Close() ; 
+       fgQAResultFile = 0x0 ; 
+//     if (!fgQAResultFile) { 
+               TString dirName(fgQAResultDirName) ; 
+               if ( dirName.Contains(fkgLabLocalFile)) 
+                       dirName.ReplaceAll(fkgLabLocalFile, "") ;
+               TString fileName(dirName + fgQAResultFileName) ; 
+               TString opt("") ; 
+               if ( !gSystem->AccessPathName(fileName) )
+                       opt = "UPDATE" ; 
+               else { 
+                       if ( gSystem->AccessPathName(dirName) )
+                               gSystem->mkdir(dirName) ; 
+                       opt = "NEW" ; 
+               }
+               fgQAResultFile = TFile::Open(fileName, opt) ;   
+//     }
+       
+       return fgQAResultFile ;
+}
+
+//_______________________________________________________________
+const TString AliQA::GetRunTypeName(RUNTYPE_t rt) 
+{ 
+       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()) ;  
+               }
+               printf("%s", rv.Data()) ; 
+               return "" ; 
+       }
+       else {
+               if ( rt > kNULLTYPE && rt < kNTYPE )
+                       rv = fgRTNames[rt] ; 
+       }
+       return rv ; 
 }
 
 //_______________________________________________________________
-const Bool_t AliQA::IsSet(DETECTORINDEX det, ALITASK tsk, QABIT bit) const
+const Bool_t AliQA::IsSet(DETECTORINDEX_t det, ALITASK_t tsk, QABIT_t bit) const
 {
   // Checks is the requested bit is set
 
@@ -265,12 +411,12 @@ AliQA * AliQA::Instance()
 }
 
 //_______________________________________________________________
-AliQA * AliQA::Instance(const DETECTORINDEX det)
+AliQA * AliQA::Instance(const DETECTORINDEX_t det)
 {
   // Get an instance of the singleton. The only authorized way to call the ctor
   
   if ( ! fgQA) {
-    TFile * f = AliQAChecker::GetQAResultFile() ; 
+    TFile * f = GetQAResultFile() ; 
        fgQA = dynamic_cast<AliQA *>(f->Get("QA")) ; 
     if ( ! fgQA ) 
                fgQA = new AliQA(det) ;
@@ -280,7 +426,7 @@ AliQA * AliQA::Instance(const DETECTORINDEX det)
 }
 
 //_______________________________________________________________
-AliQA * AliQA::Instance(const ALITASK tsk)
+AliQA * AliQA::Instance(const ALITASK_t tsk)
 {
   // get an instance of the singleton.
 
@@ -312,7 +458,26 @@ AliQA * AliQA::Instance(const ALITASK tsk)
 }
 
 //_______________________________________________________________
-const ULong_t AliQA::Offset(ALITASK tsk) const
+AliQA *  AliQA::Instance(const TASKINDEX_t tsk) 
+{
+       // get an instance of the singleton.
+       
+       ALITASK_t index = kNULLTASK ; 
+
+       if ( tsk == kRAWS )
+               index = kRAW ;
+       else if (tsk < kDIGITS)
+               index = kSIM ;
+       else if (tsk < kRECPARTICLES)
+               index = kREC ; 
+       else if (tsk == kESDS) 
+               index = kESD ; 
+
+       return Instance(index) ; 
+}
+
+//_______________________________________________________________
+const ULong_t AliQA::Offset(ALITASK_t tsk) const
 {
   // Calculates the bit offset for a given module (SIM, REC, ESD, ANA)
 
@@ -345,15 +510,70 @@ const ULong_t AliQA::Offset(ALITASK tsk) const
 }
 
 //_______________________________________________________________
-void AliQA::Set(QABIT bit)
+void AliQA::Set(QABIT_t bit)
 {
   // Set the status bit of the current detector in the current module
   
   SetStatusBit(fDet, fTask, bit) ;
 }
 
+//_____________________________________________________________________________
+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 ; 
+
+  else {
+         printf("ERROR: %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() ) ;
+}
+
+//_____________________________________________________________________________
+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) {
+      printf("AliQA::SetQARefDataDirName: %s is an unknown RUN TYPE name\n", name) ; 
+      return ; 
+       }
+       SetQARefDataDirName(rt) ; 
+}
+
+//_____________________________________________________________________________
+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, "") ;
+  fgQAResultFileName.Prepend(fgQAResultDirName) ;
+}
+
 //_______________________________________________________________
-void AliQA::SetStatusBit(DETECTORINDEX det, ALITASK tsk, QABIT bit)
+void AliQA::SetStatusBit(DETECTORINDEX_t det, ALITASK_t tsk, QABIT_t bit)
 {
  // Set the status bit for a given detector and a given task
 
@@ -374,21 +594,64 @@ void AliQA::ShowAll() const
   // dispplay the QA status word
   Int_t index ;
   for (index = 0 ; index < kNDET ; index++)
-    ShowStatus(DETECTORINDEX(index)) ;
+    ShowStatus(DETECTORINDEX_t(index)) ;
 }
 
 //_______________________________________________________________
-void AliQA::ShowStatus(DETECTORINDEX det) const
+void AliQA::ShowStatus(DETECTORINDEX_t det) 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%x, sim=0x%x, rec=0x%x, esd=0x%x, ana=0x%x", GetDetName(det).Data(), 
+                                tskStatus[kRAW], tskStatus[kSIM], tskStatus[kREC], tskStatus[kESD], tskStatus[kANA] )) ;
+       for (Int_t tsk = kRAW ; tsk < kNTASK ; tsk++) {
+               ShowASCIIStatus(det, ALITASK_t(tsk), tskStatus[tsk]) ; 
+       }
+}
+
+//_______________________________________________________________
+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())
+               printf("           %8s %4s 0x%4x, Problem signalled: %8s \n", GetDetName(det).Data(), GetAliTaskName(tsk), status, text.Data()) ; 
+}
 
-  AliInfo(Form("QA Status for %s 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::UnSet(QABIT_t bit)
+{
+       // UnSet the status bit of the current detector in the current module
+       
+       UnSetStatusBit(fDet, fTask, bit) ;
 }
 
+//_______________________________________________________________
+void AliQA::UnSetStatusBit(DETECTORINDEX_t det, ALITASK_t tsk, QABIT_t bit)
+{
+       // UnSet the status bit for a given detector and a given task
+       
+       CheckRange(det) ;
+       CheckRange(tsk) ;
+       CheckRange(bit) ;
+       
+       ULong_t offset = Offset(tsk) ;
+       ULong_t status = GetStatus(det) ;
+       offset+= bit ;
+       status = status & 0 << offset ;
+       SetStatus(det, status) ;
+}