Implementation of the Kolmogorov test for 2D histograms. More...

#include <JTestKolmogorov_Slice2D.hh>

Inheritance diagram for JCOMPAREHISTOGRAMS::JTestKolmogorov_Slice2D:

Public Member Functions
	JTestKolmogorov_Slice2D ()
	Default constructor.

void	check (const TH1 h1, const TH1 h2) const
	Check if given input histograms have equal binning.

TH1 &	getProjectionOntoSlicedAxis (const TH2 &h, const char const name="projection", const Int_t firstBin=0, const Int_t lastBin=-1, const Option_t option="") const
	Get projection of given 2D histogram onto sliced axis.

TH1 &	getProjection (const TH2 &h, const char const name="projection", const Int_t firstBin=0, const Int_t lastBin=-1, const Option_t option="") const
	Get projection of given 2D histogram onto non-sliced axis.

void	test (const TObject o1, const TObject o2) override
	Tests the statistical compatibility of two ROOT TObjects.

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 Types
typedef TH1D (TH2::)	pFunction(const char , Int_t, Int_t, Option_t ) const
	Type definition of pointer to `TH2` member function for projection.

Protected Attributes
pFunction	mfp1
	Pointer to `TH2` member method for projections onto the sliced axis.

pFunction	mfp2
	Pointer to `TH2` member method for projections onto the non-sliced axis.

std::unique_ptr< JTest_t >	pTest1D
	Unique pointer to 1D test variant.

double	threshold
	threshold value to decide if test has passed.

double	failuresThreshold
	threshold value to decide if test has passed.

char	slice
	Axis to slice. x or X for x-axis, y or Y for y-axis, n or N for None.

const std::string	testName
	test name

const std::string	resultType
	test result type

Detailed Description

Implementation of the Kolmogorov 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.
This test compares two 2D histograms. If the parameter slice equals x, X y or Y, the histograms are sliced along the corresponding axis, and the Kolmogorov test is applied to each slice.
The input parameter threshold, is used to evaluate whether the test is passed or failed for each slice or for the full 2D distribution.
The evaluation is done by comparing the threshold value with the resulting p-value.
The parameter threshold should therefore be a real value between 0 and 1.

Definition at line 33 of file JTestKolmogorov_Slice2D.hh.

Member Typedef Documentation

◆ pFunction

TH1D *(TH2::*) JCOMPAREHISTOGRAMS::JTestSlice2D::pFunction(const char *, Int_t, Int_t, Option_t *) const

protectedinherited

Type definition of pointer to TH2 member function for projection.

Definition at line 260 of file JTestSlice2D.hh.

Constructor & Destructor Documentation

◆ JTestKolmogorov_Slice2D()

JCOMPAREHISTOGRAMS::JTestKolmogorov_Slice2D::JTestKolmogorov_Slice2D ( )

inline

Default constructor.

Definition at line 41 of file JTestKolmogorov_Slice2D.hh.

                              :
      JTestSlice2D("KS_Slice2D", "p-Value(KS)", new JTestKolmogorov_1D())
    {}

Member Function Documentation

◆ check()

void JCOMPAREHISTOGRAMS::JTestSlice2D::check	(	const TH1 *	h1,
		const TH1 *	h2 ) const

inlineinherited

Check if given input histograms have equal binning.

Parameters

h1	first histogram
h2	second histogram

Definition at line 66 of file JTestSlice2D.hh.

    {
      using namespace JPP;
 
      if (h1 == NULL || h2 == NULL) {
        THROW(JCastException, "JTestSlice2D::check(): Could not cast given TObjects to TH2.");
      }
      
      int nSlices1 = 0;
      int nSlices2 = 0;
      
      if        (slice == 'x' || slice == 'X') {
 
        nSlices1 = h1->GetNbinsX();
        nSlices2 = h2->GetNbinsX();
        
      } else if (slice == 'y' || slice == 'Y') {
 
        nSlices1 = h1->GetNbinsY();
        nSlices2 = h2->GetNbinsY();
      }
 
      if (nSlices1 != nSlices2) {
        THROW(JValueOutOfRange, "JTestSlice2D::configure(): Histograms with different binning. The objects: " << h1->GetName() << " and " << h2->GetName() << " can not be compared");
      }
    }

◆ getProjectionOntoSlicedAxis()

TH1 & JCOMPAREHISTOGRAMS::JTestSlice2D::getProjectionOntoSlicedAxis	(	const TH2 &	h,
		const char *const	name = "projection",
		const Int_t	firstBin = 0,
		const Int_t	lastBin = -1,
		const Option_t *	option = "" ) const

inlineinherited

Get projection of given 2D histogram onto sliced axis.

Parameters

h	histogram
name	name
firstBin	first bin
lastBin	last bin
option	option

Returns: projection of input histogram on sliced axis

Definition at line 105 of file JTestSlice2D.hh.

    {
      using namespace JPP;
      
      TH1* hp = (h.*mfp1)(name, firstBin, lastBin, option);
 
      if (hp != NULL) {
        return *hp;
      } else {
        THROW(JNullPointerException, "JTestSlice2D::getProjectionOntoSlicedAxis(): Projection failed.");
      }
    }

◆ getProjection()

TH1 & JCOMPAREHISTOGRAMS::JTestSlice2D::getProjection	(	const TH2 &	h,
		const char *const	name = "projection",
		const Int_t	firstBin = 0,
		const Int_t	lastBin = -1,
		const Option_t *	option = "" ) const

inlineinherited

Get projection of given 2D histogram onto non-sliced axis.

Parameters

h	histogram
name	name
firstBin	first bin
lastBin	last bin
option	option

Returns: projection of input histogram on sliced axis

Definition at line 133 of file JTestSlice2D.hh.

    {
      using namespace JPP;
      
      TH1* hp =  (h.*mfp2)(name, firstBin, lastBin, option);
 
      if (hp != NULL) {
        return *hp;
      } else {
        THROW(JNullPointerException, "JTestSlice2D::getProjection(): Projection failed.");
      }
    }

◆ test()

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

inlineoverridevirtualinherited

Tests the statistical compatibility of two ROOT TObjects.

Parameters

o1	First object
o2	Second object

Implements JCOMPAREHISTOGRAMS::JTest_t.

Definition at line 157 of file JTestSlice2D.hh.

    {    
      using namespace std;
      using namespace JPP;
 
      const TH2* h1 = dynamic_cast<const TH2*>(o1);
      const TH2* h2 = dynamic_cast<const TH2*>(o2);
 
      check(h1, h2);
      
      const char* const h3name = (h1->GetName() == h2->GetName() ?
                                  MAKE_CSTRING(h1->GetName()                            << "_" << testName << "_" << slice) :
                                  MAKE_CSTRING(h1->GetName() << "_VS_" << h2->GetName() << "_" << testName << "_" << slice));
 
      TH1& h3 = getProjectionOntoSlicedAxis(*h1, h3name);
 
      const int nSlices = h3.GetNbinsX();
      
      int nFailures = 0;
 
      for (int i=1 ; i<=nSlices ; ++i){
 
        const std::string sliceName = MAKE_STRING(h3.GetName() << "_" << to_string(i));
             
        const TH1& s1 = getProjection(*h1, sliceName.c_str(), i, i);
        const TH1& s2 = getProjection(*h2, sliceName.c_str(), i, i);
 
        if (!(s1.GetSumOfWeights() > 0 && s2.GetSumOfWeights() > 0)) { continue; }
 
        pTest1D->test(&s1, &s2);
 
        const JTestResult& result1D = pTest1D->back();
        
        if (!result1D.passed) nFailures++;
        
        h3.SetBinContent(i, result1D.parameterValue);
      }
 
      const bool passed = (nFailures/((double) nSlices) < failuresThreshold);
      
      const JResultTitle title(testName, resultType, passed , nFailures);
 
      h3.SetTitle(title.getTitle().c_str());
      h3.GetYaxis()->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, nFailures, failuresThreshold, h3.Clone(), passed);
 
      this->push_back(r);
 
      pTest1D->clear();
    }

◆ read()

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

inlineoverridevirtualinherited

Read test parameters from input.

Parameters

in	input stream

Returns: input stream

Implements JCOMPAREHISTOGRAMS::JTest_t.

Definition at line 219 of file JTestSlice2D.hh.

    {
      using namespace std;
      using namespace JPP;
 
      if (pTest1D) {
        
        try {
          in >> (*pTest1D);
        }
        catch (const std::exception& error) {
          THROW(JValueOutOfRange, "JTestSlice2D::read(): Could not read 1D test variant parameters due to the following error:" << endl << error.what());
        }
        
      } else {
        THROW(JNullPointerException, "JTestSlice2D::read(): 1D test variant is not set");
      }
      
      in >> failuresThreshold >> slice;
      
      if (failuresThreshold < 0.0 || failuresThreshold > 1.0) {
        THROW(JValueOutOfRange, "JTestSlice2D::read(): Invalid failuresThreshold value " << failuresThreshold);
      }
 
      if        (slice == 'x' || slice == 'X') {
        mfp1 = &TH2::ProjectionX;
        mfp2 = &TH2::ProjectionY;
      } else if (slice == 'y' || slice == 'Y') {
        mfp1 = &TH2::ProjectionY;       
        mfp2 = &TH2::ProjectionX;
      } else {
        THROW(JValueOutOfRange, "JTestSlice2D::read(): Invalid slice option \'" << slice << "\'");
      }
                                                                           
      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

◆ mfp1

pFunction JCOMPAREHISTOGRAMS::JTestSlice2D::mfp1

protectedinherited

Pointer to TH2 member method for projections onto the sliced axis.

Definition at line 262 of file JTestSlice2D.hh.

◆ mfp2

pFunction JCOMPAREHISTOGRAMS::JTestSlice2D::mfp2

protectedinherited

Pointer to TH2 member method for projections onto the non-sliced axis.

Definition at line 263 of file JTestSlice2D.hh.

◆ pTest1D

std::unique_ptr<JTest_t> JCOMPAREHISTOGRAMS::JTestSlice2D::pTest1D

protectedinherited

Unique pointer to 1D test variant.

Definition at line 265 of file JTestSlice2D.hh.

◆ threshold

double JCOMPAREHISTOGRAMS::JTestSlice2D::threshold

protectedinherited

threshold value to decide if test has passed.

Definition at line 267 of file JTestSlice2D.hh.

◆ failuresThreshold

double JCOMPAREHISTOGRAMS::JTestSlice2D::failuresThreshold

protectedinherited

threshold value to decide if test has passed.

Definition at line 268 of file JTestSlice2D.hh.

◆ slice

char JCOMPAREHISTOGRAMS::JTestSlice2D::slice

protectedinherited

Axis to slice. x or X for x-axis, y or Y for y-axis, n or N for None.

Definition at line 269 of file JTestSlice2D.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:

JTestKolmogorov_Slice2D.hh

Public Member Functions

Protected Types

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ pFunction

Constructor & Destructor Documentation

◆ JTestKolmogorov_Slice2D()

Member Function Documentation

◆ check()

◆ getProjectionOntoSlicedAxis()

◆ getProjection()

◆ test()

◆ read()

◆ write()

◆ save()

◆ getTestName()

◆ getResultType()

Member Data Documentation

◆ mfp1

◆ mfp2

◆ pTest1D

◆ threshold

◆ failuresThreshold

◆ slice

◆ testName

◆ resultType