Jpp 19.3.0-rc.3
the software that should make you happy
Loading...
Searching...
No Matches
JTestKolmogorov_Slice2D.hh
Go to the documentation of this file.
1#ifndef __JCOMPAREHISTOGRAMS__JTESTKOLMOGOROV_SLICE2D__
2#define __JCOMPAREHISTOGRAMS__JTESTKOLMOGOROV_SLICE2D__
3
4#include <istream>
5#include <ostream>
6
7#include "JLang/JException.hh"
8
11
12#include "TH2.h"
13#include "TMath.h"
14
15
16/**
17 * \author rgruiz, bjung
18 */
19namespace JCOMPAREHISTOGRAMS {}
20namespace JPP { using namespace JCOMPAREHISTOGRAMS; }
21
22namespace JCOMPAREHISTOGRAMS {
23
24 /**
25 * Implementation of the Kolmogorov test for 2D histograms.\n
26 * 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.\n
27 * 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.\n
28 * The input parameter `threshold`, is used to evaluate whether the test is passed or failed for each slice or for the full 2D distribution.\n
29 * The evaluation is done by comparing the `threshold` value with the resulting p-value.\n
30 * The parameter `threshold` should therefore be a real value between 0 and 1.
31 */
33 public JTest_t
34 {
35 public:
36
37 /**
38 * Default constructor.
39 */
41 JTest_t("KS_Slice2D", "p-Value(KS)")
42 {}
43
44
45 /**
46 * Applies Kolmogorov test for two ROOT TH2 histograms.
47 *
48 * \param o1 First histogram
49 * \param o2 Second histogram
50 */
51 void test(const TObject* o1, const TObject* o2) override
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 }
145
146
147 /**
148 * Read test parameters from input.
149 *
150 * \param in input stream
151 * \return input stream
152 */
153 std::istream& read(std::istream& in) override
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 }
173
174 private:
175
176 double threshold; //!< threshold p-value to decide if test is passed.
177 double failuresThreshold; //!< threshold p-value to decide if test is passed.
178 char slice; //!< axis to slice. x or X for x-axis, y or Y for y-axis, n or N for None.
179 };
180}
181
182#endif
Exceptions.
#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...
std::string getTitle() const
Returns a standard string to be used as title of a graphical root object.
Implementation of the Kolmogorov test for 2D histograms.
std::istream & read(std::istream &in) override
Read test parameters from input.
double failuresThreshold
threshold p-value to decide if test is passed.
double threshold
threshold p-value to decide if test is passed.
void test(const TObject *o1, const TObject *o2) override
Applies Kolmogorov test for two ROOT TH2 histograms.
char slice
axis to slice. x or X for x-axis, y or Y for y-axis, n or N for None.
Interface to read input and write output for TObject tests.
Definition JTest_t.hh:42
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.
This name space includes all other name spaces (except KM3NETDAQ, KM3NET and ANTARES).
Structure containing the result of the test.