Jpp  master_rocky
the software that should make you happy
Public Member Functions | Protected Attributes | Private Attributes | List of all members
JCOMPAREHISTOGRAMS::JTestPoissonLogLikelihoodRatio Class Reference

Implementation of the Poisson log-likelihood ratio test. More...

#include <JTestPoissonLogLikelihoodRatio.hh>

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

Public Member Functions

 JTestPoissonLogLikelihoodRatio ()
 Default constructor. More...
 
void test (const TObject *o1, const TObject *o2) override
 Applies a Poissonian log-likelihood ratio test to the two given 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 chi-square to decide if test is passed. More...
 

Detailed Description

Implementation of the Poisson log-likelihood ratio test.


The first histogram is treated as an Asimov dataset corresponding to a given null hypothesis,
which is compared to an alternative hypothesis given by the second histogram.

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.

Definition at line 27 of file JTestPoissonLogLikelihoodRatio.hh.

Constructor & Destructor Documentation

◆ JTestPoissonLogLikelihoodRatio()

JCOMPAREHISTOGRAMS::JTestPoissonLogLikelihoodRatio::JTestPoissonLogLikelihoodRatio ( )
inline

Default constructor.

Definition at line 35 of file JTestPoissonLogLikelihoodRatio.hh.

35  :
36  JTest_t("Poissonian Log-Likelihood Ratio", "NLLR")
37  {}
JTest_t(const std::string &testName, const std::string &resultType)
Constructor.
Definition: JTest_t.hh:51

Member Function Documentation

◆ test()

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

Applies a Poissonian log-likelihood ratio test to the two given histograms.


The first histogram is treated as an Asimov dataset corresponding to a given null hypothesis.
The second histogram is treated as the expectation for the alternative hypothesis, to which the null hypothesis is compared.

Parameters
o1First histogram
o2Second histogram

< Penalty factor

Implements JCOMPAREHISTOGRAMS::JTest_t.

Definition at line 48 of file JTestPoissonLogLikelihoodRatio.hh.

49  {
50  using namespace std;
51  using namespace JPP;
52 
53  static const double penalty = -1e9; //!< Penalty factor
54 
55  const TH1* h1 = dynamic_cast<const TH1*>(o1);
56  const TH1* h2 = dynamic_cast<const TH1*>(o2);
57 
58  if (h1 == NULL || h2 == NULL) {
59  THROW(JValueOutOfRange, "JTestPoissonLogLikelihood::test(): Could not cast given TObjects to TH1.");
60  }
61 
62  if(h1->GetNbinsX() != h2->GetNbinsX() ||
63  h1->GetNbinsY() != h2->GetNbinsY() ||
64  h1->GetNbinsZ() != h2->GetNbinsZ()) {
65  THROW(JValueOutOfRange, "JTestPoissonLogLikelihood::test(): Histograms with different binning. The objects: " <<
66  h1->GetName() << " and " << h2->GetName() << " can not be compared." << endl);
67  }
68 
69  TH1* h3 = (TH1*) h1->Clone(h1->GetName() == h2->GetName() ?
70  MAKE_CSTRING(h1->GetName() << "_" << testName) :
71  MAKE_CSTRING(h1->GetName() << "_VS_" << h2->GetName() << "_" << testName));
72 
73  h3->Reset();
74 
75  double LnLratio = 0.0;
76 
77  for (int i=1 ; i <= h1->GetNbinsX() ; ++i){
78  for (int j=1 ; j <= h1->GetNbinsY() ; ++j){
79  for (int k=1 ; k <= h1->GetNbinsZ() ; ++k){
80 
81  double contribution;
82 
83  const double n0 = h1->GetBinContent(i,j,k);
84  const double n1 = h2->GetBinContent(i,j,k);
85 
86  if (n0 > 0.0 && n1 > 0.0) {
87  contribution = 2 * (n0 - n1 - n0 * log(n0/n1));
88  } else if (n0 > 0.0 || n1 > 0.0) {
89  contribution = penalty;
90  } else {
91  contribution = 0.0;
92  }
93 
94  h3->SetBinContent(i,j,k, contribution);
95 
96  LnLratio -= contribution;
97  }
98  }
99  }
100 
101  const bool passed = (LnLratio < threshold);
102 
103  const JResultTitle title(testName, resultType, passed, LnLratio);
104 
105  h3->SetTitle(title.getTitle().c_str());
106  h3->GetYaxis()->SetTitle(resultType.c_str());
107 
108  const JTestResult r (testName,
109  JRootObjectID(MAKE_STRING(h1->GetDirectory()->GetPath() << h1->GetName())),
110  JRootObjectID(MAKE_STRING(h2->GetDirectory()->GetPath() << h1->GetName())),
111  resultType, LnLratio, threshold, h3, passed);
112 
113  this->push_back(r);
114  }
#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: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...
Definition: JResultTitle.hh:26
double threshold
threshold chi-square to decide if test is passed.
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.
Definition: JException.hh:180
This name space includes all other name spaces (except KM3NETDAQ, KM3NET and ANTARES).
data_type r[M+1]
Definition: JPolint.hh:868
int j
Definition: JPolint.hh:792
Definition: JSTDTypes.hh:14
Structure containing the result of the test.
Definition: JTestResult.hh:30

◆ read()

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

Read test parameters from input.

Parameters
ininput stream
Returns
input stream

Implements JCOMPAREHISTOGRAMS::JTest_t.

Definition at line 123 of file JTestPoissonLogLikelihoodRatio.hh.

124  {
125  using namespace JPP;
126 
127  in >> threshold;
128 
129  if (!(threshold > 0.0)) {
130  THROW(JValueOutOfRange, "JTestPoissonLogLikelihoodRatio::read(): Given chi-square threshold " << threshold << " is invalid");
131  }
132 
133  return in;
134  }

◆ 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  }
std::ostream & print(std::ostream &out, const JTestSummary &summary, const char delimiter=' ', const bool useColors=true)
Print test summary.

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

threshold chi-square to decide if test is passed.

Definition at line 138 of file JTestPoissonLogLikelihoodRatio.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: