snemo::processing::base_tracker_clusterizer Class Reference

The base abstract class for all tracker clustering algorithms. More...

#include <falaise/snemo/processing/base_tracker_clusterizer.h>

Public Types
typedef snemo::datamodel::calibrated_tracker_hit	hit_type
typedef snemo::datamodel::calibrated_tracker_hit::handle_type	hit_handle_type
typedef snemo::datamodel::calibrated_data::tracker_hit_collection_type	hit_collection_type
typedef snemo::datamodel::calibrated_data::calorimeter_hit_collection_type	calo_hit_collection_type

Public Member Functions
void	set_logging_priority (datatools::logger::priority logging_priority_)
	Set logging priority level. More...
datatools::logger::priority	get_logging_priority () const
	Get logging priority. More...
const std::string &	get_id () const
	Return the clusterizer ID. More...
const snemo::geometry::gg_locator &	get_gg_locator () const
	Return the tracker locator. More...
bool	has_geometry_manager () const
	Check the geometry manager. More...
void	set_geometry_manager (const geomtools::manager &gmgr_)
	Address the geometry manager. More...
const geomtools::manager &	get_geometry_manager () const
	Return a non-mutable reference to the geometry manager. More...
bool	is_initialized () const
	Check if theclusterizer is initialized. More...
	base_tracker_clusterizer (const std::string &id_="anonymous")
	Default constructor. More...
virtual	~base_tracker_clusterizer ()
	Destructor. More...
int	process (const base_tracker_clusterizer::hit_collection_type &gg_hits_, const base_tracker_clusterizer::calo_hit_collection_type &calo_hits_, snemo::datamodel::tracker_clustering_data &clustering_)
	Main clustering process. More...
void	tree_dump (std::ostream &out_=std::clog, const std::string &title_="", const std::string &indent_="", bool inherit_=false) const
virtual void	initialize (const datatools::properties &setup_)=0
	Initialize the clusterizer through configuration properties. More...
virtual void	reset ()=0
	Reset the clusterizer. More...

Static Public Member Functions
static void	ocd_support (datatools::object_configuration_description &, const std::string &prefix_="")
	OCD support. More...

Protected Member Functions
void	_initialize (const datatools::properties &setup_)
	Initialize the clusterizer through configuration properties. More...
void	_reset ()
	Reset the clusterizer. More...
void	_set_defaults ()
	Set default attribute values. More...
void	_clear_working_arrays ()
	Clear working arrays. More...
void	_set_initialized (bool)
	Set the initialization flag. More...
virtual int	_prepare_process (const base_tracker_clusterizer::hit_collection_type &gg_hits_, const base_tracker_clusterizer::calo_hit_collection_type &calo_hits_, snemo::datamodel::tracker_clustering_data &clustering_)
	Prepare cluster for processing. More...
virtual int	_process_algo (const base_tracker_clusterizer::hit_collection_type &gg_hits_, const base_tracker_clusterizer::calo_hit_collection_type &calo_hits_, snemo::datamodel::tracker_clustering_data &clustering_)=0
	Specific clustering algorithm. More...
virtual int	_post_process (const base_tracker_clusterizer::hit_collection_type &gg_hits_, const base_tracker_clusterizer::calo_hit_collection_type &calo_hits_, snemo::datamodel::tracker_clustering_data &clustering_)
	Post processing. More...
void	_post_process_collect_unclustered_hits (const base_tracker_clusterizer::hit_collection_type &gg_hits_, snemo::datamodel::tracker_clustering_data &clustering_)
	Post processing to collect unclustered hits. More...

Protected Attributes
datatools::logger::priority	_logging_priority

Detailed Description

The base abstract class for all tracker clustering algorithms.

Member Typedef Documentation

calo_hit_collection_type

typedef snemo::datamodel::calibrated_data::calorimeter_hit_collection_type snemo::processing::base_tracker_clusterizer::calo_hit_collection_type

hit_collection_type

typedef snemo::datamodel::calibrated_data::tracker_hit_collection_type snemo::processing::base_tracker_clusterizer::hit_collection_type

hit_handle_type

typedef snemo::datamodel::calibrated_tracker_hit::handle_type snemo::processing::base_tracker_clusterizer::hit_handle_type

hit_type

typedef snemo::datamodel::calibrated_tracker_hit snemo::processing::base_tracker_clusterizer::hit_type

Constructor & Destructor Documentation

base_tracker_clusterizer()

snemo::processing::base_tracker_clusterizer::base_tracker_clusterizer

(

const std::string &

id_ = "anonymous"

)

Default constructor.

~base_tracker_clusterizer()

virtual snemo::processing::base_tracker_clusterizer::~base_tracker_clusterizer ( )

virtual

Destructor.

Member Function Documentation

_clear_working_arrays()

void snemo::processing::base_tracker_clusterizer::_clear_working_arrays ( )

protected

Clear working arrays.

_initialize()

void snemo::processing::base_tracker_clusterizer::_initialize ( const datatools::properties &  setup_ )

protected

Initialize the clusterizer through configuration properties.

_post_process()

virtual int snemo::processing::base_tracker_clusterizer::_post_process ( const base_tracker_clusterizer::hit_collection_type &  gg_hits_, const base_tracker_clusterizer::calo_hit_collection_type &  calo_hits_, snemo::datamodel::tracker_clustering_data &  clustering_  )

protectedvirtual

Post processing.

_post_process_collect_unclustered_hits()

void snemo::processing::base_tracker_clusterizer::_post_process_collect_unclustered_hits ( const base_tracker_clusterizer::hit_collection_type &  gg_hits_, snemo::datamodel::tracker_clustering_data &  clustering_  )

protected

Post processing to collect unclustered hits.

_prepare_process()

virtual int snemo::processing::base_tracker_clusterizer::_prepare_process ( const base_tracker_clusterizer::hit_collection_type &  gg_hits_, const base_tracker_clusterizer::calo_hit_collection_type &  calo_hits_, snemo::datamodel::tracker_clustering_data &  clustering_  )

protectedvirtual

Prepare cluster for processing.

_process_algo()

virtual int snemo::processing::base_tracker_clusterizer::_process_algo ( const base_tracker_clusterizer::hit_collection_type &  gg_hits_, const base_tracker_clusterizer::calo_hit_collection_type &  calo_hits_, snemo::datamodel::tracker_clustering_data &  clustering_  )

protectedpure virtual

Specific clustering algorithm.

_reset()

void snemo::processing::base_tracker_clusterizer::_reset ( )

protected

Reset the clusterizer.

_set_defaults()

void snemo::processing::base_tracker_clusterizer::_set_defaults ( )

protected

Set default attribute values.

_set_initialized()

void snemo::processing::base_tracker_clusterizer::_set_initialized ( bool  )

protected

Set the initialization flag.

get_geometry_manager()

const geomtools::manager& snemo::processing::base_tracker_clusterizer::get_geometry_manager

(

)

const

Return a non-mutable reference to the geometry manager.

get_gg_locator()

const snemo::geometry::gg_locator& snemo::processing::base_tracker_clusterizer::get_gg_locator

(

)

const

Return the tracker locator.

get_id()

const std::string& snemo::processing::base_tracker_clusterizer::get_id

(

)

const

Return the clusterizer ID.

get_logging_priority()

datatools::logger::priority snemo::processing::base_tracker_clusterizer::get_logging_priority

(

)

const

Get logging priority.

has_geometry_manager()

bool snemo::processing::base_tracker_clusterizer::has_geometry_manager

(

)

const

Check the geometry manager.

initialize()

virtual void snemo::processing::base_tracker_clusterizer::initialize ( const datatools::properties &  setup_ )

pure virtual

Initialize the clusterizer through configuration properties.

is_initialized()

bool snemo::processing::base_tracker_clusterizer::is_initialized

(

)

const

Check if theclusterizer is initialized.

ocd_support()

static void snemo::processing::base_tracker_clusterizer::ocd_support ( datatools::object_configuration_description &  , const std::string &  prefix_ = ""  )

static

OCD support.

process()

int snemo::processing::base_tracker_clusterizer::process	(	const base_tracker_clusterizer::hit_collection_type &	gg_hits_,
		const base_tracker_clusterizer::calo_hit_collection_type &	calo_hits_,
		snemo::datamodel::tracker_clustering_data &	clustering_
	)

Main clustering process.

reset()

virtual void snemo::processing::base_tracker_clusterizer::reset ( )

pure virtual

Reset the clusterizer.

set_geometry_manager()

void snemo::processing::base_tracker_clusterizer::set_geometry_manager

(

const geomtools::manager &

gmgr_

)

Address the geometry manager.

set_logging_priority()

void snemo::processing::base_tracker_clusterizer::set_logging_priority

(

datatools::logger::priority

logging_priority_

)

Set logging priority level.

tree_dump()

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

Member Data Documentation

_logging_priority

datatools::logger::priority snemo::processing::base_tracker_clusterizer::_logging_priority

protected

---

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

• falaise/snemo/processing/base_tracker_clusterizer.h