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

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

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

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

Public Types

typedef datatools::handle< tracker_trajectoryhandle_type
 Handle on tracker trajectory. More...
 
typedef tracker_cluster::handle_type handle_cluster
 Handle on tracker cluster. More...
 
typedef std::vector< handle_clusterclusters_collection_type
 Collection of handles on tracker clusters. More...
 
typedef datatools::handle< base_trajectory_patternhandle_pattern
 Handle on trajectory pattern. More...
 
typedef calibrated_tracker_hit::collection_type orphans_collection_type
 Collection of handles of calibrated tracker hit. 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

 tracker_trajectory ()
 Default constructor. More...
 
virtual ~tracker_trajectory ()
 Destructor. More...
 
bool has_trajectory_id () const
 Check if there is a valid trajectory ID. More...
 
int get_trajectory_id () const
 Get the trajectory ID. More...
 
void set_trajectory_id (int32_t)
 Set the trajectory ID. More...
 
void invalidate_trajectory_id ()
 Invalidate the trajectory ID. More...
 
bool has_cluster () const
 Check if the cluster is present. More...
 
void detach_cluster ()
 Detach the cluster. More...
 
void set_cluster_handle (const handle_cluster &cluster_handle_)
 Attach a cluster by handle. More...
 
handle_clustergrab_cluster_handle ()
 Return a mutable reference on the cluster handle. More...
 
const handle_clusterget_cluster_handle () const
 Return a non mutable reference on the cluster handle. More...
 
tracker_clustergrab_cluster ()
 Return a mutable reference on the cluster. More...
 
const tracker_clusterget_cluster () const
 Return a non mutable reference on the cluster. More...
 
bool has_orphans () const
 Check if there are some orphan hits along the fitted trajectory. More...
 
void reset_orphans ()
 Reset the collection of orphan hits. More...
 
orphans_collection_typegrab_orphans ()
 Return a mutable reference on the collection of orphan hits (handles) More...
 
const orphans_collection_typeget_orphans () const
 Return a non mutable reference on the collection of orphan hits (handles) More...
 
bool has_pattern () const
 Check if the pattern is present. More...
 
void detach_pattern ()
 Detach the pattern. More...
 
void set_pattern_handle (const handle_pattern &pattern_handle_)
 Attach a pattern by handle. More...
 
handle_patterngrab_pattern_handle ()
 Return a mutable reference on the pattern handle. More...
 
const handle_patternget_pattern_handle () const
 Return a non mutable reference on the pattern handle. More...
 
base_trajectory_patterngrab_pattern ()
 Return a mutable reference on the pattern. More...
 
const base_trajectory_patternget_pattern () const
 Return a non mutable reference on the pattern. More...
 
void reset ()
 Reset the tracker trajectory (see clear) More...
 
virtual void clear ()
 Empty the contents of the tracker trajectory. 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 ()
 

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_)
 
- 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 trajectory of Geiger calibrated hits referenced by handles.

Member Typedef Documentation

◆ clusters_collection_type

Collection of handles on tracker clusters.

◆ handle_cluster

Handle on tracker cluster.

◆ handle_pattern

Handle on trajectory pattern.

◆ handle_type

Handle on tracker trajectory.

◆ orphans_collection_type

Collection of handles of calibrated tracker hit.

Constructor & Destructor Documentation

◆ tracker_trajectory()

snemo::datamodel::tracker_trajectory::tracker_trajectory ( )

Default constructor.

◆ ~tracker_trajectory()

virtual snemo::datamodel::tracker_trajectory::~tracker_trajectory ( )
virtual

Destructor.

Member Function Documentation

◆ clear()

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

Empty the contents of the tracker trajectory.

Reimplemented from geomtools::base_hit.

◆ detach_cluster()

void snemo::datamodel::tracker_trajectory::detach_cluster ( )

Detach the cluster.

◆ detach_pattern()

void snemo::datamodel::tracker_trajectory::detach_pattern ( )

Detach the pattern.

◆ get_cluster()

const tracker_cluster& snemo::datamodel::tracker_trajectory::get_cluster ( ) const

Return a non mutable reference on the cluster.

◆ get_cluster_handle()

const handle_cluster& snemo::datamodel::tracker_trajectory::get_cluster_handle ( ) const

Return a non mutable reference on the cluster handle.

◆ get_orphans()

const orphans_collection_type& snemo::datamodel::tracker_trajectory::get_orphans ( ) const

Return a non mutable reference on the collection of orphan hits (handles)

◆ get_pattern()

const base_trajectory_pattern& snemo::datamodel::tracker_trajectory::get_pattern ( ) const

Return a non mutable reference on the pattern.

◆ get_pattern_handle()

const handle_pattern& snemo::datamodel::tracker_trajectory::get_pattern_handle ( ) const

Return a non mutable reference on the pattern handle.

◆ get_trajectory_id()

int snemo::datamodel::tracker_trajectory::get_trajectory_id ( ) const

Get the trajectory ID.

◆ grab_cluster()

tracker_cluster& snemo::datamodel::tracker_trajectory::grab_cluster ( )

Return a mutable reference on the cluster.

◆ grab_cluster_handle()

handle_cluster& snemo::datamodel::tracker_trajectory::grab_cluster_handle ( )

Return a mutable reference on the cluster handle.

◆ grab_orphans()

orphans_collection_type& snemo::datamodel::tracker_trajectory::grab_orphans ( )

Return a mutable reference on the collection of orphan hits (handles)

◆ grab_pattern()

base_trajectory_pattern& snemo::datamodel::tracker_trajectory::grab_pattern ( )

Return a mutable reference on the pattern.

◆ grab_pattern_handle()

handle_pattern& snemo::datamodel::tracker_trajectory::grab_pattern_handle ( )

Return a mutable reference on the pattern handle.

◆ has_cluster()

bool snemo::datamodel::tracker_trajectory::has_cluster ( ) const

Check if the cluster is present.

◆ has_orphans()

bool snemo::datamodel::tracker_trajectory::has_orphans ( ) const

Check if there are some orphan hits along the fitted trajectory.

◆ has_pattern()

bool snemo::datamodel::tracker_trajectory::has_pattern ( ) const

Check if the pattern is present.

◆ has_trajectory_id()

bool snemo::datamodel::tracker_trajectory::has_trajectory_id ( ) const

Check if there is a valid trajectory ID.

◆ invalidate_trajectory_id()

void snemo::datamodel::tracker_trajectory::invalidate_trajectory_id ( )

Invalidate the trajectory ID.

◆ reset()

void snemo::datamodel::tracker_trajectory::reset ( )

Reset the tracker trajectory (see clear)

◆ reset_orphans()

void snemo::datamodel::tracker_trajectory::reset_orphans ( )

Reset the collection of orphan hits.

◆ set_cluster_handle()

void snemo::datamodel::tracker_trajectory::set_cluster_handle ( const handle_cluster cluster_handle_)

Attach a cluster by handle.

◆ set_pattern_handle()

void snemo::datamodel::tracker_trajectory::set_pattern_handle ( const handle_pattern pattern_handle_)

Attach a pattern by handle.

◆ set_trajectory_id()

void snemo::datamodel::tracker_trajectory::set_trajectory_id ( int32_t  )

Set the trajectory ID.

◆ tree_dump()

virtual void snemo::datamodel::tracker_trajectory::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: