Removing newling

[u/mrichter/AliRoot.git] / STEER / AliQACheckerBase.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$ */

/*
  Base class for detectors quality assurance checkers 
  Compares Data made by QADataMakers with reference data
  Y. Schutz CERN August 2007
*/

// --- ROOT system ---
#include <TClass.h>
#include <TH1F.h> 
#include <TH1I.h> 
#include <TIterator.h> 
#include <TKey.h> 
#include <TFile.h> 
#include <TList.h>

// --- Standard library ---

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

ClassImp(AliQACheckerBase)

           
//____________________________________________________________________________ 
AliQACheckerBase::AliQACheckerBase(const char * name, const char * title) : 
  TNamed(name, title), 
  fDataSubDir(0x0),
  fRefSubDir(0x0) 
{
  // ctor
}

//____________________________________________________________________________ 
AliQACheckerBase::AliQACheckerBase(const AliQACheckerBase& qadm) :
  TNamed(qadm.GetName(), qadm.GetTitle()),
  fDataSubDir(qadm.fDataSubDir), 
  fRefSubDir(qadm.fRefSubDir)
{
  //copy ctor
    
}

//____________________________________________________________________________
AliQACheckerBase& AliQACheckerBase::operator = (const AliQACheckerBase& qadm )
{
  // Equal operator.
  this->~AliQACheckerBase();
  new(this) AliQACheckerBase(qadm);
  return *this;
}

//____________________________________________________________________________
const Double_t AliQACheckerBase::Check() 
{
  // Performs a basic checking
  // Compares all the histograms stored in the directory

   Double_t test = 0.0  ;
   Int_t count = 0 ; 

   if (!fDataSubDir)  
     test = 1. ; // nothing to check
   else 
     if (!fRefSubDir)
       test = -1 ; // no reference data
     else {
       TList * keyList = fDataSubDir->GetListOfKeys() ; 
       TIter next(keyList) ; 
       TKey * key ;
       count = 0 ; 
       while ( (key = static_cast<TKey *>(next())) ) {
	    TObject * odata = fRefSubDir->Get(key->GetName()) ; 
	    if ( odata->IsA()->InheritsFrom("TH1") ) {
	     TH1 * hdata = static_cast<TH1*>(odata) ; 
	     TH1 * href  = static_cast<TH1*>(fRefSubDir->Get(key->GetName())) ;
	    if (!href) 
	     test = -1 ; // no reference data ; 
	    else {
	     Double_t rv =  DiffK(hdata, href) ;
	     AliInfo(Form("%s ->Test = %f", hdata->GetName(), rv)) ; 
	     test += rv ; 
	     count++ ; 
	   }
	 }
	 else
	   AliError(Form("%s Is a Classname that cannot be processed", key->GetClassName())) ;
       }

     }
   if (count != 0) 
     test /= count ;
   
   return test ; 
}  

//____________________________________________________________________________
const Double_t AliQACheckerBase::Check(TList * list) 
{
  // Performs a basic checking
  // Compares all the histograms in the list

   Double_t test = 0.0  ;
   Int_t count = 0 ; 

   if (list->GetEntries() == 0)  
     test = 1. ; // nothing to check
   else 
     if (!fRefSubDir)
       test = -1 ; // no reference data
     else {
       TIter next(list) ; 
       TH1 * hdata ;
       count = 0 ; 
       while ( (hdata = dynamic_cast<TH1 *>(next())) ) {
		if ( hdata) { 
	     TH1 * href  = static_cast<TH1*>(fRefSubDir->Get(hdata->GetName())) ;
	     if (!href) 
	      test = -1 ; // no reference data ; 
	     else {
	      Double_t rv =  DiffK(hdata, href) ;
	      AliInfo(Form("%s ->Test = %f", hdata->GetName(), rv)) ; 
	      test += rv ; 
	      count++ ; 
	    }
	   } 
	   else
	    AliError("Data type cannot be processed") ;
       }
     }
   if (count != 0) 
     test /= count ;
   
   return test ; 
}  

//____________________________________________________________________________ 
const Double_t AliQACheckerBase::DiffC(const TH1 * href, const TH1 * hin) const
{
  // compares two histograms using the Chi2 test
  if ( hin->Integral() == 0 ) {
    AliWarning(Form("Spectrum %s in %s is empty", hin->GetName(), AliQA::GetDataName())) ; 
    return 0. ;
  }
    
  return hin->Chi2Test(href) ;  
}

//____________________________________________________________________________ 
const Double_t AliQACheckerBase::DiffK(const TH1 * href, const TH1 * hin) const
{
  // compares two histograms using the Kolmogorov test
  if ( hin->Integral() == 0 ) {
    AliWarning(Form("Spectrum %s in %s is empty", hin->GetName(), AliQA::GetDataName())) ; 
    return 0. ;
  }
    
  return hin->KolmogorovTest(href) ;  
}

//____________________________________________________________________________ 
void AliQACheckerBase::Init(const AliQA::DETECTORINDEX det)
{
  AliQA::Instance(det) ; 
}
 
//____________________________________________________________________________
void AliQACheckerBase::Run(AliQA::ALITASK index, TList * list) 
{ 
  AliInfo(Form("Processing %s", AliQA::GetAliTaskName(index))) ; 

  AliQA * qa = AliQA::Instance(index) ; 

  Double_t rv = -1 ;	
  if (list)
    rv = Check(list) ;
  else 
    rv = Check() ;   

  if ( rv <= 0.) 
    qa->Set(AliQA::kFATAL) ; 
  else if ( rv > 0 && rv <= 0.2 )
    qa->Set(AliQA::kERROR) ; 
  else if ( rv > 0.2 && rv <= 0.5 )
    qa->Set(AliQA::kWARNING) ;
  else if ( rv > 0.5 && rv < 1 ) 
    qa->Set(AliQA::kINFO) ; 
  AliInfo(Form("Test result of %s", AliQA::GetAliTaskName(index))) ;
  Finish() ; 
}

//____________________________________________________________________________
void AliQACheckerBase::Finish() const 
{
  // wrap up and save QA in proper file
    
  AliQA * qa = AliQA::Instance() ; 
  qa->Show() ;
  AliQAChecker::GetQAResultFile()->cd() ; 
  qa->Write(qa->GetName(), kWriteDelete) ;   
  AliQAChecker::GetQAResultFile()->Close() ;  
}