JASTRONOMY::JPseudoExperiment_t Struct Reference

Auxiliary interface for pseudo experiment. More...

#include <JPseudoExperiment.hh>

Inheritance diagram for JASTRONOMY::JPseudoExperiment_t:

Classes
struct	h0_type
	Auxiliary data structure for upper limit evaluations of background only pseudo experiments. More...
struct	result_type
	Result of combined pseudo experiment and fit. More...
struct	stats_type
	Statistics of pseudo experiment. More...

Public Types
typedef JAspera::fit_type	fit_type
	fit type

Public Member Functions
virtual void	set (const double fS, const double fB=1.0)=0
	Set scaling factors of signal and background strengths.
virtual JAspera &	getAspera ()=0
	Get fit method.
virtual stats_type	run (JAspera &out) const =0
	Generate pseudo experiment and transfer S/N values to fit method.
virtual stats_type	run (JAspera &out, const size_t nb) const =0
	Generate background only pseudo experiment and transfer S/N values to fit method.
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.

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

Detailed Description

Auxiliary interface for pseudo experiment.

Definition at line 36 of file JPseudoExperiment.hh.

Member Typedef Documentation

fit_type

JAspera::fit_type JASTRONOMY::JPseudoExperiment_t::fit_type

fit type

Definition at line 57 of file JPseudoExperiment.hh.

Member Function Documentation

set()

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

pure virtual

Set scaling factors of signal and background strengths.

Parameters

fS	signal strength
fB	background strength

Implemented in JASTRONOMY::JGen2, and JASTRONOMY::JPseudoExperiment.

getAspera()

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

pure virtual

Get fit method.

Returns

fit

Implemented in JASTRONOMY::JGen2, and JASTRONOMY::JPseudoExperiment.

run() [1/2]

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

pure virtual

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

Parameters

out

output

Returns

result

Implemented in JASTRONOMY::JGen2, and JASTRONOMY::JPseudoExperiment.

run() [2/2]

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

pure virtual

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

Parameters

out	output
nb	number of background events

Returns

result

Implemented in JASTRONOMY::JGen2, and JASTRONOMY::JPseudoExperiment.

operator()() [1/5]

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

inline

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 )

inline

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 )

inline

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 )

inline

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 )

inline

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

inline

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;
    }

---

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

• JPseudoExperiment.hh