JCOMPAREHISTOGRAMS::JTestChi2 Class Reference

Implementation of the Chi2 test for ROOT histograms. More...

#include <JTestChi2.hh>

Inheritance diagram for JCOMPAREHISTOGRAMS::JTestChi2:

Public Member Functions
	JTestChi2 ()
	Default constructor.
void	test (const TObject *o1, const TObject *o2) override
	Applies Chi2 test for two ROOT TH1 histograms.
std::istream &	read (std::istream &in) override
	Read test parameters from input.
virtual std::ostream &	write (std::ostream &out, const char delimiter=' ', const bool onlyFailures=false) const
	Write test result to output.
virtual void	save (TFile *f, const std::string &path, const bool onlyFailures=false) const
	Writes the test result to root file.
const std::string &	getTestName () const
	Get test name.
const std::string &	getResultType () const
	Get result type.

Protected Attributes
const std::string	testName
	test name
const std::string	resultType
	test result type

Private Attributes
double	threshold
	Threshold p-value or chi2-value to decide if test is passed.
std::string	options
	Options for the ROOT chi2 test.

Detailed Description

Implementation of the Chi2 test for ROOT 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.
The parameter threshold is used to evaluate whether the test is passed or failed.
The evaluation is done by comparing the threshold value with the result produced by JTestChi2(). The output of a Chi2 test is a p-value.
The parameter threshold should therefore be a real value between 0 and 1.

Definition at line 27 of file JTestChi2.hh.

Constructor & Destructor Documentation

JTestChi2()

JCOMPAREHISTOGRAMS::JTestChi2::JTestChi2 ( )

inline

Default constructor.

Definition at line 35 of file JTestChi2.hh.

                :
      JTest_t("Chi2", "p-Value(chi2)")
    {}

Member Function Documentation

test()

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

inlineoverridevirtual

Applies Chi2 test for two ROOT TH1 histograms.

Parameters

o1	First histogram
o2	Second histogram

Implements JCOMPAREHISTOGRAMS::JTest_t.

Definition at line 46 of file JTestChi2.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::test(): Could not cast given TObjects to TH1.");
      }
 
      vector<Double_t> residuals(h1->GetNcells());
      
      const double chi2 = h1->Chi2Test(h2 , options.c_str(), &residuals[0]);
 
      TH1* h3 = (TH1*) h1->Clone(h1->GetName() == h2->GetName() ?
                                 MAKE_CSTRING(h1->GetName()                            << "_" << testName) :
                                 MAKE_CSTRING(h1->GetName() << "_VS_" << h2->GetName() << "_" << testName));
 
      h3->Reset();
      
      for (int i = 0; i < h1->GetNcells(); ++i) {
        h3->SetBinContent(i+1, residuals[i]);
      }
 
      const bool passed = ( options.find("CHI2") != string::npos ?
                            (chi2 < threshold) :
                            (chi2 > threshold) );
 
      const JResultTitle title(testName, resultType, passed, chi2);
      
      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, chi2, threshold, h3, passed);
     
      this->push_back(r);
    }

read()

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

inlineoverridevirtual

Read test parameters from input.

Parameters

in	input stream

Returns

input stream

Implements JCOMPAREHISTOGRAMS::JTest_t.

Definition at line 103 of file JTestChi2.hh.

    {
      using namespace JPP;
      
      in >> threshold >> options;
 
      if (threshold < 0.0) {
        THROW(JValueOutOfRange, "JTestChi2::read(): Invalid threshold value " << threshold);    
      }
 
      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 85 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 109 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 136 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 147 of file JTest_t.hh.

    {
      return resultType;
    }

Member Data Documentation

threshold

double JCOMPAREHISTOGRAMS::JTestChi2::threshold

private

Threshold p-value or chi2-value to decide if test is passed.

Definition at line 118 of file JTestChi2.hh.

options

std::string JCOMPAREHISTOGRAMS::JTestChi2::options

private

Options for the ROOT chi2 test.

Definition at line 119 of file JTestChi2.hh.

testName

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

protectedinherited

test name

Definition at line 181 of file JTest_t.hh.

resultType

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

protectedinherited

test result type

Definition at line 182 of file JTest_t.hh.

---

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

• JTestChi2.hh