SuperNEMO tracker clustering data model. More...

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

Inheritance diagram for snemo::datamodel::tracker_clustering_data:

Public Types
typedef std::vector< tracker_clustering_solution::handle_type >	solution_col_type
	Collection of handles on tracker clustering solutions. More...

Public Types inherited from datatools::i_tree_dumpable
enum	ostream_type

Public Member Functions
	tracker_clustering_data ()
	Default constructor. More...

virtual	~tracker_clustering_data ()
	Destructor: More...

bool	has_solutions () const
	Check if there are some clustering solutions. More...

size_t	get_number_of_solutions () const
	Returns the number of solutions. More...

void	add_solution (const tracker_clustering_solution::handle_type &handle_, bool default_solution_=false)
	Add a clustering solution. More...

const tracker_clustering_solution &	get_solution (int i_) const
	Return a non mutable reference to a clustering solution by index. More...

void	invalidate_solutions ()
	Reset the clustering solutions. More...

bool	has_default_solution () const
	Check if there is some default clustering solution. More...

const tracker_clustering_data::solution_col_type &	get_solutions () const
	Return the non mutable reference to the collection of clustering solutions. More...

tracker_clustering_data::solution_col_type &	grab_solutions ()
	Return the mutable reference to the collection of clustering solutions. More...

const tracker_clustering_solution &	get_default_solution () const
	Return a non mutable reference to the default clustering solution is any. More...

tracker_clustering_solution &	grab_default_solution ()
	Return a mutable reference to the default clustering solution is any. More...

void	invalidate_default_solution ()
	Reset the default clustering solution is any. More...

void	set_default_solution (int index_)
	Set the default clustering solution. More...

void	reset ()
	Reset the internals. More...

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

const datatools::properties &	get_auxiliaries () const
	Return a mutable reference on the container of auxiliary properties. More...

datatools::properties &	grab_auxiliaries ()
	Return a non mutable reference on the container of auxiliary properties. More...

virtual void	clear ()
	Clear the object. 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 ()

Static Public Member Functions
static const std::string &	prompt_key ()
	Key for the boolean property associated to prompt clustering solutions. More...

static const std::string &	delayed_key ()
	Key for the boolean property associated to delayed clustering solutions. More...

static const std::string &	delayed_id_key ()
	Key for the integer property associated to delayed clustering solutions. More...

static const std::string &	clusterizer_id_key ()

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 datatools::i_tree_dumpable
	OSTREAM_COUT

	OSTREAM_CERR

	OSTREAM_CLOG

Detailed Description

SuperNEMO tracker clustering data model.

Member Typedef Documentation

◆ solution_col_type

typedef std::vector<tracker_clustering_solution::handle_type> snemo::datamodel::tracker_clustering_data::solution_col_type

Collection of handles on tracker clustering solutions.

Constructor & Destructor Documentation

◆ tracker_clustering_data()

snemo::datamodel::tracker_clustering_data::tracker_clustering_data ( )

Default constructor.

◆ ~tracker_clustering_data()

virtual snemo::datamodel::tracker_clustering_data::~tracker_clustering_data ( )

virtual

Destructor:

Member Function Documentation

◆ add_solution()

void snemo::datamodel::tracker_clustering_data::add_solution	(	const tracker_clustering_solution::handle_type &	handle_,
		bool	default_solution_ = `false`
	)

Add a clustering solution.

◆ clear()

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

virtual

Clear the object.

Implements datatools::i_clear.

◆ clusterizer_id_key()

static const std::string& snemo::datamodel::tracker_clustering_data::clusterizer_id_key ( )

static

Key for the string Id property documenting the clustering algorithm used to build a given clustering solution

◆ delayed_id_key()

static const std::string& snemo::datamodel::tracker_clustering_data::delayed_id_key ( )

static

Key for the integer property associated to delayed clustering solutions.

◆ delayed_key()

static const std::string& snemo::datamodel::tracker_clustering_data::delayed_key ( )

static

Key for the boolean property associated to delayed clustering solutions.

◆ get_auxiliaries()

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

Return a mutable reference on the container of auxiliary properties.

◆ get_default_solution()

const tracker_clustering_solution& snemo::datamodel::tracker_clustering_data::get_default_solution ( ) const

Return a non mutable reference to the default clustering solution is any.

◆ get_number_of_solutions()

size_t snemo::datamodel::tracker_clustering_data::get_number_of_solutions ( ) const

Returns the number of solutions.

◆ get_solution()

const tracker_clustering_solution& snemo::datamodel::tracker_clustering_data::get_solution ( int i_ ) const

Return a non mutable reference to a clustering solution by index.

◆ get_solutions()

const tracker_clustering_data::solution_col_type& snemo::datamodel::tracker_clustering_data::get_solutions ( ) const

Return the non mutable reference to the collection of clustering solutions.

◆ grab_auxiliaries()

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

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

◆ grab_default_solution()

tracker_clustering_solution& snemo::datamodel::tracker_clustering_data::grab_default_solution ( )

Return a mutable reference to the default clustering solution is any.

◆ grab_solutions()

tracker_clustering_data::solution_col_type& snemo::datamodel::tracker_clustering_data::grab_solutions ( )

Return the mutable reference to the collection of clustering solutions.

◆ has_default_solution()

bool snemo::datamodel::tracker_clustering_data::has_default_solution ( ) const

Check if there is some default clustering solution.

◆ has_solutions()

bool snemo::datamodel::tracker_clustering_data::has_solutions ( ) const

Check if there are some clustering solutions.

◆ invalidate_default_solution()

void snemo::datamodel::tracker_clustering_data::invalidate_default_solution ( )

Reset the default clustering solution is any.

◆ invalidate_solutions()

void snemo::datamodel::tracker_clustering_data::invalidate_solutions ( )

Reset the clustering solutions.

◆ is_valid()

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

Check if the object has a valid internal structure.

◆ prompt_key()

static const std::string& snemo::datamodel::tracker_clustering_data::prompt_key ( )

static

Key for the boolean property associated to prompt clustering solutions.

◆ reset()

void snemo::datamodel::tracker_clustering_data::reset ( )

Reset the internals.

◆ set_default_solution()

void snemo::datamodel::tracker_clustering_data::set_default_solution ( int index_ )

Set the default clustering solution.

◆ tree_dump()

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

falaise/snemo/datamodels/tracker_clustering_data.h

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ solution_col_type

Constructor & Destructor Documentation

◆ tracker_clustering_data()

◆ ~tracker_clustering_data()

Member Function Documentation

◆ add_solution()

◆ clear()

◆ clusterizer_id_key()

◆ delayed_id_key()

◆ delayed_key()

◆ get_auxiliaries()

◆ get_default_solution()

◆ get_number_of_solutions()

◆ get_solution()

◆ get_solutions()

◆ grab_auxiliaries()

◆ grab_default_solution()

◆ grab_solutions()

◆ has_default_solution()

◆ has_solutions()

◆ invalidate_default_solution()

◆ invalidate_solutions()

◆ is_valid()

◆ prompt_key()

◆ reset()

◆ set_default_solution()

◆ tree_dump()