added static method to retrieve a QA data object from a given list
[u/mrichter/AliRoot.git] / STEER / AliQAv1.h
1 #ifndef ALIQAv1_H
2 #define ALIQAv1_H
3 /* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
4  * See cxx source for full Copyright notice                               */
5
6 /* $Id: AliQAv1.h 31503 2009-03-16 11:01:16Z schutz $ */
7
8 //
9 // Quality Assurance Object
10 //
11
12 #include <TNamed.h> 
13 #include <TMath.h> 
14 class TFile ; 
15 class TH1 ; 
16
17 #include "AliLog.h"
18 #include "AliRecoParam.h"
19
20 class AliQAv1 : public TNamed {
21 public:
22   
23   enum DETECTORINDEX_t {
24     kNULLDET=-1, kITS, kTPC, kTRD, kTOF, kPHOS, kHMPID, kEMCAL, kMUON, kFMD,
25     kZDC, kPMD, kT0, kVZERO, kACORDE, kHLT, kGLOBAL, kCORR, kNDET};
26   enum ALITASK_t {
27     kNULLTASK=-1, kRAW, kSIM, kREC, kESD, kANA, kNTASK };
28   enum QABIT_t {
29     kNULLBit=-1, kINFO, kWARNING, kERROR, kFATAL, kNBIT };
30   enum TASKINDEX_t {
31     kNULLTASKINDEX=-1, kRAWS, kHITS, kSDIGITS, kDIGITS, kDIGITSR, kRECPOINTS, kTRACKSEGMENTS, kRECPARTICLES, kESDS, kNTASKINDEX };
32   enum MODE_t {kNULLMODE=0, kSIMMODE, kRECMODE};
33   
34   // Creators - destructors
35   AliQAv1(); // beware singleton, not to be used
36   AliQAv1(const Int_t qalength, ULong_t * qa, const Int_t eslength, Bool_t * es) ;
37   AliQAv1(const ALITASK_t tsk) ;
38   AliQAv1(const DETECTORINDEX_t det) ;
39   AliQAv1(const AliQAv1& qa) ;   
40   AliQAv1& operator = (const AliQAv1& qa) ;
41   virtual ~AliQAv1();
42   
43   static  AliQAv1 *      Instance() ;
44   static  AliQAv1 *      Instance(const Int_t qalength, ULong_t * qa, const Int_t eslength, Bool_t * es) ;
45   static  AliQAv1 *      Instance(const DETECTORINDEX_t det) ;
46   static  AliQAv1 *      Instance(const ALITASK_t tsk) ;
47   static  AliQAv1 *      Instance(const TASKINDEX_t tsk) ;
48   Bool_t                 CheckFatal() const ;
49   static void            Close() ; 
50   static const char *    GetAliTaskName(ALITASK_t tsk) ;
51   static  TH1 *          GetData(TObjArray** list, Int_t index, AliRecoParam::EventSpecie_t) ; 
52   Bool_t *               GetEventSpecies() { return fEventSpecies ; }
53   static const TString   GetExpert() { return fgkExpert ; }
54   static       UInt_t    GetExpertBit() { return fgkExpertBit ; }
55   static       UInt_t    GetImageBit()  { return fgkImageBit ; }
56   static const char *    GetImageFileName() { return fImageFileName.Data() ; }
57   static const char *    GetImageFileFormat() { return fImageFileFormat.Data() ; }
58   static const TString   GetLabLocalFile() { return fgkLabLocalFile ; } 
59   static const TString   GetLabLocalOCDB() { return fgkLabLocalOCDB ; } 
60   static const TString   GetLabAliEnOCDB() { return fgkLabAliEnOCDB ; } 
61   static DETECTORINDEX_t GetDetIndex(const char * name) ; 
62   static const TString   GetDetName(DETECTORINDEX_t det) { return fgDetNames[det] ; }
63   static const char *    GetDetName(Int_t det) ;
64   static const TString   GetGRPPath() { return fgGRPPath ; }  
65   ULong_t *              GetQA() { return fQA ; }
66   static       UInt_t    GetQABit() { return fgkQABit ; }
67   static TFile *         GetQADataFile(const char * name, Int_t run) ; 
68   static TFile *               GetQADataFile(const char * fileName) ;
69   static const char *    GetQADataFileName(const char * name, Int_t run) 
70   {return Form("%s.%s.%d.root", name, fgQADataFileName.Data(), run)  ; }
71   static const char *    GetQADataFileName() { return fgQADataFileName.Data() ; }
72   static Int_t           GetQADebugLevel() { return fgkQADebugLevel ; }
73   static const char *    GetQAName() { return fgkQAName ; } 
74   static const char *    GetQACorrName() { return fgkQACorrNtName ; }
75   static  UShort_t       GetMaxQAObj() { return fgkMaxQAObjects ; }
76   static TFile *         GetQAResultFile() ; 
77   static const char  *   GetQAResultFileName() { return (fgQAResultDirName + fgQAResultFileName).Data() ; }
78   static const char  *   GetQARefDefaultStorage() { return fgkQARefOCDBDefault.Data() ; }
79   static const char  *   GetQARefFileName() { return fgQARefFileName ; }
80   static const char  *   GetQARefStorage() { return fgQARefDirName.Data() ; }
81   static const char  *   GetRefOCDBDirName() { return fgkRefOCDBDirName.Data() ; }
82   static const char  *   GetRefDataDirName() { return fgRefDataDirName.Data() ; }
83   static     TASKINDEX_t GetTaskIndex(const char * name) ; 
84   static       TString   GetTaskName(UInt_t tsk) { return fgTaskNames[tsk] ; }
85   static const char *    GetModeName(MODE_t mode) { return (mode == kSIMMODE || mode == kRECMODE) ? (fgModeNames[mode]).Data() : "" ; }
86   Bool_t                 IsEventSpecieSet(AliRecoParam::EventSpecie_t es) const 
87   {Int_t ibit=0; while(es!=1<<ibit) ++ibit; return fEventSpecies[ibit];}
88   Bool_t                 IsEventSpecieSet(Int_t es) const { return fEventSpecies[es] ; }
89   Bool_t                 IsSet(DETECTORINDEX_t det, ALITASK_t tsk, AliRecoParam::EventSpecie_t es, QABIT_t bit) const ;
90   Bool_t                 IsSet(DETECTORINDEX_t det, ALITASK_t tsk, Int_t es, QABIT_t bit) const ;
91   Bool_t                 IsSetAny(DETECTORINDEX_t det, ALITASK_t tsk, AliRecoParam::EventSpecie_t es) const ;
92   Bool_t                 IsSetAny(DETECTORINDEX_t det, AliRecoParam::EventSpecie_t es) const ;
93   void                   Merge(TCollection * list) ; 
94   static MODE_t          Mode(TASKINDEX_t task) ;
95   void                   Set(QABIT_t bit, AliRecoParam::EventSpecie_t es) ;
96   void                   Set(QABIT_t bit, Int_t es) ;
97   void                   SetEventSpecie(AliRecoParam::EventSpecie_t es) 
98 //    {Int_t ibit=0; while(es!=1<<ibit) ++ibit; fEventSpecies[ibit] = kTRUE ; }
99   {if(es==AliRecoParam::kDefault) return; Int_t ibit=0; while(es!=1<<ibit) ++ibit; fEventSpecies[ibit] = kTRUE ; }
100   static void            SetQADebug() { AliLog::SetGlobalDebugLevel(GetQADebugLevel()); }
101   static void            SetQAResultDirName(const char * name) ; 
102   static void            SetQARefStorage(const char * name) ; 
103   static void            SetQARefDataDirName(AliRecoParam::EventSpecie_t es) { fgRefDataDirName = AliRecoParam::GetEventSpecieName(es) ; }
104   static void            SetQARefDataDirName(Int_t es) { fgRefDataDirName = AliRecoParam::GetEventSpecieName(es) ; }
105   void                   Show(DETECTORINDEX_t det = kNULLDET) const ;
106   void                   ShowAll() const ;
107   void                   ShowStatus(DETECTORINDEX_t det, ALITASK_t tsk=kNULLTASK, AliRecoParam::EventSpecie_t es=AliRecoParam::kDefault) const ;
108   void                   UnSet(QABIT_t bit, AliRecoParam::EventSpecie_t es) ;
109   void                   UnSet(QABIT_t bit, Int_t es) ;
110   
111 private:      
112   
113   Bool_t                CheckRange(DETECTORINDEX_t det) const ;
114   Bool_t                CheckRange(ALITASK_t tsk) const ;
115   Bool_t                CheckRange(QABIT_t bit) const ;
116   Bool_t                CheckRange(AliRecoParam::EventSpecie_t es) const ;
117   const char *          GetBitName(QABIT_t bit) const ;
118   ULong_t               GetStatus(DETECTORINDEX_t det, AliRecoParam::EventSpecie_t es) const  { return fQA[det*fNEventSpecies+(Int_t)TMath::Log2(es)] ;}
119   void                  Finish() const ;  
120   ULong_t               Offset(ALITASK_t tsk) const ;
121   void                  ShowASCIIStatus(AliRecoParam::EventSpecie_t es, DETECTORINDEX_t det, ALITASK_t tsk, ULong_t status) const ; 
122   void                  ResetStatus(DETECTORINDEX_t det) ; 
123   void                  Set(DETECTORINDEX_t det) { fDet = det ;}
124   void                  Set(ALITASK_t tsk) { fTask = tsk ; AliDebug(GetQADebugLevel(), Form("Ready to set QA status in %s", GetAliTaskName(tsk) )) ; }
125   void                  SetStatus(DETECTORINDEX_t det, AliRecoParam::EventSpecie_t es, ULong_t status) { fQA[det*fNEventSpecies+(Int_t)TMath::Log2(es)] = status ; }
126   void                  SetStatusBit(DETECTORINDEX_t det, ALITASK_t tsk, AliRecoParam::EventSpecie_t es, QABIT_t bit) ;
127   void                  UnSetStatusBit(DETECTORINDEX_t det, ALITASK_t tsk, AliRecoParam::EventSpecie_t es, QABIT_t bit) ;
128   
129   static AliQAv1 *      fgQA                           ; // pointer to the instance of the singleton
130   Int_t                 fNdet                      ; // number of detectors
131   Int_t                 fNEventSpecies         ; // number of Event Species (see AliRecoParam)
132   Int_t                 fLengthQA              ; // Auxiliary length of fQA
133   ULong_t    *          fQA                              ; //[fLengthQA]  the status word 4 bits for SIM, REC, ESD, ANA each
134   DETECTORINDEX_t       fDet                           ; //! the current detector (ITS, TPC, ....)
135   ALITASK_t             fTask                    ; //! the current environment (SIM, REC, ESD, ANA)
136   AliRecoParam::EventSpecie_t fEventSpecie     ; //! the current event specie
137   static TString        fgDetNames[]             ; //! list of detector names   
138   static TString        fgGRPPath              ; //! path of the GRP object in OCDB
139   static TFile *        fgQADataFile             ; //! the output file where the quality assurance maker store their results
140   static TString        fgQADataFileName       ; //! the name of the file where the quality assurance maker store their results
141   static TFile *        fgQARefFile                ; //! the output file where the quality assurance maker store their results
142   static TString        fgQARefDirName         ; //! name of directory where to find the reference data file
143   static TString        fgQARefFileName        ; //! file name where to find the reference data
144   static TFile *        fgQAResultFile         ; //! File where to find the QA result
145   static TString        fgQAResultDirName      ; //! the location of the output file where the QA results are stored  
146   static TString        fgQAResultFileName     ; //! the output file where the QA results are stored  
147   static TString        fgRTNames[]                ; //! list of Run Type names   
148   static TString        fgTaskNames[]            ; //! list of tasks names   
149   static TString        fgModeNames[]            ; //! list of mode names   
150   static const TString  fgkExpert              ; //! name for the expert directory
151   static const UInt_t   fgkExpertBit           ; //! TObject bit identifing the object as "expert"
152   static const UInt_t   fgkImageBit            ; //! TObject bit identifing the object to be plotted on the QA image
153   static const TString  fgkLabLocalFile        ; //! label to identify a file as local 
154   static const TString  fgkLabLocalOCDB        ; //! label to identify a file as local OCDB 
155   static const TString  fgkLabAliEnOCDB        ; //! label to identify a file as AliEn OCDB 
156   static const TString  fgkRefFileName         ; //! name of Reference File Name 
157   static const UInt_t   fgkQABit               ; //! bit in the QA data object which is set when Checker does not return 0
158   static const Int_t    fgkQADebugLevel        ; //! debug level used for QA verbosity
159   static const TString  fgkQAName              ; //! name of QA object 
160   static const TString  fgkQACorrNtName        ; //! name of QA Correlation Ntuple
161   static const TString  fgkRefOCDBDirName      ; //! name of Reference directory name in OCDB   
162   static       TString  fgRefDataDirName       ; //! name of Reference directory name in OCDB for data          
163   static const TString  fgkQARefOCDBDefault    ; //! default storage for QA in OCDB 
164   Bool_t *              fEventSpecies          ; //[fNEventSpecies] list of event species encountered in a run
165   static const TString  fImageFileName         ; //! name of the file that contains all the QA images
166   static const TString  fImageFileFormat       ; //! format of the file that contains all the QA images
167   static const UShort_t fgkMaxQAObjects        ;//! maximum number of QA objects allowed dor each task (Raws, digits,....) 
168
169  ClassDef(AliQAv1,3)  //ALICE Quality Assurance Object
170 };
171 #endif