JASTRONOMY::JPseudoExperiment Struct Reference

Pseudo experiment using CDF for combined generation and likelihood evaluation. More...

#include <JPseudoExperiment.hh>

Inheritance diagram for JASTRONOMY::JPseudoExperiment:

Classes
struct	cdf_type
	Auxiliary data structure for CDF. More...
struct	parameters_type
	Nuisance parameters. More...

Public Types
typedef JAspera::fit_type	fit_type
	fit type

Public Member Functions
	JPseudoExperiment ()
	Default constructor.
template<class H_t >
	JPseudoExperiment (const H_t &hs, const H_t &hb)
	Constructor.
template<class H_t >
	JPseudoExperiment (const H_t &hS, const H_t &hB, const H_t &hs, const H_t &hb)
	Constructor.
void	add (const TObject *ps, const TObject *pb)
	Add objects with PDFs of signal and background.
void	add (const TObject *pS, const TObject *pB, const TObject *ps, const TObject *pb)
	Add objects with PDFs of signal and background.
void	add (const TH1 &hs, const TH1 &hb)
	Add histograms with PDFs of signal and background.
void	add (const TH1 &hS, const TH1 &hB, const TH1 &hs, const TH1 &hb)
	Add histograms with PDFs of signal and background.
void	add (const TH2 &hs, const TH2 &hb)
	Add histograms with PDFs of signal and background.
void	add (const TH2 &hS, const TH2 &hB, const TH2 &hs, const TH2 &hb)
	Add histograms with PDFs of signal and background.
void	add (const TH3 &hs, const TH3 &hb)
	Add histograms with PDFs of signal and background.
void	add (const TH3 &hS, const TH3 &hB, const TH3 &hs, const TH3 &hb)
	Add histograms with PDFs of signal and background.
void	add (const double s, const double b)
	Add signal and background.
void	add (const double S, const double B, const double s, const double b)
	Add signal and background.
double	getSignal () const
	Get total signal.
double	getBackground () const
	Get total background.
virtual void	set (const double fS, const double fB=1.0) override
	Set scaling factors of signal and background strengths.
virtual JAspera &	getAspera () override
	Get fit method.
virtual stats_type	run (JAspera &out) const
	Generate pseudo experiment and transfer values to fit method.
virtual stats_type	run (JAspera &out, const size_t nb) const
	Generate background only pseudo experiment and transfer S/N values to fit method.
void	configure (size_t N)
	Configure lookup tables.
result_type	operator() ()
	Generate pseudo experiment and fit signal strength.
result_type	operator() (const size_t nb)
	Generate background only pseudo experiment and fit signal strength.
void	operator() (std::vector< result_type > &storage)
	Run pseudo experiments using given storage.
template<class T , class JValue_t >
void	operator() (JValue_t result_type::*pm, std::vector< T > &storage)
	Run pseudo experiments using given storage.
template<class T , class JValue_t >
void	operator() (JValue_t JAspera::fit_type::*pm, std::vector< T > &storage)
	Run pseudo experiments using given storage.
double	getProbabilityForUpperLimit (const double ps, const double ts, const size_t nx) const
	Get probability for given pseudo experiment and signal strength to exceed minimal test statistic for upper limit.

Static Public Member Functions
static double	getSNR ()
	Get minimal signa-to-noise ratio.
static void	setSNR (const double value)
	Set minimal signa-to-noise ratio.
static bool	check (const double s, const double b)
	Check validity of signal and background.
static bool	check (const TAxis *ha, const TAxis *hb)
	Check histogram bins.
static bool	check (const TH1 &ha, const TH1 &hb)
	Check histogram bins.
static bool	check (const TH2 &ha, const TH2 &hb)
	Check histogram bins.
static bool	check (const TH3 &ha, const TH3 &hb)
	Check histogram bins.

Public Attributes
struct JASTRONOMY::JPseudoExperiment::parameters_type	nuisance

Protected Member Functions
template<class H_t >
bool	add (const TObject *ps, const TObject *pb)
	Add objects with PDF of signal and background.
template<class H_t >
bool	add (const TObject *pS, const TObject *pB, const TObject *ps, const TObject *pb)
	Add objects with PDF of signal and background.

Protected Attributes
cdf_type	cs
	CDF of signal.
cdf_type	cb
	CDF of background.
JAspera	aspera
	pre-computed N/S values
double	fs = 1.0
	scaling factor signal strength
double	fb = 1.0
	scaling factor background strength
JAspera	fit
	fit

Static Private Member Functions
static double &	get_snr ()
	Get minimal signa-to-noise ratio.

Detailed Description

Pseudo experiment using CDF for combined generation and likelihood evaluation.

Definition at line 265 of file JPseudoExperiment.hh.

Member Typedef Documentation

fit_type

JAspera::fit_type JASTRONOMY::JPseudoExperiment_t::fit_type

inherited

fit type

Definition at line 57 of file JPseudoExperiment.hh.

Constructor & Destructor Documentation

JPseudoExperiment() [1/3]

JASTRONOMY::JPseudoExperiment::JPseudoExperiment ( )

inline

Default constructor.

Definition at line 273 of file JPseudoExperiment.hh.

    {}

JPseudoExperiment() [2/3]

template<class H_t >

JASTRONOMY::JPseudoExperiment::JPseudoExperiment ( const H_t & hs, const H_t & hb )

inline

Constructor.

Parameters

hs	histogram with PDF of signal
hb	histogram with PDF of background

Definition at line 284 of file JPseudoExperiment.hh.

    {
      add(hs, hb);
    }

JPseudoExperiment() [3/3]

template<class H_t >

JASTRONOMY::JPseudoExperiment::JPseudoExperiment ( const H_t & hS, const H_t & hB, const H_t & hs, const H_t & hb )

inline

Constructor.

Parameters

hS	histogram with PDF for generation of signal
hB	histogram with PDF for generation of background
hs	histogram with PDF for evaluation of signal
hb	histogram with PDF for evaluation of background

Definition at line 300 of file JPseudoExperiment.hh.

    {
      add(hS, hB, hs, hb);
    }

Member Function Documentation

add() [1/12]

void JASTRONOMY::JPseudoExperiment::add ( const TObject * ps, const TObject * pb )

inline

Add objects with PDFs of signal and background.

Parameters

ps	pointer to object with PDF of signal
pb	pointer to object with PDF of background

Definition at line 315 of file JPseudoExperiment.hh.

    {
      if (add<TH3>(ps, pb)) { return; }
      if (add<TH2>(ps, pb)) { return; }
      if (add<TH1>(ps, pb)) { return; }
    }

add() [2/12]

void JASTRONOMY::JPseudoExperiment::add ( const TObject * pS, const TObject * pB, const TObject * ps, const TObject * pb )

inline

Add objects with PDFs of signal and background.

Parameters

pS	pointer to object with PDF for generation of signal
pB	pointer to object with PDF for generation of background
ps	pointer to object with PDF for evaluation of signal
pb	pointer to object with PDF for evaluation of background

Definition at line 332 of file JPseudoExperiment.hh.

    {
      if (add<TH3>(pS, pB, ps, pb)) { return; }
      if (add<TH2>(pS, pB, ps, pb)) { return; }
      if (add<TH1>(pS, pB, ps, pb)) { return; }
    }

add() [3/12]

void JASTRONOMY::JPseudoExperiment::add ( const TH1 & hs, const TH1 & hb )

inline

Add histograms with PDFs of signal and background.

Parameters

hs	histogram with PDF of signal
hb	histogram with PDF of background

Definition at line 349 of file JPseudoExperiment.hh.

    {
      for (Int_t ix = 1; ix <= hs.GetXaxis()->GetNbins(); ++ix) {
        add(hs.GetBinContent(ix),
            hb.GetBinContent(ix));
      }
    }

add() [4/12]

void JASTRONOMY::JPseudoExperiment::add ( const TH1 & hS, const TH1 & hB, const TH1 & hs, const TH1 & hb )

inline

Add histograms with PDFs of signal and background.

Parameters

hS	histogram with PDF for generation of signal
hB	histogram with PDF for generation of background
hs	histogram with PDF for evaluation of signal
hb	histogram with PDF for evaluation of background

Definition at line 367 of file JPseudoExperiment.hh.

    {
      for (Int_t ix = 1; ix <= hs.GetXaxis()->GetNbins(); ++ix) {
        add(hS.GetBinContent(ix),
            hB.GetBinContent(ix),
            hs.GetBinContent(ix),
            hb.GetBinContent(ix));
      }
    }

add() [5/12]

void JASTRONOMY::JPseudoExperiment::add ( const TH2 & hs, const TH2 & hb )

inline

Add histograms with PDFs of signal and background.

Parameters

hs	histogram with PDF of signal
hb	histogram with PDF of background

Definition at line 387 of file JPseudoExperiment.hh.

    {
      for (Int_t ix = 1; ix <= hs.GetXaxis()->GetNbins(); ++ix) {
        for (Int_t iy = 1; iy <= hs.GetYaxis()->GetNbins(); ++iy) {
          add(hs.GetBinContent(ix, iy),
              hb.GetBinContent(ix, iy));
        }
      }
    }

add() [6/12]

void JASTRONOMY::JPseudoExperiment::add ( const TH2 & hS, const TH2 & hB, const TH2 & hs, const TH2 & hb )

inline

Add histograms with PDFs of signal and background.

Parameters

hS	histogram with PDF for generation of signal
hB	histogram with PDF for generation of background
hs	histogram with PDF for evaluation of signal
hb	histogram with PDF for evaluation of background

Definition at line 407 of file JPseudoExperiment.hh.

    {
      for (Int_t ix = 1; ix <= hs.GetXaxis()->GetNbins(); ++ix) {
        for (Int_t iy = 1; iy <= hs.GetYaxis()->GetNbins(); ++iy) {
          add(hS.GetBinContent(ix, iy),
              hB.GetBinContent(ix, iy),
              hs.GetBinContent(ix, iy),
              hb.GetBinContent(ix, iy));
        }
      }
    }

add() [7/12]

void JASTRONOMY::JPseudoExperiment::add ( const TH3 & hs, const TH3 & hb )

inline

Add histograms with PDFs of signal and background.

Parameters

hs	histogram with PDF of signal
hb	histogram with PDF of background

Definition at line 429 of file JPseudoExperiment.hh.

    {
      for (Int_t ix = 1; ix <= hs.GetXaxis()->GetNbins(); ++ix) {
        for (Int_t iy = 1; iy <= hs.GetYaxis()->GetNbins(); ++iy) {
          for (Int_t iz = 1; iz <= hs.GetZaxis()->GetNbins(); ++iz) {
            add(hs.GetBinContent(ix, iy, iz),
                hb.GetBinContent(ix, iy, iz));
          }
        }
      }
    }

add() [8/12]

void JASTRONOMY::JPseudoExperiment::add ( const TH3 & hS, const TH3 & hB, const TH3 & hs, const TH3 & hb )

inline

Add histograms with PDFs of signal and background.

Parameters

hS	histogram with PDF for generation of signal
hB	histogram with PDF for generation of background
hs	histogram with PDF for evaluation of signal
hb	histogram with PDF for evaluation of background

Definition at line 451 of file JPseudoExperiment.hh.

    {
      for (Int_t ix = 1; ix <= hs.GetXaxis()->GetNbins(); ++ix) {
        for (Int_t iy = 1; iy <= hs.GetYaxis()->GetNbins(); ++iy) {
          for (Int_t iz = 1; iz <= hs.GetZaxis()->GetNbins(); ++iz) {
            add(hS.GetBinContent(ix, iy, iz),
                hB.GetBinContent(ix, iy, iz),
                hs.GetBinContent(ix, iy, iz),
                hb.GetBinContent(ix, iy, iz));
          }
        }
      }
    }

add() [9/12]

void JASTRONOMY::JPseudoExperiment::add ( const double s, const double b )

inline

Add signal and background.

Parameters

s	signal
b	background

Definition at line 475 of file JPseudoExperiment.hh.

    {
      if (check(s, b)) {
 
        cs.put(s);
        cb.put(b);
 
        aspera.put(s, b);
      }
    }

add() [10/12]

void JASTRONOMY::JPseudoExperiment::add ( const double S, const double B, const double s, const double b )

inline

Add signal and background.

Parameters

S	signal for generation
B	background for generation
s	signal for evaluation
b	background for evaluation

Definition at line 496 of file JPseudoExperiment.hh.

    {
      if (//check(S, B) &&
          check(s, b)) {
 
        cs.put(S);
        cb.put(B);
 
        aspera.put(s, b);
      }
    }

getSignal()

double JASTRONOMY::JPseudoExperiment::getSignal ( ) const

inline

Get total signal.

Returns

signal

Definition at line 517 of file JPseudoExperiment.hh.

    {
      return cs.back() * this->fs;
    }

getBackground()

double JASTRONOMY::JPseudoExperiment::getBackground ( ) const

inline

Get total background.

Returns

background

Definition at line 528 of file JPseudoExperiment.hh.

    {
      return cb.back() * this->fb;
    }

set()

virtual void JASTRONOMY::JPseudoExperiment::set ( const double fS, const double fB = 1.0 )

inlineoverridevirtual

Set scaling factors of signal and background strengths.

Parameters

fS	signal strength
fB	background strength

Implements JASTRONOMY::JPseudoExperiment_t.

Definition at line 540 of file JPseudoExperiment.hh.

    {
      for (auto& i : aspera) {
        i *= fB / this->fb;
      }
      
      this->fs = fS;
      this->fb = fB;
    }

getAspera()

virtual JAspera & JASTRONOMY::JPseudoExperiment::getAspera ( )

inlineoverridevirtual

Get fit method.

Returns

fit

Implements JASTRONOMY::JPseudoExperiment_t.

Definition at line 556 of file JPseudoExperiment.hh.

    {
      return this->fit;
    }

run() [1/2]

virtual stats_type JASTRONOMY::JPseudoExperiment::run ( JAspera & out ) const

inlinevirtual

Generate pseudo experiment and transfer values to fit method.

Parameters

out

output

Returns

result

Implements JASTRONOMY::JPseudoExperiment_t.

Definition at line 568 of file JPseudoExperiment.hh.

    {
      out.addSignal(aspera.getSignal());
 
      const size_t ns = gRandom->Poisson(getSignal()     * nuisance.signal    ->get());           // number of signal events
      const size_t nb = gRandom->Poisson(getBackground() * nuisance.background->get());           // number of background events
 
      for (size_t i = ns; i != 0; --i) { out.push_back(aspera[cs.get_index(gRandom->Rndm())]); }  // store distributed signal events
      for (size_t i = nb; i != 0; --i) { out.push_back(aspera[cb.get_index(gRandom->Rndm())]); }  // store distributed background events
 
      return { ns, nb };
    }

run() [2/2]

virtual stats_type JASTRONOMY::JPseudoExperiment::run ( JAspera & out, const size_t nb ) const

inlinevirtual

Generate background only pseudo experiment and transfer S/N values to fit method.

Parameters

out	output
nb	number of background events

Returns

result

Implements JASTRONOMY::JPseudoExperiment_t.

Definition at line 589 of file JPseudoExperiment.hh.

    {
      out.addSignal(aspera.getSignal());
 
      for (size_t i = nb; i != 0; --i) { out.push_back(aspera[cb.get_index(gRandom->Rndm())]); }  // store distributed background events
 
      return { 0, nb };
    }

configure()

void JASTRONOMY::JPseudoExperiment::configure ( size_t N )

inline

Configure lookup tables.

Parameters

N	number of bins

Definition at line 642 of file JPseudoExperiment.hh.

    {
      cs.configure(N);
      cb.configure(N);
    }

add() [11/12]

template<class H_t >

bool JASTRONOMY::JPseudoExperiment::add ( const TObject * ps, const TObject * pb )

inlineprotected

Add objects with PDF of signal and background.

Parameters

ps	pointer to object with PDF of signal
pb	pointer to object with PDF of background

Returns

true if added; else false

Definition at line 657 of file JPseudoExperiment.hh.

    {
      if (dynamic_cast<const H_t*>(ps) != NULL &&
          dynamic_cast<const H_t*>(pb) != NULL) {
 
        const H_t& hs = dynamic_cast<const H_t&>(*ps);
        const H_t& hb = dynamic_cast<const H_t&>(*pb);
 
        if (check(hs, hb)) {
 
          add(hs, hb);
 
          return true;
        }
      }
 
      return false;
    }

add() [12/12]

template<class H_t >

bool JASTRONOMY::JPseudoExperiment::add ( const TObject * pS, const TObject * pB, const TObject * ps, const TObject * pb )

inlineprotected

Add objects with PDF of signal and background.

Parameters

pS	pointer to object with PDF for generation of signal
pB	pointer to object with PDF for generation of background
ps	pointer to object with PDF for evaluation of signal
pb	pointer to object with PDF for evaluation of background

Returns

true if added; else false

Definition at line 688 of file JPseudoExperiment.hh.

    {
      if (dynamic_cast<const H_t*>(pS) != NULL &&
          dynamic_cast<const H_t*>(pB) != NULL &&
          dynamic_cast<const H_t*>(ps) != NULL &&
          dynamic_cast<const H_t*>(pb) != NULL) {
 
        const H_t& hS = dynamic_cast<const H_t&>(*pS);
        const H_t& hB = dynamic_cast<const H_t&>(*pB);
        const H_t& hs = dynamic_cast<const H_t&>(*ps);
        const H_t& hb = dynamic_cast<const H_t&>(*pb);
 
        if (check(hS, hB) && check(hB, hs) && check(hs, hb)) {
 
          add(hS, hB, hs, hb);
 
          return true;
        }
      }
 
      return false;
    }

operator()() [1/5]

result_type JASTRONOMY::JPseudoExperiment_t::operator() ( )

inlineinherited

Generate pseudo experiment and fit signal strength.

Returns

result

Definition at line 154 of file JPseudoExperiment.hh.

    {
      JAspera& aspera = getAspera();
 
      // reset
 
      aspera.clear();
      aspera.setSignal(0.0);
 
      return { run(aspera), aspera() };
    }

operator()() [2/5]

result_type JASTRONOMY::JPseudoExperiment_t::operator() ( const size_t nb )

inlineinherited

Generate background only pseudo experiment and fit signal strength.

Parameters

nb	number of background events

Returns

result

Definition at line 173 of file JPseudoExperiment.hh.

    {
      JAspera& aspera = getAspera();
 
      // reset
 
      aspera.clear();
      aspera.setSignal(0.0);
 
      return { run(aspera, nb), aspera() };
    }

operator()() [3/5]

void JASTRONOMY::JPseudoExperiment_t::operator() ( std::vector< result_type > & storage )

inlineinherited

Run pseudo experiments using given storage.

Parameters

storage

storage

Definition at line 191 of file JPseudoExperiment.hh.

    {
      for (auto& i : storage) {
        i = (*this)();
      }
    }

operator()() [4/5]

template<class T , class JValue_t >

void JASTRONOMY::JPseudoExperiment_t::operator() ( JValue_t result_type::* pm, std::vector< T > & storage )

inlineinherited

Run pseudo experiments using given storage.

Parameters

pm	pointer to data member of result
storage	storage

Definition at line 206 of file JPseudoExperiment.hh.

    {
      for (auto& i : storage) {
        i = (*this)().*pm;
      }
    }

operator()() [5/5]

template<class T , class JValue_t >

void JASTRONOMY::JPseudoExperiment_t::operator() ( JValue_t JAspera::fit_type::* pm, std::vector< T > & storage )

inlineinherited

Run pseudo experiments using given storage.

Parameters

pm	pointer to data member of result
storage	storage

Definition at line 221 of file JPseudoExperiment.hh.

    {
      (*this)(static_cast<JValue_t result_type::*>(pm), storage);
    }

getProbabilityForUpperLimit()

double JASTRONOMY::JPseudoExperiment_t::getProbabilityForUpperLimit ( const double ps, const double ts, const size_t nx ) const

inlineinherited

Get probability for given pseudo experiment and signal strength to exceed minimal test statistic for upper limit.

Parameters

ps	signal strength
ts	test statistic
nx	number of pseudo experiments

Definition at line 234 of file JPseudoExperiment.hh.

    {
      size_t ns = 0;
 
      for (size_t i = 0; i != nx; ++i) {
 
        JAspera aspera;
 
        this->run(aspera);
 
        if (ps <= std::numeric_limits<double>::min()) {
 
          if (aspera().signal <= ps) {
            ns += 1;
          }
 
        } else if (aspera.getTestStatisticForUpperLimit(ps) > ts) {
          ns += 1;
        }
      }
 
      return (double) ns / (double) nx;
    }

getSNR()

static double JASTRONOMY::JExperiment::getSNR ( )

inlinestaticinherited

Get minimal signa-to-noise ratio.

Returns

signa-to-noise ratio.

Definition at line 32 of file JExperiment.hh.

    {
      return get_snr();
    }

setSNR()

static void JASTRONOMY::JExperiment::setSNR ( const double value )

inlinestaticinherited

Set minimal signa-to-noise ratio.

Parameters

value

signa-to-noise ratio.

Definition at line 43 of file JExperiment.hh.

    {
      get_snr() = value;
    }

check() [1/5]

static bool JASTRONOMY::JExperiment::check ( const double s, const double b )

inlinestaticinherited

Check validity of signal and background.

Parameters

s	signal
b	background

Returns

true if signal and backgroud are valid; else false

Definition at line 56 of file JExperiment.hh.

    {
      return (s > 0.0 && b > 0.0 && s/b >= getSNR());
    }

check() [2/5]

static bool JASTRONOMY::JExperiment::check ( const TAxis * ha, const TAxis * hb )

inlinestaticinherited

Check histogram bins.

Parameters

ha	histogram axis
hb	histogram axis

Returns

true if same binning; else false

Definition at line 69 of file JExperiment.hh.

    {
      return (ha->GetNbins() == hb->GetNbins()       &&
              ha->GetXmin()  == hb->GetXmin()        &&
              ha->GetXmax()  == hb->GetXmax());
    }

check() [3/5]

static bool JASTRONOMY::JExperiment::check ( const TH1 & ha, const TH1 & hb )

inlinestaticinherited

Check histogram bins.

Parameters

ha	histogram
hb	histogram

Returns

true if same binning; else false

Definition at line 83 of file JExperiment.hh.

    {
      return check(ha.GetXaxis(), hb.GetXaxis());
    }

check() [4/5]

static bool JASTRONOMY::JExperiment::check ( const TH2 & ha, const TH2 & hb )

inlinestaticinherited

Check histogram bins.

Parameters

ha	histogram
hb	histogram

Returns

true if same binning; else false

Definition at line 96 of file JExperiment.hh.

    {
      return (check(ha.GetXaxis(), hb.GetXaxis())    &&
              check(ha.GetYaxis(), hb.GetYaxis()));
    }

check() [5/5]

static bool JASTRONOMY::JExperiment::check ( const TH3 & ha, const TH3 & hb )

inlinestaticinherited

Check histogram bins.

Parameters

ha	histogram
hb	histogram

Returns

true if same binning; else false

Definition at line 110 of file JExperiment.hh.

    {
      return (check(ha.GetXaxis(), hb.GetXaxis())    &&
              check(ha.GetYaxis(), hb.GetYaxis())    &&
              check(ha.GetZaxis(), hb.GetZaxis()));
    }

get_snr()

static double & JASTRONOMY::JExperiment::get_snr ( )

inlinestaticprivateinherited

Get minimal signa-to-noise ratio.

Returns

signa-to-noise ratio.

Definition at line 123 of file JExperiment.hh.

    {
      static double value = 0.0;
 
      return value;
    }

Member Data Documentation

nuisance

struct JASTRONOMY::JPseudoExperiment::parameters_type JASTRONOMY::JPseudoExperiment::nuisance

cs

cdf_type JASTRONOMY::JPseudoExperiment::cs

protected

CDF of signal.

Definition at line 809 of file JPseudoExperiment.hh.

cb

cdf_type JASTRONOMY::JPseudoExperiment::cb

protected

CDF of background.

Definition at line 810 of file JPseudoExperiment.hh.

aspera

JAspera JASTRONOMY::JPseudoExperiment::aspera

protected

pre-computed N/S values

Definition at line 812 of file JPseudoExperiment.hh.

fs

double JASTRONOMY::JPseudoExperiment::fs = 1.0

protected

scaling factor signal strength

Definition at line 814 of file JPseudoExperiment.hh.

fb

double JASTRONOMY::JPseudoExperiment::fb = 1.0

protected

scaling factor background strength

Definition at line 815 of file JPseudoExperiment.hh.

fit

JAspera JASTRONOMY::JPseudoExperiment::fit

protected

fit

Definition at line 817 of file JPseudoExperiment.hh.

---

The documentation for this struct was generated from the following file:

• JPseudoExperiment.hh