Implementation of a bin-by-bin Chi2 test for 2D histograms. More...

#include <JTestChi2_Bin.hh>

Inheritance diagram for JCOMPAREHISTOGRAMS::JTestChi2_Bin:

Public Member Functions
	JTestChi2_Bin ()
	Default constructor. More...

void	test (const TObject o1, const TObject o2) override
	Tests the statistical compatibility of two ROOT 2D histograms. More...

std::istream &	read (std::istream &in) override
	Read test parameters from input. More...

virtual std::ostream &	write (std::ostream &out, const char delimiter=' ', const bool onlyFailures=false) const
	Write test result to output. More...

virtual void	save (TFile *f, const std::string &path, const bool onlyFailures=false) const
	Writes the test result to root file. More...

const std::string &	getTestName () const
	Get test name. More...

const std::string &	getResultType () const
	Get result type. More...

Protected Attributes
const std::string	testName
	test name More...

const std::string	resultType
	test result type More...

Private Attributes
double	chi2Threshold
	threshold chi2-value to decide if test is passed for a bin. More...

double	outliersThreshold
	fraction of bins allowed to fail the test. More...

Detailed Description

Implementation of a bin-by-bin Chi2 test for 2D histograms.

This class is derived from the abstract class JTest_t(). For a general description of the implementation of this and other tests derived from JTest_t(), see its documentation.

Definition at line 27 of file JTestChi2_Bin.hh.

Constructor & Destructor Documentation

◆ JTestChi2_Bin()

JCOMPAREHISTOGRAMS::JTestChi2_Bin::JTestChi2_Bin ( )

inline

Default constructor.

Definition at line 35 of file JTestChi2_Bin.hh.

                     :
       JTest_t("Chi2_Bin", "Outliers[%]")
     {}

Member Function Documentation

◆ test()

void JCOMPAREHISTOGRAMS::JTestChi2_Bin::test	(	const TObject *	o1,
		const TObject *	o2
	)

inlineoverridevirtual

Tests the statistical compatibility of two ROOT 2D histograms.

Parameters

o1	First histogram
o2	Second histogram

Implements JCOMPAREHISTOGRAMS::JTest_t.

Definition at line 46 of file JTestChi2_Bin.hh.

     {    
       using namespace std;
       using namespace JPP;
  
       const TH1* h1 = dynamic_cast<const TH1*>(o1);
       const TH1* h2 = dynamic_cast<const TH1*>(o2);
  
       if (h1 == NULL || h2 == NULL) {
         THROW(JValueOutOfRange, "JTestChi2_Bin::test(): Could not cast given TObjects to TH1.");
       }
     
       const int nx1 = h1->GetNbinsX();
       const int nx2 = h2->GetNbinsX();      
       const int ny1 = h1->GetNbinsY();
       const int ny2 = h2->GetNbinsY();
       const int nz1 = h1->GetNbinsZ();
       const int nz2 = h2->GetNbinsZ();
       
       const double M = h1->GetSumOfWeights();
       const double N = h2->GetSumOfWeights();
  
       if(nx1 != nx2 || ny1 != ny2 || nz1 != nz2 || M == 0 || N == 0) {
         THROW(JValueOutOfRange, "JTestChi2_t::JChi2TestBin_2D(): Histograms with different binning or with zero entries.");
       }
  
       TH1* h3 = (TH1*) h1->Clone(h1->GetName() == h2->GetName() ?
                                  MAKE_CSTRING(h1->GetName()                            << "_" << testName) :
                                  MAKE_CSTRING(h1->GetName() << "_VS_" << h2->GetName() << "_" << testName));
  
       h3->Reset();
       
       double outliers = 0;
     
       for (int i=1 ; i<nx1 ; ++i) {
         for (int j=1 ; j<ny1 ; ++j) {
           for (int k=1 ; k<nz1 ; ++k) {
               
             const double m = h1->GetBinContent(i,j,k);
             const double n = h2->GetBinContent(i,j,k);
  
             const double em = h1->GetBinError(i,j,k);
             const double en = h2->GetBinError(i,j,k);
  
             if (n > 0.0 && m > 0.0 && em > 0.0 && en > 0.0) {
  
               const double delta = N*m - M*n;
               const double sigma = M*M*en*en + N*N*em*em;
               const double chi2  = delta*delta / sigma;
  
               if (fabs(chi2) > chi2Threshold) {
                 outliers += 1./(nx1*ny1);
               }
             
               h3->SetBinContent(i,j,k,chi2);
             }
           }
         }
       }
  
       const bool passed = (outliers < outliersThreshold);
  
       const JResultTitle title(testName, resultType, passed, 100.*outliers);
       
       h3->SetTitle(title.getTitle().c_str());
  
       const int Ndims = h3->GetDimension();
  
       if        (Ndims == 1) {
         h3->GetYaxis()->SetTitle(resultType.c_str());
       } else if (Ndims == 2) {
         h3->GetZaxis()->SetTitle(resultType.c_str());
       }
         
       const JTestResult r(testName,
                           JRootObjectID(MAKE_STRING(h1->GetDirectory()->GetPath() << h1->GetName())),
                           JRootObjectID(MAKE_STRING(h2->GetDirectory()->GetPath() << h1->GetName())),
                           resultType, 100.*outliers, 100.*outliersThreshold, h3, passed);
       
       this->push_back(r);
     }

◆ read()

std::istream& JCOMPAREHISTOGRAMS::JTestChi2_Bin::read ( std::istream & in )

inlineoverridevirtual

Read test parameters from input.

Parameters

in	input stream

Returns: input stream

Implements JCOMPAREHISTOGRAMS::JTest_t.

Definition at line 135 of file JTestChi2_Bin.hh.

     {
       using namespace JPP;
       
       in >> chi2Threshold >> outliersThreshold;
  
       if (chi2Threshold < 0.0) {
         THROW(JValueOutOfRange, "JTestChi2_Bin::read(): Invalid chi2-threshold value " << chi2Threshold);       
       }
  
       if (outliersThreshold < 0.0 || outliersThreshold > 1.0) {
         THROW(JValueOutOfRange, "JTestChi2_Bin::read(): Invalid outliers threshold value " << outliersThreshold);       
       }
  
       return in;
     }

◆ write()

virtual std::ostream& JCOMPAREHISTOGRAMS::JTest_t::write	(	std::ostream &	out,
		const char	delimiter = `' '`,
		const bool	onlyFailures = `false`
	)		const

inlinevirtualinherited

Write test result to output.

Parameters

out	output stream
delimiter	field delimiter
onlyFailures	if true, write only failures.

Returns: output stream

Definition at line 84 of file JTest_t.hh.

     {
       using namespace std;
       using namespace JPP;
  
       for (vector<JTestResult>::const_iterator r = this->begin() ; r != this->end() ; ++r) {
  
         if (onlyFailures && r->passed) { continue; }
         
         print(out, *r, delimiter, true);
       }
       
       return out;
     }

◆ save()

virtual void JCOMPAREHISTOGRAMS::JTest_t::save	(	TFile *	f,
		const std::string &	path,
		const bool	onlyFailures = `false`
	)		const

inlinevirtualinherited

Writes the test result to root file.

Parameters

f	A ROOT file
path	Path in root file.
onlyFailures	If true, write only failures.

Definition at line 108 of file JTest_t.hh.

     {
       using namespace std;
       using namespace JPP;
  
       if (f->GetDirectory(path.c_str())==0) {
         f->mkdir(path.c_str());
       }
       
       f->cd(path.c_str());
  
       for (vector<JTestResult>::const_iterator r = this->begin() ; r != this->end() ; ++r) {
  
         if (onlyFailures && r->passed) { continue; }
         
         r->obj->Write();
       }
     }

◆ getTestName()

const std::string& JCOMPAREHISTOGRAMS::JTest_t::getTestName ( ) const

inlineinherited

Get test name.

Returns: test name

Definition at line 135 of file JTest_t.hh.

     {
       return testName;
     }

◆ getResultType()

const std::string& JCOMPAREHISTOGRAMS::JTest_t::getResultType ( ) const

inlineinherited

Get result type.

Returns: result type

Definition at line 146 of file JTest_t.hh.

     {
       return resultType;
     }

Member Data Documentation

◆ chi2Threshold

double JCOMPAREHISTOGRAMS::JTestChi2_Bin::chi2Threshold

private

threshold chi2-value to decide if test is passed for a bin.

Definition at line 155 of file JTestChi2_Bin.hh.

◆ outliersThreshold

double JCOMPAREHISTOGRAMS::JTestChi2_Bin::outliersThreshold

private

fraction of bins allowed to fail the test.

Definition at line 156 of file JTestChi2_Bin.hh.

◆ testName

const std::string JCOMPAREHISTOGRAMS::JTest_t::testName

protectedinherited

test name

Definition at line 180 of file JTest_t.hh.

◆ resultType

const std::string JCOMPAREHISTOGRAMS::JTest_t::resultType

protectedinherited

test result type

Definition at line 181 of file JTest_t.hh.

The documentation for this class was generated from the following file:

JTestChi2_Bin.hh

Public Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ JTestChi2_Bin()

Member Function Documentation

◆ test()

◆ read()

◆ write()

◆ save()

◆ getTestName()

◆ getResultType()

Member Data Documentation

◆ chi2Threshold

◆ outliersThreshold

◆ testName

◆ resultType