JASTRONOMY::JExperiment Struct Reference

Auxiliary base class for experiment. More...

#include <JExperiment.hh>

Inheritance diagram for JASTRONOMY::JExperiment:

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 base class for experiment.

Definition at line 25 of file JExperiment.hh.

Member Function Documentation

getSNR()

static double JASTRONOMY::JExperiment::getSNR ( )

inlinestatic

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 )

inlinestatic

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 )

inlinestatic

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 )

inlinestatic

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 )

inlinestatic

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 )

inlinestatic

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 )

inlinestatic

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 ( )

inlinestaticprivate

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:

• JExperiment.hh