Jpp test-rotations-old
the software that should make you happy
Loading...
Searching...
No Matches
JCOMPAREHISTOGRAMS::JTestKolmogorov_Slice2D Class Reference

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

#include <JTestKolmogorov_Slice2D.hh>

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

Public Member Functions

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

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

Constructor & Destructor Documentation

◆ JTestKolmogorov_Slice2D()

JCOMPAREHISTOGRAMS::JTestKolmogorov_Slice2D::JTestKolmogorov_Slice2D ( )
inline

Default constructor.

Definition at line 40 of file JTestKolmogorov_Slice2D.hh.

40 :
41 JTest_t("KS_Slice2D", "p-Value(KS)")
42 {}
JTest_t(const std::string &testName, const std::string &resultType)
Constructor.
Definition JTest_t.hh:51

Member Function Documentation

◆ test()

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

Applies Kolmogorov test for two ROOT TH2 histograms.

Parameters
o1First histogram
o2Second histogram

Implements JCOMPAREHISTOGRAMS::JTest_t.

Definition at line 51 of file JTestKolmogorov_Slice2D.hh.

52 {
53 using namespace std;
54 using namespace JPP;
55
56 const TH2* h1 = dynamic_cast<const TH2*>(o1);
57 const TH2* h2 = dynamic_cast<const TH2*>(o2);
58
59 if (h1 == NULL || h2 == NULL) {
60 THROW(JValueOutOfRange, "JTestKolmogorov_Slice2D::test(): Could not cast given TObjects to TH2.");
61 }
62
63 TH1* h3 = NULL;
64
65 const char* const h3name = (h1->GetName() == h2->GetName() ?
66 MAKE_CSTRING(h1->GetName() << "_" << testName << "_" << slice) :
67 MAKE_CSTRING(h1->GetName() << "_VS_" << h2->GetName() << "_" << testName << "_" << slice));
68
69 int nFailures = 0;
70 int nSlices = 0;
71
72 if(slice == 'x' || slice == 'X') {
73
74 const int nSlices1 = h1->GetNbinsX();
75 const int nSlices2 = h2->GetNbinsX();
76
77 if (nSlices1 != nSlices2) {
78 THROW(JValueOutOfRange, "JTestKolmogorov_Slice2D::test(): Histograms with different binning. The objects: " << h1->GetName() << " and " << h2->GetName() << " can not be compared." << endl);
79 }
80
81 nSlices = nSlices1;
82
83 h3 = h1->ProjectionX(h3name);
84
85 for (int i=1 ; i<=nSlices1 ; ++i) {
86
87 const std::string sliceName = MAKE_STRING(h3->GetName() << "_" << to_string(i));
88
89 const TH1* s1 = h1->ProjectionY (sliceName.c_str(),i,i);
90 const TH1* s2 = h2->ProjectionY (sliceName.c_str(),i,i);
91
92 if (!(s1->GetSumOfWeights() > 0 && s2->GetSumOfWeights() > 0)) { continue; }
93
94 const double p = s1 -> KolmogorovTest (s2);
95
96 if (p < threshold) nFailures++;
97
98 h3->SetBinContent(i,p);
99 }
100
101 } else if (slice == 'y' || slice == 'Y') {
102
103 const int nSlices1 = h1->GetNbinsY();
104 const int nSlices2 = h2->GetNbinsY();
105
106 if (nSlices1 != nSlices2) {
107 THROW(JValueOutOfRange, "JTestKolmogorov_Slice2D::test(): Histograms with different binning. The objects: " << h1->GetName() << " and " << h2->GetName() << " can not be compared." << endl);
108 }
109
110 nSlices = nSlices1;
111
112 h3 = h1->ProjectionY(h3name);
113
114 for (int i=1 ; i<=nSlices1 ; ++i){
115
116 const std::string sliceName = MAKE_STRING(h3->GetName() << "_" << to_string(i));
117
118 const TH1* s1 = h1->ProjectionX (sliceName.c_str(),i,i);
119 const TH1* s2 = h2->ProjectionX (sliceName.c_str(),i,i);
120
121 if (!(s1->GetSumOfWeights() > 0 && s2->GetSumOfWeights() > 0)) { continue; }
122
123 const double p = s1 -> KolmogorovTest (s2);
124
125 if (p < threshold) nFailures++;
126
127 h3->SetBinContent(i,p);
128 }
129 }
130
131 const bool passed = (nFailures/nSlices < failuresThreshold);
132
133 const JResultTitle title(testName, resultType, passed, nFailures);
134
135 h3->SetTitle(title.getTitle().c_str());
136 h3->GetYaxis()->SetTitle(resultType.c_str());
137
138 const JTestResult r(testName,
139 JRootObjectID(MAKE_STRING(h1->GetDirectory()->GetPath() << h1->GetName())),
140 JRootObjectID(MAKE_STRING(h2->GetDirectory()->GetPath() << h1->GetName())),
141 resultType, nFailures, failuresThreshold, h3, passed);
142
143 this->push_back(r);
144 }
#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 failuresThreshold
threshold p-value to decide if test is passed.
double threshold
threshold p-value to decide if test is 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 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.
std::string to_string(const T &value)
Convert value to string.
This name space includes all other name spaces (except KM3NETDAQ, KM3NET and ANTARES).
Structure containing the result of the test.

◆ read()

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

Read test parameters from input.

Parameters
ininput stream
Returns
input stream

Implements JCOMPAREHISTOGRAMS::JTest_t.

Definition at line 153 of file JTestKolmogorov_Slice2D.hh.

154 {
155 using namespace JPP;
156
158
160 THROW(JValueOutOfRange, "JTestKolmogorov_Slice2D::read(): Invalid threshold value " << threshold);
161 }
162
164 THROW(JValueOutOfRange, "JTestKolmogorov_Slice2D::read(): Invalid failuresThreshold value " << failuresThreshold);
165 }
166
167 if (slice != 'x' && slice != 'X' && slice != 'y' && slice != 'Y') {
168 THROW(JValueOutOfRange, "JTestKolmogorov_Slice2D::read(): Invalid slice option " << slice);
169 }
170
171 return in;
172 }

◆ 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::JTestKolmogorov_Slice2D::threshold
private

threshold p-value to decide if test is passed.

Definition at line 176 of file JTestKolmogorov_Slice2D.hh.

◆ failuresThreshold

double JCOMPAREHISTOGRAMS::JTestKolmogorov_Slice2D::failuresThreshold
private

threshold p-value to decide if test is passed.

Definition at line 177 of file JTestKolmogorov_Slice2D.hh.

◆ slice

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 178 of file JTestKolmogorov_Slice2D.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: