#include <bayeux/mctools/base_step_hit_processor.h>

Inheritance diagram for mctools::base_step_hit_processor:

Public Types
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 { OSTREAM_COUT = 1, OSTREAM_CERR = 2, OSTREAM_CLOG = 3 }
	Enumeration for standard output streams. More...

Public Member Functions
bool	is_debug () const
	Check the debug flag. More...

void	set_debug (bool)
	Set the debug flag. More...

void	set_pool (pool_type &)
	Set the pool of hits. More...

bool	has_pool () const
	Check for a pool of hits. More...

pool_type &	get_pool () const
	Return a reference to a mutable pool of hits. More...

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 ()
	Default constructor. More...

virtual	~base_step_hit_processor ()
	Destructor. More...

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

virtual bool	accept_external_rng () const

virtual void	set_external_rng (mygsl::rng &rng_)

void	initialize (const datatools::properties &config_)
	Initialization from a set of configuration properties. More...

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

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
	Smart print. More...

datatools::logger::priority	get_logging_priority () const
	Return the logging priority threshold. More...

void	set_logging_priority (datatools::logger::priority)
	Set the logging priority threshold. More...

Public Member Functions inherited from datatools::i_tree_dumpable
	i_tree_dumpable ()
	Constructor. More...

virtual	~i_tree_dumpable ()
	Destructor. More...

virtual void	print_tree (std::ostream &out_=std::clog, const boost::property_tree::ptree &options_=empty_options()) const
	Main new interface method for printing. More...

void	print_tree_json (std::ostream &out_=std::clog, const std::string &json_options_="") const
	Printing with jsonized options. More...

void	print_tree_json (std::ostream &out_=std::clog, const char *json_options_=nullptr) const
	Printing with jsonized options. More...

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 void	init_ocd (datatools::object_configuration_description &)
	OCD support. 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_)

Static Public Attributes
static const size_t	DEFAULT_POOL_CAPACITY = 100

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

Protected Attributes
datatools::logger::priority	_logging_priority
	Logging priority threshold. More...

std::string	_name
	Name of the step hit processor. More...

std::string	_hit_category

std::string	_sensitive_category

const geomtools::manager *	_geom_manager = nullptr
	The geometry manager. More...

datatools::properties	_auxiliaries
	Some auxiliary properties. More...

pool_type *	_private_pool = nullptr
	A private embedded pool of hits. More...

bool	_pool_owner
	Pool of hits ownership flag. More...

pool_type *	_pool = nullptr
	Reference to an external pool of hits. More...

Detailed Description

Base step hit processor. The 'process' pure abstract method must be implemented.

Member Typedef Documentation

◆ pool_type

typedef datatools::handle_pool<base_step_hit> mctools::base_step_hit_processor::pool_type

◆ step_hit_ptr_collection_type

typedef std::vector<base_step_hit *> mctools::base_step_hit_processor::step_hit_ptr_collection_type

Constructor & Destructor Documentation

◆ base_step_hit_processor()

mctools::base_step_hit_processor::base_step_hit_processor ( )

Default constructor.

◆ ~base_step_hit_processor()

virtual mctools::base_step_hit_processor::~base_step_hit_processor ( )

virtual

Destructor.

Member Function Documentation

◆ _initialize()

void mctools::base_step_hit_processor::_initialize	(	const datatools::properties &	config_,
		datatools::service_manager &	service_mgr_
	)

protected

◆ accept_external_rng()

virtual bool mctools::base_step_hit_processor::accept_external_rng ( ) const

virtual

◆ add_new_hit()

void mctools::base_step_hit_processor::add_new_hit ( simulated_data::hit_handle_collection_type & hits_ )

◆ get_auxiliaries()

const datatools::properties& mctools::base_step_hit_processor::get_auxiliaries ( ) const

◆ get_geom_manager()

const geomtools::manager& mctools::base_step_hit_processor::get_geom_manager ( ) const

◆ get_hit_category()

const std::string& mctools::base_step_hit_processor::get_hit_category ( ) const

◆ get_logging_priority()

datatools::logger::priority mctools::base_step_hit_processor::get_logging_priority ( ) const

Return the logging priority threshold.

◆ get_name()

const std::string& mctools::base_step_hit_processor::get_name ( ) const

◆ get_pool()

pool_type& mctools::base_step_hit_processor::get_pool ( ) const

Return a reference to a mutable pool of hits.

◆ get_sensitive_category()

const std::string& mctools::base_step_hit_processor::get_sensitive_category ( ) const

◆ grab_auxiliaries()

datatools::properties& mctools::base_step_hit_processor::grab_auxiliaries ( )

◆ has_geom_manager()

bool mctools::base_step_hit_processor::has_geom_manager ( ) const

◆ has_pool()

bool mctools::base_step_hit_processor::has_pool ( ) const

Check for a pool of hits.

◆ init_ocd()

static void mctools::base_step_hit_processor::init_ocd ( datatools::object_configuration_description & )

static

OCD support.

◆ initialize() [1/2]

void mctools::base_step_hit_processor::initialize ( const datatools::properties & config_ )

Initialization from a set of configuration properties.

◆ initialize() [2/2]

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

virtual

Main setup routine:

◆ is_debug()

bool mctools::base_step_hit_processor::is_debug ( ) const

Check the debug flag.

◆ process() [1/3]

void mctools::base_step_hit_processor::process	(	const step_hit_ptr_collection_type &	base_step_hits_,
		simulated_data &	sim_data_
	)

High level routine: Given the input 'the_base_step_hits' collection of pointers to MC step hits, this method adds the proper list of 'hits' in the 'a_sim_data' instance. This method uses one of both 'process' virtual methods below depending on the type of output collection.

◆ process() [2/3]

virtual void mctools::base_step_hit_processor::process	(	const step_hit_ptr_collection_type &	base_step_hits_,
		simulated_data::hit_handle_collection_type &	hits_
	)

pure virtual

Main processing routine: Given the input 'the_base_step_hits' collection of pointers to simulated step hits, this method builds the output 'the_hits' collection, typically by clusterization of original step hits.

◆ process() [3/3]

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

virtual

◆ set_debug()

void mctools::base_step_hit_processor::set_debug ( bool )

Set the debug flag.

◆ set_external_rng()

virtual void mctools::base_step_hit_processor::set_external_rng ( mygsl::rng & rng_ )

virtual

◆ set_geom_manager()

void mctools::base_step_hit_processor::set_geom_manager ( const geomtools::manager & gmgr_ )

◆ set_hit_category()

void mctools::base_step_hit_processor::set_hit_category ( const std::string & hc_ )

◆ set_logging_priority()

void mctools::base_step_hit_processor::set_logging_priority ( datatools::logger::priority )

Set the logging priority threshold.

◆ set_name()

void mctools::base_step_hit_processor::set_name ( const std::string & )

◆ set_pool()

void mctools::base_step_hit_processor::set_pool ( pool_type & )

Set the pool of hits.

◆ set_sensitive_category()

void mctools::base_step_hit_processor::set_sensitive_category ( const std::string & sc_ )

◆ setup_private_pool()

void mctools::base_step_hit_processor::setup_private_pool ( size_t capacity_ = DEFAULT_POOL_CAPACITY )

◆ tree_dump()

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

virtual

Smart print.

Reimplemented from datatools::i_tree_dumpable.

Reimplemented in mctools::calorimeter_step_hit_processor, and mctools::fluence_step_hit_processor.

◆ using_private_pool()

bool mctools::base_step_hit_processor::using_private_pool ( ) const

Member Data Documentation

◆ _auxiliaries

datatools::properties mctools::base_step_hit_processor::_auxiliaries

protected

Some auxiliary properties.

◆ _geom_manager

const geomtools::manager* mctools::base_step_hit_processor::_geom_manager = nullptr

protected

The geometry manager.

◆ _hit_category

std::string mctools::base_step_hit_processor::_hit_category

protected

The name of the category of hits the hit processor accumulates

◆ _logging_priority

datatools::logger::priority mctools::base_step_hit_processor::_logging_priority

protected

Logging priority threshold.

◆ _name

std::string mctools::base_step_hit_processor::_name

protected

Name of the step hit processor.

◆ _pool

pool_type* mctools::base_step_hit_processor::_pool = nullptr

protected

Reference to an external pool of hits.

◆ _pool_owner

bool mctools::base_step_hit_processor::_pool_owner

protected

Pool of hits ownership flag.

◆ _private_pool

pool_type* mctools::base_step_hit_processor::_private_pool = nullptr

protected

A private embedded pool of hits.

◆ _sensitive_category

std::string mctools::base_step_hit_processor::_sensitive_category

protected

The name of the category of sensitive detector the hit processor is attached with

◆ DEFAULT_POOL_CAPACITY

const size_t mctools::base_step_hit_processor::DEFAULT_POOL_CAPACITY = 100

static

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

bayeux/mctools/base_step_hit_processor.h

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ pool_type

◆ step_hit_ptr_collection_type

Constructor & Destructor Documentation

◆ base_step_hit_processor()

◆ ~base_step_hit_processor()

Member Function Documentation

◆ _initialize()

◆ accept_external_rng()

◆ add_new_hit()

◆ get_auxiliaries()

◆ get_geom_manager()

◆ get_hit_category()

◆ get_logging_priority()

◆ get_name()

◆ get_pool()

◆ get_sensitive_category()

◆ grab_auxiliaries()

◆ has_geom_manager()

◆ has_pool()

◆ init_ocd()

◆ initialize() [1/2]

◆ initialize() [2/2]

◆ is_debug()

◆ process() [1/3]

◆ process() [2/3]

◆ process() [3/3]

◆ set_debug()

◆ set_external_rng()

◆ set_geom_manager()

◆ set_hit_category()

◆ set_logging_priority()

◆ set_name()

◆ set_pool()

◆ set_sensitive_category()

◆ setup_private_pool()

◆ tree_dump()

◆ using_private_pool()

Member Data Documentation

◆ _auxiliaries

◆ _geom_manager

◆ _hit_category

◆ _logging_priority

◆ _name

◆ _pool

◆ _pool_owner

◆ _private_pool

◆ _sensitive_category

◆ DEFAULT_POOL_CAPACITY