A basic processor of simulated step hits in some drift cell in Geiger regime. More...

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

Inheritance diagram for snemo::simulation::gg_step_hit_processor:

Public Member Functions
const mygsl::rng &	get_rng () const
	Return a non mutable reference to the PRNG. More...

mygsl::rng &	grab_rng ()
	Return a mutable reference to the PRNG. More...

bool	has_external_rng () const
	Check if processor uses an external PRNG. More...

virtual bool	accept_external_rng () const
	Check if processor accepts an external PRNG. More...

virtual void	set_external_rng (mygsl::rng &rng_)
	Set an external PRNG. More...

	gg_step_hit_processor ()
	Default constructor. More...

virtual	~gg_step_hit_processor ()
	Destructor. More...

virtual void	reset ()
	Reset. More...

virtual void	initialize (const ::datatools::properties &config_, ::datatools::service_manager &service_mgr_)
	Main setup routine. More...

virtual void	process (const ::mctools::base_step_hit_processor::step_hit_ptr_collection_type &the_base_step_hits, ::mctools::simulated_data::hit_handle_collection_type &the_handle_hits)
	Main processing routine : More...

virtual void	process (const ::mctools::base_step_hit_processor::step_hit_ptr_collection_type &the_base_step_hits, ::mctools::simulated_data::hit_collection_type &the_plain_hits)
	Main processing routine : More...

bool	match_gg_hit (const mctools::base_step_hit &gg_hit_, const mctools::base_step_hit &step_hit_) const
	Check if a step hit is a candidate for being part within a proposed Geiger hit. More...

Public Member Functions inherited from mctools::base_step_hit_processor
bool	is_debug () const

void	set_debug (bool)

void	set_pool (pool_type &)

bool	has_pool () const

pool_type &	get_pool () const

bool	using_private_pool () const

void	setup_private_pool (size_t capacity_=DEFAULT_POOL_CAPACITY)

void	add_new_hit (simulated_data::hit_handle_collection_type &hits_)

const std::string &	get_name () const

void	set_name (const std::string &)

	base_step_hit_processor ()

virtual	~base_step_hit_processor ()

const std::string &	get_hit_category () const

void	set_hit_category (const std::string &hc_)

const std::string &	get_sensitive_category () const

void	set_sensitive_category (const std::string &sc_)

bool	has_geom_manager () const

void	set_geom_manager (const geomtools::manager &gmgr_)

const geomtools::manager &	get_geom_manager () const

const datatools::properties &	get_auxiliaries () const

datatools::properties &	grab_auxiliaries ()

void	initialize (const datatools::properties &config_)

virtual void	initialize (const datatools::properties &config_, datatools::service_manager &service_mgr_)

void	process (const step_hit_ptr_collection_type &base_step_hits_, simulated_data &sim_data_)

virtual void	process (const step_hit_ptr_collection_type &base_step_hits_, simulated_data::hit_handle_collection_type &hits_)=0

virtual void	process (const step_hit_ptr_collection_type &base_step_hit_s, simulated_data::hit_collection_type &plain_hits_)

virtual void	tree_dump (std::ostream &out_=std::clog, const std::string &title_="", const std::string &indent_="", bool inherit_=false) const

datatools::logger::priority	get_logging_priority () const

void	set_logging_priority (datatools::logger::priority)

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 values for attributes. More...

void	_process (const mctools::base_step_hit_processor::step_hit_ptr_collection_type &base_step_hits_, mctools::simulated_data::hit_handle_collection_type gg_hits_, mctools::simulated_data::hit_collection_type plain_gg_hits_)
	Main process method. More...

void	_purge_gg_hits (mctools::simulated_data::hit_handle_collection_type gg_hits_, mctools::simulated_data::hit_collection_type plain_gg_hits_)
	To be documented. More...

Protected Member Functions inherited from mctools::base_step_hit_processor
void	_initialize (const datatools::properties &config_, datatools::service_manager &service_mgr_)

Additional Inherited Members
Public Types inherited from mctools::base_step_hit_processor
typedef std::vector< base_step_hit * >	step_hit_ptr_collection_type

typedef datatools::handle_pool< base_step_hit >	pool_type

Public Types inherited from datatools::i_tree_dumpable
enum	ostream_type

Static Public Member Functions inherited from mctools::base_step_hit_processor
static void	init_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_)

Public Attributes inherited from datatools::i_tree_dumpable
	OSTREAM_COUT

	OSTREAM_CERR

	OSTREAM_CLOG

Static Public Attributes inherited from mctools::base_step_hit_processor
static const size_t	DEFAULT_POOL_CAPACITY

Protected Attributes inherited from mctools::base_step_hit_processor
datatools::logger::priority	_logging_priority

std::string	_name

std::string	_hit_category

std::string	_sensitive_category

const geomtools::manager *	_geom_manager

datatools::properties	_auxiliaries

pool_type *	_private_pool

bool	_pool_owner

pool_type *	_pool

Detailed Description

A basic processor of simulated step hits in some drift cell in Geiger regime.

Constructor & Destructor Documentation

◆ gg_step_hit_processor()

snemo::simulation::gg_step_hit_processor::gg_step_hit_processor ( )

Default constructor.

◆ ~gg_step_hit_processor()

virtual snemo::simulation::gg_step_hit_processor::~gg_step_hit_processor ( )

virtual

Destructor.

Member Function Documentation

◆ _process()

void snemo::simulation::gg_step_hit_processor::_process	(	const mctools::base_step_hit_processor::step_hit_ptr_collection_type &	base_step_hits_,
		mctools::simulated_data::hit_handle_collection_type *	gg_hits_,
		mctools::simulated_data::hit_collection_type *	plain_gg_hits_
	)

protected

Main process method.

◆ _purge_gg_hits()

void snemo::simulation::gg_step_hit_processor::_purge_gg_hits	(	mctools::simulated_data::hit_handle_collection_type *	gg_hits_,
		mctools::simulated_data::hit_collection_type *	plain_gg_hits_
	)

protected

To be documented.

◆ _set_defaults()

void snemo::simulation::gg_step_hit_processor::_set_defaults ( )

protected

Set default values for attributes.

◆ accept_external_rng()

virtual bool snemo::simulation::gg_step_hit_processor::accept_external_rng ( ) const

virtual

Check if processor accepts an external PRNG.

Reimplemented from mctools::base_step_hit_processor.

◆ get_rng()

const mygsl::rng& snemo::simulation::gg_step_hit_processor::get_rng ( ) const

Return a non mutable reference to the PRNG.

◆ grab_rng()

mygsl::rng& snemo::simulation::gg_step_hit_processor::grab_rng ( )

Return a mutable reference to the PRNG.

◆ has_external_rng()

bool snemo::simulation::gg_step_hit_processor::has_external_rng ( ) const

Check if processor uses an external PRNG.

◆ initialize()

virtual void snemo::simulation::gg_step_hit_processor::initialize	(	const ::datatools::properties &	config_,
		::datatools::service_manager &	service_mgr_
	)

virtual

Main setup routine.

◆ match_gg_hit()

bool snemo::simulation::gg_step_hit_processor::match_gg_hit	(	const mctools::base_step_hit &	gg_hit_,
		const mctools::base_step_hit &	step_hit_
	)		const

Check if a step hit is a candidate for being part within a proposed Geiger hit.

◆ process() [1/2]

virtual void snemo::simulation::gg_step_hit_processor::process	(	const ::mctools::base_step_hit_processor::step_hit_ptr_collection_type &	the_base_step_hits,
		::mctools::simulated_data::hit_handle_collection_type &	the_handle_hits
	)

virtual

Main processing routine :

◆ process() [2/2]

virtual void snemo::simulation::gg_step_hit_processor::process	(	const ::mctools::base_step_hit_processor::step_hit_ptr_collection_type &	the_base_step_hits,
		::mctools::simulated_data::hit_collection_type &	the_plain_hits
	)

virtual

Main processing routine :

◆ reset()

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

virtual

Reset.

◆ set_external_rng()

virtual void snemo::simulation::gg_step_hit_processor::set_external_rng ( mygsl::rng & rng_ )

virtual

Set an external PRNG.

Reimplemented from mctools::base_step_hit_processor.

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

falaise/snemo/simulation/gg_step_hit_processor.h

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ gg_step_hit_processor()

◆ ~gg_step_hit_processor()

Member Function Documentation

◆ _process()

◆ _purge_gg_hits()

◆ _set_defaults()

◆ accept_external_rng()

◆ get_rng()

◆ grab_rng()

◆ has_external_rng()

◆ initialize()

◆ match_gg_hit()

◆ process() [1/2]

◆ process() [2/2]

◆ reset()

◆ set_external_rng()