[u/mrichter/AliRoot.git] / STEER / AliQA.cxx


/**************************************************************************
 * Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
 *                                                                        *
 * Author: The ALICE Off-line Project.                                    *
 * Contributors are mentioned in the code where appropriate.              *
 *                                                                        *
 * Permission to use, copy, modify and distribute this software and its   *
 * documentation strictly for non-commercial purposes is hereby granted   *
 * without fee, provided that the above copyright notice appears in all   *
 * copies and that both the copyright notice and this permission notice   *
 * appear in the supporting documentation. The authors make no claims     *
 * about the suitability of this software for any purpose. It is          *
 * provided "as is" without express or implied warranty.                  *
 **************************************************************************/
/* $Id$ */

//////////////////////////////////////////////////////////////////////////////
//
// 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)
// Each of the 4 bits corresponds to a severity level of increasing importance
// from lower to higher bit (INFO, WARNING, ERROR, FATAL)
//
//*-- Yves Schutz CERN, July 2007 
//////////////////////////////////////////////////////////////////////////////


#include <cstdlib>
// --- ROOT system ---
#include <TFile.h>
#include <TSystem.h>
#include <TROOT.h>

// --- Standard library ---

// --- AliRoot header files ---
#include "AliLog.h"
#include "AliQA.h"


ClassImp(AliQA)
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::fgRTNames[]            = {"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("", ""), 
  fNdet(kNDET), 
  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 ; 
}

//____________________________________________________________________________
AliQA::AliQA(const AliQA& qa) :
  TNamed(qa),
  fNdet(qa.fNdet), 
  fQA(qa.fQA), 
  fDet(qa.fDet),
  fTask(qa.fTask)
{ 
  // cpy ctor
}

//_____________________________________________________________________________
AliQA& AliQA::operator = (const AliQA& qa)
{
// assignment operator

  this->~AliQA();
  new(this) AliQA(qa);
  return *this;
}

//_______________________________________________________________
AliQA::AliQA(const DETECTORINDEX_t det) :
  TNamed("QA", "Quality Assurance status"),
  fNdet(kNDET),  
  fQA(new ULong_t[fNdet]), 
  fDet(det),
  fTask(kNULLTASK) 
{
  // constructor to be used
  if (! CheckRange(det) ) {
    fDet = kNULLDET ; 
    return ;
  } 
  Int_t index ; 
  for (index = 0; index < fNdet; index++) 
    fQA[index] = 0 ; 
}
  
//_______________________________________________________________
AliQA::AliQA(const ALITASK_t tsk) :
  TNamed("QA", "Quality Assurance status"), 
  fNdet(kNDET),
  fQA(new ULong_t[fNdet]), 
  fDet(kNULLDET),
  fTask(tsk)
{
  // constructor to be used in the AliRoot module (SIM, REC, ESD or ANA)
  if (! CheckRange(tsk) ) {
    fTask = kNULLTASK ; 
    return ;
  } 
  Int_t index ; 
  for (index = 0; index < fNdet; index++) 
    fQA[index] = 0 ; 
}

//____________________________________________________________________________
AliQA::~AliQA() 
{
  // dtor  
  delete[] fQA ;
}

//_______________________________________________________________
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

  Bool_t rv = ( det < 0 || det > kNDET )  ? kFALSE : kTRUE ;
  if (!rv)
    AliFatal(Form("Detector index %d is out of range: 0 <= index <= %d", det, kNDET)) ;
  return rv ;
}

//_______________________________________________________________
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 ;
  if (!rv)
    AliFatal(Form("Module index %d is out of range: 0 <= index <= %d", task, kNTASK)) ;
  return rv ;
}

//_______________________________________________________________
const Bool_t AliQA::CheckRange(QABIT_t bit) const
{ 
  // check if bit is in given bit range: 0-kNBit

  Bool_t rv = ( bit < 0 || bit > kNBIT )  ? kFALSE : kTRUE ;
  if (!rv)
    AliFatal(Form("Status bit %d is out of range: 0 <= bit <= %d", bit, kNBIT)) ;
  return rv ;
}


//_______________________________________________________________
const 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() ;
}
//_______________________________________________________________
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 
		return NULL ; 
}

//_______________________________________________________________
TFile * AliQA::GetQADataFile(const char * name, const Int_t run, const Int_t cycle) 
{
  // 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 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 ; 
}

//_______________________________________________________________
TFile * AliQA::GetQAResultFile() 
{
  // 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_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 ;
  status = (status & 1 << offset) != 0 ;
  return status ;
}

//_______________________________________________________________
AliQA * AliQA::Instance()
{
  // Get an instance of the singleton.
  // Object must have been instantiated with Instance(ALITASK) first

  return fgQA ;
}

//_______________________________________________________________
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 = GetQAResultFile() ; 
	fgQA = dynamic_cast<AliQA *>(f->Get("QA")) ; 
    if ( ! fgQA ) 
		fgQA = new AliQA(det) ;
  }		
  fgQA->Set(det) ;
  return fgQA ;
}

//_______________________________________________________________
AliQA * AliQA::Instance(const ALITASK_t tsk)
{
  // get an instance of the singleton.

  if ( ! fgQA)
    switch (tsk) {
    case kNULLTASK:
      break ;
	case kRAW:
      fgQA = new AliQA(tsk) ;
      break ;
	case kSIM:
      fgQA = new AliQA(tsk) ;
      break ;
    case kREC:
      printf("fgQA = gAlice->GetQA()") ;
      break ;
    case kESD:
      printf("fgQA = dynamic_cast<AliQA *> (esdFile->Get(\"QA\")") ;
      break ;
    case kANA:
      printf("fgQA = dynamic_cast<AliQA *> (esdFile->Get(\"QA\")") ;
      break ;
    case kNTASK:
      break ;
    }
  if (fgQA) 
    fgQA->Set(tsk) ;
  return fgQA ;
}

//_______________________________________________________________
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)

  CheckRange(tsk) ; 

  ULong_t offset = 0 ;
  switch (tsk) {
  case kNULLTASK:
    break ;
  case kRAW:
    offset+= 0 ;
    break ;
  case kSIM:
    offset+= 4 ;
    break ;
  case kREC:
    offset+= 8 ;
    break ;
  case kESD:
    offset+= 12 ;
    break ;
  case kANA:
    offset+= 16 ;
    break ;
  case kNTASK:
    break ;
  }

  return offset ;
}

//_______________________________________________________________
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::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_t det, ALITASK_t tsk, QABIT_t bit)
{
 // Set 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 | 1 << offset ;
  SetStatus(det, status) ;
}

//_______________________________________________________________
void AliQA::ShowAll() const
{
  // dispplay the QA status word
  Int_t index ;
  for (index = 0 ; index < kNDET ; index++)
    ShowStatus(DETECTORINDEX_t(index)) ;
}

//_______________________________________________________________
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 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()) ; 
}

//_______________________________________________________________
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) ;
}
Commit	Line	Data
8661738e	1
421ab0fb	2	/**************************************************************************
	3	* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
	4	* *
	5	* Author: The ALICE Off-line Project. *
	6	* Contributors are mentioned in the code where appropriate. *
	7	* *
	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	**************************************************************************/
	16	/* $Id$ */
	17
	18	//////////////////////////////////////////////////////////////////////////////
	19	//
	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 (SIM)
	24	// bit 4-7 : QA raised during reconstruction (REC)
	25	// bit 8-11 : QA raised during ESD checking (ESD)
	26	// bit 12-15: QA raised during analysis (ANA)
	27	// Each of the 4 bits corresponds to a severity level of increasing importance
	28	// from lower to higher bit (INFO, WARNING, ERROR, FATAL)
	29	//
	30	//*-- Yves Schutz CERN, July 2007
	31	//////////////////////////////////////////////////////////////////////////////
	32
	33
b09247a2	34	#include <cstdlib>
421ab0fb	35	// --- ROOT system ---
	36	#include <TFile.h>
	37	#include <TSystem.h>
0d13dd63	38	#include <TROOT.h>
421ab0fb	39
	40	// --- Standard library ---
	41
	42	// --- AliRoot header files ---
	43	#include "AliLog.h"
2e42b4d4	44	#include "AliQA.h"
421ab0fb	45
421ab0fb	46
2e42b4d4	47	ClassImp(AliQA)
f73f556a	48	AliQA * AliQA::fgQA = 0x0 ;
	49	TFile * AliQA::fgQADataFile = 0x0 ;
	50	TString AliQA::fgQADataFileName = "QA" ; // will transform into Det.QA.run.cycle.root
	51	TFile * AliQA::fgQARefFile = 0x0 ;
	52	TString AliQA::fgQARefDirName = "" ;
	53	TString AliQA::fgQARefFileName = "QA.root" ;
	54	TFile * AliQA::fgQAResultFile = 0x0 ;
	55	TString AliQA::fgQAResultDirName = "" ;
	56	TString AliQA::fgQAResultFileName = "QA.root" ;
	57	TString AliQA::fgDetNames[] = {"ITS", "TPC", "TRD", "TOF", "PHOS", "HMPID", "EMCAL", "MUON", "FMD",
7c002d48	58	"ZDC", "PMD", "T0", "VZERO", "ACORDE", "HLT", "Global"} ;
51757634	59	TString AliQA::fgRTNames[] = {"AUTO_TEST", "CALIBRATION", "CALIBRATION_PULSER", "CHANNEL_DELAY_TUNING", "COSMIC",
	60	"COSMICS", "DAQ_FO_UNIF_SCAN", "DAQ_GEN_DAC_SCAN", "DAQ_MEAN_TH_SCAN", "DAQ_MIN_TH_SCAN",
	61	"DAQ_NOISY_PIX_SCAN", "DAQ_PIX_DELAY_SCAN", "DAQ_UNIFORMITY_SCAN", "DCS_FO_UNIF_SCAN",
	62	"DCS_MEAN_TH_SCAN", "DCS_MIN_TH_SCAN", "DCS_PIX_DELAY_SCAN", "DCS_UNIFORMITY_SCAN",
	63	"DDL_TEST", "GAIN", "PEDESTAL", "INJECTOR", "LASER", "MONTECARLO", "NOISE", "NOISY_PIX_SCAN",
	64	"PHYSICS", "PULSER", "STANDALONE", "STANDALONE_BC", "STANDALONE_CENTRAL", "STANDALONE_COSMIC",
	65	"STANDALONE_EMD", "STANDALONE_LASER", "STANDALONE_MB", "STANDALONE_PEDESTAL",
	66	"STANDALONE_SEMICENTRAL", "STANDALONE_PULSER" } ;
f73f556a	67	TString AliQA::fgTaskNames[] = {"Raws", "Hits", "SDigits", "Digits", "RecPoints", "TrackSegments", "RecParticles", "ESDs"} ;
	68	const TString AliQA::fkgLabLocalFile = "file://" ;
	69	const TString AliQA::fkgLabLocalOCDB = "local://" ;
	70	const TString AliQA::fkgLabAliEnOCDB = "alien://" ;
	71	const TString AliQA::fkgRefFileName = "QA.root" ;
96d67a8d	72	const TString AliQA::fkgQAName = "QA" ;
f73f556a	73	const TString AliQA::fkgRefOCDBDirName = "Ref" ;
51757634	74	TString AliQA::fkgRefDataDirName = "" ;
13c8b505	75	const TString AliQA::fkgQARefOCDBDefault = "alien://folder=/alice/QA/20" ;
421ab0fb	76	//____________________________________________________________________________
2e42b4d4	77	AliQA::AliQA() :
421ab0fb	78	TNamed("", ""),
9a223722	79	fNdet(kNDET),
9a223722	80	fQA(new ULong_t[fNdet]),
421ab0fb	81	fDet(kNULLDET),
421ab0fb	82	fTask(kNULLTASK)
4edbc5bc	83
421ab0fb	84	{
	85	// default constructor
	86	// beware singleton: not to be used
4ecde5fc	87
9a223722	88	for (Int_t index = 0 ; index < fNdet ; index++)
9a223722	89	fQA[index] = 0 ;
421ab0fb	90	}
	91
	92	//____________________________________________________________________________
2e42b4d4	93	AliQA::AliQA(const AliQA& qa) :
421ab0fb	94	TNamed(qa),
9a223722	95	fNdet(qa.fNdet),
421ab0fb	96	fQA(qa.fQA),
	97	fDet(qa.fDet),
	98	fTask(qa.fTask)
	99	{
	100	// cpy ctor
	101	}
	102
	103	//_____________________________________________________________________________
2e42b4d4	104	AliQA& AliQA::operator = (const AliQA& qa)
421ab0fb	105	{
	106	// assignment operator
	107
2e42b4d4	108	this->~AliQA();
2e42b4d4	109	new(this) AliQA(qa);
421ab0fb	110	return *this;
	111	}
	112
	113	//_______________________________________________________________
96d67a8d	114	AliQA::AliQA(const DETECTORINDEX_t det) :
9a223722	115	TNamed("QA", "Quality Assurance status"),
	116	fNdet(kNDET),
	117	fQA(new ULong_t[fNdet]),
a5fa6165	118	fDet(det),
4edbc5bc	119	fTask(kNULLTASK)
a5fa6165	120	{
	121	// constructor to be used
	122	if (! CheckRange(det) ) {
	123	fDet = kNULLDET ;
	124	return ;
a4976ef3	125	}
a5fa6165	126	Int_t index ;
9a223722	127	for (index = 0; index < fNdet; index++)
a5fa6165	128	fQA[index] = 0 ;
	129	}
	130
	131	//_______________________________________________________________
96d67a8d	132	AliQA::AliQA(const ALITASK_t tsk) :
421ab0fb	133	TNamed("QA", "Quality Assurance status"),
9a223722	134	fNdet(kNDET),
9a223722	135	fQA(new ULong_t[fNdet]),
421ab0fb	136	fDet(kNULLDET),
	137	fTask(tsk)
	138	{
	139	// constructor to be used in the AliRoot module (SIM, REC, ESD or ANA)
	140	if (! CheckRange(tsk) ) {
	141	fTask = kNULLTASK ;
	142	return ;
a4976ef3	143	}
a5fa6165	144	Int_t index ;
9a223722	145	for (index = 0; index < fNdet; index++)
a5fa6165	146	fQA[index] = 0 ;
421ab0fb	147	}
	148
	149	//____________________________________________________________________________
2e42b4d4	150	AliQA::~AliQA()
421ab0fb	151	{
	152	// dtor
	153	delete[] fQA ;
	154	}
	155
46ca5304	156	//_______________________________________________________________
	157	void AliQA::Close()
	158	{
	159	// close the open files
	160	if (fgQADataFile)
	161	if (fgQADataFile->IsOpen())
	162	fgQADataFile->Close() ;
	163	if (fgQAResultFile)
	164	if (fgQAResultFile->IsOpen())
	165	fgQAResultFile->Close() ;
	166	if (fgQARefFile)
	167	if (fgQARefFile->IsOpen())
	168	fgQARefFile->Close() ;
	169	}
	170
4ecde5fc	171	//_______________________________________________________________
	172	const Bool_t AliQA::CheckFatal() const
	173	{
	174	// check if any FATAL status is set
	175	Bool_t rv = kFALSE ;
	176	Int_t index ;
	177	for (index = 0; index < kNDET ; index++)
96d67a8d	178	rv = rv \|\| IsSet(DETECTORINDEX_t(index), fTask, kFATAL) ;
4ecde5fc	179	return rv ;
	180	}
	181
421ab0fb	182	//_______________________________________________________________
96d67a8d	183	const Bool_t AliQA::CheckRange(DETECTORINDEX_t det) const
421ab0fb	184	{
a4976ef3	185	// check if detector is in given detector range: 0-kNDET
421ab0fb	186
a5fa6165	187	Bool_t rv = ( det < 0 \|\| det > kNDET ) ? kFALSE : kTRUE ;
421ab0fb	188	if (!rv)
	189	AliFatal(Form("Detector index %d is out of range: 0 <= index <= %d", det, kNDET)) ;
	190	return rv ;
	191	}
	192
	193	//_______________________________________________________________
96d67a8d	194	const Bool_t AliQA::CheckRange(ALITASK_t task) const
421ab0fb	195	{
421ab0fb	196	// check if task is given taskk range: 0:kNTASK
6c18591a	197	Bool_t rv = ( task < kRAW \|\| task > kNTASK ) ? kFALSE : kTRUE ;
421ab0fb	198	if (!rv)
	199	AliFatal(Form("Module index %d is out of range: 0 <= index <= %d", task, kNTASK)) ;
	200	return rv ;
	201	}
	202
	203	//_______________________________________________________________
96d67a8d	204	const Bool_t AliQA::CheckRange(QABIT_t bit) const
421ab0fb	205	{
	206	// check if bit is in given bit range: 0-kNBit
	207
	208	Bool_t rv = ( bit < 0 \|\| bit > kNBIT ) ? kFALSE : kTRUE ;
	209	if (!rv)
	210	AliFatal(Form("Status bit %d is out of range: 0 <= bit <= %d", bit, kNBIT)) ;
	211	return rv ;
	212	}
	213
421ab0fb	214
4ecde5fc	215
a5fa6165	216	//_______________________________________________________________
96d67a8d	217	const char * AliQA::GetAliTaskName(ALITASK_t tsk)
421ab0fb	218	{
0b96c27c	219	// returns the char name corresponding to module index
	220	TString tskName ;
	221	switch (tsk) {
	222	case kNULLTASK:
	223	break ;
	224	case kRAW:
	225	tskName = "RAW" ;
	226	break ;
	227	case kSIM:
	228	tskName = "SIM" ;
	229	break ;
	230	case kREC:
	231	tskName = "REC" ;
	232	break ;
	233	case kESD:
	234	tskName = "ESD" ;
	235	break ;
	236	case kANA:
	237	tskName = "ANA" ;
	238	break ;
	239	default:
	240	tsk = kNULLTASK ;
	241	break ;
	242	}
	243	return tskName.Data() ;
	244	}
	245	//_______________________________________________________________
	246	const char * AliQA::GetBitName(QABIT_t bit) const
	247	{
	248	// returns the char name corresponding to bit
	249	TString bitName ;
	250	switch (bit) {
	251	case kNULLBit:
	252	break ;
	253	case kINFO:
	254	bitName = "INFO" ;
	255	break ;
	256	case kWARNING:
	257	bitName = "WARNING" ;
	258	break ;
	259	case kERROR:
	260	bitName = "ERROR" ;
	261	break ;
	262	case kFATAL:
	263	bitName = "FATAL" ;
	264	break ;
	265	default:
	266	bit = kNULLBit ;
	267	break ;
	268	}
	269	return bitName.Data() ;
421ab0fb	270	}
421ab0fb	271
46ca5304	272	//_______________________________________________________________
7c002d48	273	const AliQA::DETECTORINDEX_t AliQA::GetDetIndex(const char * name)
96d67a8d	274	{
	275	// returns the detector index corresponding to a given name
	276	TString sname(name) ;
	277	DETECTORINDEX_t rv = kNULLDET ;
	278	for (Int_t det = 0; det < kNDET ; det++) {
	279	if ( GetDetName(det) == sname ) {
	280	rv = DETECTORINDEX_t(det) ;
	281	break ;
	282	}
	283	}
	284	return rv ;
	285	}
	286
7c002d48	287	//_______________________________________________________________
	288	const char * AliQA::GetDetName(Int_t det)
	289	{
	290	// returns the detector name corresponding to a given index (needed in a loop)
	291
	292	if ( det >= 0 && det < kNDET)
	293	return (fgDetNames[det]).Data() ;
	294	else
	295	return NULL ;
	296	}
	297
46ca5304	298	//_______________________________________________________________
	299	TFile * AliQA::GetQADataFile(const char * name, const Int_t run, const Int_t cycle)
	300	{
	301	// opens the file to store the detectors Quality Assurance Data Maker results
96d67a8d	302	const char * temp = Form("%s.%s.%d.%d.root", name, fgQADataFileName.Data(), run, cycle) ;
	303	TString opt ;
	304	if (! fgQADataFile ) {
	305	if (gSystem->AccessPathName(temp))
	306	opt = "NEW" ;
	307	else
	308	opt = "UPDATE" ;
	309	fgQADataFile = TFile::Open(temp, opt.Data()) ;
	310	} else {
	311	if ( strcmp(temp, fgQADataFile->GetName()) != 0 ) {
	312	fgQADataFile = dynamic_cast<TFile *>(gROOT->FindObject(temp)) ;
	313	if ( !fgQADataFile ) {
	314	if (gSystem->AccessPathName(temp))
	315	opt = "NEW" ;
	316	else
	317	opt = "UPDATE" ;
	318	fgQADataFile = TFile::Open(temp, opt.Data()) ;
	319	}
	320	}
46ca5304	321	}
96d67a8d	322	return fgQADataFile ;
46ca5304	323	}
	324
	325	//_____________________________________________________________________________
	326	TFile * AliQA::GetQADataFile(const char * fileName)
	327	{
	328	// Open if necessary the Data file and return its pointer
	329
	330	if (!fgQADataFile)
	331	if (!fileName)
	332	fileName = AliQA::GetQADataFileName() ;
	333	if (!gSystem->AccessPathName(fileName)) {
	334	fgQADataFile = TFile::Open(fileName) ;
	335	} else {
	336	printf("File %s not found", fileName) ;
	337	exit(1) ;
	338	}
	339	return fgQADataFile ;
	340	}
	341
4ecde5fc	342	//_______________________________________________________________
	343	TFile * AliQA::GetQAResultFile()
	344	{
	345	// opens the file to store the Quality Assurance Data Checker results
2ba0b5f5	346	if (fgQAResultFile)
	347	fgQAResultFile->Close() ;
	348	fgQAResultFile = 0x0 ;
	349	// if (!fgQAResultFile) {
1c0190ec	350	TString dirName(fgQAResultDirName) ;
4edbc5bc	351	if ( dirName.Contains(fkgLabLocalFile))
4edbc5bc	352	dirName.ReplaceAll(fkgLabLocalFile, "") ;
1c0190ec	353	TString fileName(dirName + fgQAResultFileName) ;
46ca5304	354	TString opt("") ;
	355	if ( !gSystem->AccessPathName(fileName) )
	356	opt = "UPDATE" ;
5bd22145	357	else {
1c0190ec	358	if ( gSystem->AccessPathName(dirName) )
1c0190ec	359	gSystem->mkdir(dirName) ;
46ca5304	360	opt = "NEW" ;
5bd22145	361	}
46ca5304	362	fgQAResultFile = TFile::Open(fileName, opt) ;
2ba0b5f5	363	// }
46ca5304	364
46ca5304	365	return fgQAResultFile ;
421ab0fb	366	}
421ab0fb	367
51757634	368	//_______________________________________________________________
	369	const TString AliQA::GetRunTypeName(RUNTYPE_t rt)
	370	{
	371	TString rv("Invalid Run Type") ;
	372	if ( rt == kNULLTYPE ) {
	373	rv = "Known RUN_TYPE are: \n" ;
	374	for (Int_t index = 0 ; index < kNTYPE; index++) {
	375	rv += Form("%2d -- %s\n", index, fgRTNames[index].Data()) ;
	376	}
	377	printf("%s", rv.Data()) ;
	378	return "" ;
	379	}
	380	else {
	381	if ( rt > kNULLTYPE && rt < kNTYPE )
	382	rv = fgRTNames[rt] ;
	383	}
	384	return rv ;
	385	}
	386
421ab0fb	387	//_______________________________________________________________
96d67a8d	388	const Bool_t AliQA::IsSet(DETECTORINDEX_t det, ALITASK_t tsk, QABIT_t bit) const
421ab0fb	389	{
	390	// Checks is the requested bit is set
	391
	392	CheckRange(det) ;
	393	CheckRange(tsk) ;
	394	CheckRange(bit) ;
	395
	396	ULong_t offset = Offset(tsk) ;
	397	ULong_t status = GetStatus(det) ;
	398	offset+= bit ;
	399	status = (status & 1 << offset) != 0 ;
	400	return status ;
	401	}
	402
	403	//_______________________________________________________________
2e42b4d4	404	AliQA * AliQA::Instance()
421ab0fb	405	{
	406	// Get an instance of the singleton.
	407	// Object must have been instantiated with Instance(ALITASK) first
	408
	409	return fgQA ;
	410	}
	411
	412	//_______________________________________________________________
96d67a8d	413	AliQA * AliQA::Instance(const DETECTORINDEX_t det)
421ab0fb	414	{
	415	// Get an instance of the singleton. The only authorized way to call the ctor
	416
9a223722	417	if ( ! fgQA) {
46ca5304	418	TFile * f = GetQAResultFile() ;
9a223722	419	fgQA = dynamic_cast<AliQA *>(f->Get("QA")) ;
	420	if ( ! fgQA )
	421	fgQA = new AliQA(det) ;
	422	}
421ab0fb	423	fgQA->Set(det) ;
	424	return fgQA ;
	425	}
	426
	427	//_______________________________________________________________
96d67a8d	428	AliQA * AliQA::Instance(const ALITASK_t tsk)
421ab0fb	429	{
	430	// get an instance of the singleton.
	431
	432	if ( ! fgQA)
	433	switch (tsk) {
	434	case kNULLTASK:
	435	break ;
6c18591a	436	case kRAW:
2e42b4d4	437	fgQA = new AliQA(tsk) ;
6c18591a	438	break ;
6c18591a	439	case kSIM:
2e42b4d4	440	fgQA = new AliQA(tsk) ;
421ab0fb	441	break ;
	442	case kREC:
	443	printf("fgQA = gAlice->GetQA()") ;
	444	break ;
	445	case kESD:
	446	printf("fgQA = dynamic_cast<AliQA *> (esdFile->Get(\"QA\")") ;
	447	break ;
	448	case kANA:
	449	printf("fgQA = dynamic_cast<AliQA *> (esdFile->Get(\"QA\")") ;
	450	break ;
	451	case kNTASK:
	452	break ;
	453	}
	454	if (fgQA)
	455	fgQA->Set(tsk) ;
	456	return fgQA ;
	457	}
	458
	459	//_______________________________________________________________
96d67a8d	460	AliQA * AliQA::Instance(const TASKINDEX_t tsk)
	461	{
	462	// get an instance of the singleton.
	463
	464	ALITASK_t index = kNULLTASK ;
	465
	466	if ( tsk == kRAWS )
	467	index = kRAW ;
	468	else if (tsk < kDIGITS)
	469	index = kSIM ;
	470	else if (tsk < kRECPARTICLES)
	471	index = kREC ;
	472	else if (tsk == kESDS)
	473	index = kESD ;
	474
	475	return Instance(index) ;
	476	}
	477
	478	//_______________________________________________________________
	479	const ULong_t AliQA::Offset(ALITASK_t tsk) const
421ab0fb	480	{
	481	// Calculates the bit offset for a given module (SIM, REC, ESD, ANA)
	482
	483	CheckRange(tsk) ;
	484
	485	ULong_t offset = 0 ;
	486	switch (tsk) {
	487	case kNULLTASK:
	488	break ;
6c18591a	489	case kRAW:
421ab0fb	490	offset+= 0 ;
421ab0fb	491	break ;
6c18591a	492	case kSIM:
421ab0fb	493	offset+= 4 ;
421ab0fb	494	break ;
6c18591a	495	case kREC:
421ab0fb	496	offset+= 8 ;
421ab0fb	497	break ;
6c18591a	498	case kESD:
421ab0fb	499	offset+= 12 ;
421ab0fb	500	break ;
6c18591a	501	case kANA:
	502	offset+= 16 ;
	503	break ;
421ab0fb	504	case kNTASK:
	505	break ;
	506	}
	507
	508	return offset ;
	509	}
	510
	511	//_______________________________________________________________
96d67a8d	512	void AliQA::Set(QABIT_t bit)
421ab0fb	513	{
	514	// Set the status bit of the current detector in the current module
	515
	516	SetStatusBit(fDet, fTask, bit) ;
	517	}
	518
4ecde5fc	519	//_____________________________________________________________________________
4edbc5bc	520	void AliQA::SetQARefStorage(const char * name)
4ecde5fc	521	{
72c25501	522	// Set the root directory where the QA reference data are stored
	523
	524	fgQARefDirName = name ;
	525	if ( fgQARefDirName.Contains(fkgLabLocalFile) )
	526	fgQARefFileName = fkgRefFileName ;
	527	else if ( fgQARefDirName.Contains(fkgLabLocalOCDB) )
96d67a8d	528	fgQARefFileName = fkgQAName ;
72c25501	529	else if ( fgQARefDirName.Contains(fkgLabAliEnOCDB) )
96d67a8d	530	fgQARefFileName = fkgQAName ;
4ecde5fc	531
4edbc5bc	532	else {
	533	printf("ERROR: %s is an invalid storage definition\n", name) ;
	534	fgQARefDirName = "" ;
	535	fgQARefFileName = "" ;
	536	}
72c25501	537	TString tmp(fgQARefDirName) ; // + fgQARefFileName) ;
4edbc5bc	538	printf("AliQA::SetQARefDir: QA references are in %s\n", tmp.Data() ) ;
4ecde5fc	539	}
	540
	541	//_____________________________________________________________________________
	542	void AliQA::SetQAResultDirName(const char * name)
	543	{
	544	// Set the root directory where to store the QA status object
	545
	546	fgQAResultDirName.Prepend(name) ;
	547	printf("AliQA::SetQAResultDirName: QA results are in %s\n", fgQAResultDirName.Data()) ;
4edbc5bc	548	if ( fgQAResultDirName.Contains(fkgLabLocalFile))
4edbc5bc	549	fgQAResultDirName.ReplaceAll(fkgLabLocalFile, "") ;
4ecde5fc	550	fgQAResultFileName.Prepend(fgQAResultDirName) ;
	551	}
	552
421ab0fb	553	//_______________________________________________________________
96d67a8d	554	void AliQA::SetStatusBit(DETECTORINDEX_t det, ALITASK_t tsk, QABIT_t bit)
421ab0fb	555	{
	556	// Set the status bit for a given detector and a given task
	557
	558	CheckRange(det) ;
	559	CheckRange(tsk) ;
	560	CheckRange(bit) ;
	561
	562	ULong_t offset = Offset(tsk) ;
	563	ULong_t status = GetStatus(det) ;
	564	offset+= bit ;
	565	status = status \| 1 << offset ;
	566	SetStatus(det, status) ;
	567	}
	568
	569	//_______________________________________________________________
2e42b4d4	570	void AliQA::ShowAll() const
421ab0fb	571	{
	572	// dispplay the QA status word
	573	Int_t index ;
	574	for (index = 0 ; index < kNDET ; index++)
96d67a8d	575	ShowStatus(DETECTORINDEX_t(index)) ;
421ab0fb	576	}
	577
	578	//_______________________________________________________________
96d67a8d	579	void AliQA::ShowStatus(DETECTORINDEX_t det) const
421ab0fb	580	{
0b96c27c	581	// Prints the full QA status of a given detector
	582	CheckRange(det) ;
	583	ULong_t status = GetStatus(det) ;
	584	ULong_t tskStatus[kNTASK] ;
	585	tskStatus[kRAW] = status & 0x0000f ;
	586	tskStatus[kSIM] = status & 0x000f0 ;
	587	tskStatus[kREC] = status & 0x00f00 ;
	588	tskStatus[kESD] = status & 0x0f000 ;
	589	tskStatus[kANA] = status & 0xf0000 ;
	590
	591	AliInfo(Form("====> QA Status for %8s raw =0x%x, sim=0x%x, rec=0x%x, esd=0x%x, ana=0x%x", GetDetName(det).Data(),
	592	tskStatus[kRAW], tskStatus[kSIM], tskStatus[kREC], tskStatus[kESD], tskStatus[kANA] )) ;
	593	for (Int_t tsk = kRAW ; tsk < kNTASK ; tsk++) {
	594	ShowASCIIStatus(det, ALITASK_t(tsk), tskStatus[tsk]) ;
	595	}
	596	}
421ab0fb	597
0b96c27c	598	//_______________________________________________________________
	599	void AliQA::ShowASCIIStatus(DETECTORINDEX_t det, ALITASK_t tsk, const ULong_t status) const
	600	{
	601	// print the QA status in human readable format
	602	TString text;
	603	for (Int_t bit = kINFO ; bit < kNBIT ; bit++) {
	604	if (IsSet(det, tsk, QABIT_t(bit))) {
	605	text = GetBitName(QABIT_t(bit)) ;
	606	text += " " ;
	607	}
	608	}
	609	if (! text.IsNull())
	610	printf(" %8s %4s 0x%4x, Problem signalled: %8s \n", GetDetName(det).Data(), GetAliTaskName(tsk), status, text.Data()) ;
421ab0fb	611	}
421ab0fb	612
96d67a8d	613	//_______________________________________________________________
	614	void AliQA::UnSet(QABIT_t bit)
	615	{
	616	// UnSet the status bit of the current detector in the current module
	617
	618	UnSetStatusBit(fDet, fTask, bit) ;
	619	}
	620
	621	//_______________________________________________________________
	622	void AliQA::UnSetStatusBit(DETECTORINDEX_t det, ALITASK_t tsk, QABIT_t bit)
	623	{
	624	// UnSet the status bit for a given detector and a given task
	625
	626	CheckRange(det) ;
	627	CheckRange(tsk) ;
	628	CheckRange(bit) ;
	629
	630	ULong_t offset = Offset(tsk) ;
	631	ULong_t status = GetStatus(det) ;
	632	offset+= bit ;
	633	status = status & 0 << offset ;
	634	SetStatus(det, status) ;
92a357bf	635	}