Jpp  18.6.0-rc.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::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. More...
 
void test (const TObject *o1, const TObject *o2) override
 Applies Kolmogorov 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. x or X for x-axis, y or Y for y-axis, n or N for None. More...
 

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

Constructor & Destructor Documentation

JCOMPAREHISTOGRAMS::JTestKolmogorov_Slice2D::JTestKolmogorov_Slice2D ( )
inline

Default constructor.

Definition at line 39 of file JTestKolmogorov_Slice2D.hh.

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

Member Function Documentation

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

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

153  {
154  using namespace JPP;
155 
157 
158  if (threshold < 0.0 || threshold > 1.0) {
159  THROW(JValueOutOfRange, "JTestKolmogorov_Slice2D::read(): Invalid threshold value " << threshold);
160  }
161 
162  if (failuresThreshold < 0.0 || failuresThreshold > 1.0) {
163  THROW(JValueOutOfRange, "JTestKolmogorov_Slice2D::read(): Invalid failuresThreshold value " << failuresThreshold);
164  }
165 
166  if (slice != 'x' && slice != 'X' && slice != 'y' && slice != 'Y') {
167  THROW(JValueOutOfRange, "JTestKolmogorov_Slice2D::read(): Invalid slice option " << slice);
168  }
169 
170  return in;
171  }
#define THROW(JException_t, A)
Marco for throwing exception with std::ostream compatible message.
Definition: JException.hh:712
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.
double threshold
threshold p-value to decide if test is passed.
then fatal The output file must have the wildcard in the e g root fi 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  }
std::ostream & print(std::ostream &out, const JTestSummary &summary, const char delimiter= ' ', const bool useColors=true)
Print test summary.
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  }
o $QUALITY_ROOT d $DEBUG!CHECK_EXIT_CODE JPlot1D f
Definition: JDataQuality.sh:76
data_type r[M+1]
Definition: JPolint.hh:868
$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
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  }
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  }
const std::string resultType
test result type
Definition: JTest_t.hh:181

Member Data Documentation

double JCOMPAREHISTOGRAMS::JTestKolmogorov_Slice2D::threshold
private

threshold p-value to decide if test is passed.

Definition at line 175 of file JTestKolmogorov_Slice2D.hh.

double JCOMPAREHISTOGRAMS::JTestKolmogorov_Slice2D::failuresThreshold
private

threshold p-value to decide if test is passed.

Definition at line 176 of file JTestKolmogorov_Slice2D.hh.

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 177 of file JTestKolmogorov_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: