1 /**************************************************************************
2 * Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
4 * Author: The ALICE Off-line Project. *
5 * Contributors are mentioned in the code where appropriate. *
7 * Permission to use, copy, modify and distribute this software and its *
8 * documentation strictly for non-commercial purposes is hereby granted *
9 * without fee, provided that the above copyright notice appears in all *
10 * copies and that both the copyright notice and this permission notice *
11 * appear in the supporting documentation. The authors make no claims *
12 * about the suitability of this software for any purpose. It is *
13 * provided "as is" without express or implied warranty. *
14 **************************************************************************/
20 // Base class for detectors quality assurance checkers
21 // Compares Data made by QADataMakers with reference data
22 // Y. Schutz CERN August 2007
25 // --- ROOT system ---
30 #include <TIterator.h>
35 #include <TParameter.h>
36 #include <TPaveText.h>
38 // --- Standard library ---
40 // --- AliRoot header files ---
41 #include "AliCDBEntry.h"
44 #include "AliQAChecker.h"
45 #include "AliQACheckerBase.h"
46 #include "AliQADataMaker.h"
47 #include "AliQAManager.h"
48 #include "AliDetectorRecoParam.h"
50 ClassImp(AliQACheckerBase)
53 //____________________________________________________________________________
54 AliQACheckerBase::AliQACheckerBase(const char * name, const char * title) :
58 fRefOCDBSubDir(new TObjArray*[AliRecoParam::kNSpecies]),
59 fLowTestValue(new Float_t[AliQAv1::kNBIT]),
60 fUpTestValue(new Float_t[AliQAv1::kNBIT]),
61 fImage(new TCanvas*[AliRecoParam::kNSpecies]),
63 fExternParamList(new TList())
66 fLowTestValue[AliQAv1::kINFO] = 0.5 ;
67 fUpTestValue[AliQAv1::kINFO] = 1.0 ;
68 fLowTestValue[AliQAv1::kWARNING] = 0.002 ;
69 fUpTestValue[AliQAv1::kWARNING] = 0.5 ;
70 fLowTestValue[AliQAv1::kERROR] = 0.0 ;
71 fUpTestValue[AliQAv1::kERROR] = 0.002 ;
72 fLowTestValue[AliQAv1::kFATAL] = -1.0 ;
73 fUpTestValue[AliQAv1::kFATAL] = 0.0 ;
75 AliDebug(AliQAv1::GetQADebugLevel(), "Default setting is:") ;
76 if ( AliDebugLevel() == AliQAv1::GetQADebugLevel() ) {
77 const Char_t * text= Form(" INFO -> %1.5f < value < %1.5f WARNING -> %1.5f < value <= %1.5f \n ERROR -> %1.5f < value <= %1.5f \n FATAL -> %1.5f <= value < %1.5f \n",
78 fLowTestValue[AliQAv1::kINFO], fUpTestValue[AliQAv1::kINFO],
79 fLowTestValue[AliQAv1::kWARNING], fUpTestValue[AliQAv1::kWARNING],
80 fLowTestValue[AliQAv1::kERROR], fUpTestValue[AliQAv1::kERROR],
81 fLowTestValue[AliQAv1::kFATAL], fUpTestValue[AliQAv1::kFATAL]) ;
82 AliInfo(Form("%s", text)) ;
85 for (Int_t specie = 0 ; specie < AliRecoParam::kNSpecies ; specie++) {
86 fImage[specie] = NULL ;
87 fRefOCDBSubDir[specie] = NULL ;
91 //____________________________________________________________________________
92 AliQACheckerBase::AliQACheckerBase(const AliQACheckerBase& qac) :
93 TNamed(qac.GetName(), qac.GetTitle()),
94 fDataSubDir(qac.fDataSubDir),
95 fRefSubDir(qac.fRefSubDir),
96 fRefOCDBSubDir(qac.fRefOCDBSubDir),
97 fLowTestValue(new Float_t[AliQAv1::kNBIT]),
98 fUpTestValue(new Float_t[AliQAv1::kNBIT]),
99 fImage(new TCanvas*[AliRecoParam::kNSpecies]),
101 fExternParamList(new TList())
104 for (Int_t index = 0 ; index < AliQAv1::kNBIT ; index++) {
105 fLowTestValue[index] = qac.fLowTestValue[index] ;
106 fUpTestValue[index] = qac.fUpTestValue[index] ;
108 for (Int_t specie = 0 ; specie < AliRecoParam::kNSpecies ; specie++) {
109 fImage[specie] = qac.fImage[specie] ;
110 fRefOCDBSubDir[specie] = qac.fRefOCDBSubDir[specie] ;
112 if (qac.fExternParamList) {
113 TIter next(qac.fExternParamList) ;
114 TParameter<double> * p ;
115 while ( (p = (TParameter<double>*)next()) )
116 fExternParamList->Add(p) ;
120 //____________________________________________________________________________
121 AliQACheckerBase& AliQACheckerBase::operator = (const AliQACheckerBase& qac )
124 this->~AliQACheckerBase();
125 new(this) AliQACheckerBase(qac);
129 //____________________________________________________________________________
130 AliQACheckerBase::~AliQACheckerBase()
132 delete [] fLowTestValue ;
133 delete [] fUpTestValue ;
134 for (Int_t esIndex = 0 ; esIndex < AliRecoParam::kNSpecies ; esIndex++) {
135 if ( fImage[esIndex] )
136 delete fImage[esIndex] ;
137 if ( fRefOCDBSubDir[esIndex] )
138 delete fRefOCDBSubDir[esIndex] ;
141 delete[] fRefOCDBSubDir ;
142 AliQAv1::GetQAResultFile()->Close() ;
143 if (fExternParamList) {
144 fExternParamList->Clear() ;
145 delete fExternParamList ;
149 //____________________________________________________________________________
150 void AliQACheckerBase::Check(Double_t * test, AliQAv1::ALITASK_t index, const AliDetectorRecoParam * recoParam)
152 // Performs a basic checking
153 // Compares all the histograms stored in the directory
154 // With reference histograms either in a file of in OCDB
156 TObjArray ** list = new TObjArray *[AliRecoParam::kNSpecies] ;
158 for (specie = 0 ; specie < AliRecoParam::kNSpecies ; specie++) {
159 list[specie] = new TObjArray(AliQAv1::GetMaxQAObj()) ;
160 if ( !AliQAv1::Instance()->IsEventSpecieSet(specie) )
163 TList * keyList = fDataSubDir->GetListOfKeys() ;
164 TIter next(keyList) ;
166 while ( (key = static_cast<TKey *>(next())) ) {
167 TDirectory * specieDir = fDataSubDir->GetDirectory(key->GetName()) ;
168 TList * keykeyList = specieDir->GetListOfKeys() ;
169 TIter next2(keykeyList) ;
171 while ( (keykey = static_cast<TKey *>(next2())) ) {
172 TObject * odata = specieDir->Get(keykey->GetName()) ;
173 if ( odata->IsA()->InheritsFrom("TH1") ) {
174 TH1 * hdata = static_cast<TH1*>(odata) ;
175 list[specie]->Add(hdata) ;
176 } else if (!odata->IsA()->InheritsFrom("TDirectory")) // skip the expert directory
177 AliError(Form("%s Is a Classname that cannot be processed", key->GetClassName())) ;
183 Check(test, index, list, recoParam) ;
189 //____________________________________________________________________________
190 void AliQACheckerBase::Check(Double_t * test, AliQAv1::ALITASK_t task, TObjArray ** list, const AliDetectorRecoParam * /*recoParam*/)
192 // Performs a basic checking
193 // Compares all the histograms in the list
195 Int_t count[AliRecoParam::kNSpecies] = { 0 };
197 GetRefSubDir(GetName(), AliQAv1::GetTaskName(task), fRefSubDir, fRefOCDBSubDir) ;
198 // SetRefandData(refDir, refOCDBDir) ;
200 for (Int_t specie = 0 ; specie < AliRecoParam::kNSpecies ; specie++) {
202 if ( !AliQAv1::Instance()->IsEventSpecieSet(specie))
204 if (list[specie]->GetEntries() == 0)
205 test[specie] = 0. ; // nothing to check
207 if (!fRefSubDir && !fRefOCDBSubDir)
208 test[specie] = -1 ; // no reference data
210 TIter next(list[specie]) ;
213 while ( (hdata = static_cast<TH1 *>(next())) ) {
214 if ( hdata->IsA()->InheritsFrom("TH1") ) {
215 if ( hdata->TestBit(AliQAv1::GetExpertBit()) ) // does not perform the test for expert data
219 href = static_cast<TH1*>(fRefSubDir->Get(hdata->GetName())) ;
220 else if (fRefOCDBSubDir[specie])
221 href = static_cast<TH1*>(fRefOCDBSubDir[specie]->FindObject(hdata->GetName())) ;
223 test[specie] = -1 ; // no reference data ;
225 Double_t rv = DiffK(hdata, href) ;
226 AliDebug(AliQAv1::GetQADebugLevel(), Form("%s ->Test = %f", hdata->GetName(), rv)) ;
231 AliError("Data type cannot be processed") ;
232 if (count[specie] != 0)
233 test[specie] /= count[specie] ;
241 //____________________________________________________________________________
242 Double_t AliQACheckerBase::DiffC(const TH1 * href, const TH1 * hin) const
244 // compares two histograms using the Chi2 test
245 if ( hin->Integral() == 0 ) {
246 AliDebug(AliQAv1::GetQADebugLevel(), Form("Spectrum %s is empty", hin->GetName())) ;
250 return hin->Chi2Test(href) ;
253 //____________________________________________________________________________
254 Double_t AliQACheckerBase::DiffK(const TH1 * href, const TH1 * hin) const
256 // compares two histograms using the Kolmogorov test
257 if ( hin->Integral() == 0 || href->Integral() == 0) {
258 AliDebug(AliQAv1::GetQADebugLevel(), Form("Spectrum %s or its reference is empty", hin->GetName())) ;
262 return hin->KolmogorovTest(href) ;
265 //_____________________________________________________________________________
266 void AliQACheckerBase::GetRefSubDir(const char * det, const char * task, TDirectory *& dirFile, TObjArray **& dirOCDB)
268 // Opens and returns the file with the reference data
270 TString refStorage(AliQAv1::GetQARefStorage()) ;
271 if (!refStorage.Contains(AliQAv1::GetLabLocalOCDB()) && !refStorage.Contains(AliQAv1::GetLabAliEnOCDB())) {
272 AliError(Form("%s is not a valid location for reference data", refStorage.Data())) ;
275 AliQAManager* manQA = AliQAManager::QAManager(AliQAv1::GetTaskIndex(task)) ;
276 // dirOCDB = new TObjArray*[AliRecoParam::kNSpecies] ;
277 for (Int_t specie = 0 ; specie < AliRecoParam::kNSpecies ; specie++) {
278 dirOCDB[specie] = NULL ;
279 if ( !AliQAv1::Instance()->IsEventSpecieSet(specie) )
281 AliQAv1::SetQARefDataDirName(specie) ;
282 if ( ! manQA->GetLock() ) {
283 manQA->SetDefaultStorage(AliQAv1::GetQARefStorage()) ;
284 manQA->SetSpecificStorage("*", AliQAv1::GetQARefStorage()) ;
285 manQA->SetRun(AliCDBManager::Instance()->GetRun()) ;
288 char * detOCDBDir = Form("%s/%s/%s", det, AliQAv1::GetRefOCDBDirName(), AliQAv1::GetRefDataDirName()) ;
289 AliCDBEntry * entry = manQA->Get(detOCDBDir, manQA->GetRun()) ;
291 TList * listDetQAD =static_cast<TList *>(entry->GetObject()) ;
292 if ( strcmp(listDetQAD->ClassName(), "TList") != 0 ) {
293 AliError(Form("Expected a Tlist and found a %s for detector %s", listDetQAD->ClassName(), det)) ;
298 TIter next(listDetQAD) ;
300 while ( (ar = (TObjArray*)next()) )
301 dirOCDB[specie] = static_cast<TObjArray *>(listDetQAD->FindObject(Form("%s/%s", task, AliRecoParam::GetEventSpecieName(specie)))) ;
308 //____________________________________________________________________________
309 void AliQACheckerBase::PrintExternParam()
311 // Print the list of external parameter list
312 TIter next(fExternParamList) ;
313 TParameter<double> *pp ;
314 TString printit("\n") ;
315 while( (pp = (TParameter<double>*)next()) )
316 printit += Form("%s = %f\n", pp->GetName(), pp->GetVal());
317 AliInfo(Form("%s", printit.Data())) ;
320 //____________________________________________________________________________
321 void AliQACheckerBase::Run(AliQAv1::ALITASK_t index, AliDetectorRecoParam * recoParam)
323 AliDebug(AliQAv1::GetQADebugLevel(), Form("Processing %s", AliQAv1::GetAliTaskName(index))) ;
325 Double_t * rv = NULL ;
326 Check(rv, index, recoParam) ;
329 AliDebug(AliQAv1::GetQADebugLevel(), Form("Test result of %s", AliQAv1::GetAliTaskName(index))) ;
336 //____________________________________________________________________________
337 void AliQACheckerBase::Run(AliQAv1::ALITASK_t index, TObjArray ** list, AliDetectorRecoParam * recoParam)
339 AliDebug(AliQAv1::GetQADebugLevel(), Form("Processing %s", AliQAv1::GetAliTaskName(index))) ;
341 Double_t * rv = new Double_t[AliRecoParam::kNSpecies] ;
342 Check(rv, index, list, recoParam) ;
345 AliDebug(AliQAv1::GetQADebugLevel(), Form("Test result of %s", AliQAv1::GetAliTaskName(index))) ;
351 //____________________________________________________________________________
352 void AliQACheckerBase::Finish() const
354 // wrap up and save QA in proper file
355 AliQAv1::GetQAResultFile() ;
356 AliQAv1 * qa = AliQAv1::Instance() ;
357 qa->Write(AliQAv1::GetQAName(), kWriteDelete) ;
360 //____________________________________________________________________________
361 void AliQACheckerBase::MakeImage( TObjArray ** list, AliQAv1::TASKINDEX_t task, AliQAv1::MODE_t mode)
363 // makes the QA image for sim and rec
365 for (Int_t esIndex = 0 ; esIndex < AliRecoParam::kNSpecies ; esIndex++) {
366 if (! AliQAv1::Instance(AliQAv1::GetDetIndex(GetName()))->IsEventSpecieSet(AliRecoParam::ConvertIndex(esIndex)) )
368 TIter next(list[esIndex]) ;
370 while ( (hdata=static_cast<TH1 *>(next())) ) {
371 TString cln(hdata->ClassName()) ;
372 if ( ! cln.Contains("TH") )
374 if ( hdata->TestBit(AliQAv1::GetImageBit()) )
379 if ( nImages == 0 ) {
380 AliDebug(AliQAv1::GetQADebugLevel(), Form("No histogram will be plotted for %s %s\n", GetName(), AliQAv1::GetTaskName(task).Data())) ;
382 AliDebug(AliQAv1::GetQADebugLevel(), Form("%d histograms will be plotted for %s %s\n", nImages, GetName(), AliQAv1::GetTaskName(task).Data())) ;
383 for (Int_t esIndex = 0 ; esIndex < AliRecoParam::kNSpecies ; esIndex++) {
384 if (! AliQAv1::Instance(AliQAv1::GetDetIndex(GetName()))->IsEventSpecieSet(AliRecoParam::ConvertIndex(esIndex)) || list[esIndex]->GetEntries() == 0)
386 const Char_t * title = Form("QA_%s_%s_%s", GetName(), AliQAv1::GetTaskName(task).Data(), AliRecoParam::GetEventSpecieName(esIndex)) ;
387 if ( !fImage[esIndex] ) {
388 fImage[esIndex] = new TCanvas(title, title) ;
390 fImage[esIndex]->Clear() ;
391 fImage[esIndex]->SetTitle(title) ;
392 fImage[esIndex]->cd() ;
393 TPaveText someText(0.015, 0.015, 0.98, 0.98) ;
394 someText.AddText(title) ;
396 fImage[esIndex]->Print(Form("%s%s%d.%s", AliQAv1::GetImageFileName(), AliQAv1::GetModeName(mode), AliQAChecker::Instance()->GetRunNumber(), AliQAv1::GetImageFileFormat()), "ps") ;
397 fImage[esIndex]->Clear() ;
398 Int_t nx = TMath::Nint(TMath::Sqrt(nImages));
400 if (nx < TMath::Sqrt(nImages))
403 fImage[esIndex]->Divide(nx, ny) ;
404 TIter nexthist(list[esIndex]) ;
407 fImage[esIndex]->cd(npad) ;
408 while ( (hist=static_cast<TH1*>(nexthist())) ) {
409 TString cln(hist->ClassName()) ;
410 if ( ! cln.Contains("TH") )
412 if(hist->TestBit(AliQAv1::GetImageBit())) {
414 fImage[esIndex]->cd(++npad) ;
417 fImage[esIndex]->Print(Form("%s%s%d.%s", AliQAv1::GetImageFileName(), AliQAv1::GetModeName(mode), AliQAChecker::Instance()->GetRunNumber(), AliQAv1::GetImageFileFormat()), "ps") ;
422 //____________________________________________________________________________
423 void AliQACheckerBase::SetHiLo(Float_t * hiValue, Float_t * lowValue)
425 AliDebug(AliQAv1::GetQADebugLevel(), "Previous setting was:") ;
426 if ( AliDebugLevel() == AliQAv1::GetQADebugLevel() ) {
427 const Char_t * text= Form(" INFO -> %1.5f < value < %1.5f WARNING -> %1.5f < value <= %1.5f \n ERROR -> %1.5f < value <= %1.5f \n FATAL -> %1.5f <= value < %1.5f \n",
428 fLowTestValue[AliQAv1::kINFO], fUpTestValue[AliQAv1::kINFO],
429 fLowTestValue[AliQAv1::kWARNING], fUpTestValue[AliQAv1::kWARNING],
430 fLowTestValue[AliQAv1::kERROR], fUpTestValue[AliQAv1::kERROR],
431 fLowTestValue[AliQAv1::kFATAL], fUpTestValue[AliQAv1::kFATAL]) ;
432 AliInfo(Form("%s", text)) ;
435 for (Int_t index = 0 ; index < AliQAv1::kNBIT ; index++) {
436 fLowTestValue[index] = lowValue[index] ;
437 fUpTestValue[index] = hiValue[index] ;
439 AliDebug(AliQAv1::GetQADebugLevel(), "Current setting is:") ;
440 if ( AliDebugLevel() == AliQAv1::GetQADebugLevel() ) {
441 const Char_t * text= Form(" INFO -> %1.5f < value < %1.5f WARNING -> %1.5f < value <= %1.5f \n ERROR -> %1.5f < value <= %1.5f \n FATAL -> %1.5f <= value < %1.5f \n",
442 fLowTestValue[AliQAv1::kINFO], fUpTestValue[AliQAv1::kINFO],
443 fLowTestValue[AliQAv1::kWARNING], fUpTestValue[AliQAv1::kWARNING],
444 fLowTestValue[AliQAv1::kERROR], fUpTestValue[AliQAv1::kERROR],
445 fLowTestValue[AliQAv1::kFATAL], fUpTestValue[AliQAv1::kFATAL]) ; AliInfo(Form("%s", text)) ;
449 //____________________________________________________________________________
450 void AliQACheckerBase::SetQA(AliQAv1::ALITASK_t index, Double_t * value) const
452 // sets the QA according the return value of the Check
454 AliQAv1 * qa = AliQAv1::Instance(index) ;
456 for (Int_t specie = 0 ; specie < AliRecoParam::kNSpecies ; specie++) {
457 if (! qa->IsEventSpecieSet(AliRecoParam::ConvertIndex(specie)))
459 if ( value == NULL ) { // No checker is implemented, set all QA to Fatal
460 qa->Set(AliQAv1::kFATAL, specie) ;
462 if ( value[specie] >= fLowTestValue[AliQAv1::kFATAL] && value[specie] < fUpTestValue[AliQAv1::kFATAL] )
463 qa->Set(AliQAv1::kFATAL, AliRecoParam::ConvertIndex(specie)) ;
464 else if ( value[specie] > fLowTestValue[AliQAv1::kERROR] && value[specie] <= fUpTestValue[AliQAv1::kERROR] )
465 qa->Set(AliQAv1::kERROR, AliRecoParam::ConvertIndex(specie)) ;
466 else if ( value[specie] > fLowTestValue[AliQAv1::kWARNING] && value[specie] <= fUpTestValue[AliQAv1::kWARNING] )
467 qa->Set(AliQAv1::kWARNING, AliRecoParam::ConvertIndex(specie)) ;
468 else if ( value[specie] > fLowTestValue[AliQAv1::kINFO] && value[specie] <= fUpTestValue[AliQAv1::kINFO] )
469 qa->Set(AliQAv1::kINFO, AliRecoParam::ConvertIndex(specie)) ;