The base class for all Monte-Carlo (MC) hit objects. More...

#include <bayeux/mctools/base_step_hit.h>

Inheritance diagram for mctools::base_step_hit:

Public Types
enum	store_mask_type { STORE_POSITION_START = datatools::bit_mask::bit03, STORE_POSITION_STOP = datatools::bit_mask::bit04, STORE_TIME_START = datatools::bit_mask::bit05, STORE_TIME_STOP = datatools::bit_mask::bit06, STORE_MOMENTUM_START = datatools::bit_mask::bit07, STORE_MOMENTUM_STOP = datatools::bit_mask::bit08, STORE_ENERGY_DEPOSIT = datatools::bit_mask::bit09, STORE_PARTICLE_NAME = datatools::bit_mask::bit10, STORE_BIASING_WEIGHT = datatools::bit_mask::bit11, STORE_KINETIC_ENERGY_START = datatools::bit_mask::bit12, STORE_KINETIC_ENERGY_STOP = datatools::bit_mask::bit13, STORE_STEP_LENGTH = datatools::bit_mask::bit14, STORE_ENTERING_VOLUME_FLAG = datatools::bit_mask::bit15, STORE_LEAVING_VOLUME_FLAG = datatools::bit_mask::bit16, STORE_CREATOR_PROCESS_NAME = datatools::bit_mask::bit17, STORE_PRIMARY_PARTICLE_FLAG = datatools::bit_mask::bit18, STORE_MAJOR_TRACK_FLAG = datatools::bit_mask::bit19, STORE_DELTA_RAY_FROM_ALPHA_FLAG = datatools::bit_mask::bit20, STORE_TRACK_ID = datatools::bit_mask::bit21, STORE_PARENT_TRACK_ID = datatools::bit_mask::bit22, STORE_MATERIAL_NAME = datatools::bit_mask::bit23, STORE_SENSITIVE_CATEGORY = datatools::bit_mask::bit24, STORE_G4_VOLUME_NAME = datatools::bit_mask::bit25, STORE_G4_VOLUME_COPY_NUMBER = datatools::bit_mask::bit26, STORE_HIT_PROCESSOR = datatools::bit_mask::bit27, STORE_VISU_HIGHLIGHT_FLAG = datatools::bit_mask::bit28, STORE_LAST = STORE_VISU_HIGHLIGHT_FLAG }
	Masks to automatically tag the attributes to be stored. More...

Public Types inherited from geomtools::base_hit
enum	store_mask_type { STORE_NOTHING = 0, STORE_HIT_ID = datatools::bit_mask::bit00, STORE_GEOM_ID = datatools::bit_mask::bit01, STORE_AUXILIARIES = datatools::bit_mask::bit02, STORE_RESERVED30 = datatools::bit_mask::bit30, STORE_RESERVED31 = datatools::bit_mask::bit31 }
	Masks to automatically tag the attributes to be stored. More...

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	has_track_id () const
	Check if the hit records the track ID. More...

int	get_track_id () const
	Get the track ID. More...

void	set_track_id (const int id_)
	Set the track ID. More...

void	invalidate_track_id ()
	Invalidate the track ID. More...

bool	has_parent_track_id () const
	Check if the hit records the parent track ID. More...

int	get_parent_track_id () const
	Get the parent track ID. More...

void	set_parent_track_id (const int id_)
	Set the parent track ID. More...

void	invalidate_parent_track_id ()
	Invalidate the parent track ID. More...

bool	has_position_start () const

const geomtools::vector_3d &	get_position_start () const
	Get the start position of the hit (the coordinate system and units are arbitrary) More...

void	set_position_start (const geomtools::vector_3d &)
	Set the start position of the hit (the coordinate system and units are arbitrary) More...

void	invalidate_position_start ()
	Reset/invalidate the start position of the hit. More...

bool	has_position_stop () const

const geomtools::vector_3d &	get_position_stop () const
	Get the stop position of the hit (the coordinate system and units are arbitrary) More...

void	set_position_stop (const geomtools::vector_3d &)
	Set the stop position of the hit (the coordinate system and units are arbitrary) More...

void	invalidate_position_stop ()
	Reset/invalidate the stop position of the hit. More...

bool	has_momentum_stop () const

const geomtools::vector_3d &	get_momentum_stop () const
	Get the stop momentum of the hit (units are arbitrary) More...

void	set_momentum_stop (const geomtools::vector_3d &)
	Set the stop momentum of the hit (units are arbitrary) More...

void	invalidate_momentum_stop ()
	Reset/invalidate the stop momentum of the hit. More...

bool	has_momentum_start () const

const geomtools::vector_3d &	get_momentum_start () const
	Get the start momentum of the hit (units are arbitrary) More...

void	set_momentum_start (const geomtools::vector_3d &)
	Set the start momentum of the hit (units are arbitrary) More...

void	invalidate_momentum_start ()
	Reset/invalidate the start momentum of the hit. More...

bool	has_time_start () const

double	get_time_start () const
	Get the start time of the hit (units are arbitrary) More...

void	set_time_start (const double)
	Set the start time of the hit (units are arbitrary) More...

void	invalidate_time_start ()
	Reset/invalidate the start time of the hit. More...

bool	has_time_stop () const

double	get_time_stop () const
	Get the stop time of the hit (units are arbitrary) More...

void	set_time_stop (const double)
	Set the stop time of the hit (units are arbitrary) More...

void	invalidate_time_stop ()
	Reset/invalidate the stop time of the hit. More...

bool	has_energy_deposit () const

double	get_energy_deposit () const
	Get the energy deposit along the hit (units are arbitrary) More...

void	set_energy_deposit (const double)
	Set the energy deposit along the hit (units are arbitrary) More...

void	invalidate_energy_deposit ()
	Reset/invalidate the energy deposit along the hit. More...

bool	has_particle_name () const

const std::string &	get_particle_name () const
	Get the particle name associated to the hit. More...

void	set_particle_name (const std::string &)
	Set the particle name associated to the hit. More...

void	invalidate_particle_name ()
	Reset/invalidate the particle name associated to the hit. More...

bool	has_biasing_weight () const
	Check if a biasing weight is associated to the hit. More...

void	set_biasing_weight (double)
	Set the current biasing weight of the particle track. More...

double	get_biasing_weight () const
	Return the current biasing weight of the particle track. More...

void	invalidate_biasing_weight ()
	Reset/invalidate the current biasing weight. More...

bool	has_kinetic_energy_start () const

double	get_kinetic_energy_start () const

void	set_kinetic_energy_start (const double ke_)

void	invalidate_kinetic_energy_start ()

bool	has_kinetic_energy_stop () const

double	get_kinetic_energy_stop () const

void	set_kinetic_energy_stop (const double ke_)

void	invalidate_kinetic_energy_stop ()

bool	has_step_length () const

double	get_step_length () const

void	set_step_length (const double)

void	invalidate_step_length ()

bool	has_entering_volume () const

bool	is_entering_volume () const

void	set_entering_volume (const bool flag_)

void	invalidate_entering_volume ()

bool	has_leaving_volume () const

bool	is_leaving_volume () const

void	set_leaving_volume (const bool flag_)

void	invalidate_leaving_volume ()

bool	has_creator_process_name () const

const std::string &	get_creator_process_name () const

void	set_creator_process_name (const std::string &)

void	invalidate_creator_process_name ()

bool	has_primary_particle () const
	Primary particle flag : check if the MC hit has been generated by a primary particle. More...

bool	is_primary_particle () const

void	set_primary_particle (const bool flag_)

void	invalidate_primary_particle ()

bool	has_major_track () const

bool	is_major_track () const

void	set_major_track (const bool flag_)

void	invalidate_major_track ()

bool	has_delta_ray_from_alpha () const

bool	is_delta_ray_from_alpha () const

void	set_delta_ray_from_alpha (const bool flag_)

void	invalidate_delta_ray_from_alpha ()

bool	has_material_name () const

const std::string &	get_material_name () const

void	set_material_name (const std::string &)

void	invalidate_material_name ()

bool	has_sensitive_category () const

const std::string &	get_sensitive_category () const

void	set_sensitive_category (const std::string &)

void	invalidate_sensitive_category ()

bool	has_hit_processor () const

const std::string &	get_hit_processor () const

void	set_hit_processor (const std::string &)

void	invalidate_hit_processor ()

bool	has_g4_volume_name () const

const std::string &	get_g4_volume_name () const

void	set_g4_volume_name (const std::string &)

void	invalidate_g4_volume_name ()

bool	has_g4_volume_copy_number () const

int	get_g4_volume_copy_number () const

void	set_g4_volume_copy_number (const int)

void	invalidate_g4_volume_copy_number ()

bool	has_visu_highlight () const

bool	is_visu_highlight () const

void	set_visu_highlight (const bool flag_)

void	invalidate_visu_highlight ()

virtual bool	is_valid () const
	Check if the hit has a valid internal structure. More...

virtual void	invalidate ()
	Reset/invalidate the internal structure of the hit. More...

	base_step_hit ()
	Default constructor. More...

virtual	~base_step_hit ()

void	reset ()
	Reset/invalidate the internal structure of the hit. More...

virtual void	clear ()
	Reset/invalidate the internal structure of the hit. More...

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

void	print_tree (std::ostream &out_=std::clog, const boost::property_tree::ptree &options_=datatools::i_tree_dumpable::empty_options()) const override

void	dump () const
	Smart print (default behaviour/shortcut) More...

Public Member Functions inherited from geomtools::base_hit
bool	has_hit_id () const

int32_t	get_hit_id () const

void	set_hit_id (int32_t)
	Set the hit ID integer value. More...

void	invalidate_hit_id ()

bool	has_geom_id () const
	Check if the geometry ID is valid. More...

const geomtools::geom_id &	get_geom_id () const
	Get a reference on the non-mutable geometry ID. More...

geomtools::geom_id &	grab_geom_id ()
	Get a reference on the mutable geometry ID. More...

void	set_geom_id (const geomtools::geom_id &)
	Set the geometry ID. More...

void	invalidate_geom_id ()
	Reset the geometry ID. More...

bool	has_auxiliaries () const
	Check if there are stored auxiliary properties. More...

const datatools::properties &	get_auxiliaries () const
	Get a non-mutable reference on the auxiliaries container. More...

datatools::properties &	grab_auxiliaries ()
	Get a mutable reference on the auxiliaries container. More...

void	set_auxiliaries (const datatools::properties &)
	Set the auxiliaries container. More...

void	invalidate_auxiliaries ()
	Reset the mutable auxiliaries container. More...

	base_hit ()
	Default constructor. More...

virtual	~base_hit ()
	Destructor. More...

void	reset ()
	Reset the internals of the hit, making it invalid. More...

base_hit &	measure (i_measurement &)
	Apply a measurement on the current hit. More...

void	dump () const
	Smart print (default behaviour) More...

Public Member Functions inherited from datatools::i_serializable
	i_serializable ()
	Default constructor. More...

virtual	~i_serializable ()
	Destructor. More...

virtual const std::string &	get_serial_tag () const =0
	Return the serialization string identifier of the class. More...

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

virtual	~i_tree_dumpable ()
	Destructor. 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

Public Member Functions inherited from datatools::i_clear
virtual	~i_clear ()
	Destructor. More...

Additional Inherited Members
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 inherited from geomtools::base_hit
static const int32_t	INVALID_HIT_ID = -1

Protected Member Functions inherited from geomtools::base_hit
void	_store_set (uint32_t bit_mask_)
	Set the bits from a mask. More...

void	_store_unset (uint32_t bit_mask_)
	Unset the bits from a mask. More...

bool	_store_check (uint32_t bit_mask_) const
	Check the bits from a mask. More...

Protected Attributes inherited from geomtools::base_hit
uint32_t	_store

Detailed Description

The base class for all Monte-Carlo (MC) hit objects.

start o \ \ particle track step \ \ \ o stop

Member Enumeration Documentation

◆ store_mask_type

enum mctools::base_step_hit::store_mask_type

Masks to automatically tag the attributes to be stored.

Enumerator
STORE_POSITION_START	Serialization mask for the position start attribute.
STORE_POSITION_STOP	Serialization mask for the position stop attribute.
STORE_TIME_START	Serialization mask for the time start attribute.
STORE_TIME_STOP	Serialization mask for the time stop attribute.
STORE_MOMENTUM_START	Serialization mask for the momentum start attribute.
STORE_MOMENTUM_STOP	Serialization mask for the momentum stop attribute.
STORE_ENERGY_DEPOSIT	Serialization mask for the energy deposit attribute.
STORE_PARTICLE_NAME	Serialization mask for the particle name attribute.
STORE_BIASING_WEIGHT	Serialization mask for the biasing weight attribute (BUG 2015-02-26: was datatools::bit_mask::bit20)
STORE_KINETIC_ENERGY_START	Serialization mask for the start kinetic energy attribute.
STORE_KINETIC_ENERGY_STOP	Serialization mask for the stop kinetic energy attribute.
STORE_STEP_LENGTH	Serialization mask for the step length.
STORE_ENTERING_VOLUME_FLAG	Serialization mask for the entering volume flag.
STORE_LEAVING_VOLUME_FLAG	Serialization mask for the leaving volume flag.
STORE_CREATOR_PROCESS_NAME	Serialization mask for the creator process name.
STORE_PRIMARY_PARTICLE_FLAG	Serialization mask for the primary particle flag.
STORE_MAJOR_TRACK_FLAG	Serialization mask for the major track flag.
STORE_DELTA_RAY_FROM_ALPHA_FLAG	Serialization mask for the delta-ray from alpha flag.
STORE_TRACK_ID	Serialization mask for the track ID.
STORE_PARENT_TRACK_ID	Serialization mask for the parent track ID.
STORE_MATERIAL_NAME	Serialization mask for the material name.
STORE_SENSITIVE_CATEGORY	Serialization mask for the sensitive category.
STORE_G4_VOLUME_NAME	Serialization mask for the Geant4 volume name.
STORE_G4_VOLUME_COPY_NUMBER	Serialization mask for the Geant4 volume copy number.
STORE_HIT_PROCESSOR	Serialization mask for the step hit processor.
STORE_VISU_HIGHLIGHT_FLAG	Serialization mask for the visu highlight flag.
STORE_LAST

Constructor & Destructor Documentation

◆ base_step_hit()

mctools::base_step_hit::base_step_hit ( )

Default constructor.

◆ ~base_step_hit()

virtual mctools::base_step_hit::~base_step_hit ( )

virtual

Member Function Documentation

◆ clear()

virtual void mctools::base_step_hit::clear ( )

virtual

Reset/invalidate the internal structure of the hit.

Reimplemented from geomtools::base_hit.

◆ dump()

void mctools::base_step_hit::dump ( ) const

Smart print (default behaviour/shortcut)

◆ get_biasing_weight()

double mctools::base_step_hit::get_biasing_weight ( ) const

Return the current biasing weight of the particle track.

◆ get_creator_process_name()

const std::string& mctools::base_step_hit::get_creator_process_name ( ) const

◆ get_energy_deposit()

double mctools::base_step_hit::get_energy_deposit ( ) const

Get the energy deposit along the hit (units are arbitrary)

◆ get_g4_volume_copy_number()

int mctools::base_step_hit::get_g4_volume_copy_number ( ) const

◆ get_g4_volume_name()

const std::string& mctools::base_step_hit::get_g4_volume_name ( ) const

◆ get_hit_processor()

const std::string& mctools::base_step_hit::get_hit_processor ( ) const

◆ get_kinetic_energy_start()

double mctools::base_step_hit::get_kinetic_energy_start ( ) const

◆ get_kinetic_energy_stop()

double mctools::base_step_hit::get_kinetic_energy_stop ( ) const

◆ get_material_name()

const std::string& mctools::base_step_hit::get_material_name ( ) const

◆ get_momentum_start()

const geomtools::vector_3d& mctools::base_step_hit::get_momentum_start ( ) const

Get the start momentum of the hit (units are arbitrary)

◆ get_momentum_stop()

const geomtools::vector_3d& mctools::base_step_hit::get_momentum_stop ( ) const

Get the stop momentum of the hit (units are arbitrary)

◆ get_parent_track_id()

int mctools::base_step_hit::get_parent_track_id ( ) const

Get the parent track ID.

◆ get_particle_name()

const std::string& mctools::base_step_hit::get_particle_name ( ) const

Get the particle name associated to the hit.

◆ get_position_start()

const geomtools::vector_3d& mctools::base_step_hit::get_position_start ( ) const

Get the start position of the hit (the coordinate system and units are arbitrary)

◆ get_position_stop()

const geomtools::vector_3d& mctools::base_step_hit::get_position_stop ( ) const

Get the stop position of the hit (the coordinate system and units are arbitrary)

◆ get_sensitive_category()

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

◆ get_step_length()

double mctools::base_step_hit::get_step_length ( ) const

◆ get_time_start()

double mctools::base_step_hit::get_time_start ( ) const

Get the start time of the hit (units are arbitrary)

◆ get_time_stop()

double mctools::base_step_hit::get_time_stop ( ) const

Get the stop time of the hit (units are arbitrary)

◆ get_track_id()

int mctools::base_step_hit::get_track_id ( ) const

Get the track ID.

◆ has_biasing_weight()

bool mctools::base_step_hit::has_biasing_weight ( ) const

Check if a biasing weight is associated to the hit.

◆ has_creator_process_name()

bool mctools::base_step_hit::has_creator_process_name ( ) const

◆ has_delta_ray_from_alpha()

bool mctools::base_step_hit::has_delta_ray_from_alpha ( ) const

◆ has_energy_deposit()

bool mctools::base_step_hit::has_energy_deposit ( ) const

◆ has_entering_volume()

bool mctools::base_step_hit::has_entering_volume ( ) const

◆ has_g4_volume_copy_number()

bool mctools::base_step_hit::has_g4_volume_copy_number ( ) const

◆ has_g4_volume_name()

bool mctools::base_step_hit::has_g4_volume_name ( ) const

◆ has_hit_processor()

bool mctools::base_step_hit::has_hit_processor ( ) const

◆ has_kinetic_energy_start()

bool mctools::base_step_hit::has_kinetic_energy_start ( ) const

◆ has_kinetic_energy_stop()

bool mctools::base_step_hit::has_kinetic_energy_stop ( ) const

◆ has_leaving_volume()

bool mctools::base_step_hit::has_leaving_volume ( ) const

◆ has_major_track()

bool mctools::base_step_hit::has_major_track ( ) const

◆ has_material_name()

bool mctools::base_step_hit::has_material_name ( ) const

◆ has_momentum_start()

bool mctools::base_step_hit::has_momentum_start ( ) const

◆ has_momentum_stop()

bool mctools::base_step_hit::has_momentum_stop ( ) const

◆ has_parent_track_id()

bool mctools::base_step_hit::has_parent_track_id ( ) const

Check if the hit records the parent track ID.

◆ has_particle_name()

bool mctools::base_step_hit::has_particle_name ( ) const

◆ has_position_start()

bool mctools::base_step_hit::has_position_start ( ) const

◆ has_position_stop()

bool mctools::base_step_hit::has_position_stop ( ) const

◆ has_primary_particle()

bool mctools::base_step_hit::has_primary_particle ( ) const

Primary particle flag : check if the MC hit has been generated by a primary particle.

◆ has_sensitive_category()

bool mctools::base_step_hit::has_sensitive_category ( ) const

◆ has_step_length()

bool mctools::base_step_hit::has_step_length ( ) const

◆ has_time_start()

bool mctools::base_step_hit::has_time_start ( ) const

◆ has_time_stop()

bool mctools::base_step_hit::has_time_stop ( ) const

◆ has_track_id()

bool mctools::base_step_hit::has_track_id ( ) const

Check if the hit records the track ID.

◆ has_visu_highlight()

bool mctools::base_step_hit::has_visu_highlight ( ) const

◆ invalidate()

virtual void mctools::base_step_hit::invalidate ( )

virtual

Reset/invalidate the internal structure of the hit.

Reimplemented from geomtools::base_hit.

◆ invalidate_biasing_weight()

void mctools::base_step_hit::invalidate_biasing_weight ( )

Reset/invalidate the current biasing weight.

◆ invalidate_creator_process_name()

void mctools::base_step_hit::invalidate_creator_process_name ( )

◆ invalidate_delta_ray_from_alpha()

void mctools::base_step_hit::invalidate_delta_ray_from_alpha ( )

◆ invalidate_energy_deposit()

void mctools::base_step_hit::invalidate_energy_deposit ( )

Reset/invalidate the energy deposit along the hit.

◆ invalidate_entering_volume()

void mctools::base_step_hit::invalidate_entering_volume ( )

◆ invalidate_g4_volume_copy_number()

void mctools::base_step_hit::invalidate_g4_volume_copy_number ( )

◆ invalidate_g4_volume_name()

void mctools::base_step_hit::invalidate_g4_volume_name ( )

◆ invalidate_hit_processor()

void mctools::base_step_hit::invalidate_hit_processor ( )

◆ invalidate_kinetic_energy_start()

void mctools::base_step_hit::invalidate_kinetic_energy_start ( )

◆ invalidate_kinetic_energy_stop()

void mctools::base_step_hit::invalidate_kinetic_energy_stop ( )

◆ invalidate_leaving_volume()

void mctools::base_step_hit::invalidate_leaving_volume ( )

◆ invalidate_major_track()

void mctools::base_step_hit::invalidate_major_track ( )

◆ invalidate_material_name()

void mctools::base_step_hit::invalidate_material_name ( )

◆ invalidate_momentum_start()

void mctools::base_step_hit::invalidate_momentum_start ( )

Reset/invalidate the start momentum of the hit.

◆ invalidate_momentum_stop()

void mctools::base_step_hit::invalidate_momentum_stop ( )

Reset/invalidate the stop momentum of the hit.

◆ invalidate_parent_track_id()

void mctools::base_step_hit::invalidate_parent_track_id ( )

Invalidate the parent track ID.

◆ invalidate_particle_name()

void mctools::base_step_hit::invalidate_particle_name ( )

Reset/invalidate the particle name associated to the hit.

◆ invalidate_position_start()

void mctools::base_step_hit::invalidate_position_start ( )

Reset/invalidate the start position of the hit.

◆ invalidate_position_stop()

void mctools::base_step_hit::invalidate_position_stop ( )

Reset/invalidate the stop position of the hit.

◆ invalidate_primary_particle()

void mctools::base_step_hit::invalidate_primary_particle ( )

◆ invalidate_sensitive_category()

void mctools::base_step_hit::invalidate_sensitive_category ( )

◆ invalidate_step_length()

void mctools::base_step_hit::invalidate_step_length ( )

◆ invalidate_time_start()

void mctools::base_step_hit::invalidate_time_start ( )

Reset/invalidate the start time of the hit.

◆ invalidate_time_stop()

void mctools::base_step_hit::invalidate_time_stop ( )

Reset/invalidate the stop time of the hit.

◆ invalidate_track_id()

void mctools::base_step_hit::invalidate_track_id ( )

Invalidate the track ID.

◆ invalidate_visu_highlight()

void mctools::base_step_hit::invalidate_visu_highlight ( )

◆ is_delta_ray_from_alpha()

bool mctools::base_step_hit::is_delta_ray_from_alpha ( ) const

◆ is_entering_volume()

bool mctools::base_step_hit::is_entering_volume ( ) const

◆ is_leaving_volume()

bool mctools::base_step_hit::is_leaving_volume ( ) const

◆ is_major_track()

bool mctools::base_step_hit::is_major_track ( ) const

◆ is_primary_particle()

bool mctools::base_step_hit::is_primary_particle ( ) const

◆ is_valid()

virtual bool mctools::base_step_hit::is_valid ( ) const

virtual

Check if the hit has a valid internal structure.

We consider a base step hit valid if:

a valid hit ID is set
a valid geometry ID is set
start time is set
start position is set

Reimplemented from geomtools::base_hit.

◆ is_visu_highlight()

bool mctools::base_step_hit::is_visu_highlight ( ) const

◆ print_tree()

void mctools::base_step_hit::print_tree	(	std::ostream &	out_ = `std::clog`,
		const boost::property_tree::ptree &	options_ = `datatools::i_tree_dumpable::empty_options()`
	)		const

overridevirtual

Supported options:

{
  "title"    : "My title: ",
  "indent"   : "[debug] ",
  "inherit"  : false,
  "list_auxiliaries" : true
}

Reimplemented from geomtools::base_hit.

◆ reset()

void mctools::base_step_hit::reset ( )

Reset/invalidate the internal structure of the hit.

◆ set_biasing_weight()

void mctools::base_step_hit::set_biasing_weight ( double )

Set the current biasing weight of the particle track.

◆ set_creator_process_name()

void mctools::base_step_hit::set_creator_process_name ( const std::string & )

◆ set_delta_ray_from_alpha()

void mctools::base_step_hit::set_delta_ray_from_alpha ( const bool flag_ )

◆ set_energy_deposit()

void mctools::base_step_hit::set_energy_deposit ( const double )

Set the energy deposit along the hit (units are arbitrary)

◆ set_entering_volume()

void mctools::base_step_hit::set_entering_volume ( const bool flag_ )

◆ set_g4_volume_copy_number()

void mctools::base_step_hit::set_g4_volume_copy_number ( const int )

◆ set_g4_volume_name()

void mctools::base_step_hit::set_g4_volume_name ( const std::string & )

◆ set_hit_processor()

void mctools::base_step_hit::set_hit_processor ( const std::string & )

◆ set_kinetic_energy_start()

void mctools::base_step_hit::set_kinetic_energy_start ( const double ke_ )

◆ set_kinetic_energy_stop()

void mctools::base_step_hit::set_kinetic_energy_stop ( const double ke_ )

◆ set_leaving_volume()

void mctools::base_step_hit::set_leaving_volume ( const bool flag_ )

◆ set_major_track()

void mctools::base_step_hit::set_major_track ( const bool flag_ )

◆ set_material_name()

void mctools::base_step_hit::set_material_name ( const std::string & )

◆ set_momentum_start()

void mctools::base_step_hit::set_momentum_start ( const geomtools::vector_3d & )

Set the start momentum of the hit (units are arbitrary)

◆ set_momentum_stop()

void mctools::base_step_hit::set_momentum_stop ( const geomtools::vector_3d & )

Set the stop momentum of the hit (units are arbitrary)

◆ set_parent_track_id()

void mctools::base_step_hit::set_parent_track_id ( const int id_ )

Set the parent track ID.

◆ set_particle_name()

void mctools::base_step_hit::set_particle_name ( const std::string & )

Set the particle name associated to the hit.

◆ set_position_start()

void mctools::base_step_hit::set_position_start ( const geomtools::vector_3d & )

Set the start position of the hit (the coordinate system and units are arbitrary)

◆ set_position_stop()

void mctools::base_step_hit::set_position_stop ( const geomtools::vector_3d & )

Set the stop position of the hit (the coordinate system and units are arbitrary)

◆ set_primary_particle()

void mctools::base_step_hit::set_primary_particle ( const bool flag_ )

◆ set_sensitive_category()

void mctools::base_step_hit::set_sensitive_category ( const std::string & )

◆ set_step_length()

void mctools::base_step_hit::set_step_length ( const double )

◆ set_time_start()

void mctools::base_step_hit::set_time_start ( const double )

Set the start time of the hit (units are arbitrary)

◆ set_time_stop()

void mctools::base_step_hit::set_time_stop ( const double )

Set the stop time of the hit (units are arbitrary)

◆ set_track_id()

void mctools::base_step_hit::set_track_id ( const int id_ )

Set the track ID.

◆ set_visu_highlight()

void mctools::base_step_hit::set_visu_highlight ( const bool flag_ )

◆ tree_dump()

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

virtual

Deprecated:: Smart print

Reimplemented from geomtools::base_hit.

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

bayeux/mctools/base_step_hit.h

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ store_mask_type

Constructor & Destructor Documentation

◆ base_step_hit()

◆ ~base_step_hit()

Member Function Documentation

◆ clear()

◆ dump()

◆ get_biasing_weight()

◆ get_creator_process_name()

◆ get_energy_deposit()

◆ get_g4_volume_copy_number()

◆ get_g4_volume_name()

◆ get_hit_processor()

◆ get_kinetic_energy_start()

◆ get_kinetic_energy_stop()

◆ get_material_name()

◆ get_momentum_start()

◆ get_momentum_stop()

◆ get_parent_track_id()

◆ get_particle_name()

◆ get_position_start()

◆ get_position_stop()

◆ get_sensitive_category()

◆ get_step_length()

◆ get_time_start()

◆ get_time_stop()

◆ get_track_id()

◆ has_biasing_weight()

◆ has_creator_process_name()

◆ has_delta_ray_from_alpha()

◆ has_energy_deposit()

◆ has_entering_volume()

◆ has_g4_volume_copy_number()

◆ has_g4_volume_name()

◆ has_hit_processor()

◆ has_kinetic_energy_start()

◆ has_kinetic_energy_stop()

◆ has_leaving_volume()

◆ has_major_track()

◆ has_material_name()

◆ has_momentum_start()

◆ has_momentum_stop()

◆ has_parent_track_id()

◆ has_particle_name()

◆ has_position_start()

◆ has_position_stop()

◆ has_primary_particle()

◆ has_sensitive_category()

◆ has_step_length()

◆ has_time_start()

◆ has_time_stop()

◆ has_track_id()

◆ has_visu_highlight()

◆ invalidate()

◆ invalidate_biasing_weight()

◆ invalidate_creator_process_name()

◆ invalidate_delta_ray_from_alpha()

◆ invalidate_energy_deposit()

◆ invalidate_entering_volume()

◆ invalidate_g4_volume_copy_number()

◆ invalidate_g4_volume_name()

◆ invalidate_hit_processor()

◆ invalidate_kinetic_energy_start()

◆ invalidate_kinetic_energy_stop()

◆ invalidate_leaving_volume()

◆ invalidate_major_track()

◆ invalidate_material_name()

◆ invalidate_momentum_start()

◆ invalidate_momentum_stop()

◆ invalidate_parent_track_id()

◆ invalidate_particle_name()

◆ invalidate_position_start()

◆ invalidate_position_stop()

◆ invalidate_primary_particle()

◆ invalidate_sensitive_category()