snemo::datamodel::calibrated_tracker_hit Class Reference

Model of a calibrated tracker hit (Geiger regime) More...

#include <falaise/snemo/datamodels/calibrated_tracker_hit.h>

Inheritance diagram for snemo::datamodel::calibrated_tracker_hit:

Public Types
enum	traits_type {   none = 0x0, delayed = datatools::bit_mask::bit00, noisy = datatools::bit_mask::bit01, missing_bottom_cathode = datatools::bit_mask::bit02,   missing_top_cathode = datatools::bit_mask::bit03, peripheral = datatools::bit_mask::bit04, xy = datatools::bit_mask::bit05, sterile = datatools::bit_mask::bit06,   fake = datatools::bit_mask::bit07 }
	Special traits. More...
typedef datatools::handle< calibrated_tracker_hit >	handle_type
	Alias for a handle on a calibrated tracker hit. More...
typedef std::vector< handle_type >	collection_type
	Alias for a collection of handles on calibrated tracker hits. More...
Public Types inherited from geomtools::base_hit
enum	store_mask_type
Public Types inherited from datatools::i_tree_dumpable
enum	ostream_type

Public Member Functions
int32_t	get_id () const
	Return the hit ID. More...
int32_t	get_module () const
	Return the module number. More...
int32_t	get_side () const
	Return the number of the tracker submodule. More...
int32_t	get_layer () const
	Return the layer. More...
int32_t	get_row () const
	Return the row. More...
double	get_z () const
	Return the longitudinal position of the Geiger hit along the anode wire. More...
void	set_z (double)
	Set the longitudinal position of the Geiger hit along the anode wire. More...
double	get_sigma_z () const
	Return the error on the longitudinal position of the Geiger hit along the anode wire. More...
void	set_sigma_z (double)
	Set the error on the longitudinal position of the Geiger hit along the anode wire. More...
double	get_r () const
	Return the drift radius of the Geiger hit. More...
void	set_r (double)
	Set the drift radius of the Geiger hit. More...
double	get_sigma_r () const
	Return the error on the drift radius of the Geiger hit. More...
void	set_sigma_r (double)
	Set the error on the drift radius of the Geiger hit. More...
double	get_x () const
	Return the X position of the center of the cell in the module coordinates system. More...
double	get_y () const
	Return the Y position of the center of the cell in the module coordinates system. More...
bool	has_xy () const
	Check if the X/Y position of the center of the cell is stored. More...
void	set_xy (double x_, double y_)
	Set the X/Y position of the center of the cell in the module coordinates system. More...
void	invalidate_xy ()
	Invalidate X/Y position of the center of the cell. More...
void	invalidate_positions ()
	Reset all calibration informations. More...
bool	has_anode_time () const
	Check if the anode drift time is stored as an auxiliary property. More...
void	set_anode_time (double)
	Store the anode drift time as an auxiliary property. More...
double	get_anode_time () const
	Get the anode drift time from a stored auxiliary property. More...
bool	get_trait_bit (uint32_t mask_) const
	Interface to deal with trait bits. More...
bool	is_noisy () const
	Check if the hit is marked as noisy. More...
void	set_noisy (bool)
	Mark/unmark the hit as noisy. More...
bool	is_delayed () const
	Check if the hit is marked as delayed. More...
void	set_delayed (bool)
	Mark/unmark the hit as delayed. More...
bool	has_delayed_time () const
	Check if the delayed time is stored. More...
double	get_delayed_time () const
	Return the delayed reference time of the hit. More...
bool	has_delayed_time_error () const
	Check if the delayed time error is stored. More...
double	get_delayed_time_error () const
	Return the delayed reference time error of the hit. More...
void	set_delayed_time (double ref_delayed_time_, double ref_delayed_time_error_=0.0)
	Set the hit as delayed and store its referece delayed time and associated error. More...
bool	is_prompt () const
	Check if the hit is not marked as delayed. More...
bool	is_peripheral () const
	Check if the hit is marked as peripheral. More...
void	set_peripheral (bool)
	Mark/unmark the hit as peripheral. More...
bool	is_bottom_cathode_missing () const
	Check if the hit lacks the measurement of the bottom cathode signal. More...
void	set_bottom_cathode_missing (bool)
	Mark/unmark the hit lacking the measurement of the bottom cathode signal. More...
bool	is_top_cathode_missing () const
	Check if the hit lacks the measurement of the top cathode signal. More...
void	set_top_cathode_missing (bool)
	Mark/unmark the hit lacking the measurement of the bottom cathode signal. More...
bool	are_both_cathodes_missing () const
	Check if the hit lacks both measurements of the top and bottom cathode signals. More...
bool	is_sterile () const
	Check if the hit is marked as sterile. More...
void	set_sterile (bool)
	Mark/unmark the hit as sterile. More...
bool	is_fake () const
	Check if the hit is marked as fake. More...
void	set_fake (bool)
	Mark/unmark the hit as fake. More...
	calibrated_tracker_hit ()
	Default constructor. More...
virtual	~calibrated_tracker_hit ()
bool	is_valid () const
	Check if minimal calibration informations are present to consider the hit as valid and usable. More...
void	invalidate ()
	Invalidate calibration informations stored in the hit. More...
virtual void	clear ()
	Invalidate calibration informations stored in the hit. More...
calibrated_tracker_hit &	measure (i_measurement &)
	Apply a measurement functor on the hit. More...
virtual void	tree_dump (std::ostream &a_out=std::clog, const std::string &a_title="", const std::string &a_indent="", bool a_inherit=false) const
	Smart print method. More...
void	dump () const
	Shortcut for the smart print method. 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)
void	invalidate_hit_id ()
bool	has_geom_id () const
const geomtools::geom_id &	get_geom_id () const
geomtools::geom_id &	grab_geom_id ()
void	set_geom_id (const geomtools::geom_id &)
void	invalidate_geom_id ()
bool	has_auxiliaries () const
const datatools::properties &	get_auxiliaries () const
datatools::properties &	grab_auxiliaries ()
void	set_auxiliaries (const datatools::properties &)
void	invalidate_auxiliaries ()
	base_hit ()
virtual	~base_hit ()
void	reset ()
base_hit &	measure (i_measurement &)
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
Public Member Functions inherited from datatools::i_serializable
	i_serializable ()
virtual	~i_serializable ()
virtual const std::string &	get_serial_tag () const=0
Public Member Functions inherited from datatools::i_tree_dumpable
	i_tree_dumpable ()
virtual	~i_tree_dumpable ()
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
Public Member Functions inherited from datatools::i_clear
virtual	~i_clear ()

Static Public Member Functions
static const std::string &	anode_time_key ()
	Name of the property to store optional anode time. More...
static const std::string &	bottom_cathode_time_key ()
	Name of the property to store optional bottom cathode time. More...
static const std::string &	top_cathode_time_key ()
	Name of the property to store optional top cathode time. 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_)

Protected Member Functions
void	_set_x (double)
	Set the X position of the center of the cell in the module coordinates system. More...
void	_set_y (double)
	Set the Y position of the center of the cell in the module coordinates system. More...
void	_set_trait_bit (bool value_, uint32_t mask_)
bool	_get_trait_bit (uint32_t mask_) const
Protected Member Functions inherited from geomtools::base_hit
void	_store_set (uint32_t bit_mask_)
void	_store_unset (uint32_t bit_mask_)
bool	_store_check (uint32_t bit_mask_) const

Additional Inherited Members
Public Attributes inherited from geomtools::base_hit
	STORE_NOTHING
	STORE_HIT_ID
	STORE_GEOM_ID
	STORE_AUXILIARIES
	STORE_RESERVED30
	STORE_RESERVED31
Public Attributes inherited from datatools::i_tree_dumpable
	OSTREAM_COUT
	OSTREAM_CERR
	OSTREAM_CLOG
Static Public Attributes inherited from geomtools::base_hit
static const int32_t	INVALID_HIT_ID
Protected Attributes inherited from geomtools::base_hit
uint32_t	_store

Detailed Description

Model of a calibrated tracker hit (Geiger regime)

Member Typedef Documentation

collection_type

typedef std::vector<handle_type> snemo::datamodel::calibrated_tracker_hit::collection_type

Alias for a collection of handles on calibrated tracker hits.

handle_type

typedef datatools::handle<calibrated_tracker_hit> snemo::datamodel::calibrated_tracker_hit::handle_type

Alias for a handle on a calibrated tracker hit.

Member Enumeration Documentation

traits_type

enum snemo::datamodel::calibrated_tracker_hit::traits_type

Special traits.

Enumerator
none
delayed
noisy
missing_bottom_cathode
missing_top_cathode
peripheral
xy
sterile
fake

Constructor & Destructor Documentation

calibrated_tracker_hit()

snemo::datamodel::calibrated_tracker_hit::calibrated_tracker_hit

(

)

Default constructor.

~calibrated_tracker_hit()

virtual snemo::datamodel::calibrated_tracker_hit::~calibrated_tracker_hit ( )

virtual

Member Function Documentation

_get_trait_bit()

bool snemo::datamodel::calibrated_tracker_hit::_get_trait_bit ( uint32_t  mask_ ) const

protected

_set_trait_bit()

void snemo::datamodel::calibrated_tracker_hit::_set_trait_bit ( bool  value_, uint32_t  mask_  )

protected

_set_x()

void snemo::datamodel::calibrated_tracker_hit::_set_x ( double  )

protected

Set the X position of the center of the cell in the module coordinates system.

_set_y()

void snemo::datamodel::calibrated_tracker_hit::_set_y ( double  )

protected

Set the Y position of the center of the cell in the module coordinates system.

anode_time_key()

static const std::string& snemo::datamodel::calibrated_tracker_hit::anode_time_key ( )

static

Name of the property to store optional anode time.

are_both_cathodes_missing()

bool snemo::datamodel::calibrated_tracker_hit::are_both_cathodes_missing

(

)

const

Check if the hit lacks both measurements of the top and bottom cathode signals.

bottom_cathode_time_key()

static const std::string& snemo::datamodel::calibrated_tracker_hit::bottom_cathode_time_key ( )

static

Name of the property to store optional bottom cathode time.

clear()

virtual void snemo::datamodel::calibrated_tracker_hit::clear ( )

virtual

Invalidate calibration informations stored in the hit.

Reimplemented from geomtools::base_hit.

dump()

void snemo::datamodel::calibrated_tracker_hit::dump

(

)

const

Shortcut for the smart print method.

get_anode_time()

double snemo::datamodel::calibrated_tracker_hit::get_anode_time

(

)

const

Get the anode drift time from a stored auxiliary property.

get_delayed_time()

double snemo::datamodel::calibrated_tracker_hit::get_delayed_time

(

)

const

Return the delayed reference time of the hit.

get_delayed_time_error()

double snemo::datamodel::calibrated_tracker_hit::get_delayed_time_error

(

)

const

Return the delayed reference time error of the hit.

get_id()

int32_t snemo::datamodel::calibrated_tracker_hit::get_id

(

)

const

Return the hit ID.

get_layer()

int32_t snemo::datamodel::calibrated_tracker_hit::get_layer

(

)

const

Return the layer.

get_module()

int32_t snemo::datamodel::calibrated_tracker_hit::get_module

(

)

const

Return the module number.

get_r()

double snemo::datamodel::calibrated_tracker_hit::get_r

(

)

const

Return the drift radius of the Geiger hit.

get_row()

int32_t snemo::datamodel::calibrated_tracker_hit::get_row

(

)

const

Return the row.

get_side()

int32_t snemo::datamodel::calibrated_tracker_hit::get_side

(

)

const

Return the number of the tracker submodule.

get_sigma_r()

double snemo::datamodel::calibrated_tracker_hit::get_sigma_r

(

)

const

Return the error on the drift radius of the Geiger hit.

get_sigma_z()

double snemo::datamodel::calibrated_tracker_hit::get_sigma_z

(

)

const

Return the error on the longitudinal position of the Geiger hit along the anode wire.

get_trait_bit()

bool snemo::datamodel::calibrated_tracker_hit::get_trait_bit

(

uint32_t

mask_

)

const

Interface to deal with trait bits.

get_x()

double snemo::datamodel::calibrated_tracker_hit::get_x

(

)

const

Return the X position of the center of the cell in the module coordinates system.

get_y()

double snemo::datamodel::calibrated_tracker_hit::get_y

(

)

const

Return the Y position of the center of the cell in the module coordinates system.

get_z()

double snemo::datamodel::calibrated_tracker_hit::get_z

(

)

const

Return the longitudinal position of the Geiger hit along the anode wire.

has_anode_time()

bool snemo::datamodel::calibrated_tracker_hit::has_anode_time

(

)

const

Check if the anode drift time is stored as an auxiliary property.

has_delayed_time()

bool snemo::datamodel::calibrated_tracker_hit::has_delayed_time

(

)

const

Check if the delayed time is stored.

has_delayed_time_error()

bool snemo::datamodel::calibrated_tracker_hit::has_delayed_time_error

(

)

const

Check if the delayed time error is stored.

has_xy()

bool snemo::datamodel::calibrated_tracker_hit::has_xy

(

)

const

Check if the X/Y position of the center of the cell is stored.

invalidate()

void snemo::datamodel::calibrated_tracker_hit::invalidate ( )

virtual

Invalidate calibration informations stored in the hit.

Reimplemented from geomtools::base_hit.

invalidate_positions()

void snemo::datamodel::calibrated_tracker_hit::invalidate_positions

(

)

Reset all calibration informations.

invalidate_xy()

void snemo::datamodel::calibrated_tracker_hit::invalidate_xy

(

)

Invalidate X/Y position of the center of the cell.

is_bottom_cathode_missing()

bool snemo::datamodel::calibrated_tracker_hit::is_bottom_cathode_missing

(

)

const

Check if the hit lacks the measurement of the bottom cathode signal.

is_delayed()

bool snemo::datamodel::calibrated_tracker_hit::is_delayed

(

)

const

Check if the hit is marked as delayed.

is_fake()

bool snemo::datamodel::calibrated_tracker_hit::is_fake

(

)

const

Check if the hit is marked as fake.

is_noisy()

bool snemo::datamodel::calibrated_tracker_hit::is_noisy

(

)

const

Check if the hit is marked as noisy.

is_peripheral()

bool snemo::datamodel::calibrated_tracker_hit::is_peripheral

(

)

const

Check if the hit is marked as peripheral.

is_prompt()

bool snemo::datamodel::calibrated_tracker_hit::is_prompt

(

)

const

Check if the hit is not marked as delayed.

is_sterile()

bool snemo::datamodel::calibrated_tracker_hit::is_sterile

(

)

const

Check if the hit is marked as sterile.

is_top_cathode_missing()

bool snemo::datamodel::calibrated_tracker_hit::is_top_cathode_missing

(

)

const

Check if the hit lacks the measurement of the top cathode signal.

is_valid()

bool snemo::datamodel::calibrated_tracker_hit::is_valid ( ) const

virtual

Check if minimal calibration informations are present to consider the hit as valid and usable.

Reimplemented from geomtools::base_hit.

measure()

calibrated_tracker_hit& snemo::datamodel::calibrated_tracker_hit::measure

(

i_measurement &

)

Apply a measurement functor on the hit.

set_anode_time()

void snemo::datamodel::calibrated_tracker_hit::set_anode_time

(

double

)

Store the anode drift time as an auxiliary property.

set_bottom_cathode_missing()

void snemo::datamodel::calibrated_tracker_hit::set_bottom_cathode_missing

(

bool

)

Mark/unmark the hit lacking the measurement of the bottom cathode signal.

set_delayed()

void snemo::datamodel::calibrated_tracker_hit::set_delayed

(

bool

)

Mark/unmark the hit as delayed.

set_delayed_time()

void snemo::datamodel::calibrated_tracker_hit::set_delayed_time	(	double	ref_delayed_time_,
		double	ref_delayed_time_error_ = 0.0
	)

Set the hit as delayed and store its referece delayed time and associated error.

set_fake()

void snemo::datamodel::calibrated_tracker_hit::set_fake

(

bool

)

Mark/unmark the hit as fake.

set_noisy()

void snemo::datamodel::calibrated_tracker_hit::set_noisy

(

bool

)

Mark/unmark the hit as noisy.

set_peripheral()

void snemo::datamodel::calibrated_tracker_hit::set_peripheral

(

bool

)

Mark/unmark the hit as peripheral.

set_r()

void snemo::datamodel::calibrated_tracker_hit::set_r

(

double

)

Set the drift radius of the Geiger hit.

set_sigma_r()

void snemo::datamodel::calibrated_tracker_hit::set_sigma_r

(

double

)

Set the error on the drift radius of the Geiger hit.

set_sigma_z()

void snemo::datamodel::calibrated_tracker_hit::set_sigma_z

(

double

)

Set the error on the longitudinal position of the Geiger hit along the anode wire.

set_sterile()

void snemo::datamodel::calibrated_tracker_hit::set_sterile

(

bool

)

Mark/unmark the hit as sterile.

set_top_cathode_missing()

void snemo::datamodel::calibrated_tracker_hit::set_top_cathode_missing

(

bool

)

Mark/unmark the hit lacking the measurement of the bottom cathode signal.

set_xy()

void snemo::datamodel::calibrated_tracker_hit::set_xy	(	double	x_,
		double	y_
	)

Set the X/Y position of the center of the cell in the module coordinates system.

set_z()

void snemo::datamodel::calibrated_tracker_hit::set_z

(

double

)

Set the longitudinal position of the Geiger hit along the anode wire.

top_cathode_time_key()

static const std::string& snemo::datamodel::calibrated_tracker_hit::top_cathode_time_key ( )

static

Name of the property to store optional top cathode time.

tree_dump()

virtual void snemo::datamodel::calibrated_tracker_hit::tree_dump ( std::ostream &  a_out = std::clog, const std::string &  a_title = "", const std::string &  a_indent = "", bool  a_inherit = false  ) const

virtual

Smart print method.

Reimplemented from geomtools::base_hit.

---

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

• falaise/snemo/datamodels/calibrated_tracker_hit.h