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)) continue ;
203 if (list[specie]->GetEntries() == 0)
204 test[specie] = 0. ; // nothing to check
206 if (!fRefSubDir && !fRefOCDBSubDir)
207 test[specie] = -1 ; // no reference data
209 TIter next(list[specie]) ;
212 while ( (hdata = static_cast<TH1 *>(next())) ) {
213 if ( hdata->IsA()->InheritsFrom("TH1") ) {
214 if ( hdata->TestBit(AliQAv1::GetExpertBit()) ) // does not perform the test for expert data
217 // First try to find the ref histo with exact name (with possible trigger clon ending)
218 TString hname = hdata->GetName();
220 if (fRefSubDir) href = static_cast<TH1*>(fRefSubDir->Get(hname.Data())) ;
221 else if (fRefOCDBSubDir[specie]) href = static_cast<TH1*>(fRefOCDBSubDir[specie]->FindObject(hname.Data()));
223 if (!href && hdata->TestBit(AliQAv1::GetClonedBit())) { // try to find the histo for the base name (w/o trigger ending
224 int ind = hname.Index(AliQADataMaker::GetTriggerPrefix());
227 if (fRefSubDir) href = static_cast<TH1*>(fRefSubDir->Get(hname.Data())) ;
228 else if (fRefOCDBSubDir[specie]) href = static_cast<TH1*>(fRefOCDBSubDir[specie]->FindObject(hname.Data()));
233 test[specie] = -1 ; // no reference data ;
235 Double_t rv = DiffK(hdata, href) ;
236 AliDebug(AliQAv1::GetQADebugLevel(), Form("%s ->Test = %f", hdata->GetName(), rv)) ;
241 AliError("Data type cannot be processed") ;
242 if (count[specie] != 0)
243 test[specie] /= count[specie] ;
251 //____________________________________________________________________________
252 Double_t AliQACheckerBase::DiffC(const TH1 * href, const TH1 * hin) const
254 // compares two histograms using the Chi2 test
255 if ( hin->Integral() == 0 ) {
256 AliDebug(AliQAv1::GetQADebugLevel(), Form("Spectrum %s is empty", hin->GetName())) ;
260 return hin->Chi2Test(href) ;
263 //____________________________________________________________________________
264 Double_t AliQACheckerBase::DiffK(const TH1 * href, const TH1 * hin) const
266 // compares two histograms using the Kolmogorov test
267 if ( hin->Integral() == 0 || href->Integral() == 0) {
268 AliDebug(AliQAv1::GetQADebugLevel(), Form("Spectrum %s or its reference is empty", hin->GetName())) ;
272 return hin->KolmogorovTest(href) ;
275 //_____________________________________________________________________________
276 void AliQACheckerBase::GetRefSubDir(const char * det, const char * task, TDirectory *& dirFile, TObjArray **& dirOCDB)
278 // Opens and returns the file with the reference data
280 TString refStorage(AliQAv1::GetQARefStorage()) ;
281 if (!refStorage.Contains(AliQAv1::GetLabLocalOCDB()) && !refStorage.Contains(AliQAv1::GetLabAliEnOCDB())) {
282 AliError(Form("%s is not a valid location for reference data", refStorage.Data())) ;
285 AliQAManager* manQA = AliQAManager::QAManager(AliQAv1::GetTaskIndex(task)) ;
286 // dirOCDB = new TObjArray*[AliRecoParam::kNSpecies] ;
287 for (Int_t specie = 0 ; specie < AliRecoParam::kNSpecies ; specie++) {
288 dirOCDB[specie] = NULL ;
289 if ( !AliQAv1::Instance()->IsEventSpecieSet(specie) )
291 AliQAv1::SetQARefDataDirName(specie) ;
292 if ( ! manQA->GetLock() ) {
293 manQA->SetDefaultStorage(AliQAv1::GetQARefStorage()) ;
294 manQA->SetSpecificStorage("*", AliQAv1::GetQARefStorage()) ;
295 manQA->SetRun(AliCDBManager::Instance()->GetRun()) ;
298 char * detOCDBDir = Form("%s/%s/%s", det, AliQAv1::GetRefOCDBDirName(), AliQAv1::GetRefDataDirName()) ;
299 AliCDBEntry * entry = manQA->Get(detOCDBDir, manQA->GetRun()) ;
301 TList * listDetQAD =static_cast<TList *>(entry->GetObject()) ;
302 if ( listDetQAD && strcmp(listDetQAD->ClassName(), "TList") != 0 ) {
303 AliError(Form("Expected a Tlist and found a %s for detector %s", listDetQAD->ClassName(), det)) ;
308 TIter next(listDetQAD) ;
309 while ( (TObjArray*)next() )
310 dirOCDB[specie] = static_cast<TObjArray *>(listDetQAD->FindObject(Form("%s/%s", task, AliRecoParam::GetEventSpecieName(specie)))) ;
317 //____________________________________________________________________________
318 void AliQACheckerBase::PrintExternParam()
320 // Print the list of external parameter list
321 TIter next(fExternParamList) ;
322 TParameter<double> *pp ;
323 TString printit("\n") ;
324 while( (pp = (TParameter<double>*)next()) )
325 printit += Form("%s = %f\n", pp->GetName(), pp->GetVal());
326 AliInfo(Form("%s", printit.Data())) ;
329 //____________________________________________________________________________
330 void AliQACheckerBase::Run(AliQAv1::ALITASK_t index, AliDetectorRecoParam * recoParam)
332 AliDebug(AliQAv1::GetQADebugLevel(), Form("Processing %s", AliQAv1::GetAliTaskName(index))) ;
334 Double_t * rv = new Double_t[AliRecoParam::kNSpecies] ;
335 Check(rv, index, recoParam) ;
338 AliDebug(AliQAv1::GetQADebugLevel(), Form("Test result of %s", AliQAv1::GetAliTaskName(index))) ;
344 //____________________________________________________________________________
345 void AliQACheckerBase::Run(AliQAv1::ALITASK_t index, TObjArray ** list, AliDetectorRecoParam * recoParam)
347 // RS: perform check for all trigger classes in loop
348 Double_t * rv = new Double_t[AliRecoParam::kNSpecies] ;
350 TObjArray ** listTrig = new TObjArray *[AliRecoParam::kNSpecies];
352 for (int itc=-1;itc<AliQADataMaker::GetNTrigClasses();itc++) {
354 // RS: fetch the histograms for each specie and for given trigger
355 //AliInfo(Form("Processing %s for trigger: %s", AliQAv1::GetAliTaskName(index),AliQADataMaker::GetTrigClassName(itc)));
357 for (int specie=0;specie<AliRecoParam::kNSpecies;specie++) {
358 listTrig[specie] = 0;
359 if ( !AliQAv1::Instance()->IsEventSpecieSet(specie) || !list[specie]) continue;
360 listTrig[specie] = new TObjArray( list[specie]->GetSize() ); // destination for clones of this trigger
361 AliQADataMaker::GetDataOfTrigClass(list[specie],itc, listTrig[specie]);
363 AliDebug(AliQAv1::GetQADebugLevel(), Form("Processing %s for trigger: %s", AliQAv1::GetAliTaskName(index),AliQADataMaker::GetTrigClassName(itc)));
364 Check(rv, index, listTrig, recoParam) ;
366 AliDebug(AliQAv1::GetQADebugLevel(), Form("Test result of %s for trigger: %s", AliQAv1::GetAliTaskName(index),AliQADataMaker::GetTrigClassName(itc)));
368 for (int specie=0;specie<AliRecoParam::kNSpecies;specie++) if (listTrig[specie]) delete listTrig[specie]; // clean temporary container
375 //____________________________________________________________________________
376 void AliQACheckerBase::Finish() const
378 // wrap up and save QA in proper file
379 AliQAv1::GetQAResultFile() ;
380 AliQAv1 * qa = AliQAv1::Instance() ;
381 qa->Write(AliQAv1::GetQAName(), kWriteDelete) ;
384 //____________________________________________________________________________
385 void AliQACheckerBase::MakeImage( TObjArray ** list, AliQAv1::TASKINDEX_t task, AliQAv1::MODE_t mode)
387 // makes the QA image for sim and rec
388 TObjArray tmpArr; // array to store flat version of original array (which may contain clones)
390 for (Int_t esIndex = 0; esIndex < AliRecoParam::kNSpecies; esIndex++) {
391 if (! AliQAv1::Instance(AliQAv1::GetDetIndex(GetName()))->IsEventSpecieSet(AliRecoParam::ConvertIndex(esIndex)) || list[esIndex]->GetEntries() == 0) continue;
393 TIter next(list[esIndex]);
394 TObject* hdata = NULL;
396 while ( (hdata=(next())) ) { // count histos and transfere to flat array
397 if (hdata->InheritsFrom(TH1::Class()) && hdata->TestBit(AliQAv1::GetImageBit()) ) { // histo, not cloned
399 tmpArr.AddLast(hdata);
402 if (!hdata->TestBit(AliQAv1::GetClonedBit())) continue; // not an array of clones, unknown object
403 TIter nextCl((TObjArray*)hdata); // array of histo clones
405 while ((hcl=nextCl())) if (hcl->InheritsFrom(TH1::Class()) && hcl->TestBit(AliQAv1::GetImageBit())) {tmpArr.AddLast(hcl); nImages++;}
408 if ( nImages == 0 ) {
409 AliDebug(AliQAv1::GetQADebugLevel(), Form("No histogram will be plotted for %s %s %s\n", GetName(), AliQAv1::GetTaskName(task).Data(), AliRecoParam::GetEventSpecieName(esIndex)));
412 AliDebug(AliQAv1::GetQADebugLevel(), Form("%d histograms will be plotted for %s %s %s\n", nImages, GetName(), AliQAv1::GetTaskName(task).Data(),AliRecoParam::GetEventSpecieName(esIndex)));
414 const Char_t * title = Form("QA_%s_%s_%s", GetName(), AliQAv1::GetTaskName(task).Data(), AliRecoParam::GetEventSpecieName(esIndex));
416 if ( !fImage[esIndex] ) fImage[esIndex] = new TCanvas(title, title);
418 fImage[esIndex]->Clear();
419 fImage[esIndex]->SetTitle(title);
420 fImage[esIndex]->cd();
421 TPaveText someText(0.015, 0.015, 0.98, 0.98);
422 someText.AddText(title);
424 fImage[esIndex]->Print(Form("%s%s%d.%s", AliQAv1::GetImageFileName(), AliQAv1::GetModeName(mode), AliQAChecker::Instance()->GetRunNumber(), AliQAv1::GetImageFileFormat()));
425 fImage[esIndex]->Clear();
426 Int_t nx = TMath::Nint(TMath::Sqrt(nImages));
428 if (nx < TMath::Sqrt(nImages)) ny++;
430 fImage[esIndex]->Divide(nx, ny);
431 TIter nexthist(&tmpArr);
433 fImage[esIndex]->cd(npad);
435 while ( (histo=(TH1*)nexthist()) ) { // tmpArr is guaranteed to contain only plottable histos, no checks needed
436 TString opts = histo->GetDrawOption();
437 if (opts.Contains("logy",TString::kIgnoreCase)) gPad->SetLogy();
438 if (opts.Contains("logx",TString::kIgnoreCase)) gPad->SetLogx();
440 fImage[esIndex]->cd(++npad);
442 fImage[esIndex]->Print(Form("%s%s%d.%s", AliQAv1::GetImageFileName(), AliQAv1::GetModeName(mode), AliQAChecker::Instance()->GetRunNumber(), AliQAv1::GetImageFileFormat()), "ps");
446 //____________________________________________________________________________
447 void AliQACheckerBase::SetHiLo(Float_t * hiValue, Float_t * lowValue)
449 AliDebug(AliQAv1::GetQADebugLevel(), "Previous setting was:") ;
450 if ( AliDebugLevel() == AliQAv1::GetQADebugLevel() ) {
451 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",
452 fLowTestValue[AliQAv1::kINFO], fUpTestValue[AliQAv1::kINFO],
453 fLowTestValue[AliQAv1::kWARNING], fUpTestValue[AliQAv1::kWARNING],
454 fLowTestValue[AliQAv1::kERROR], fUpTestValue[AliQAv1::kERROR],
455 fLowTestValue[AliQAv1::kFATAL], fUpTestValue[AliQAv1::kFATAL]) ;
456 AliInfo(Form("%s", text)) ;
459 for (Int_t index = 0 ; index < AliQAv1::kNBIT ; index++) {
460 fLowTestValue[index] = lowValue[index] ;
461 fUpTestValue[index] = hiValue[index] ;
463 AliDebug(AliQAv1::GetQADebugLevel(), "Current setting is:") ;
464 if ( AliDebugLevel() == AliQAv1::GetQADebugLevel() ) {
465 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",
466 fLowTestValue[AliQAv1::kINFO], fUpTestValue[AliQAv1::kINFO],
467 fLowTestValue[AliQAv1::kWARNING], fUpTestValue[AliQAv1::kWARNING],
468 fLowTestValue[AliQAv1::kERROR], fUpTestValue[AliQAv1::kERROR],
469 fLowTestValue[AliQAv1::kFATAL], fUpTestValue[AliQAv1::kFATAL]) ; AliInfo(Form("%s", text)) ;
473 //____________________________________________________________________________
474 void AliQACheckerBase::SetQA(AliQAv1::ALITASK_t index, Double_t * value) const
476 // sets the QA according the return value of the Check
478 AliQAv1 * qa = AliQAv1::Instance(index) ;
480 for (Int_t specie = 0 ; specie < AliRecoParam::kNSpecies ; specie++) {
481 if (! qa->IsEventSpecieSet(AliRecoParam::ConvertIndex(specie)))
483 if ( value == NULL ) { // No checker is implemented, set all QA to Fatal
484 qa->Set(AliQAv1::kFATAL, specie) ;
486 if ( value[specie] >= fLowTestValue[AliQAv1::kFATAL] && value[specie] < fUpTestValue[AliQAv1::kFATAL] )
487 qa->Set(AliQAv1::kFATAL, AliRecoParam::ConvertIndex(specie)) ;
488 else if ( value[specie] > fLowTestValue[AliQAv1::kERROR] && value[specie] <= fUpTestValue[AliQAv1::kERROR] )
489 qa->Set(AliQAv1::kERROR, AliRecoParam::ConvertIndex(specie)) ;
490 else if ( value[specie] > fLowTestValue[AliQAv1::kWARNING] && value[specie] <= fUpTestValue[AliQAv1::kWARNING] )
491 qa->Set(AliQAv1::kWARNING, AliRecoParam::ConvertIndex(specie)) ;
492 else if ( value[specie] > fLowTestValue[AliQAv1::kINFO] && value[specie] <= fUpTestValue[AliQAv1::kINFO] )
493 qa->Set(AliQAv1::kINFO, AliRecoParam::ConvertIndex(specie)) ;