Jpp 20.0.0-rc.3
the software that should make you happy
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | Private Attributes | List of all members
JCOMPAREHISTOGRAMS::JTestSignificance Class Reference

Significance test. More...

#include <JTestSignificance.hh>

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

Public Member Functions

 JTestSignificance ()
 Default constructor.
 
void test (const TObject *o1, const TObject *o2) override
 Applies Significance test for two ROOT TH1 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 K
 normalization factor between histograms.
 
bool usePoissonStatistics
 toggle use of Poisson statistics
 

Detailed Description

Significance test.

Compares two histograms $ H_a $ and $ H_b $ by calculating the average bin significance

\[ S = \frac{1}{N} \cdot \sum_{i=0}^{N} \frac{|a_i - K \cdot b_i|}{\sqrt{\sigma_{a_i}^2 + K^2 \cdot \sigma_{b_i}^2}} \]

where:

  • $ N $ is the number of bins in $ H_a $ and $ H_b $.
  • $ a_i $ and $ b_i $ are the contents of bin $ i $ in $ H_a $ and $ H_b $.
  • $ K $ is a normalisation parameter which can be specified by the user.
    • It should be interpreted as the integral of $ H_a $ divided by the integral of $ H_b $.
    • Note that if the specified value of K is negative, the value will be reset to the integral of $ H_a $ divided by the integral of $ H_b $.
  • $\sigma_{a_i}$ and $\sigma_{b_i}$ are the bin content uncertainties corresponding to respectively $ a_i $ and $ b_i $.

A threshold value for $ S $ is used to tag the test as passed or failed.

Definition at line 42 of file JTestSignificance.hh.

Constructor & Destructor Documentation

◆ JTestSignificance()

JCOMPAREHISTOGRAMS::JTestSignificance::JTestSignificance ( )
inline

Default constructor.

Definition at line 50 of file JTestSignificance.hh.

50 :
51 JTest_t("Significance", "Significance")
52 {}
JCOMPAREHISTOGRAMS::JTest_t::JTest_t
JTest_t(const std::string &testName, const std::string &resultType)
Constructor.
Definition JTest_t.hh:51

Member Function Documentation

◆ test()

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

Applies Significance test for two ROOT TH1 histograms.

Parameters
o1First histogram
o2Second histogram

Implements JCOMPAREHISTOGRAMS::JTest_t.

Definition at line 61 of file JTestSignificance.hh.

62 {
63 using namespace std;
64 using namespace JPP;
65
66 const TH1* h1 = dynamic_cast<const TH1*>(o1);
67 const TH1* h2 = dynamic_cast<const TH1*>(o2);
68
69 if (h1 == NULL || h2 == NULL) {
70 THROW(JValueOutOfRange, "JTestSignificance::test(): Could not cast given TObjects to TH1.");
71 }
72
73 if(h1->GetNbinsX() != h2->GetNbinsX() ||
74 h1->GetNbinsY() != h2->GetNbinsY() ||
75 h1->GetNbinsZ() != h2->GetNbinsZ()) {
76 THROW(JValueOutOfRange, "JTestSignificance::test(): Histograms with different bining. The objects: " <<
77 h1->GetName() << " and " << h2->GetName() << " can not be compared." << endl);
78 }
79
80 if (K < 0) {
81 K = h2->GetEntries() / h1->GetEntries();
82 }
83
84 TH1* h3 = (TH1*) h1->Clone(h1->GetName() == h2->GetName() ?
85 MAKE_CSTRING(h1->GetName() << "_" << testName) :
86 MAKE_CSTRING(h1->GetName() << "_VS_" << h2->GetName() << "_" << testName));
87
88 h3->Add(h2,-1*K);
89
90 double S = 0;
91
92 for (int i=1 ; i <= h1->GetNbinsX() ; ++i){
93 for (int j=1 ; j <= h1->GetNbinsY() ; ++j){
94 for (int k=1 ; k <= h1->GetNbinsZ() ; ++k){
95
96 const double a = h1->GetBinContent(i,j,k);
97 const double b = h2->GetBinContent(i,j,k);
98
99 const double ea = usePoissonStatistics ? sqrt(a) : h1->GetBinError(i,j,k);
100 const double eb = usePoissonStatistics ? sqrt(b) : h2->GetBinError(i,j,k);
101
102 if (a!=0 || b!=0) {
103 S += fabs((a - K*b)/sqrt(ea*ea + K*K*eb*eb));
104 }
105 }
106 }
107 }
108
109 S /= (h1->GetNbinsX()*h1->GetNbinsY()*h1->GetNbinsZ());
110
111 const bool passed = (S < threshold);
112
113 const JResultTitle title(testName, resultType, passed, S);
114
115 h3->SetTitle(title.getTitle().c_str());
116
117 const int Ndims = h3->GetDimension();
118
119 if (Ndims == 1) {
120 h3->GetYaxis()->SetTitle(resultType.c_str());
121 } else if (Ndims == 2) {
122 h3->GetZaxis()->SetTitle(resultType.c_str());
123 }
124
125 const JTestResult r(testName,
126 JRootObjectID(MAKE_STRING(h1->GetDirectory()->GetPath() << h1->GetName())),
127 JRootObjectID(MAKE_STRING(h2->GetDirectory()->GetPath() << h1->GetName())),
128 resultType, S, threshold, h3, passed);
129
130 this->push_back(r);
131 }
THROW
#define THROW(JException_t, A)
Marco for throwing exception with std::ostream compatible message.
Definition JException.hh:712
MAKE_CSTRING
#define MAKE_CSTRING(A)
Make C-string.
Definition JPrint.hh:72
MAKE_STRING
#define MAKE_STRING(A)
Make string.
Definition JPrint.hh:63
JCOMPAREHISTOGRAMS::JResultTitle
Class dedicated to standardize the title of the graphical objects produced by the JTest_t() derived c...
Definition JResultTitle.hh:26
JCOMPAREHISTOGRAMS::JTestSignificance::K
double K
normalization factor between histograms.
Definition JTestSignificance.hh:156
JCOMPAREHISTOGRAMS::JTestSignificance::usePoissonStatistics
bool usePoissonStatistics
toggle use of Poisson statistics
Definition JTestSignificance.hh:157
JCOMPAREHISTOGRAMS::JTestSignificance::threshold
double threshold
threshold p-value to decide if test is passed.
Definition JTestSignificance.hh:155
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
JGIZMO::JRootObjectID
Auxiliary class to handle file name, ROOT directory and object name.
Definition JRootObjectID.hh:37
JLANG::JValueOutOfRange
Exception for accessing a value in a collection that is outside of its range.
Definition JException.hh:180
JPP
This name space includes all other name spaces (except KM3NETDAQ, KM3NET and ANTARES).
Definition JAAnetToolkit.hh:45
JTOOLS::j
int j
Definition JPolint.hh:801
JCOMPAREHISTOGRAMS::JTestResult
Structure containing the result of the test.
Definition JTestResult.hh:30

◆ read()

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

Read test parameters from input.

Parameters
ininput stream
Returns
input stream

Implements JCOMPAREHISTOGRAMS::JTest_t.

Definition at line 140 of file JTestSignificance.hh.

141 {
142 using namespace JPP;
143
144 in >> threshold >> K >> usePoissonStatistics;
145
146 if (threshold < 0.0) {
147 THROW(JValueOutOfRange, "JTestSignificance::read(): Invalid threshold value " << threshold);
148 }
149
150 return in;
151 }

◆ 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 }
JCOMPAREHISTOGRAMS::print
std::ostream & print(std::ostream &out, const JTestSummary &summary, T __begin, T __end, const bool useColors=true, const JFormat_t &formatting=JFormat_t(18, 3, std::ios::fixed))
Print test summary.
Definition JTestSummary.hh:254

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

threshold p-value to decide if test is passed.

Definition at line 155 of file JTestSignificance.hh.

◆ K

double JCOMPAREHISTOGRAMS::JTestSignificance::K
private

normalization factor between histograms.

Definition at line 156 of file JTestSignificance.hh.

◆ usePoissonStatistics

bool JCOMPAREHISTOGRAMS::JTestSignificance::usePoissonStatistics
private

toggle use of Poisson statistics

Definition at line 157 of file JTestSignificance.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:
Generated by doxygen 1.12.0