Falaise  4.0.1
SuperNEMO Software Toolkit
Public Types | Public Member Functions | Protected Member Functions | List of all members
snemo::processing::mock_calorimeter_s2c_module Class Reference

A mock calibration for SuperNEMO calorimeter hits. More...

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

Inheritance diagram for snemo::processing::mock_calorimeter_s2c_module:
dpp::base_module datatools::i_tree_dumpable

Public Types

typedef std::map< std::string, calorimeter_regimecalorimeter_regime_col_type
 Dictionary of calorimeter regime objects associated to collection of calorimeter-like hits. More...
 
- Public Types inherited from dpp::base_module
enum  process_status
 
- Public Types inherited from datatools::i_tree_dumpable
enum  ostream_type
 

Public Member Functions

void set_geom_manager (const geomtools::manager &gmgr_)
 Setting geometry manager. More...
 
const geomtools::managerget_geom_manager () const
 Getting geometry manager. More...
 
void set_external_random (mygsl::rng &rng_)
 Set the external PRNG. More...
 
void reset_external_random ()
 Reset the external PRNG. More...
 
bool has_external_random () const
 Check if the module use an external PRNG. More...
 
 mock_calorimeter_s2c_module (datatools::logger::priority=datatools::logger::PRIO_FATAL)
 Constructor. More...
 
virtual ~mock_calorimeter_s2c_module ()
 Destructor. More...
 
virtual void initialize (const datatools::properties &setup_, datatools::service_manager &service_manager_, dpp::module_handle_dict_type &module_dict_)
 Initialization. More...
 
virtual void reset ()
 Reset. More...
 
virtual process_status process (datatools::things &data_)
 Data record processing. More...
 
- Public Member Functions inherited from dpp::base_module
 base_module (datatools::logger::priority p_=datatools::logger::PRIO_FATAL)
 
virtual ~base_module ()
 
bool has_name () const
 
void set_name (const std::string &)
 
const std::string & get_name () const
 
bool has_description () const
 
const std::string & get_description () const
 
void set_description (const std::string &description_)
 
bool has_last_error_message () const
 
void set_last_error_message (const std::string &)
 
void append_last_error_message (const std::string &errmsg_)
 
void reset_last_error_message ()
 
const std::string & get_last_error_message () const
 
bool is_initialized () const
 
virtual void initialize_simple ()
 
virtual void initialize_simple_with_service (datatools::service_manager &service_manager_)
 
virtual void initialize_standalone (const datatools::properties &config_)
 
virtual void initialize_with_service (const datatools::properties &config_, datatools::service_manager &service_manager_)
 
virtual void initialize_without_service (const datatools::properties &config, module_handle_dict_type &module_dictionnary_)
 
virtual void tree_dump (std::ostream &out_=std::clog, const std::string &title_="", const std::string &indent_="", bool inherit_=false) const
 
void print (std::ostream &out_=std::clog) const
 
void set_logging_priority (datatools::logger::priority p_)
 
datatools::logger::priority get_logging_priority () const
 
- 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
 

Protected Member Functions

void _set_defaults ()
 Set default attributes values. More...
 
mygsl::rng_get_random ()
 Getting random number generator. More...
 
void _process_calorimeter_digitization (const mctools::simulated_data &simulated_data_, snemo::datamodel::calibrated_data::calorimeter_hit_collection_type &calibrated_calorimeter_hits_)
 Digitize calorimeter hits. More...
 
void _process_calorimeter_calibration (snemo::datamodel::calibrated_data::calorimeter_hit_collection_type &calorimeter_hits_)
 Calibrate calorimeter hits (energy/time resolution spread) More...
 
void _process_calorimeter_trigger (snemo::datamodel::calibrated_data::calorimeter_hit_collection_type &calorimeter_hits_)
 Apply basic trigger effect. More...
 
void _process (const mctools::simulated_data &simulated_data_, snemo::datamodel::calibrated_data::calorimeter_hit_collection_type &calibrated_calorimeter_hits_)
 Main process function. More...
 
- Protected Member Functions inherited from dpp::base_module
void _set_name (const std::string &name_)
 
void _set_initialized (bool initialized_)
 
void _common_initialize (const datatools::properties &config_)
 

Additional Inherited Members

- Static Public Member Functions inherited from dpp::base_module
static void common_ocd (datatools::object_configuration_description &ocd_)
 
- 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_)
 
- Public Attributes inherited from dpp::base_module
 PROCESS_OK
 
 PROCESS_SUCCESS
 
 PROCESS_CONTINUE
 
 PROCESS_ERROR
 
 PROCESS_FAILURE
 
 PROCESS_STOP
 
 PROCESS_ERROR_STOP
 
 PROCESS_FATAL
 
 PROCESS_INVALID
 
- Public Attributes inherited from datatools::i_tree_dumpable
 OSTREAM_COUT
 
 OSTREAM_CERR
 
 OSTREAM_CLOG
 
- Protected Attributes inherited from dpp::base_module
std::string _name
 
std::string _description
 
datatools::logger::priority _logging
 
bool _initialized
 
std::string _last_error_message
 

Detailed Description

A mock calibration for SuperNEMO calorimeter hits.

Member Typedef Documentation

◆ calorimeter_regime_col_type

Dictionary of calorimeter regime objects associated to collection of calorimeter-like hits.

Constructor & Destructor Documentation

◆ mock_calorimeter_s2c_module()

snemo::processing::mock_calorimeter_s2c_module::mock_calorimeter_s2c_module ( datatools::logger::priority  = datatools::logger::PRIO_FATAL)

Constructor.

◆ ~mock_calorimeter_s2c_module()

virtual snemo::processing::mock_calorimeter_s2c_module::~mock_calorimeter_s2c_module ( )
virtual

Destructor.

Member Function Documentation

◆ _get_random()

mygsl::rng& snemo::processing::mock_calorimeter_s2c_module::_get_random ( )
protected

Getting random number generator.

◆ _process()

void snemo::processing::mock_calorimeter_s2c_module::_process ( const mctools::simulated_data simulated_data_,
snemo::datamodel::calibrated_data::calorimeter_hit_collection_type calibrated_calorimeter_hits_ 
)
protected

Main process function.

◆ _process_calorimeter_calibration()

void snemo::processing::mock_calorimeter_s2c_module::_process_calorimeter_calibration ( snemo::datamodel::calibrated_data::calorimeter_hit_collection_type calorimeter_hits_)
protected

Calibrate calorimeter hits (energy/time resolution spread)

◆ _process_calorimeter_digitization()

void snemo::processing::mock_calorimeter_s2c_module::_process_calorimeter_digitization ( const mctools::simulated_data simulated_data_,
snemo::datamodel::calibrated_data::calorimeter_hit_collection_type calibrated_calorimeter_hits_ 
)
protected

Digitize calorimeter hits.

◆ _process_calorimeter_trigger()

void snemo::processing::mock_calorimeter_s2c_module::_process_calorimeter_trigger ( snemo::datamodel::calibrated_data::calorimeter_hit_collection_type calorimeter_hits_)
protected

Apply basic trigger effect.

◆ _set_defaults()

void snemo::processing::mock_calorimeter_s2c_module::_set_defaults ( )
protected

Set default attributes values.

◆ get_geom_manager()

const geomtools::manager& snemo::processing::mock_calorimeter_s2c_module::get_geom_manager ( ) const

Getting geometry manager.

◆ has_external_random()

bool snemo::processing::mock_calorimeter_s2c_module::has_external_random ( ) const

Check if the module use an external PRNG.

◆ initialize()

virtual void snemo::processing::mock_calorimeter_s2c_module::initialize ( const datatools::properties setup_,
datatools::service_manager service_manager_,
dpp::module_handle_dict_type module_dict_ 
)
virtual

Initialization.

Implements dpp::base_module.

◆ process()

virtual process_status snemo::processing::mock_calorimeter_s2c_module::process ( datatools::things data_)
virtual

Data record processing.

Implements dpp::base_module.

◆ reset()

virtual void snemo::processing::mock_calorimeter_s2c_module::reset ( )
virtual

Reset.

Implements dpp::base_module.

◆ reset_external_random()

void snemo::processing::mock_calorimeter_s2c_module::reset_external_random ( )

Reset the external PRNG.

◆ set_external_random()

void snemo::processing::mock_calorimeter_s2c_module::set_external_random ( mygsl::rng rng_)

Set the external PRNG.

◆ set_geom_manager()

void snemo::processing::mock_calorimeter_s2c_module::set_geom_manager ( const geomtools::manager gmgr_)

Setting geometry manager.


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