Falaise  4.0.1
SuperNEMO Software Toolkit
Public Types | Public Member Functions | Static Public Member Functions | List of all members
snemo::datamodel::tracker_cluster Class Reference

A cluster of Geiger calibrated hits referenced by handles. More...

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

Inheritance diagram for snemo::datamodel::tracker_cluster:
geomtools::base_hit datatools::i_serializable datatools::i_tree_dumpable datatools::i_clear

Public Types

typedef datatools::handle< tracker_clusterhandle_type
 Handle on tracker cluster. 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

bool is_delayed () const
 Check if the cluster is associated to delayed hits. More...
 
bool is_prompt () const
 Check if the cluster is associated to prompt hits. More...
 
void make_delayed ()
 Mark the cluster as associated to delayed hits. More...
 
void make_prompt ()
 Mark the cluster as associated to prompt hits. More...
 
 tracker_cluster ()
 Default constructor. More...
 
virtual ~tracker_cluster ()
 Destructor. More...
 
bool has_cluster_id () const
 Check if there is a valid cluster ID. More...
 
int get_cluster_id () const
 Get the cluster ID. More...
 
void set_cluster_id (int32_t)
 Set the cluster ID. More...
 
void invalidate_cluster_id ()
 Invalidate the cluster ID. More...
 
calibrated_tracker_hit::collection_typegrab_hits ()
 Return a mutable reference on the container of handles on calibrated tracker hits. More...
 
const calibrated_tracker_hit::collection_typeget_hits () const
 Return a non mutable reference on the container of handles on calibrated tracker hits. More...
 
unsigned int get_number_of_hits () const
 Return the number of hits in the cluster. More...
 
const calibrated_tracker_hitget_hit (int i_) const
 Return a non mutable reference on the calibrated tracker hit given its index. More...
 
void clear ()
 Reset/invalidate the contents of the tracker cluster. More...
 
void reset ()
 Reset/invalidate the tracker cluster(see clear) More...
 
virtual void tree_dump (std::ostream &out_=std::clog, const std::string &title_="", const std::string &indent_="", bool inherit_=false) const
 Smart print. 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_idget_geom_id () const
 
geomtools::geom_idgrab_geom_id ()
 
void set_geom_id (const geomtools::geom_id &)
 
void invalidate_geom_id ()
 
bool has_auxiliaries () const
 
const datatools::propertiesget_auxiliaries () const
 
datatools::propertiesgrab_auxiliaries ()
 
void set_auxiliaries (const datatools::properties &)
 
void invalidate_auxiliaries ()
 
 base_hit ()
 
virtual ~base_hit ()
 
virtual bool is_valid () const
 
virtual void invalidate ()
 
void reset ()
 
base_hitmeasure (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 & delayed_cluster_flag ()
 Flag for a auxiliary property. 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_)
 

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 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
 
- Protected Attributes inherited from geomtools::base_hit
uint32_t _store
 

Detailed Description

A cluster of Geiger calibrated hits referenced by handles.

Member Typedef Documentation

◆ handle_type

Handle on tracker cluster.

Constructor & Destructor Documentation

◆ tracker_cluster()

snemo::datamodel::tracker_cluster::tracker_cluster ( )

Default constructor.

◆ ~tracker_cluster()

virtual snemo::datamodel::tracker_cluster::~tracker_cluster ( )
virtual

Destructor.

Member Function Documentation

◆ clear()

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

Reset/invalidate the contents of the tracker cluster.

Reimplemented from geomtools::base_hit.

◆ delayed_cluster_flag()

static const std::string& snemo::datamodel::tracker_cluster::delayed_cluster_flag ( )
static

Flag for a auxiliary property.

◆ get_cluster_id()

int snemo::datamodel::tracker_cluster::get_cluster_id ( ) const

Get the cluster ID.

◆ get_hit()

const calibrated_tracker_hit& snemo::datamodel::tracker_cluster::get_hit ( int  i_) const

Return a non mutable reference on the calibrated tracker hit given its index.

◆ get_hits()

const calibrated_tracker_hit::collection_type& snemo::datamodel::tracker_cluster::get_hits ( ) const

Return a non mutable reference on the container of handles on calibrated tracker hits.

◆ get_number_of_hits()

unsigned int snemo::datamodel::tracker_cluster::get_number_of_hits ( ) const

Return the number of hits in the cluster.

◆ grab_hits()

calibrated_tracker_hit::collection_type& snemo::datamodel::tracker_cluster::grab_hits ( )

Return a mutable reference on the container of handles on calibrated tracker hits.

◆ has_cluster_id()

bool snemo::datamodel::tracker_cluster::has_cluster_id ( ) const

Check if there is a valid cluster ID.

◆ invalidate_cluster_id()

void snemo::datamodel::tracker_cluster::invalidate_cluster_id ( )

Invalidate the cluster ID.

◆ is_delayed()

bool snemo::datamodel::tracker_cluster::is_delayed ( ) const

Check if the cluster is associated to delayed hits.

◆ is_prompt()

bool snemo::datamodel::tracker_cluster::is_prompt ( ) const

Check if the cluster is associated to prompt hits.

◆ make_delayed()

void snemo::datamodel::tracker_cluster::make_delayed ( )

Mark the cluster as associated to delayed hits.

◆ make_prompt()

void snemo::datamodel::tracker_cluster::make_prompt ( )

Mark the cluster as associated to prompt hits.

◆ reset()

void snemo::datamodel::tracker_cluster::reset ( )

Reset/invalidate the tracker cluster(see clear)

◆ set_cluster_id()

void snemo::datamodel::tracker_cluster::set_cluster_id ( int32_t  )

Set the cluster ID.

◆ tree_dump()

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

Smart print.

Reimplemented from geomtools::base_hit.


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