Falaise  4.0.1
SuperNEMO Software Toolkit
Public Member Functions | Static Public Member Functions | List of all members
snemo::processing::calorimeter_regime Class Reference

Simple modelling of the energy and time measurement with the SuperNEMO calorimeter optical lines. More...

#include <falaise/snemo/processing/calorimeter_regime.h>

Inheritance diagram for snemo::processing::calorimeter_regime:
datatools::i_tree_dumpable

Public Member Functions

bool is_initialized () const
 Check initialization flag. More...
 
 calorimeter_regime ()
 Default constructor. More...
 
void initialize (const datatools::properties &config_)
 Initialization from parameters. More...
 
void reset ()
 Reset. More...
 
double randomize_energy (mygsl::rng &ran_, const double energy_) const
 Randomize the measured energy value given the true energy. More...
 
double get_sigma_energy (const double energy_) const
 Return the error on energy. More...
 
double quench_alpha_energy (const double energy_) const
 Compute the effective quenched energy for alpha particle. More...
 
double randomize_time (mygsl::rng &ran_, const double time_, const double energy_) const
 Randomize the measured time value given the true time and energy. More...
 
double get_sigma_time (const double energy_) const
 Return the error on time. More...
 
bool is_high_threshold (const double energy_) const
 Check if a given energy passes the high threshold. More...
 
bool is_low_threshold (const double energy_) const
 Check if a given energy passes the low threshold. More...
 
void set_category (const std::string &category_)
 Set the category of the optical modules associated to this calorimeter regime. More...
 
const std::string & get_category () const
 Return the category of the optical modules associated to this calorimeter regime. More...
 
virtual void tree_dump (std::ostream &a_out=std::clog, const std::string &a_title="", const std::string &a_indent="", bool a_inherit=false) const
 Smart print. More...
 
- Public Member Functions inherited from datatools::i_tree_dumpable
 i_tree_dumpable ()
 
virtual ~i_tree_dumpable ()
 
virtual void print_tree (std::ostream &out_=std::clog, const boost::property_tree::ptree &options_=empty_options()) const
 
void print_tree_json (std::ostream &out_=std::clog, const std::string &json_options_="") const
 
void print_tree_json (std::ostream &out_=std::clog, const char *json_options_=nullptr) const
 
void tree_dump_id (const int out_type_=OSTREAM_CLOG, const std::string &title_="", const std::string &indent_="", const bool inherit_=false) const
 
void tree_print_id (const int out_type_=OSTREAM_CLOG, const std::string &title_="") const
 
void smart_print_id (const int out_type_=OSTREAM_CLOG, const std::string &title_="", const std::string &indent_="") const
 

Static Public Member Functions

static const double & default_energy_resolution ()
 Return the default energy resolution. More...
 
static const double & default_low_energy_threshold ()
 Return the default low energy threshold. More...
 
static const double & default_high_energy_threshold ()
 Return the default high energy threshold. More...
 
static const double & default_scintillator_relaxation_time ()
 Return the default scintillator relaxation time. More...
 
- Static Public Member Functions inherited from datatools::i_tree_dumpable
static const boost::property_tree::ptree & empty_options ()
 
static boost::property_tree::ptree make_base_print_options (const std::string &title_, const std::string &indent_="", const bool inherit_=false)
 
static std::ostream & last_skip_tag (std::ostream &out_)
 
static std::ostream & skip_tag (std::ostream &out_)
 
static std::ostream & last_tag (std::ostream &out_)
 
static std::ostream & tag (std::ostream &out_)
 

Additional Inherited Members

- Public Types inherited from datatools::i_tree_dumpable
enum  ostream_type
 
- Public Attributes inherited from datatools::i_tree_dumpable
 OSTREAM_COUT
 
 OSTREAM_CERR
 
 OSTREAM_CLOG
 

Detailed Description

Simple modelling of the energy and time measurement with the SuperNEMO calorimeter optical lines.

Constructor & Destructor Documentation

◆ calorimeter_regime()

snemo::processing::calorimeter_regime::calorimeter_regime ( )

Default constructor.

Member Function Documentation

◆ default_energy_resolution()

static const double& snemo::processing::calorimeter_regime::default_energy_resolution ( )
static

Return the default energy resolution.

◆ default_high_energy_threshold()

static const double& snemo::processing::calorimeter_regime::default_high_energy_threshold ( )
static

Return the default high energy threshold.

◆ default_low_energy_threshold()

static const double& snemo::processing::calorimeter_regime::default_low_energy_threshold ( )
static

Return the default low energy threshold.

◆ default_scintillator_relaxation_time()

static const double& snemo::processing::calorimeter_regime::default_scintillator_relaxation_time ( )
static

Return the default scintillator relaxation time.

◆ get_category()

const std::string& snemo::processing::calorimeter_regime::get_category ( ) const

Return the category of the optical modules associated to this calorimeter regime.

◆ get_sigma_energy()

double snemo::processing::calorimeter_regime::get_sigma_energy ( const double  energy_) const

Return the error on energy.

◆ get_sigma_time()

double snemo::processing::calorimeter_regime::get_sigma_time ( const double  energy_) const

Return the error on time.

◆ initialize()

void snemo::processing::calorimeter_regime::initialize ( const datatools::properties config_)

Initialization from parameters.

◆ is_high_threshold()

bool snemo::processing::calorimeter_regime::is_high_threshold ( const double  energy_) const

Check if a given energy passes the high threshold.

◆ is_initialized()

bool snemo::processing::calorimeter_regime::is_initialized ( ) const

Check initialization flag.

◆ is_low_threshold()

bool snemo::processing::calorimeter_regime::is_low_threshold ( const double  energy_) const

Check if a given energy passes the low threshold.

◆ quench_alpha_energy()

double snemo::processing::calorimeter_regime::quench_alpha_energy ( const double  energy_) const

Compute the effective quenched energy for alpha particle.

◆ randomize_energy()

double snemo::processing::calorimeter_regime::randomize_energy ( mygsl::rng ran_,
const double  energy_ 
) const

Randomize the measured energy value given the true energy.

◆ randomize_time()

double snemo::processing::calorimeter_regime::randomize_time ( mygsl::rng ran_,
const double  time_,
const double  energy_ 
) const

Randomize the measured time value given the true time and energy.

◆ reset()

void snemo::processing::calorimeter_regime::reset ( )

Reset.

◆ set_category()

void snemo::processing::calorimeter_regime::set_category ( const std::string &  category_)

Set the category of the optical modules associated to this calorimeter regime.

◆ tree_dump()

virtual void snemo::processing::calorimeter_regime::tree_dump ( std::ostream &  a_out = std::clog,
const std::string &  a_title = "",
const std::string &  a_indent = "",
bool  a_inherit = false 
) const
virtual

Smart print.

Reimplemented from datatools::i_tree_dumpable.


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