[u/mrichter/AliRoot.git] / STEER / AliQAv1.h

#ifndef ALIQAv1_H
#define ALIQAv1_H
/* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
 * See cxx source for full Copyright notice                               */

/* $Id: AliQAv1.h 31503 2009-03-16 11:01:16Z schutz $ */

//
// Quality Assurance Object
//

#include <TNamed.h> 
#include <TMath.h> 
class TFile ; 

#include "AliLog.h"
#include "AliRecoParam.h"

class AliQAv1 : public TNamed {
public:
  
  enum DETECTORINDEX_t {
    kNULLDET=-1, kITS, kTPC, kTRD, kTOF, kPHOS, kHMPID, kEMCAL, kMUON, kFMD,
    kZDC, kPMD, kT0, kVZERO, kACORDE, kHLT, kGLOBAL, kCORR, kNDET};
  enum ALITASK_t {
    kNULLTASK=-1, kRAW, kSIM, kREC, kESD, kANA, kNTASK };
  enum QABIT_t {
    kNULLBit=-1, kINFO, kWARNING, kERROR, kFATAL, kNBIT };
  enum TASKINDEX_t {
    kNULLTASKINDEX=-1, kRAWS, kHITS, kSDIGITS, kDIGITS, kDIGITSR, kRECPOINTS, kTRACKSEGMENTS, kRECPARTICLES, kESDS, kNTASKINDEX };
  
  // Creators - destructors
  AliQAv1(); // beware singleton, not to be used
  AliQAv1(const Int_t qalength, ULong_t * qa, const Int_t eslength, Bool_t * es) ;
  AliQAv1(const ALITASK_t tsk) ;
  AliQAv1(const DETECTORINDEX_t det) ;
  AliQAv1(const AliQAv1& qa) ;   
  AliQAv1& operator = (const AliQAv1& qa) ;
  virtual ~AliQAv1();
  
  static  AliQAv1 *        Instance() ;
  static  AliQAv1 *        Instance(const Int_t qalength, ULong_t * qa, const Int_t eslength, Bool_t * es) ;
  static  AliQAv1 *        Instance(const DETECTORINDEX_t det) ;
  static  AliQAv1 *        Instance(const ALITASK_t tsk) ;
  static  AliQAv1 *        Instance(const TASKINDEX_t tsk) ;
  Bool_t                 CheckFatal() const ;
  static void            Close() ; 
  static const char *    GetAliTaskName(ALITASK_t tsk) ;
  Bool_t *               GetEventSpecies() { return fEventSpecies ; }
  static const TString   GetExpert() { return fgkExpert ; }
  static       UInt_t    GetExpertBit() { return fgkExpertBit ; }
  static       UInt_t    GetImageBit()  { return fgkImageBit ; }
  static const TString   GetLabLocalFile() { return fgkLabLocalFile ; } 
  static const TString   GetLabLocalOCDB() { return fgkLabLocalOCDB ; } 
  static const TString   GetLabAliEnOCDB() { return fgkLabAliEnOCDB ; } 
  static DETECTORINDEX_t GetDetIndex(const char * name) ; 
  static const TString   GetDetName(DETECTORINDEX_t det) { return fgDetNames[det] ; }
  static const char *    GetDetName(Int_t det) ;
  static const TString   GetGRPPath() { return fgGRPPath ; }  
  ULong_t *              GetQA() { return fQA ; }
  static       UInt_t    GetQABit() { return fgkQABit ; }
  static TFile *         GetQADataFile(const char * name, Int_t run) ; 
  static TFile *	       GetQADataFile(const char * fileName) ;
  static const char *    GetQADataFileName(const char * name, Int_t run) 
  {return Form("%s.%s.%d.root", name, fgQADataFileName.Data(), run)  ; }
  static const char *    GetQADataFileName() { return fgQADataFileName.Data() ; }
  static Int_t           GetQADebugLevel() { return fgkQADebugLevel ; }
  static const char *    GetQAName() { return fgkQAName ; } 
  static const char *    GetQACorrName() { return fgkQACorrNtName ; }
  static TFile *         GetQAResultFile() ; 
  static const char  *   GetQAResultFileName() { return (fgQAResultDirName + fgQAResultFileName).Data() ; }
  static const char  *   GetQARefDefaultStorage() { return fgkQARefOCDBDefault.Data() ; }
  static const char  *   GetQARefFileName() { return fgQARefFileName ; }
  static const char  *   GetQARefStorage() { return fgQARefDirName.Data() ; }
  static const char  *   GetRefOCDBDirName() { return fgkRefOCDBDirName.Data() ; }
  static const char  *   GetRefDataDirName() { return fgRefDataDirName.Data() ; }
  static     TASKINDEX_t GetTaskIndex(const char * name) ; 
  static       TString   GetTaskName(UInt_t tsk) { return fgTaskNames[tsk] ; }
  Bool_t                 IsEventSpecieSet(AliRecoParam::EventSpecie_t es) const 
  {Int_t ibit=0; while(es!=1<<ibit) ++ibit; return fEventSpecies[ibit];}
  Bool_t                 IsEventSpecieSet(Int_t es) const { return fEventSpecies[es] ; }
  Bool_t                 IsSet(DETECTORINDEX_t det, ALITASK_t tsk, AliRecoParam::EventSpecie_t es, QABIT_t bit) const ;
  Bool_t                 IsSet(DETECTORINDEX_t det, ALITASK_t tsk, Int_t es, QABIT_t bit) const ;
  Bool_t                 IsSetAny(DETECTORINDEX_t det, ALITASK_t tsk, AliRecoParam::EventSpecie_t es) const ;
  Bool_t                 IsSetAny(DETECTORINDEX_t det, AliRecoParam::EventSpecie_t es) const ;
  void                   Merge(TCollection * list) ; 
  void                   Set(QABIT_t bit, AliRecoParam::EventSpecie_t es) ;
  void                   Set(QABIT_t bit, Int_t es) ;
  void                   SetEventSpecie(AliRecoParam::EventSpecie_t es) 
  {Int_t ibit=0; while(es!=1<<ibit) ++ibit; fEventSpecies[ibit] = kTRUE ; }
  static void            SetQADebug() { AliLog::SetGlobalDebugLevel(GetQADebugLevel()); }
  static void            SetQAResultDirName(const char * name) ; 
  static void            SetQARefStorage(const char * name) ; 
  static void            SetQARefDataDirName(AliRecoParam::EventSpecie_t es) { fgRefDataDirName = AliRecoParam::GetEventSpecieName(es) ; }
  static void            SetQARefDataDirName(Int_t es) { fgRefDataDirName = AliRecoParam::GetEventSpecieName(es) ; }
  void                   Show(DETECTORINDEX_t det = kNULLDET) const ;
  void                   ShowAll() const ;
  void                   ShowStatus(DETECTORINDEX_t det, ALITASK_t tsk=kNULLTASK, AliRecoParam::EventSpecie_t es=AliRecoParam::kDefault) const ;
  void                   UnSet(QABIT_t bit, AliRecoParam::EventSpecie_t es) ;
  void                   UnSet(QABIT_t bit, Int_t es) ;
  
private:      
  
  Bool_t                CheckRange(DETECTORINDEX_t det) const ;
  Bool_t                CheckRange(ALITASK_t tsk) const ;
  Bool_t                CheckRange(QABIT_t bit) const ;
  Bool_t                CheckRange(AliRecoParam::EventSpecie_t es) const ;
  const char *          GetBitName(QABIT_t bit) const ;
  ULong_t               GetStatus(DETECTORINDEX_t det, AliRecoParam::EventSpecie_t es) const  { return fQA[det*fNEventSpecies+(Int_t)TMath::Log2(es)] ;}
  void                  Finish() const ;  
  ULong_t               Offset(ALITASK_t tsk) const ;
  void                  ShowASCIIStatus(AliRecoParam::EventSpecie_t es, DETECTORINDEX_t det, ALITASK_t tsk, ULong_t status) const ; 
  void                  ResetStatus(DETECTORINDEX_t det) ; 
  void                  Set(DETECTORINDEX_t det) { fDet = det ;}
  void                  Set(ALITASK_t tsk) { fTask = tsk ; AliDebug(GetQADebugLevel(), Form("Ready to set QA status in %s", GetAliTaskName(tsk) )) ; }
  void                  SetStatus(DETECTORINDEX_t det, AliRecoParam::EventSpecie_t es, ULong_t status) { fQA[det*fNEventSpecies+(Int_t)TMath::Log2(es)] = status ; }
  void                  SetStatusBit(DETECTORINDEX_t det, ALITASK_t tsk, AliRecoParam::EventSpecie_t es, QABIT_t bit) ;
  void                  UnSetStatusBit(DETECTORINDEX_t det, ALITASK_t tsk, AliRecoParam::EventSpecie_t es, QABIT_t bit) ;
  
  static AliQAv1 *     fgQA		                ; // pointer to the instance of the singleton
  Int_t                fNdet     	            ; // number of detectors
  Int_t                fNEventSpecies         ; // number of Event Species (see AliRecoParam)
  Int_t                fLengthQA              ; // Auxiliary length of fQA
  ULong_t    *         fQA		                ; //[fLengthQA]  the status word 4 bits for SIM, REC, ESD, ANA each
  DETECTORINDEX_t      fDet		                ; //! the current detector (ITS, TPC, ....)
  ALITASK_t            fTask	                ; //! the current environment (SIM, REC, ESD, ANA)
  AliRecoParam::EventSpecie_t fEventSpecie    ; //! the current event specie
  static TString       fgDetNames[]	          ; //! list of detector names   
  static TString       fgGRPPath              ; //! path of the GRP object in OCDB
  static TFile *       fgQADataFile	          ; //! the output file where the quality assurance maker store their results
  static TString       fgQADataFileName       ; //! the name of the file where the quality assurance maker store their results
  static TFile *       fgQARefFile	          ; //! the output file where the quality assurance maker store their results
  static TString       fgQARefDirName	        ; //! name of directory where to find the reference data file
  static TString       fgQARefFileName        ; //! file name where to find the reference data
  static TFile *       fgQAResultFile         ; //! File where to find the QA result
  static TString       fgQAResultDirName      ; //! the location of the output file where the QA results are stored  
  static TString       fgQAResultFileName     ; //! the output file where the QA results are stored  
  static TString       fgRTNames[]	          ; //! list of Run Type names   
  static TString       fgTaskNames[]	        ; //! list of tasks names   
  static const TString fgkExpert              ; //! name for the expert directory
  static const UInt_t  fgkExpertBit           ; //! TObject bit identifing the object as "expert"
  static const UInt_t  fgkImageBit            ; //! TObject bit identifing the object to be plotted on the QA image
  static const TString fgkLabLocalFile        ; //! label to identify a file as local 
  static const TString fgkLabLocalOCDB        ; //! label to identify a file as local OCDB 
  static const TString fgkLabAliEnOCDB        ; //! label to identify a file as AliEn OCDB 
  static const TString fgkRefFileName         ; //! name of Reference File Name 
  static const UInt_t  fgkQABit               ; //! bit in the QA data object which is set when Checker does not return 0
  static const Int_t   fgkQADebugLevel        ; //! debug level used for QA verbosity
  static const TString fgkQAName              ; //! name of QA object 
  static const TString fgkQACorrNtName        ; //! name of QA Correlation Ntuple
  static const TString fgkRefOCDBDirName      ; //! name of Reference directory name in OCDB  	
  static       TString fgRefDataDirName       ; //! name of Reference directory name in OCDB for data  	
  static const TString fgkQARefOCDBDefault    ; //! default storage for QA in OCDB 
  Bool_t *             fEventSpecies          ; //[fNEventSpecies] list of event species encountered in a run

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