Falaise  4.0.1
SuperNEMO Software Toolkit
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
snemo::simulation::cosmic_muon_generator Class Reference

Generator for cosmic muons. More...

#include <falaise/snemo/simulation/cosmic_muon_generator.h>

Inheritance diagram for snemo::simulation::cosmic_muon_generator:
genbb::i_genbb datatools::i_tree_dumpable

Classes

struct  sea_level_pdg_setup
 
struct  sea_level_toy_setup
 
struct  underground_setup
 

Public Types

enum  mode_type { MODE_INVALID = -1, MODE_SEA_LEVEL = 0, MODE_UNDERGROUND = 1 }
 
enum  sea_level_mode_type { SEA_LEVEL_INVALID = -1, SEA_LEVEL_TOY = 0, SEA_LEVEL_PDG = 1 }
 
- Public Types inherited from datatools::i_tree_dumpable
enum  ostream_type
 

Public Member Functions

bool is_initialized () const
 
int get_mode () const
 
void set_mode (int)
 
const mygsl::rngget_random () const
 
mygsl::rnggrab_random ()
 
bool can_external_random () const
 
 cosmic_muon_generator ()
 Constructor. More...
 
virtual ~cosmic_muon_generator ()
 Destructor. More...
 
virtual void initialize (const datatools::properties &setup_, datatools::service_manager &service_manager_, ::genbb::detail::pg_dict_type &dictionary_)
 Main initialization interface method. More...
 
virtual void reset ()
 Reset the object. More...
 
virtual bool has_next ()
 Check if some next primary event is available. More...
 
- Public Member Functions inherited from genbb::i_genbb
bool has_name () const
 
const std::string & get_name () const
 
void set_name (const std::string &)
 
void reset_name ()
 
 i_genbb ()
 
virtual ~i_genbb ()
 
virtual void load_next (primary_event &event_, bool compute_classification_=true)
 
virtual bool has_external_random () const
 
virtual void set_external_random (mygsl::rng &)
 
virtual void reset_external_random ()
 
mygsl::rnggrab_external_random ()
 
const mygsl::rngget_external_random () const
 
virtual void initialize_simple ()
 
virtual void initialize_standalone (const datatools::properties &setup_)
 
virtual void initialize_with_service_only (const datatools::properties &setup_, datatools::service_manager &service_manager_)
 
virtual void initialize_with_dictionary_only (const datatools::properties &setup_, detail::pg_dict_type &dictionary_)
 
virtual void initialize (const datatools::properties &setup_, datatools::service_manager &service_manager_, detail::pg_dict_type &dictionary_)=0
 
datatools::logger::priority get_logging_priority () const
 
void set_logging_priority (datatools::logger::priority p)
 
bool is_debug () const
 
void set_assign_generation_ids (bool)
 
bool is_assign_generation_ids () const
 
virtual void tree_dump (std::ostream &out=std::clog, const std::string &title="", const std::string &indent="", bool inherit=false) 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
 

Static Public Member Functions

static double energy_spectrum_at_sea_level_HE (double muon_cos_theta, double muon_energy)
 
- Static Public Member Functions inherited from genbb::i_genbb
static void base_initialize_ocd (datatools::object_configuration_description &)
 
- 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_)
 

Protected Member Functions

virtual void _load_next (::genbb::primary_event &event_, bool compute_classification_=true)
 
- Protected Member Functions inherited from genbb::i_genbb
virtual void _load_next (primary_event &event_, bool compute_classification_)=0
 
void _initialize_base (const datatools::properties &setup_)
 

Additional Inherited Members

- Public Attributes inherited from datatools::i_tree_dumpable
 OSTREAM_COUT
 
 OSTREAM_CERR
 
 OSTREAM_CLOG
 
- Protected Attributes inherited from genbb::i_genbb
datatools::logger::priority _logging_priority
 

Detailed Description

Generator for cosmic muons.

Member Enumeration Documentation

◆ mode_type

Enumerator
MODE_INVALID 
MODE_SEA_LEVEL 
MODE_UNDERGROUND 

◆ sea_level_mode_type

Enumerator
SEA_LEVEL_INVALID 
SEA_LEVEL_TOY 
SEA_LEVEL_PDG 

Constructor & Destructor Documentation

◆ cosmic_muon_generator()

snemo::simulation::cosmic_muon_generator::cosmic_muon_generator ( )

Constructor.

◆ ~cosmic_muon_generator()

virtual snemo::simulation::cosmic_muon_generator::~cosmic_muon_generator ( )
virtual

Destructor.

Member Function Documentation

◆ _load_next()

virtual void snemo::simulation::cosmic_muon_generator::_load_next ( ::genbb::primary_event event_,
bool  compute_classification_ = true 
)
protectedvirtual

◆ can_external_random()

bool snemo::simulation::cosmic_muon_generator::can_external_random ( ) const
virtual

Reimplemented from genbb::i_genbb.

◆ energy_spectrum_at_sea_level_HE()

static double snemo::simulation::cosmic_muon_generator::energy_spectrum_at_sea_level_HE ( double  muon_cos_theta,
double  muon_energy 
)
static

◆ get_mode()

int snemo::simulation::cosmic_muon_generator::get_mode ( ) const

◆ get_random()

const mygsl::rng& snemo::simulation::cosmic_muon_generator::get_random ( ) const

◆ grab_random()

mygsl::rng& snemo::simulation::cosmic_muon_generator::grab_random ( )

◆ has_next()

virtual bool snemo::simulation::cosmic_muon_generator::has_next ( )
virtual

Check if some next primary event is available.

Implements genbb::i_genbb.

◆ initialize()

virtual void snemo::simulation::cosmic_muon_generator::initialize ( const datatools::properties setup_,
datatools::service_manager service_manager_,
::genbb::detail::pg_dict_type dictionary_ 
)
virtual

Main initialization interface method.

◆ is_initialized()

bool snemo::simulation::cosmic_muon_generator::is_initialized ( ) const
virtual

Implements genbb::i_genbb.

◆ reset()

virtual void snemo::simulation::cosmic_muon_generator::reset ( )
virtual

Reset the object.

Implements genbb::i_genbb.

◆ set_mode()

void snemo::simulation::cosmic_muon_generator::set_mode ( int  )

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