JTestKolmogorov_1D Class Reference

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

#include <JTestKolmogorov_1D.hh>

Inheritance diagram for JTestKolmogorov_1D:

Public Member Functions
	JTestKolmogorov_1D ()
	Default constructor. More...
std::istream &	read (std::istream &in) override
	Read test parameters from input. More...
std::ostream &	write (std::ostream &out, std::string delimiter=" ", bool onlyFailures=false) const override
	Write test result to output. More...
void	test (TObject *o1, TObject *o2) override
	Applies Kolmogorov test for two ROOT TH1 histograms. More...
virtual void	save (TFile *f, std::string path, bool onlyFailures=false) override
	Writes the test result to root file. More...
void	clear () override
	Clear results. More...
std::string	getName () override
	Get test name. More...
std::string	getParameter () override
	Get parameter name. More...
JTestResult	JKolmogorovTest (TH1 *h1, TH1 *h2, double threshold, std::string testName, std::string parameterName)
	Kolmogorov test for 1D histograms. More...
JTestResult	JKolmogorovTestSlice (TH2 *h1, TH2 *h2, double threshold, double failuresThreshold, std::string testName, std::string parameterName, char slice)
	Kolmogorov test for sliced 2D histograms. More...
JTestResult	JKolmogorovTest2D (TH2 *h1, TH2 *h2, double threshold, std::string testName, std::string parameterName)
	Kolmogorov test for 2D histograms. More...

Public Attributes
std::vector< JTestResult >	results

Private Attributes
double	threshold
	threshold p-value to decide if test is passed. More...
const std::string	name = "KS_1D"
	test name. More...
const std::string	parameter = "p-Value(KS)"
	parameter name. More...

Detailed Description

Implementation of the Kolmogorov test for 1D histograms.

Author

rgruiz
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 uses the input parameter threshold() to evaluate whether the test is passed or failed.
The evaluation is done by comparing the threshold value with the result of the JKolmogorovTest() test. This is a p-value.
The parameter threshold should therefore be a real value between 0 and 1.

Definition at line 22 of file JTestKolmogorov_1D.hh.

Constructor & Destructor Documentation

JTestKolmogorov_1D::JTestKolmogorov_1D ( )

inline

Default constructor.

Definition at line 31 of file JTestKolmogorov_1D.hh.

{}

Member Function Documentation

std::istream& JTestKolmogorov_1D::read ( std::istream &  in )

inlineoverridevirtual

Read test parameters from input.

Parameters

in	input stream

Returns

input stream

Implements JTest_t.

Definition at line 39 of file JTestKolmogorov_1D.hh.

                                           { 
    return in >> threshold;
  };

std::ostream& JTestKolmogorov_1D::write ( std::ostream &  out, std::string  delimiter = " ", bool  onlyFailures = false  ) const

inlineoverridevirtual

Write test result to output.

Parameters

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

Returns

output stream

Implements JTest_t.

Definition at line 52 of file JTestKolmogorov_1D.hh.

                                                                                                         {
    for (std::vector<JTestResult>::const_iterator r = results.begin() ; r != results.end() ; ++r) {
      if (onlyFailures){
        if (!r->passed)
          out << std::scientific << std::setprecision(2) << (r->passed ? JPP::GREEN : JPP::RED) << r->print(delimiter) << std::endl;
      }else{
        out << std::scientific << std::setprecision(2) << (r->passed ? JPP::GREEN : JPP::RED) << r->print(delimiter) << std::endl;
      }
    }
    return out;
  };

void JTestKolmogorov_1D::test ( TObject *  o1, TObject *  o2  )

inlineoverridevirtual

Applies Kolmogorov test for two ROOT TH1 histograms.

Parameters

o1	First histogram
o2	Second histogram

Implements JTest_t.

Definition at line 71 of file JTestKolmogorov_1D.hh.

                                              {    

    using namespace std;
    
    if (!(dynamic_cast<TH2*>(o1) == NULL) || !(dynamic_cast<TH2*>(o2) == NULL)) {
      ERROR("For 2D histograms call JTestKolmogorov_2D: " << o1->GetName() << endl);
    
    } else if (!(dynamic_cast<TH1*>(o1) == NULL) && !(dynamic_cast<TH1*>(o2) == NULL)) {
      
      TH1D* h1 =  dynamic_cast<TH1D*>(o1);
      TH1D* h2 =  dynamic_cast<TH1D*>(o2);

      JTestResult r = JKolmogorovTest(h1, h2, threshold, name, parameter);
  
      results.push_back(r);
    }
  };

virtual void JTestKolmogorov_1D::save ( TFile *  f, std::string  path, bool  onlyFailures = false  )

inlineoverridevirtual

Writes the test result to root file.

Parameters

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

Implements JTest_t.

Definition at line 96 of file JTestKolmogorov_1D.hh.

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

void JTestKolmogorov_1D::clear ( )

inlineoverridevirtual

Clear results.

Implements JTest_t.

Definition at line 120 of file JTestKolmogorov_1D.hh.

                       {
    results.clear();
  }

std::string JTestKolmogorov_1D::getName ( )

inlineoverridevirtual

Get test name.

Implements JTest_t.

Definition at line 127 of file JTestKolmogorov_1D.hh.

                              {
    return name;
  }

std::string JTestKolmogorov_1D::getParameter ( )

inlineoverridevirtual

Get parameter name.

Implements JTest_t.

Definition at line 134 of file JTestKolmogorov_1D.hh.

                                   {
    return parameter;
  }

JTestResult JTestKolmogorov_t::JKolmogorovTest ( TH1 *  h1, TH1 *  h2, double  threshold, std::string  testName, std::string  parameterName  )

inlineinherited

Kolmogorov test for 1D histograms.

The input 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 of the Kolmogorov test. The output of a Kolmogorov test is a p-value.
The parameter threshold should therefore be a real value between 0 and 1.

Parameters

h1	First histogram
h2	Second historgram
threshold	p-value
parameterName	Name of the parameter used to test the histograms
testName	Name of the test used to compare the histograms

Returns

Test result

Definition at line 37 of file JTestKolmogorov_t.hh.

                                                                                                               {    

    using namespace std;
    using namespace JPP;
      
    int n1 = h1 -> GetNbinsX();
    int n2 = h2 -> GetNbinsX();

    if(n1 != n2)
      ERROR("Histograms with different bining. The objects: " << h1 -> GetName() << " can not be compared." << endl);
     
    TH2D* h3 = (TH2D*)h1->Clone(h1->GetName()==h2->GetName() ?
                                MAKE_CSTRING(to_string(h1->GetName())) :
                                MAKE_CSTRING(to_string(h1->GetName()) + "_VS_" + to_string(h2->GetName())));

    bool afunc1 = false;
    bool afunc2 = false;
    double s1 = 1./h1->Integral();
    double s2 = 1./h2->Integral();

    double ew1, ew2, w1 = 0, w2 = 0;

    for (int bin = 1; bin <= n1; ++bin){
      ew1 = h1->GetBinError(bin);
      ew2 = h2->GetBinError(bin);
      w1 += ew1*ew1;
      w2 += ew2*ew2;
    }
    
    double esum1 = 0, esum2 = 0;
    if (w1 > 0)
       esum1 = 1./s1/s1/w1;
    else
       afunc1 = true;
    if (w2 > 0)
       esum2 = 1./s2/s2/w2;
    else
       afunc2 = true;
    if (afunc2 && afunc1) {
       ERROR("Errors are zero for both histograms\n");
    }
 
    double c1 = 0, c2 = 0;
 
    double dmax = 0;
    for (int bin=1 ; bin<=n1 ; ++bin){
      c1 += s1*h1->GetBinContent(bin);
      c2 += s2*h2->GetBinContent(bin);
      double d = TMath::Abs(c1-c2)*TMath::Sqrt(esum1*esum2/(esum1+esum2));
      double p = TMath::KolmogorovProb(d);
      h3->SetBinContent(bin,p);
      dmax = TMath::Max(dmax,TMath::Abs(c1-c2));
    }
 
    double z;
    
    if  (afunc1)
      z = dmax*TMath::Sqrt(esum2);
    else if (afunc2)
      z = dmax*TMath::Sqrt(esum1);
    else
      z = dmax*TMath::Sqrt(esum1*esum2/(esum1+esum2));
    
    double pValue = TMath::KolmogorovProb(z);

    bool passed;
    
    (pValue < threshold ? passed = false : passed = true);
    
    JResultTitle title(testName, parameterName, passed , pValue);
    
    h3->SetTitle(title.getTitle().c_str());
    
    JTestResult r (testName,
                   string (h1->GetDirectory()->GetPath()).append(h1->GetName()),
                   string (h2->GetDirectory()->GetPath()).append(h2->GetName()),
                   h1->GetDirectory()->GetFile()->GetName(),
                   h2->GetDirectory()->GetFile()->GetName(),
                   parameterName, pValue, threshold, h3, passed);

    return r;
  };

JTestResult JTestKolmogorov_t::JKolmogorovTestSlice ( TH2 *  h1, TH2 *  h2, double  threshold, double  failuresThreshold, std::string  testName, std::string  parameterName, char  slice  )

inlineinherited

Kolmogorov test for sliced 2D histograms.

The histograms are sliced along the axis specified by the slice parameter. A slice per bin is made.
For each of the slices, the input 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 of the Kolmogorov test. The output of the Kolmogorov test is a p-value.
The parameter threshold should therefore be a real value between 0 and 1. The fraction of failed tests is compared to the input parameter failuresThreshold. If this fraction is larger than failuresThreshold, the test fails.

Parameters

h1	First histogram
h2	Second histogram
threshold	Threshold value for the test result
failuresThreshold	Threshold value for the test result
parameterName	Name of the parameter used to test the histograms
testName	Name of the test used to compare the histograms
slice	The axis along which the histogram is sliced.

Returns

Test result.

Definition at line 139 of file JTestKolmogorov_t.hh.

                                                                                                                                                          {

    using namespace std;
    using namespace JPP;

    int nFailures = 0;

    JTestResult r;
    
    if(slice == 'x' || slice == 'X'){
    
      int nSlices1 = h1->GetNbinsX();
      int nSlices2 = h2->GetNbinsX();

      TH1* h3 = h1->ProjectionX(h1->GetName()==h2->GetName() ?
                                MAKE_CSTRING(to_string(h1->GetName())) :
                                MAKE_CSTRING(to_string(h1->GetName()) + "_VS_" + to_string(h2->GetName())));
      
      if(nSlices1 != nSlices2)
        ERROR("Histograms with different binning. The objects: " << h1->GetName() << " and " << h2->GetName() << " can not be compared." << endl);

      for (int i=1 ; i<=nSlices1 ; ++i){

        std::string sliceName = MAKE_STRING(h1->GetName() + to_string("_") + to_string(i));
             
        TH1D* s1 = h1->ProjectionY (sliceName.c_str(),i,i);
        TH1D* s2 = h2->ProjectionY (sliceName.c_str(),i,i);
        
        double p = s1 -> KolmogorovTest (s2);

        bool passed;
        
        (p < threshold ? passed = false : passed = true);

        if (!passed) nFailures++;
        
        h3->SetBinContent(i,p);
        
      }

      bool passed;

      (nFailures/nSlices1 > failuresThreshold ? passed = false : passed = true);
      
      JResultTitle title(testName, parameterName, passed , nFailures);
      
      h3->SetTitle(title.getTitle().c_str());
      
      r = JTestResult  (testName,
                        string (h1->GetDirectory()->GetPath()).append(h1->GetName()),
                        string (h2->GetDirectory()->GetPath()).append(h2->GetName()),
                        h1->GetDirectory()->GetFile()->GetName(),
                        h2->GetDirectory()->GetFile()->GetName(),
                        parameterName, nFailures, failuresThreshold, h3, passed);
            
    }else if (slice == 'y' || slice == 'Y'){
           
      int nSlices1 = h1->GetNbinsY();
      int nSlices2 = h2->GetNbinsY();

      TH1* h3 = h1->ProjectionY(h1->GetName()==h2->GetName() ?
                                MAKE_CSTRING(to_string(h1->GetName())) :
                                MAKE_CSTRING(to_string(h1->GetName()) + "_VS_" + to_string(h2->GetName())));
      
      if(nSlices1 != nSlices2)
        ERROR("Histograms with different binning. The objects: " << h1->GetName() << " can not be compared." << endl);

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

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

        double p = s1 -> KolmogorovTest (s2);

        bool passed;
        
        (p < threshold ? passed = false : passed = true);

        if (!passed) nFailures++;
        
        h3->SetBinContent(i,p);
      }
      
      bool passed;
      
      (nFailures/nSlices1 > failuresThreshold ? passed = false : passed = true);
      
      JResultTitle title(testName, parameterName, passed , nFailures);
      
      h3->SetTitle(title.getTitle().c_str());
      
      r = JTestResult (testName,
                       string (h1->GetDirectory()->GetPath()).append(h1->GetName()),
                       string (h2->GetDirectory()->GetPath()).append(h2->GetName()),
                       h1->GetDirectory()->GetFile()->GetName(),
                       h2->GetDirectory()->GetFile()->GetName(),
                       parameterName, nFailures, failuresThreshold, h3, passed);
      
    }

    return r;
  };

JTestResult JTestKolmogorov_t::JKolmogorovTest2D ( TH2 *  h1, TH2 *  h2, double  threshold, std::string  testName, std::string  parameterName  )

inlineinherited

Kolmogorov test for 2D histograms.

The input 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 of the Kolmogorov test. The output of a Kolmogorov test is a p-value.
The parameter threshold should therefore be a real value between 0 and 1.

Parameters

h1	First histogram
h2	Second historgram
threshold	p-value
parameterName	Name of the parameter used to test the histograms
testName	Name of the test used to compare the histograms

Returns

Test result

Definition at line 260 of file JTestKolmogorov_t.hh.

                                                                                                                 {    

    using namespace std;
    using namespace JPP;
    
    int n1x = h1 -> GetNbinsX();
    int n2x = h2 -> GetNbinsX();
    int n1y = h1 -> GetNbinsY();
    int n2y = h2 -> GetNbinsY();

    if(n1x != n2x || n1y != n2y)
      ERROR("Histograms with different bining. The objects: " << h1 -> GetName() << " can not be compared." << endl);
     
    if(h1->Integral()==0 || h2->Integral()==0)
      ERROR("Empty histogram: " << h1 -> GetName() << " can not be compared." << endl);

    double s1 = 1./h1->Integral();
    double s2 = 1./h2->Integral();

    TH2D* h3 = (TH2D*)h1->Clone(h1->GetName()==h2->GetName() ?
                                MAKE_CSTRING(to_string(h1->GetName())) :
                                MAKE_CSTRING(to_string(h1->GetName()) + "_VS_" + to_string(h2->GetName())));

    bool afunc1 = false;
    bool afunc2 = false;

    double ew1, ew2, w1 = 0, w2 = 0;

    for (int i = 1; i <= n1x; ++i){
      for (int j = 1; j <= n1y; ++j){
        ew1 = h1->GetBinError(i,j);
        ew2 = h2->GetBinError(i,j);
        w1 += ew1*ew1;
        w2 += ew2*ew2;
      }
    }
    
    double esum1 = 0, esum2 = 0;
    if (w1 > 0)
       esum1 = 1./s1/s1/w1;
    else
       afunc1 = true;
    if (w2 > 0)
       esum2 = 1./s2/s2/w2;
    else
       afunc2 = true;
    if (afunc2 && afunc1) {
       ERROR("Errors are zero for both histograms\n");
    }
 
    double c1 = 0, c2 = 0;

    double dmax1 = 0;
    for (int i=1 ; i<=n1x ; ++i){
      for (int j=1 ; j<=n1y ; ++j){
        c1 += s1*h1->GetBinContent(i,j);
        c2 += s2*h2->GetBinContent(i,j);
        double d = TMath::Abs(c1-c2)*TMath::Sqrt(esum1*esum2/(esum1+esum2));
        h3->Fill(i,j,d);
        dmax1 = TMath::Max(dmax1,TMath::Abs(c1-c2));
      }
    }

    c1 = 0, c2 = 0;
    
    double dmax2 = 0;
    for (int j=1 ; j<=n1y ; ++j){
      for (int i=1 ; i<=n1x ; ++i){
        c1 += s1*h1->GetBinContent(i,j);
        c2 += s2*h2->GetBinContent(i,j);
        double d = TMath::Abs(c1-c2)*TMath::Sqrt(esum1*esum2/(esum1+esum2));
        h3->Fill(i,j,d);
        dmax1 = TMath::Max(dmax2,TMath::Abs(c1-c2));
      }
    }
        
    double dmax = 0.5*(dmax1+dmax2);
    double z;

    if  (afunc1)
      z = dmax*TMath::Sqrt(esum2);
    else if (afunc2)
      z = dmax*TMath::Sqrt(esum1);
    else
      z = dmax*TMath::Sqrt(esum1*esum2/(esum1+esum2));
    
    double pValue = TMath::KolmogorovProb(z);

    for (int i=1 ; i<=n1x ; ++i){
      for (int j=1 ; j<=n1y ; ++j){
        h3->SetBinContent(i,j,TMath::KolmogorovProb(0.5 * h3->GetBinContent(i,j)));
      }
    }

    bool passed;
    
    (pValue < threshold ? passed = false : passed = true);
    
    JResultTitle title(testName, parameterName, passed , pValue);
    
    h3->SetTitle(title.getTitle().c_str());
    
    JTestResult r (testName,
                   string (h1->GetDirectory()->GetPath()).append(h1->GetName()),
                   string (h2->GetDirectory()->GetPath()).append(h2->GetName()),
                   h1->GetDirectory()->GetFile()->GetName(),
                   h2->GetDirectory()->GetFile()->GetName(),
                   parameterName, pValue, threshold, h3, passed);

    return r;
  };

Member Data Documentation

double JTestKolmogorov_1D::threshold

private

threshold p-value to decide if test is passed.

Definition at line 139 of file JTestKolmogorov_1D.hh.

const std::string JTestKolmogorov_1D::name = "KS_1D"

private

test name.

Definition at line 140 of file JTestKolmogorov_1D.hh.

const std::string JTestKolmogorov_1D::parameter = "p-Value(KS)"

private

parameter name.

Definition at line 141 of file JTestKolmogorov_1D.hh.

std::vector<JTestResult> JTest_t::results

inherited

Buffer to store results of multiple tests.

Definition at line 251 of file JTest_t.hh.

---

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

• JTestKolmogorov_1D.hh