Jpp 19.3.0-rc.1
the software that should make you happy
Loading...
Searching...
No Matches
JCOMPAREHISTOGRAMS::JTestRuns_1D Class Reference

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

#include <JTestRuns_1D.hh>

Inheritance diagram for JCOMPAREHISTOGRAMS::JTestRuns_1D:
JCOMPAREHISTOGRAMS::JTest_t std::vector< JTestResult >

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.

37 :
38 JTest_t("Runs_1D", "#sigma")
39 {}
JTest_t(const std::string &testName, const std::string &resultType)
Constructor.
Definition JTest_t.hh:51

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
o1First object
o2Second object

Implements JCOMPAREHISTOGRAMS::JTest_t.

Definition at line 48 of file JTestRuns_1D.hh.

49 {
50 using namespace std;
51 using namespace JPP;
52
53 const TH1* h1 = dynamic_cast<const TH1*>(o1);
54 const TH1* h2 = dynamic_cast<const TH1*>(o2);
55
56 if (h1 == NULL || h2 == NULL) {
57 THROW(JValueOutOfRange, "JTestRuns_1D::test(): Could not cast given TObjects to TH1.");
58 }
59
60 if (h1->GetDimension() != 1 || h2->GetDimension() != 1) {
61 THROW(JValueOutOfRange, "JTestRuns_1D::test(): Given histograms must be 1-D.");
62 }
63
64 if(h1->GetNbinsX() != h2->GetNbinsX()) {
65 THROW(JValueOutOfRange, "JTestIdentical::test(): Histograms with different bining. The objects: " <<
66 h1->GetName() << " and " << h2->GetName() << " can not be compared." << endl);
67 }
68
69 const double R = h1->Integral();
70 const double T = h2->Integral();
71
72 TH1* h3 = (TH1*) h1->Clone(h1->GetName() == h2->GetName() ?
73 MAKE_CSTRING(h1->GetName() << "_" << testName) :
74 MAKE_CSTRING(h1->GetName() << "_VS_" << h2->GetName() << "_" << testName));
75
76 for (int i=1 ; i<h1->GetNbinsX() ; ++i) {
77 h3->SetBinContent(i, (T/R)*h1->GetBinContent(i) - h2->GetBinContent(i));
78 }
79
80 bool a = ((T/R)*h1->GetBinContent(1) - h2->GetBinContent(1)) < 0;
81
82 int n = 1;
83 double p = (a ? 1 : 0);
84 double q = (a ? 0 : 1);
85
86 for (int i = 2 ; i<h1->GetNbinsX() ; ++i){
87
88 const bool b = ((T/R)*h1->GetBinContent(i) - h2->GetBinContent(i)) < 0;
89
90 (b ? ++p : ++q);
91
92 if (b != a){
93 ++n;
94 a=b;
95 }
96 }
97
98 const double N = 1 + 2*p*q/(p+q) ;
99 const double s = sqrt( 2*p*q*(2*p*q-p-q)/(p+q)/(p+q)/(p+q-1) );
100 const double d = (n-N)/s;
101
102 const bool passed = (fabs(d) < threshold);
103
104 const JResultTitle title(testName, resultType , passed , fabs(d));
105
106 h3->SetTitle(title.getTitle().c_str());
107 h3->GetYaxis()->SetTitle(resultType.c_str());
108
109 const JTestResult r(testName,
110 JRootObjectID(MAKE_STRING(h1->GetDirectory()->GetPath() << h1->GetName())),
111 JRootObjectID(MAKE_STRING(h2->GetDirectory()->GetPath() << h1->GetName())),
112 resultType, fabs(d), threshold, h3, passed);
113
114 this->push_back(r);
115 }
#define THROW(JException_t, A)
Marco for throwing exception with std::ostream compatible message.
#define MAKE_CSTRING(A)
Make C-string.
Definition JPrint.hh:72
#define MAKE_STRING(A)
Make string.
Definition JPrint.hh:63
Class dedicated to standardize the title of the graphical objects produced by the JTest_t() derived c...
double threshold
threshold value to decide if test is passed.
const std::string resultType
test result type
Definition JTest_t.hh:181
const std::string testName
test name
Definition JTest_t.hh:180
Auxiliary class to handle file name, ROOT directory and object name.
Exception for accessing a value in a collection that is outside of its range.
const double a
This name space includes all other name spaces (except KM3NETDAQ, KM3NET and ANTARES).
const int n
Definition JPolint.hh:791
Structure containing the result of the test.

◆ read()

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

Read test parameters from input.

Parameters
ininput stream
Returns
input stream

Implements JCOMPAREHISTOGRAMS::JTest_t.

Definition at line 124 of file JTestRuns_1D.hh.

125 {
126 using namespace JPP;
127
128 in >> threshold;
129
130 if (threshold < 0.0) {
131 THROW(JValueOutOfRange, "JTestRuns_1D::read(): Invalid threshold value " << threshold);
132 }
133
134 return in;
135 }

◆ 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
outoutput stream
delimiterfield delimiter
onlyFailuresif true, write only failures.
Returns
output stream

Definition at line 84 of file JTest_t.hh.

87 {
88 using namespace std;
89 using namespace JPP;
90
91 for (vector<JTestResult>::const_iterator r = this->begin() ; r != this->end() ; ++r) {
92
93 if (onlyFailures && r->passed) { continue; }
94
95 print(out, *r, delimiter, true);
96 }
97
98 return out;
99 }
std::ostream & print(std::ostream &out, const JTestSummary &summary, const char delimiter=' ', const bool useColors=true)
Print test summary.

◆ 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
fA ROOT file
pathPath in root file.
onlyFailuresIf true, write only failures.

Definition at line 108 of file JTest_t.hh.

111 {
112 using namespace std;
113 using namespace JPP;
114
115 if (f->GetDirectory(path.c_str())==0) {
116 f->mkdir(path.c_str());
117 }
118
119 f->cd(path.c_str());
120
121 for (vector<JTestResult>::const_iterator r = this->begin() ; r != this->end() ; ++r) {
122
123 if (onlyFailures && r->passed) { continue; }
124
125 r->obj->Write();
126 }
127 }

◆ 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.

136 {
137 return testName;
138 }

◆ 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.

147 {
148 return resultType;
149 }

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: