JCOMPAREHISTOGRAMS::JTestKolmogorov_Slice2D Class Reference

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. More...
void	test (const TObject *o1, const TObject *o2) override
	Applies Kolmogorov test for two ROOT TH2 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	threshold
	threshold p-value to decide if test is passed. More...
double	failuresThreshold
	threshold p-value to decide if test is passed. More...
char	slice
	axis to slice. x or X for x-axis, y or Y for y-axis, n or N for None. More...

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 31 of file JTestKolmogorov_Slice2D.hh.

Constructor & Destructor Documentation

JCOMPAREHISTOGRAMS::JTestKolmogorov_Slice2D::JTestKolmogorov_Slice2D ( )

inline

Default constructor.

Definition at line 39 of file JTestKolmogorov_Slice2D.hh.

                              :
      JTest_t("KS_Slice2D", "p-Value(KS)")
    {}

Member Function Documentation

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

inlineoverridevirtual

Applies Kolmogorov test for two ROOT TH2 histograms.

Parameters

o1	First histogram
o2	Second histogram

Implements JCOMPAREHISTOGRAMS::JTest_t.

Definition at line 50 of file JTestKolmogorov_Slice2D.hh.

    {
      using namespace std;
      using namespace JPP;

      const TH2* h1 = dynamic_cast<const TH2*>(o1);
      const TH2* h2 = dynamic_cast<const TH2*>(o2);

      if (h1 == NULL || h2 == NULL) {
        THROW(JValueOutOfRange, "JTestKolmogorov_Slice2D::test(): Could not cast given TObjects to TH2.");
      }

      TH1* h3 = NULL;

      const char* const h3name = (h1->GetName() == h2->GetName() ?
                                  MAKE_CSTRING(h1->GetName()                            << "_" << testName << "_" << slice) :
                                  MAKE_CSTRING(h1->GetName() << "_VS_" << h2->GetName() << "_" << testName << "_" << slice));

      int  nFailures = 0;
      int  nSlices   = 0;
    
      if(slice == 'x' || slice == 'X') {
    
        const int nSlices1 = h1->GetNbinsX();
        const int nSlices2 = h2->GetNbinsX();

        if (nSlices1 != nSlices2) {
          THROW(JValueOutOfRange, "JTestKolmogorov_Slice2D::test(): Histograms with different binning. The objects: " << h1->GetName() << " and " << h2->GetName() << " can not be compared." << endl);
        }

        nSlices = nSlices1;

        h3 = h1->ProjectionX(h3name);
      
        for (int i=1 ; i<=nSlices1 ; ++i) {

          const std::string sliceName = MAKE_STRING(h3->GetName() << "_" << to_string(i));
             
          const TH1* s1 = h1->ProjectionY (sliceName.c_str(),i,i);
          const TH1* s2 = h2->ProjectionY (sliceName.c_str(),i,i);

          if (!(s1->GetSumOfWeights() > 0 && s2->GetSumOfWeights() > 0)) { continue; }    
        
          const double p = s1 -> KolmogorovTest (s2);

          if (p < threshold) nFailures++;
        
          h3->SetBinContent(i,p);
        }
            
      } else if (slice == 'y' || slice == 'Y') {
           
        const int nSlices1 = h1->GetNbinsY();
        const int nSlices2 = h2->GetNbinsY();

        if (nSlices1 != nSlices2) {
          THROW(JValueOutOfRange, "JTestKolmogorov_Slice2D::test(): Histograms with different binning. The objects: " << h1->GetName() << " and " << h2->GetName() << " can not be compared." << endl);
        }

        nSlices = nSlices1;     

        h3 = h1->ProjectionY(h3name);
        
        for (int i=1 ; i<=nSlices1 ; ++i){
             
          const std::string sliceName = MAKE_STRING(h3->GetName() << "_" << to_string(i));

          const TH1* s1 = h1->ProjectionX (sliceName.c_str(),i,i);
          const TH1* s2 = h2->ProjectionX (sliceName.c_str(),i,i);

          if (!(s1->GetSumOfWeights() > 0 && s2->GetSumOfWeights() > 0)) { continue; }

          const double p = s1 -> KolmogorovTest (s2);

          if (p < threshold) nFailures++;
        
          h3->SetBinContent(i,p);
        }
      }

      const bool passed = (nFailures/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, passed);
      
      this->push_back(r);
    }

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

inlineoverridevirtual

Read test parameters from input.

Parameters

in	input stream

Returns

input stream

Implements JCOMPAREHISTOGRAMS::JTest_t.

Definition at line 152 of file JTestKolmogorov_Slice2D.hh.

    {
      using namespace JPP;
      
      in >> threshold >> failuresThreshold >> slice;

      if (threshold < 0.0 || threshold > 1.0) {
        THROW(JValueOutOfRange, "JTestKolmogorov_Slice2D::read(): Invalid threshold value " << threshold);
      }

      if (failuresThreshold < 0.0 || failuresThreshold > 1.0) {
        THROW(JValueOutOfRange, "JTestKolmogorov_Slice2D::read(): Invalid failuresThreshold value " << failuresThreshold);
      }
      
      if (slice != 'x' && slice != 'X' && slice != 'y' && slice != 'Y') {
        THROW(JValueOutOfRange, "JTestKolmogorov_Slice2D::read(): Invalid slice option " << slice);
      }

      return in;
    }

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;
    }

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();
      }
    }

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;
    }

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

double JCOMPAREHISTOGRAMS::JTestKolmogorov_Slice2D::threshold

private

threshold p-value to decide if test is passed.

Definition at line 175 of file JTestKolmogorov_Slice2D.hh.

double JCOMPAREHISTOGRAMS::JTestKolmogorov_Slice2D::failuresThreshold

private

threshold p-value to decide if test is passed.

Definition at line 176 of file JTestKolmogorov_Slice2D.hh.

char JCOMPAREHISTOGRAMS::JTestKolmogorov_Slice2D::slice

private

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

Definition at line 177 of file JTestKolmogorov_Slice2D.hh.

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

protectedinherited

test name

Definition at line 180 of file JTest_t.hh.

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