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::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 38 of file JTestPoissonLogLikelihoodRatioBeestonBarlow.hh.

Constructor & Destructor Documentation

JCOMPAREHISTOGRAMS::JTestPoissonLogLikelihoodRatioBeestonBarlow::JTestPoissonLogLikelihoodRatioBeestonBarlow ( )
inline

Default constructor.

Definition at line 46 of file JTestPoissonLogLikelihoodRatioBeestonBarlow.hh.

46  :
47  JTest_t("Poissonian Log-Likelihood Ratio with Beeston-Barlow Correction", "NLLR")
48  {}
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::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 59 of file JTestPoissonLogLikelihoodRatioBeestonBarlow.hh.

60  {
61  using namespace std;
62  using namespace JPP;
63 
64  static const double penalty = -1e9; //!< Penalty factor
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, "JTestPoissonLogLikelihood::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, "JTestPoissonLogLikelihood::test(): Histograms with different binning. The objects: " <<
77  h1->GetName() << " and " << h2->GetName() << " can not be compared." << endl);
78  }
79 
80  RooRealVar x("x", "x", h1->GetBinLowEdge(1), h1->GetBinLowEdge(h1->GetNbinsX()) + h1->GetBinWidth(h1->GetNbinsX()));
81 
82  RooDataHist dh1("dh1", h1->GetTitle(), x, h1);
83  RooDataHist dh2("dh2", h2->GetTitle(), x, h2);
84 
85  RooParamHistFunc ph1("ph1", "ph1", dh1);
86  RooHistConstraint hc1("hc1", "hc1", ph1);
87 
88  RooRealSumPdf model_tmp1("model_tmp1", "model_tmp1", ph1, RooRealConstant::value(1.0));
89  RooProdPdf model1 ("model1", "model1", hc1, RooFit::Conditional(model_tmp1,x));
90 
91  RooFitResult* result1 = (RooFitResult*) model1.fitTo(dh2,
92  RooFit::SumW2Error(false),
93  RooFit::PrintLevel(-1),
94  RooFit::Verbose(false),
95  RooFit::Save());
96 
97  if (result1 == NULL) {
98  THROW(JValueOutOfRange, "JTestPoissonLogLikelihoodRatioBeestonBarlow::test(): Unable to retrieve fit results");
99  }
100 
101  double nll2 = 0.0; // Poissonian negative log-likelihood of Asimov data-set onto itself
102 
103  for (int i=1 ; i <= h1->GetNbinsX() ; ++i) {
104  for (int j=1 ; j <= h1->GetNbinsY() ; ++j) {
105  for (int k=1 ; k <= h1->GetNbinsZ() ; ++k) {
106 
107  const double n = h2->GetBinContent(i,j,k);
108 
109  if (n > 0.0) {
110  nll2 += -n*log(n) + log(tgamma(n+1)) + n;
111  } else {
112  nll2 -= penalty;
113  }
114  }
115  }
116  }
117 
118  const double nllratio = 2 * (result1->minNll() - nll2);
119  const bool passed = (nllratio < threshold);
120 
121  const JResultTitle title(testName, resultType, passed, nllratio);
122 
123  TH2* h3 = result1->correlationHist();
124  h3->SetTitle(title.getTitle().c_str());
125 
126  const JTestResult r (testName,
127  JRootObjectID(MAKE_STRING(h1->GetDirectory()->GetPath() << h1->GetName())),
128  JRootObjectID(MAKE_STRING(h2->GetDirectory()->GetPath() << h1->GetName())),
129  resultType, nllratio, threshold, h3, passed);
130 
131  this->push_back(r);
132  }
k
then fatal No hydrophone data file $HYDROPHONE_TXT fi sort gr k
Definition: hydrophone-phi:fit.sh:35
THROW
#define THROW(JException_t, A)
Marco for throwing exception with std::ostream compatible message.
Definition: JException.hh:712
JTOOLS::r
data_type r[M+1]
Definition: JPolint.hh:868
MAKE_STRING
#define MAKE_STRING(A)
Make string.
Definition: JPrint.hh:127
JTOOLS::n
const int n
Definition: JPolint.hh:786
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
JTOOLS::j
int j
Definition: JPolint.hh:792
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 141 of file JTestPoissonLogLikelihoodRatioBeestonBarlow.hh.

142  {
143  using namespace JPP;
144 
145  in >> threshold;
146 
147  if (!(threshold > 0.0)) {
148  THROW(JValueOutOfRange, "JTestPoissonLogLikelihoodRatioBeestonBarlow::read(): Given chi-square threshold " << threshold << " is invalid");
149  }
150 
151  return in;
152  }
THROW
#define THROW(JException_t, A)
Marco for throwing exception with std::ostream compatible message.
Definition: JException.hh:712
in
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  }
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::JTestPoissonLogLikelihoodRatioBeestonBarlow::threshold
private

threshold chi-square to decide if test is passed.

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