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

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

#include <JTestChi2_Slice2D.hh>

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

Public Member Functions

 JTestChi2_Slice2D ()
 Default constructor. More...
 
void test (const TObject *o1, const TObject *o2) override
 Applies Chi2 test for two ROOT TH2 histograms. More...
 
std::istream & read (std::istream &in) override
 Read test parameters from input. More...
 
virtual std::ostream & write (std::ostream &out, const char delimiter= ' ', const bool onlyFailures=false) const
 Write test result to output. More...
 
virtual void save (TFile *f, const std::string &path, const bool onlyFailures=false) const
 Writes the test result to root file. More...
 
const std::string & getTestName () const
 Get test name. More...
 
const std::string & getResultType () const
 Get result type. More...
 

Protected Attributes

const std::string testName
 test name More...
 
const std::string resultType
 test result type More...
 

Private Attributes

double threshold
 threshold p-value to decide if test is passed. More...
 
double failuresThreshold
 threshold p-value to decide if test is passed. More...
 
char slice
 axis to slice. More...
 
std::string options
 options for the ROOT chi2 test. More...
 

Detailed Description

Implementation of the Chi2 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.
The parameter slice() can have the values x, X, y or Y. The histograms are sliced along the corresponding axis, and the JChi2Test() test is applied to each slice.
The input parameter threshold, is used to evaluate whether the test is passed or failed for each slice.
The evaluation is done by comparing the threshold value with the result produced by the Chi2 test for each slice. The output of JChi2Test() is a p-value.
The parameter threshold should therefore be a real value between 0 and 1.

Definition at line 32 of file JTestChi2_Slice2D.hh.

Constructor & Destructor Documentation

JCOMPAREHISTOGRAMS::JTestChi2_Slice2D::JTestChi2_Slice2D ( )
inline

Default constructor.

Definition at line 40 of file JTestChi2_Slice2D.hh.

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

Member Function Documentation

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

Applies Chi2 test for two ROOT TH2 histograms.

Parameters
o1First histogram
o2Second histogram

Implements JCOMPAREHISTOGRAMS::JTest_t.

Definition at line 51 of file JTestChi2_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, "JTestChi2_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, "JTestChi2_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 chi2 = s1->Chi2Test(s2 , options.c_str());
95 
96  const bool failed = (options.find("CHI2") != std::string::npos ?
97  (chi2 > threshold ? true : false) :
98  (chi2 < threshold ? true : false));
99 
100  if (failed) nFailures++;
101 
102  h3->SetBinContent(i,chi2);
103  }
104 
105  } else if (slice == 'y' || slice == 'Y') {
106 
107  const int nSlices1 = h1->GetNbinsY();
108  const int nSlices2 = h2->GetNbinsY();
109 
110  if (nSlices1 != nSlices2) {
111  THROW(JValueOutOfRange, "JTestChi2_Slice2D::test(): Histograms with different binning. The objects: " << h1->GetName() << " and " << h2->GetName() << " can not be compared." << endl);
112  }
113 
114  nSlices = nSlices1;
115 
116  h3 = h1->ProjectionY(h3name);
117 
118  for (int i=1 ; i<=nSlices1 ; ++i){
119 
120  const std::string sliceName = MAKE_STRING(h3->GetName() << "_" << to_string(i));
121 
122  const TH1* s1 = h1->ProjectionX(sliceName.c_str(),i,i);
123  const TH1* s2 = h2->ProjectionX(sliceName.c_str(),i,i);
124 
125  if (!(s1->GetSumOfWeights() > 0 && s2->GetSumOfWeights() > 0)) { continue; }
126 
127  const double chi2 = s1->Chi2Test (s2 , options.c_str());
128 
129  const bool failed = (options.find("CHI2") != std::string::npos ?
130  (chi2 > threshold ? true : false) :
131  (chi2 < threshold ? true : false));;
132 
133  if (failed) nFailures++;
134 
135  h3->SetBinContent(i,chi2);
136  }
137  }
138 
139  const bool passed = (nFailures/nSlices < failuresThreshold);
140 
141  const JResultTitle title(testName, resultType, passed , nFailures);
142 
143  h3->SetTitle(title.getTitle().c_str());
144  h3->GetYaxis()->SetTitle(resultType.c_str());
145 
146  const JTestResult r(testName,
147  JRootObjectID(MAKE_STRING(h1->GetDirectory()->GetPath() << h1->GetName())),
148  JRootObjectID(MAKE_STRING(h2->GetDirectory()->GetPath() << h1->GetName())),
149  resultType, nFailures, failuresThreshold, h3, passed);
150 
151  this->push_back(r);
152  }
JCOMPAREHISTOGRAMS::JTestChi2_Slice2D::failuresThreshold
double failuresThreshold
threshold p-value to decide if test is passed.
Definition: JTestChi2_Slice2D.hh:186
JCOMPAREHISTOGRAMS::JTestChi2_Slice2D::slice
char slice
axis to slice.
Definition: JTestChi2_Slice2D.hh:187
JCOMPAREHISTOGRAMS::JResultTitle
Class dedicated to standardize the title of the graphical objects produced by the JTest_t() derived c...
Definition: JResultTitle.hh:25
THROW
#define THROW(JException_t, A)
Marco for throwing exception with std::ostream compatible message.
Definition: JException.hh:712
JCOMPAREHISTOGRAMS::JTestChi2_Slice2D::threshold
double threshold
threshold p-value to decide if test is passed.
Definition: JTestChi2_Slice2D.hh:185
MAKE_CSTRING
#define MAKE_CSTRING(A)
Make C-string.
Definition: JPrint.hh:136
JTOOLS::r
data_type r[M+1]
Definition: JPolint.hh:868
MAKE_STRING
#define MAKE_STRING(A)
Make string.
Definition: JPrint.hh:127
JCOMPAREHISTOGRAMS::JTestChi2_Slice2D::options
std::string options
options for the ROOT chi2 test.
Definition: JTestChi2_Slice2D.hh:188
string
then awk string
Definition: pre-calibration.sh:45
JCOMPAREHISTOGRAMS::JTest_t::resultType
const std::string resultType
test result type
Definition: JTest_t.hh:181
JCOMPAREHISTOGRAMS::JTest_t::testName
const std::string testName
test name
Definition: JTest_t.hh:180
JLANG::to_string
std::string to_string(const T &value)
Convert value to string.
Definition: JLangToolkit.hh:207
chi2
then if[[!-f $DETECTOR]] then JDetector sh $DETECTOR fi cat $WORKDIR trigger_parameters txt<< EOFtrigger3DMuon.enabled=1;trigger3DMuon.numberOfHits=5;trigger3DMuon.gridAngle_deg=1;ctMin=0.0;TMaxLocal_ns=15.0;EOF set_variable TRIGGEREFFICIENCY_TRIGGERED_EVENTS_ONLY INPUT_FILES=() for((i=1;$i<=$NUMBER_OF_RUNS;++i));do JSirene.sh $DETECTOR $JPP_DATA/genhen.km3net_wpd_V2_0.evt.gz $WORKDIR/sirene_ ${i}.root JTriggerEfficiency.sh $DETECTOR $DETECTOR $WORKDIR/sirene_ ${i}.root $WORKDIR/trigger_efficiency_ ${i}.root $WORKDIR/trigger_parameters.txt $JPP_DATA/PMT_parameters.txt INPUT_FILES+=($WORKDIR/trigger_efficiency_ ${i}.root) done for ANGLE_DEG in $ANGLES_DEG[*];do set_variable SIGMA_NS 3.0 set_variable OUTLIERS 3 set_variable OUTPUT_FILE $WORKDIR/matrix\[${ANGLE_DEG}\deg\].root $JPP_DIR/examples/JReconstruction-f"$INPUT_FILES[*]"-o $OUTPUT_FILE-S ${SIGMA_NS}-A ${ANGLE_DEG}-O ${OUTLIERS}-d ${DEBUG}--!fiif[[$OPTION=="plot"]];then if((0));then for H1 in h0 h1;do JPlot1D-f"$WORKDIR/matrix["${^ANGLES_DEG}" deg].root:${H1}"-y"1 2e3"-Y-L TR-T""-\^"number of events [a.u.]"-> o chi2
Definition: JMatrixNZ.sh:106
JCOMPAREHISTOGRAMS::JTestResult
Structure containing the result of the test.
Definition: JTestResult.hh:28
std::istream& JCOMPAREHISTOGRAMS::JTestChi2_Slice2D::read ( std::istream &  in)
inlineoverridevirtual

Read test parameters from input.

Parameters
ininput stream
Returns
input stream

Implements JCOMPAREHISTOGRAMS::JTest_t.

Definition at line 161 of file JTestChi2_Slice2D.hh.

162  {
163  using namespace JPP;
164 
165  in >> threshold >> failuresThreshold >> slice >> options;
166 
167  if (threshold < 0.0) {
168  THROW(JValueOutOfRange, "JTestChi2_Slice2D::read(): Invalid threshold value " << threshold);
169  }
170 
171  if (failuresThreshold < 0.0 || failuresThreshold > 1.0) {
172  THROW(JValueOutOfRange, "JTestChi2_Slice2D::read(): Invalid failuresThreshold value " << failuresThreshold);
173  }
174 
175  if (slice != 'x' && slice != 'X' && slice != 'y' && slice != 'Y') {
176  THROW(JValueOutOfRange, "JTestChi2_Slice2D::read(): Invalid slice option " << slice);
177  }
178 
179  return in;
180  }
JCOMPAREHISTOGRAMS::JTestChi2_Slice2D::failuresThreshold
double failuresThreshold
threshold p-value to decide if test is passed.
Definition: JTestChi2_Slice2D.hh:186
JCOMPAREHISTOGRAMS::JTestChi2_Slice2D::slice
char slice
axis to slice.
Definition: JTestChi2_Slice2D.hh:187
THROW
#define THROW(JException_t, A)
Marco for throwing exception with std::ostream compatible message.
Definition: JException.hh:712
JCOMPAREHISTOGRAMS::JTestChi2_Slice2D::threshold
double threshold
threshold p-value to decide if test is passed.
Definition: JTestChi2_Slice2D.hh:185
JCOMPAREHISTOGRAMS::JTestChi2_Slice2D::options
std::string options
options for the ROOT chi2 test.
Definition: JTestChi2_Slice2D.hh:188
in
then fatal Wrong number of arguments fi set_variable DETECTOR $argv[1] set_variable INPUT_FILE $argv[2] eval JPrintDetector a $DETECTOR O IDENTIFIER eval JPrintDetector a $DETECTOR O SUMMARY JAcoustics sh $DETECTOR_ID source JAcousticsToolkit sh CHECK_EXIT_CODE typeset A EMITTERS get_tripods $WORKDIR tripod txt EMITTERS get_transmitters $WORKDIR transmitter txt EMITTERS for EMITTER in
Definition: JCanberra.sh:48
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  }
JCOMPAREHISTOGRAMS::print
std::ostream & print(std::ostream &out, const JTestSummary &summary, const char delimiter= ' ', const bool useColors=true)
Print test summary.
Definition: JTestSummary.hh:255
JTOOLS::r
data_type r[M+1]
Definition: JPolint.hh:868
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  }
f
o $QUALITY_ROOT d $DEBUG!CHECK_EXIT_CODE JPlot1D f
Definition: JDataQuality.sh:76
JTOOLS::r
data_type r[M+1]
Definition: JPolint.hh:868
path
$WORKDIR driver txt done cat $WORKDIR driver txt<< EOFprocess ${DATAFILTER}$FILTER_HOST csh-c '(setenv ROOTSYS $ROOTSYS &&source $JPP_DIR/setenv.csh $JPP_DIR &&(JDataFilter-H\$SERVER\$-M\$LOGGER\$-d $DEBUG-u ${DATAFILTER}-P $PORT</dev/null > &/dev/null &))';process ${DATAWRITER}$WRITER_HOST csh-c '(setenv ROOTSYS $ROOTSYS &&source $JPP_DIR/setenv.csh $JPP_DIR &&(JDataWriter-H\$SERVER\$-M\$LOGGER\$-d $DEBUG-u ${DATAWRITER}</dev/null > &/dev/null &))';print enterevent ev_init{RC_CMD}event ev_reset{RC_CMD}event ev_init{RC_CMD}event ev_configure{RC_DFLTR%<$WORKDIR/ev_configure_datafilter.txt > RC_DQSIM<$WORKDIR/ev_configure_dqsimulator.txt > RC_DWRT path
Definition: software/JDataFilter/JDataFilter.sh:199
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  }
JCOMPAREHISTOGRAMS::JTest_t::testName
const std::string testName
test name
Definition: JTest_t.hh:180
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  }
JCOMPAREHISTOGRAMS::JTest_t::resultType
const std::string resultType
test result type
Definition: JTest_t.hh:181

Member Data Documentation

double JCOMPAREHISTOGRAMS::JTestChi2_Slice2D::threshold
private

threshold p-value to decide if test is passed.

Definition at line 185 of file JTestChi2_Slice2D.hh.

double JCOMPAREHISTOGRAMS::JTestChi2_Slice2D::failuresThreshold
private

threshold p-value to decide if test is passed.

Definition at line 186 of file JTestChi2_Slice2D.hh.

char JCOMPAREHISTOGRAMS::JTestChi2_Slice2D::slice
private

axis to slice.

Definition at line 187 of file JTestChi2_Slice2D.hh.

std::string JCOMPAREHISTOGRAMS::JTestChi2_Slice2D::options
private

options for the ROOT chi2 test.

Definition at line 188 of file JTestChi2_Slice2D.hh.

const std::string JCOMPAREHISTOGRAMS::JTest_t::testName
protectedinherited

test name

Definition at line 180 of file JTest_t.hh.

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:
Generated by   doxygen 1.8.5