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

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

#include <JTestPoissonLogLikelihoodRatioBeestonBarlow.hh>

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

Public Member Functions

 JTestPoissonLogLikelihoodRatioBeestonBarlow ()
 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 40 of file JTestPoissonLogLikelihoodRatioBeestonBarlow.hh.

Constructor & Destructor Documentation

◆ JTestPoissonLogLikelihoodRatioBeestonBarlow()

JCOMPAREHISTOGRAMS::JTestPoissonLogLikelihoodRatioBeestonBarlow::JTestPoissonLogLikelihoodRatioBeestonBarlow ( )
inline

Default constructor.

Definition at line 48 of file JTestPoissonLogLikelihoodRatioBeestonBarlow.hh.

48  :
49  JTest_t("Poissonian Log-Likelihood Ratio with Beeston-Barlow Correction", "NLLR")
50  {}
JTest_t(const std::string &testName, const std::string &resultType)
Constructor.
Definition: JTest_t.hh:51

Member Function Documentation

◆ test()

void JCOMPAREHISTOGRAMS::JTestPoissonLogLikelihoodRatioBeestonBarlow::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 61 of file JTestPoissonLogLikelihoodRatioBeestonBarlow.hh.

62  {
63  using namespace std;
64  using namespace JPP;
65 
66  static const double penalty = -1e9; //!< Penalty factor
67 
68  const TH1* h1 = dynamic_cast<const TH1*>(o1);
69  const TH1* h2 = dynamic_cast<const TH1*>(o2);
70 
71  if (h1 == NULL || h2 == NULL) {
72  THROW(JValueOutOfRange, "JTestPoissonLogLikelihood::test(): Could not cast given TObjects to TH1.");
73  }
74 
75  if(h1->GetNbinsX() != h2->GetNbinsX() ||
76  h1->GetNbinsY() != h2->GetNbinsY() ||
77  h1->GetNbinsZ() != h2->GetNbinsZ()) {
78  THROW(JValueOutOfRange, "JTestPoissonLogLikelihood::test(): Histograms with different binning. The objects: " <<
79  h1->GetName() << " and " << h2->GetName() << " can not be compared." << endl);
80  }
81 
82  RooRealVar x("x", "x", h1->GetBinLowEdge(1), h1->GetBinLowEdge(h1->GetNbinsX()) + h1->GetBinWidth(h1->GetNbinsX()));
83 
84  RooDataHist dh1("dh1", h1->GetTitle(), x, h1);
85  RooDataHist dh2("dh2", h2->GetTitle(), x, h2);
86 
87 #if ROOT_VERSION_CODE < ROOT_VERSION(6,32,0)
88  RooParamHistFunc ph1("ph1", "ph1", dh1);
89 #else
90  RooParamHistFunc ph1("ph1", "ph1", dh1,x);
91 #endif
92  RooHistConstraint hc1("hc1", "hc1", ph1);
93 
94  RooRealSumPdf model_tmp1("model_tmp1", "model_tmp1", ph1, RooRealConstant::value(1.0));
95  RooProdPdf model1 ("model1", "model1", hc1, RooFit::Conditional(model_tmp1,x));
96 
97  RooFitResult* result1 = (RooFitResult*) model1.fitTo(dh2,
98  RooFit::SumW2Error(false),
99  RooFit::PrintLevel(-1),
100  RooFit::Verbose(false),
101  RooFit::Save());
102 
103  if (result1 == NULL) {
104  THROW(JValueOutOfRange, "JTestPoissonLogLikelihoodRatioBeestonBarlow::test(): Unable to retrieve fit results");
105  }
106 
107  double nll2 = 0.0; // Poissonian negative log-likelihood of Asimov data-set onto itself
108 
109  for (int i=1 ; i <= h1->GetNbinsX() ; ++i) {
110  for (int j=1 ; j <= h1->GetNbinsY() ; ++j) {
111  for (int k=1 ; k <= h1->GetNbinsZ() ; ++k) {
112 
113  const double n = h2->GetBinContent(i,j,k);
114 
115  if (n > 0.0) {
116  nll2 += -n*log(n) + log(tgamma(n+1)) + n;
117  } else {
118  nll2 -= penalty;
119  }
120  }
121  }
122  }
123 
124  const double nllratio = 2 * (result1->minNll() - nll2);
125  const bool passed = (nllratio < threshold);
126 
127  const JResultTitle title(testName, resultType, passed, nllratio);
128 
129  TH2* h3 = result1->correlationHist();
130  h3->SetTitle(title.getTitle().c_str());
131 
132  const JTestResult r (testName,
133  JRootObjectID(MAKE_STRING(h1->GetDirectory()->GetPath() << h1->GetName())),
134  JRootObjectID(MAKE_STRING(h2->GetDirectory()->GetPath() << h1->GetName())),
135  resultType, nllratio, threshold, h3, passed);
136 
137  this->push_back(r);
138  }
#define THROW(JException_t, A)
Marco for throwing exception with std::ostream compatible message.
Definition: JException.hh:712
#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
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).
const int n
Definition: JPolint.hh:786
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::JTestPoissonLogLikelihoodRatioBeestonBarlow::read ( std::istream &  in)
inlineoverridevirtual

Read test parameters from input.

Parameters
ininput stream
Returns
input stream

Implements JCOMPAREHISTOGRAMS::JTest_t.

Definition at line 147 of file JTestPoissonLogLikelihoodRatioBeestonBarlow.hh.

148  {
149  using namespace JPP;
150 
151  in >> threshold;
152 
153  if (!(threshold > 0.0)) {
154  THROW(JValueOutOfRange, "JTestPoissonLogLikelihoodRatioBeestonBarlow::read(): Given chi-square threshold " << threshold << " is invalid");
155  }
156 
157  return in;
158  }

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

threshold chi-square to decide if test is passed.

Definition at line 162 of file JTestPoissonLogLikelihoodRatioBeestonBarlow.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: