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

A collection of tracker clusters , solution of a trajectory algorithm. More...

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

Inheritance diagram for snemo::datamodel::tracker_trajectory_solution:
datatools::i_serializable datatools::i_tree_dumpable datatools::i_clear

Public Types

typedef tracker_trajectory::handle_type trajectory_handle_type
 Handle on tracker cluster. More...
 
typedef std::vector< trajectory_handle_typetrajectory_col_type
 Collection of handles on tracker clusters. More...
 
typedef datatools::handle< tracker_clustering_solutionhandle_clustering_solution_type
 Handle on tracker cluster solution. More...
 
typedef datatools::handle< tracker_trajectory_solutionhandle_type
 Handle on tracker trajectory solution. More...
 
typedef datatools::handle< tracker_clustercluster_handle_type
 Handle on tracker cluster. More...
 
typedef std::vector< cluster_handle_typecluster_col_type
 Collection of handles on tracker clusters. More...
 
- Public Types inherited from datatools::i_tree_dumpable
enum  ostream_type
 

Public Member Functions

 tracker_trajectory_solution ()
 Default constructor. More...
 
virtual ~tracker_trajectory_solution ()
 Default constructor. More...
 
void reset ()
 Reset the tracker cluster solution. More...
 
bool has_solution_id () const
 Check if there is a valid solution ID. More...
 
int get_solution_id () const
 Get the solution ID. More...
 
void set_solution_id (int32_t)
 Set the solution ID. More...
 
void invalidate_solution_id ()
 Invalidate the solution ID. More...
 
bool has_clustering_solution () const
 Check if there is a valid reference clustering solution. More...
 
void set_clustering_solution (const handle_clustering_solution_type &clustering_solution_)
 Set the reference clustering solution. More...
 
void invalidate_clustering_solution ()
 Reset the reference clustering solution. More...
 
tracker_clustering_solutiongrab_clustering_solution ()
 Return a mutable reference on the reference clustering solution. More...
 
const tracker_clustering_solutionget_clustering_solution () const
 Return a non mutable reference on the reference clustering solution. More...
 
datatools::propertiesgrab_auxiliaries ()
 Return a mutable reference on the container of auxiliary properties. More...
 
const datatools::propertiesget_auxiliaries () const
 Return a non mutable reference on the container of auxiliary properties. More...
 
bool has_trajectories () const
 Check if there is trajectories. More...
 
trajectory_col_typegrab_trajectories ()
 Return a mutable reference on the container of trajectories. More...
 
const trajectory_col_typeget_trajectories () const
 Return a non mutable reference on the container of trajectories. More...
 
void invalidate_trajectories ()
 Reset the trajectories. More...
 
bool has_unfitted_clusters () const
 Check if there is unfitted clusters. More...
 
cluster_col_typegrab_unfitted_clusters ()
 Return a mutable reference on the container of handles on unfitted clusters. More...
 
const cluster_col_typeget_unfitted_clusters () const
 Return a non mutable reference on the container of handles on unfitted clusters. More...
 
void invalidate_unfitted_clusters ()
 Reset the unfitted clusters. More...
 
virtual void clear ()
 Empty the contents of the tracker trajectories solution. 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 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 ()
 
virtual void print_tree (std::ostream &out_=std::clog, const boost::property_tree::ptree &options_=empty_options()) const
 
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 datatools::i_tree_dumpable
 OSTREAM_COUT
 
 OSTREAM_CERR
 
 OSTREAM_CLOG
 

Detailed Description

A collection of tracker clusters , solution of a trajectory algorithm.

Member Typedef Documentation

◆ cluster_col_type

Collection of handles on tracker clusters.

◆ cluster_handle_type

Handle on tracker cluster.

◆ handle_clustering_solution_type

Handle on tracker cluster solution.

◆ handle_type

Handle on tracker trajectory solution.

◆ trajectory_col_type

Collection of handles on tracker clusters.

◆ trajectory_handle_type

Handle on tracker cluster.

Constructor & Destructor Documentation

◆ tracker_trajectory_solution()

snemo::datamodel::tracker_trajectory_solution::tracker_trajectory_solution ( )

Default constructor.

◆ ~tracker_trajectory_solution()

virtual snemo::datamodel::tracker_trajectory_solution::~tracker_trajectory_solution ( )
virtual

Default constructor.

Member Function Documentation

◆ clear()

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

Empty the contents of the tracker trajectories solution.

Implements datatools::i_clear.

◆ get_auxiliaries()

const datatools::properties& snemo::datamodel::tracker_trajectory_solution::get_auxiliaries ( ) const

Return a non mutable reference on the container of auxiliary properties.

◆ get_clustering_solution()

const tracker_clustering_solution& snemo::datamodel::tracker_trajectory_solution::get_clustering_solution ( ) const

Return a non mutable reference on the reference clustering solution.

◆ get_solution_id()

int snemo::datamodel::tracker_trajectory_solution::get_solution_id ( ) const

Get the solution ID.

◆ get_trajectories()

const trajectory_col_type& snemo::datamodel::tracker_trajectory_solution::get_trajectories ( ) const

Return a non mutable reference on the container of trajectories.

◆ get_unfitted_clusters()

const cluster_col_type& snemo::datamodel::tracker_trajectory_solution::get_unfitted_clusters ( ) const

Return a non mutable reference on the container of handles on unfitted clusters.

◆ grab_auxiliaries()

datatools::properties& snemo::datamodel::tracker_trajectory_solution::grab_auxiliaries ( )

Return a mutable reference on the container of auxiliary properties.

◆ grab_clustering_solution()

tracker_clustering_solution& snemo::datamodel::tracker_trajectory_solution::grab_clustering_solution ( )

Return a mutable reference on the reference clustering solution.

◆ grab_trajectories()

trajectory_col_type& snemo::datamodel::tracker_trajectory_solution::grab_trajectories ( )

Return a mutable reference on the container of trajectories.

◆ grab_unfitted_clusters()

cluster_col_type& snemo::datamodel::tracker_trajectory_solution::grab_unfitted_clusters ( )

Return a mutable reference on the container of handles on unfitted clusters.

◆ has_clustering_solution()

bool snemo::datamodel::tracker_trajectory_solution::has_clustering_solution ( ) const

Check if there is a valid reference clustering solution.

◆ has_solution_id()

bool snemo::datamodel::tracker_trajectory_solution::has_solution_id ( ) const

Check if there is a valid solution ID.

◆ has_trajectories()

bool snemo::datamodel::tracker_trajectory_solution::has_trajectories ( ) const

Check if there is trajectories.

◆ has_unfitted_clusters()

bool snemo::datamodel::tracker_trajectory_solution::has_unfitted_clusters ( ) const

Check if there is unfitted clusters.

◆ invalidate_clustering_solution()

void snemo::datamodel::tracker_trajectory_solution::invalidate_clustering_solution ( )

Reset the reference clustering solution.

◆ invalidate_solution_id()

void snemo::datamodel::tracker_trajectory_solution::invalidate_solution_id ( )

Invalidate the solution ID.

◆ invalidate_trajectories()

void snemo::datamodel::tracker_trajectory_solution::invalidate_trajectories ( )

Reset the trajectories.

◆ invalidate_unfitted_clusters()

void snemo::datamodel::tracker_trajectory_solution::invalidate_unfitted_clusters ( )

Reset the unfitted clusters.

◆ reset()

void snemo::datamodel::tracker_trajectory_solution::reset ( )

Reset the tracker cluster solution.

◆ set_clustering_solution()

void snemo::datamodel::tracker_trajectory_solution::set_clustering_solution ( const handle_clustering_solution_type clustering_solution_)

Set the reference clustering solution.

◆ set_solution_id()

void snemo::datamodel::tracker_trajectory_solution::set_solution_id ( int32_t  )

Set the solution ID.

◆ tree_dump()

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


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