Jpp  15.0.2
the software that should make you happy
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | List of all members
JCOMPAREHISTOGRAMS::JTestChi2_t Class Reference

Implementation of the different Chi2-related tests. More...

#include <JTestChi2_t.hh>

Inheritance diagram for JCOMPAREHISTOGRAMS::JTestChi2_t:
JCOMPAREHISTOGRAMS::JTestChi2_1D JCOMPAREHISTOGRAMS::JTestChi2_2D JCOMPAREHISTOGRAMS::JTestChi2_Bin JCOMPAREHISTOGRAMS::JTestChi2R_1D JCOMPAREHISTOGRAMS::JTestChi2R_2D

Public Member Functions

 JTestChi2_t ()
 Default constructor. More...
 
JTestResult JChi2Test (TH1 *h1, TH1 *h2, double threshold, std::string testName, std::string parameterName, std::string options)
 Chi2 test for 1D histograms. More...
 
JTestResult JChi2TestSlice (TH2 *h1, TH2 *h2, double threshold, double failuresThreshold, std::string testName, std::string parameterName, std::string options, char slice)
 Chi2 test for sliced 2D histograms. More...
 
JTestResult JChi2TestBin_2D (TH2 *h1, TH2 *h2, double outliersThreshold, double chi2Threshold, std::string testName, std::string parameterName)
 Bin-by-Bin Chi2 comparison of 2D histograms. More...
 

Detailed Description

Implementation of the different Chi2-related tests.

Definition at line 21 of file JTestChi2_t.hh.

Constructor & Destructor Documentation

JCOMPAREHISTOGRAMS::JTestChi2_t::JTestChi2_t ( )
inline

Default constructor.

Definition at line 28 of file JTestChi2_t.hh.

28 {}

Member Function Documentation

JTestResult JCOMPAREHISTOGRAMS::JTestChi2_t::JChi2Test ( TH1 *  h1,
TH1 *  h2,
double  threshold,
std::string  testName,
std::string  parameterName,
std::string  options 
)
inline

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

Parameters
h1First histogram
h2Second histogram
thresholdThreshold value for the test result
parameterNameName of the parameter used to test the histograms
testNameName of the test used to compare the histograms
optionsROOT options for the test.
Returns
Test result.

Definition at line 45 of file JTestChi2_t.hh.

45  {
46 
47  using namespace std;
48  using namespace JPP;
49 
50  if(h1 -> GetNbinsX() != h2 -> GetNbinsX())
51  ERROR("Histograms with different bining. The objects: " << h1 -> GetName() << " can not be compared." << endl);
52 
53  double chi2 = h1 -> Chi2Test (h2 , options.c_str());
54 
55  double M = h1->Integral();
56  double N = h2->Integral();
57 
58  TH2D* h3 = (TH2D*)h1->Clone(h1->GetName()==h2->GetName() ?
59  MAKE_CSTRING(to_string(h1->GetName())) :
60  MAKE_CSTRING(to_string(h1->GetName()) + "_VS_" + to_string(h2->GetName())));
61 
62  h3->Reset();
63 
64  for (int i=1 ; i < h1->GetNbinsX() ; ++i){
65 
66  double m = h1->GetBinContent(i);
67  double n = h2->GetBinContent(i);
68  if(n!=0 && m!=0){
69 
70  double c = (M*n - N*m)/sqrt((n+m)*(N*M));
71  h3->SetBinContent(i,c);
72  }
73  }
74 
75  bool passed;
76 
77  if (options.find("CHI2") != std::string::npos) {
78  (chi2 > threshold ? passed = false : passed = true);
79  }else{
80  (chi2 < threshold ? passed = false : passed = true);
81  }
82 
83  JResultTitle title(testName, parameterName, passed , chi2);
84 
85  h3->SetTitle(title.getTitle().c_str());
86 
87  JTestResult r (testName,
88  JRootObjectID(MAKE_STRING(h1->GetDirectory()->GetPath() << h1->GetName())),
89  JRootObjectID(MAKE_STRING(h2->GetDirectory()->GetPath() << h1->GetName())),
90  parameterName, chi2, threshold, h3, passed);
91 
92  return r;
93 
94  };
M
do $JPP JMEstimator M
Definition: JMEstimator.sh:37
N
then JShowerPostfit f $INPUT_FILE o $OUTPUT_FILE N
Definition: JShowerPostfit.sh:95
MAKE_CSTRING
#define MAKE_CSTRING(A)
Make C-string.
Definition: JPrint.hh:151
h1
then for HISTOGRAM in h0 h1
Definition: JMatrixNZ.sh:71
JTOOLS::r
data_type r[M+1]
Definition: JPolint.hh:742
MAKE_STRING
#define MAKE_STRING(A)
Make string.
Definition: JPrint.hh:142
JTOOLS::n
const int n
Definition: JPolint.hh:660
options
then usage $script[port]< option > nPossible options
Definition: JLigier-local.sh:28
ERROR
#define ERROR(A)
Definition: JMessage.hh:66
JLANG::to_string
std::string to_string(const T &value)
Convert value to string.
Definition: JLangToolkit.hh:207
JTestResult JCOMPAREHISTOGRAMS::JTestChi2_t::JChi2TestSlice ( TH2 *  h1,
TH2 *  h2,
double  threshold,
double  failuresThreshold,
std::string  testName,
std::string  parameterName,
std::string  options,
char  slice 
)
inline

Chi2 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 Chi2 test. The output of a Chi2 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
h1First histogram
h2Second histogram
thresholdThreshold value for the test result
failuresThresholdThreshold value for the fraction of failed tests.
parameterNameName of the parameter used to test the histograms
testNameName of the test used to compare the histograms
optionsROOT options for the test.
sliceThe axis along which the histogram is sliced.
Returns
Test result.

Definition at line 115 of file JTestChi2_t.hh.

115  {
116 
117  using namespace std;
118  using namespace JPP;
119 
120  int nFailures = 0;
121 
122  JTestResult r;
123 
124  if(slice == 'x' || slice == 'X'){
125 
126  int nSlices1 = h1->GetNbinsX();
127  int nSlices2 = h2->GetNbinsX();
128 
129  TH1* h3 = h1->ProjectionX(h1->GetName()==h2->GetName() ?
130  MAKE_CSTRING(to_string(h1->GetName())) :
131  MAKE_CSTRING(to_string(h1->GetName()) + "_VS_" + to_string(h2->GetName())));
132 
133  if(nSlices1 != nSlices2)
134  ERROR("Histograms with different binning. The objects: " << h1->GetName() << " and " << h2->GetName() << " can not be compared." << endl);
135 
136  for (int i=1 ; i<=nSlices1 ; ++i){
137 
138  std::string sliceName = MAKE_STRING(h1->GetName() + to_string("_") + to_string(i));
139 
140  TH1D* s1 = h1->ProjectionY (sliceName.c_str(),i,i);
141  TH1D* s2 = h2->ProjectionY (sliceName.c_str(),i,i);
142 
143  double chi2 = s1 -> Chi2Test (s2 , options.c_str());
144 
145  bool passed;
146 
147  if (options.find("CHI2") != std::string::npos) {
148  (chi2 > threshold ? passed = false : passed = true);
149  }else{
150  (chi2 < threshold ? passed = false : passed = true);
151  }
152 
153  if (!passed) nFailures++;
154 
155  h3->SetBinContent(i,chi2);
156 
157  }
158 
159  bool passed;
160 
161  (nFailures/nSlices1 > failuresThreshold ? passed = false : passed = true);
162 
163  JResultTitle title(testName, parameterName, passed , nFailures);
164 
165  h3->SetTitle(title.getTitle().c_str());
166 
167  r = JTestResult(testName,
168  JRootObjectID(MAKE_STRING(h1->GetDirectory()->GetPath() << h1->GetName())),
169  JRootObjectID(MAKE_STRING(h2->GetDirectory()->GetPath() << h1->GetName())),
170  parameterName, nFailures, failuresThreshold, h3, passed);
171 
172  }else if (slice == 'y' || slice == 'Y'){
173 
174  int nSlices1 = h1->GetNbinsY();
175  int nSlices2 = h2->GetNbinsY();
176 
177  TH1* h3 = h1->ProjectionY(h1->GetName()==h2->GetName() ?
178  MAKE_CSTRING(to_string(h1->GetName())) :
179  MAKE_CSTRING(to_string(h1->GetName()) + "_VS_" + to_string(h2->GetName())));
180 
181  if(nSlices1 != nSlices2)
182  ERROR("Histograms with different binning. The objects: " << h1->GetName() << " can not be compared." << endl);
183 
184  for (int i=1 ; i<=nSlices1 ; ++i){
185 
186  std::string sliceName = MAKE_STRING(h1->GetName() + to_string("_") + to_string(i));
187 
188  TH1D* s1 = h1->ProjectionX (sliceName.c_str(),i,i);
189  TH1D* s2 = h2->ProjectionX (sliceName.c_str(),i,i);
190 
191  double chi2 = s1 -> Chi2Test (s2 , options.c_str());
192 
193  bool passed;
194 
195  if (options.find("CHI2") != std::string::npos) {
196  (chi2 > threshold ? passed = false : passed = true);
197  }else{
198  (chi2 < threshold ? passed = false : passed = true);
199  }
200 
201  if (!passed) nFailures++;
202 
203  h3->SetBinContent(i,chi2);
204  }
205 
206  bool passed;
207 
208  (nFailures/nSlices1 > failuresThreshold ? passed = false : passed = true);
209 
210  JResultTitle title(testName, parameterName, passed , nFailures);
211 
212  h3->SetTitle(title.getTitle().c_str());
213 
214  r = JTestResult (testName,
215  JRootObjectID(MAKE_STRING(h1->GetDirectory()->GetPath() << h1->GetName())),
216  JRootObjectID(MAKE_STRING(h2->GetDirectory()->GetPath() << h1->GetName())),
217  parameterName, nFailures, failuresThreshold, h3, passed);
218 
219  }
220 
221  return r;
222  };
MAKE_CSTRING
#define MAKE_CSTRING(A)
Make C-string.
Definition: JPrint.hh:151
h1
then for HISTOGRAM in h0 h1
Definition: JMatrixNZ.sh:71
JTOOLS::r
data_type r[M+1]
Definition: JPolint.hh:742
MAKE_STRING
#define MAKE_STRING(A)
Make string.
Definition: JPrint.hh:142
options
then usage $script[port]< option > nPossible options
Definition: JLigier-local.sh:28
ERROR
#define ERROR(A)
Definition: JMessage.hh:66
JLANG::to_string
std::string to_string(const T &value)
Convert value to string.
Definition: JLangToolkit.hh:207
JTestResult JCOMPAREHISTOGRAMS::JTestChi2_t::JChi2TestBin_2D ( TH2 *  h1,
TH2 *  h2,
double  outliersThreshold,
double  chi2Threshold,
std::string  testName,
std::string  parameterName 
)
inline

Bin-by-Bin Chi2 comparison of 2D histograms.


The Chi distance between h1 and h2 is calculated for each bin, and compared to the chi2Threshold() parameter.
If the calculated Chi distance is above this threshold, the test is passed for that bin.
If the fraction of failures is above the input parameter outliersThreshold(), the test is failed.

Parameters
h1First object
h2Second object
outliersThresholdfraction of bins allowed to fail the test
chi2Thresholdp-value
parameterNameName of the parameter used to test the histograms
testNameName of the test used to compare the histograms
Returns
Test result.

Definition at line 240 of file JTestChi2_t.hh.

240  {
241 
242  using namespace std;
243  using namespace JPP;
244 
245  int nx1 = h1->GetNbinsX();
246  int nx2 = h2->GetNbinsX();
247  int ny1 = h1->GetNbinsY();
248  int ny2 = h2->GetNbinsY();
249 
250  double M = h1->Integral();
251  double N = h2->Integral();
252 
253  if(nx1 != nx2 || ny1 != ny2 || M == 0 || N == 0)
254  ERROR("Histograms with different binning. The objects: " << h1->GetName() << " can not be compared." << endl);
255 
256  TH2D* h3 = (TH2D*)h1->Clone(h1->GetName()==h2->GetName() ?
257  MAKE_CSTRING(to_string(h1->GetName())) :
258  MAKE_CSTRING(to_string(h1->GetName()) + "_VS_" + to_string(h2->GetName())));
259 
260  h3->Reset();
261 
262  double outliers = 0;
263 
264  for (int i=1 ; i<nx1 ; ++i){
265  for (int j=1 ; j<ny1 ; ++j){
266 
267  double m = h1 -> GetBinContent(i,j);
268  double n = h2 -> GetBinContent(i,j);
269  double chi2 = (n-m*N/M)/sqrt(m*N/M);
270  (fabs(chi2) > chi2Threshold ? outliers+=1./(nx1*ny1) : outliers+=0 );
271  h3->SetBinContent(i,j,chi2);
272  }
273  }
274 
275  bool passed;
276 
277  (outliers > outliersThreshold ? passed = false : passed = true);
278 
279  JResultTitle title(testName, parameterName , passed , 100*outliers);
280 
281  h3->SetTitle(title.getTitle().c_str());
282 
283  JTestResult r (testName,
284  JRootObjectID(MAKE_STRING(h1->GetDirectory()->GetPath() << h1->GetName())),
285  JRootObjectID(MAKE_STRING(h2->GetDirectory()->GetPath() << h1->GetName())),
286  parameterName, 100*outliers, 100*outliersThreshold, h3, passed);
287 
288  return r;
289  };
M
do $JPP JMEstimator M
Definition: JMEstimator.sh:37
N
then JShowerPostfit f $INPUT_FILE o $OUTPUT_FILE N
Definition: JShowerPostfit.sh:95
MAKE_CSTRING
#define MAKE_CSTRING(A)
Make C-string.
Definition: JPrint.hh:151
h1
then for HISTOGRAM in h0 h1
Definition: JMatrixNZ.sh:71
JTOOLS::r
data_type r[M+1]
Definition: JPolint.hh:742
MAKE_STRING
#define MAKE_STRING(A)
Make string.
Definition: JPrint.hh:142
JTOOLS::n
const int n
Definition: JPolint.hh:660
ERROR
#define ERROR(A)
Definition: JMessage.hh:66
JLANG::to_string
std::string to_string(const T &value)
Convert value to string.
Definition: JLangToolkit.hh:207
JTOOLS::j
int j
Definition: JPolint.hh:666
The documentation for this class was generated from the following file:
Generated by   doxygen 1.8.5