Auxiliary data structure to fit signal strength using likelihood ratio for multiple pseudo experiments. More...

#include <JGen2.hh>

Inheritance diagram for JASTRONOMY::JGen2:

Public Types
typedef JAspera::fit_type	fit_type
	fit type

Public Member Functions
void	configure (size_t N)
	Configure lookup tables.

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 S/N 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.

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	getSignalStrengthForUpperLimit (const JAspera &aspera, const double Q, const size_t numberOfTests, const double precision=1.0e-4)
	Get signal strength given result of experiment and probability of 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 Public Attributes
static constexpr double	MINIMAL_SIGNAL_STRENGTH = 1.0e-10

static constexpr double	MAXIMAL_SIGNAL_STRENGTH = 1.0e+10

Protected Member Functions
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.

Protected Attributes
JAspera	fit
	fit

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

Detailed Description

Auxiliary data structure to fit signal strength using likelihood ratio for multiple pseudo experiments.

Definition at line 25 of file JGen2.hh.

Member Typedef Documentation

◆ fit_type

JAspera::fit_type JASTRONOMY::JPseudoExperiment_t::fit_type

inherited

fit type

Definition at line 62 of file JPseudoExperiment.hh.

Member Function Documentation

◆ configure()

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

inline

Configure lookup tables.

Parameters

N	number of bins

Definition at line 34 of file JGen2.hh.

    {
      for (auto& i : static_cast<std::vector<JPseudoExperiment>&>(*this)) {
        i.configure(N);
      }
    }

◆ getSignal()

double JASTRONOMY::JGen2::getSignal ( ) const

inline

Get total signal.

Returns: signal

Definition at line 47 of file JGen2.hh.

    {
      return std::accumulate(this->begin(), this->end(), 0.0, [](const double y, const JPseudoExperiment& px) { return y + px.getSignal(); } );
    }

◆ getBackground()

double JASTRONOMY::JGen2::getBackground ( ) const

inline

Get total background.

Returns: background

Definition at line 58 of file JGen2.hh.

    {
      return std::accumulate(this->begin(), this->end(), 0.0, [](const double y, const JPseudoExperiment& px) { return y + px.getBackground(); } );
    }

◆ set()

virtual void JASTRONOMY::JGen2::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 70 of file JGen2.hh.

    {
      for (auto& i : static_cast<std::vector<JPseudoExperiment>&>(*this)) {
        i.set(fS, fB);
      }
    }

◆ getAspera()

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

inlineoverridevirtual

Get fit method.

Returns: fit

Implements JASTRONOMY::JPseudoExperiment_t.

Definition at line 83 of file JGen2.hh.

    {
      return this->fit;
    }

◆ run() [1/2]

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

inlinevirtual

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

Parameters

out output

Returns: result

Implements JASTRONOMY::JPseudoExperiment_t.

Definition at line 95 of file JGen2.hh.

    {
      stats_type ps = { 0, 0 };
      
      for (const auto& px : static_cast<const std::vector<JPseudoExperiment>&>(*this)) {
        ps += px.run(out);
      }
 
      return ps;
    }

◆ run() [2/2]

virtual stats_type JASTRONOMY::JGen2::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 114 of file JGen2.hh.

    {
      stats_type ps = { 0, 0 };
 
      const double B = this->getBackground();
 
      for (size_t i = 0; i != nb; ++i) {
 
        const double X = gRandom->Uniform(0.0, B);
 
        double x = 0.0;
 
        for (const auto& px : static_cast<const std::vector<JPseudoExperiment>&>(*this)) {
 
          x += px.getBackground();
 
          if (x >= X) {
 
            ps += px.run(out, 1);
 
            break;
          }
        }
      }
 
      return ps;
    }

◆ operator()() [1/5]

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

inlineinherited

Generate pseudo experiment and fit signal strength.

Returns: result

Definition at line 115 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 134 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 152 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 167 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 182 of file JPseudoExperiment.hh.

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

◆ getSignalStrengthForUpperLimit()

double JASTRONOMY::JPseudoExperiment_t::getSignalStrengthForUpperLimit	(	const JAspera &	aspera,
		const double	Q,
		const size_t	numberOfTests,
		const double	precision = 1.0e-4 )

inlineinherited

Get signal strength given result of experiment and probability of upper limit.

Parameters

aspera	result of experiment
Q	probability
numberOfTests	number of tests
precision	precision

Returns: signal strength

Definition at line 201 of file JPseudoExperiment.hh.

    {
      using namespace std;
 
      const JAspera::fit_type result = aspera(true);
 
      size_t n = 0;
 
      this->set(0.0);
 
      for (size_t i = 0; i != numberOfTests; ++i) {
 
        JAspera aspera;
 
        this->run(aspera);
 
        if (aspera(true).signal < result.signal) {
          n += 1;
        }
      }
 
      if (n > (1.0 - Q) * numberOfTests) {
 
        double mumin = 1.0;
        double mumax = 1.0;
 
        {
          for ( ; ; mumax *= 2.0) {
 
            const double ts = aspera.getTestStatisticForUpperLimit(mumax);
 
            this->set(mumax);
 
            const double ps = this->getProbabilityForUpperLimit(mumax, ts, numberOfTests);
 
            if (ps < 1.0 - Q || mumax > MAXIMAL_SIGNAL_STRENGTH) {
              break;
            }
          }
        }
 
        if (mumax == 1.0) {
 
          mumin = 0.5*mumax;
 
          for ( ; ; mumin *= 0.5) {
 
            const double ts = aspera.getTestStatisticForUpperLimit(mumin);
 
            this->set(mumin);
 
            const double ps = this->getProbabilityForUpperLimit(mumin, ts, numberOfTests);
 
            if (ps > 1.0 - Q || mumin < MINIMAL_SIGNAL_STRENGTH) {
              break;
            }
          }
 
          mumax = 2.0*mumin;
 
        } else {
 
          mumin = 0.5*mumax;
        }
 
        if      (mumin < MINIMAL_SIGNAL_STRENGTH)
          return mumin;
        else if (mumax > MAXIMAL_SIGNAL_STRENGTH)
          return  mumax;
        else {
 
          for ( ; ; ) {                               // binary search
 
            const double mu = 0.5 * (mumin + mumax);
 
            const double ts = aspera.getTestStatisticForUpperLimit(mu);
 
            this->set(mu);
 
            const double ps = this->getProbabilityForUpperLimit(mu, ts, numberOfTests);
 
            if (fabs(ps - (1.0 - Q)) <= precision) {
              return mu;
            }
 
            if (ps >= 1.0 - Q)
              mumin = mu;
            else
              mumax = mu;
          }
        }
      }
 
      return 0.0;
    }

◆ getProbabilityForUpperLimit()

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

inlineprotectedinherited

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 308 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

◆ fit

JAspera JASTRONOMY::JGen2::fit

protected

fit

Definition at line 143 of file JGen2.hh.

◆ MINIMAL_SIGNAL_STRENGTH

double JASTRONOMY::JPseudoExperiment_t::MINIMAL_SIGNAL_STRENGTH = 1.0e-10

staticconstexprinherited

Definition at line 188 of file JPseudoExperiment.hh.

◆ MAXIMAL_SIGNAL_STRENGTH

double JASTRONOMY::JPseudoExperiment_t::MAXIMAL_SIGNAL_STRENGTH = 1.0e+10

staticconstexprinherited

Definition at line 189 of file JPseudoExperiment.hh.

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

JGen2.hh

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Static Private Member Functions

Detailed Description

Member Typedef Documentation

◆ fit_type

Member Function Documentation

◆ configure()

◆ getSignal()

◆ getBackground()

◆ set()

◆ getAspera()

◆ run() [1/2]

◆ run() [2/2]

◆ operator()() [1/5]

◆ operator()() [2/5]

◆ operator()() [3/5]

◆ operator()() [4/5]

◆ operator()() [5/5]

◆ getSignalStrengthForUpperLimit()

◆ getProbabilityForUpperLimit()

◆ getSNR()

◆ setSNR()

◆ check() [1/5]

◆ check() [2/5]

◆ check() [3/5]

◆ check() [4/5]

◆ check() [5/5]

◆ get_snr()

Member Data Documentation

◆ fit

◆ MINIMAL_SIGNAL_STRENGTH

◆ MAXIMAL_SIGNAL_STRENGTH