JCOMPAREHISTOGRAMS::JTestRuns_1D Class Reference

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

#include <JTestRuns_1D.hh>

Inheritance diagram for JCOMPAREHISTOGRAMS::JTestRuns_1D:

Public Member Functions
	JTestRuns_1D ()
	Default constructor.
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 Attributes
const std::string	testName
	test name
const std::string	resultType
	test result type

Private Attributes
double	threshold
	threshold value to decide if test is passed.

Detailed Description

Implementation of the Runs test for 1D 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 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 runs test.

Definition at line 29 of file JTestRuns_1D.hh.

Constructor & Destructor Documentation

JTestRuns_1D()

JCOMPAREHISTOGRAMS::JTestRuns_1D::JTestRuns_1D ( )

inline

Default constructor.

Definition at line 37 of file JTestRuns_1D.hh.

                   :
      JTest_t("Runs_1D", "#sigma")
    {}

Member Function Documentation

test()

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

inlineoverridevirtual

Tests the statistical compatibility of two ROOT TObjects.

Parameters

o1	First object
o2	Second object

Implements JCOMPAREHISTOGRAMS::JTest_t.

Definition at line 48 of file JTestRuns_1D.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, "JTestRuns_1D::test(): Could not cast given TObjects to TH1.");
      }
 
      if (h1->GetDimension() != 1 || h2->GetDimension() != 1) {
        THROW(JValueOutOfRange, "JTestRuns_1D::test(): Given histograms must be 1-D.");
      }
 
      if(h1->GetNbinsX() != h2->GetNbinsX()) {
        THROW(JValueOutOfRange, "JTestIdentical::test(): Histograms with different bining. The objects: " <<
              h1->GetName() << " and " << h2->GetName() << " can not be compared." << endl);
      }
 
      const double R = h1->Integral();
      const double T = h2->Integral();
 
      TH1* h3 = (TH1*) h1->Clone(h1->GetName() == h2->GetName() ?
                                 MAKE_CSTRING(h1->GetName()                            << "_" << testName) :
                                 MAKE_CSTRING(h1->GetName() << "_VS_" << h2->GetName() << "_" << testName));
    
      for (int i=1 ; i<h1->GetNbinsX() ; ++i) {
        h3->SetBinContent(i, (T/R)*h1->GetBinContent(i) - h2->GetBinContent(i));
      }
        
      bool a = ((T/R)*h1->GetBinContent(1) - h2->GetBinContent(1)) < 0;
 
      int    n = 1;
      double p = (a ? 1 : 0);
      double q = (a ? 0 : 1);
 
      for (int i = 2 ; i<h1->GetNbinsX() ; ++i){
      
        const bool b = ((T/R)*h1->GetBinContent(i) - h2->GetBinContent(i)) < 0;
 
        (b ? ++p : ++q);
 
        if (b != a){
          ++n;
          a=b;
        }
      }
 
      const double N = 1 + 2*p*q/(p+q) ;
      const double s = sqrt( 2*p*q*(2*p*q-p-q)/(p+q)/(p+q)/(p+q-1) );
      const double d = (n-N)/s;
    
      const bool passed = (fabs(d) < threshold);
 
      const JResultTitle title(testName, resultType , passed , fabs(d));
      
      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, fabs(d), threshold, h3, passed);
      
      this->push_back(r);
    }

read()

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

inlineoverridevirtual

Read test parameters from input.

Parameters

in	input stream

Returns

input stream

Implements JCOMPAREHISTOGRAMS::JTest_t.

Definition at line 124 of file JTestRuns_1D.hh.

    {
      using namespace JPP;
      
      in >> threshold;
 
      if (threshold < 0.0) {
        THROW(JValueOutOfRange, "JTestRuns_1D::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 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

threshold

double JCOMPAREHISTOGRAMS::JTestRuns_1D::threshold

private

threshold value to decide if test is passed.

Definition at line 139 of file JTestRuns_1D.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:

• JTestRuns_1D.hh