Falaise  4.0.1
SuperNEMO Software Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
snemo::processing::base_gamma_builder Class Referenceabstract

The base class for all gamma builder algorithms. More...

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

Public Types

typedef snemo::datamodel::calibrated_data::calorimeter_hit_collection_type hit_collection_type
 Typedef to calibrated calorimeter hits. More...
 

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 gamma builder ID. More...
 
const snemo::geometry::calo_locatorget_calo_locator () const
 Return the main wall calorimeter locator. More...
 
const snemo::geometry::xcalo_locatorget_xcalo_locator () const
 Return the X-wall calorimeter locator. More...
 
const snemo::geometry::gveto_locatorget_gveto_locator () const
 Return the gamma veto calorimeter 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::managerget_geometry_manager () const
 Return a non-mutable reference to the geometry manager. More...
 
bool is_initialized () const
 Check if theclusterizer is initialized. More...
 
 base_gamma_builder (const std::string &id_="anonymous")
 Default constructor. More...
 
virtual ~base_gamma_builder ()
 Destructor. More...
 
int process (const base_gamma_builder::hit_collection_type &calo_hits_, snemo::datamodel::particle_track_data &ptd_)
 Main tracker trajectory driver. More...
 
virtual void initialize (const datatools::properties &setup_)=0
 Initialize the tracker trajectory fitter through configuration properties. More...
 
virtual void reset ()=0
 Reset the tracker trajectory fitter. More...
 
void tree_dump (std::ostream &out_=std::clog, const std::string &title_="", const std::string &indent_="", bool inherit_=false) const
 Smart print. 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 _set_initialized (bool)
 Set the initialization flag. More...
 
void _clear_working_arrays ()
 Clear working arrays. More...
 
virtual int _prepare_process (const base_gamma_builder::hit_collection_type &calo_hits_, snemo::datamodel::particle_track_data &ptd_)
 Prepare data for processing. More...
 
virtual int _process_algo (const base_gamma_builder::hit_collection_type &calo_hits_, snemo::datamodel::particle_track_data &ptd_)=0
 Specific algorithm. More...
 
virtual int _post_process (const base_gamma_builder::hit_collection_type &calo_hits_, snemo::datamodel::particle_track_data &ptd_)
 Post processing. More...
 

Protected Attributes

datatools::logger::priority _logging_priority
 Logging priority threshold. More...
 

Detailed Description

The base class for all gamma builder algorithms.

Member Typedef Documentation

◆ hit_collection_type

Typedef to calibrated calorimeter hits.

Constructor & Destructor Documentation

◆ base_gamma_builder()

snemo::processing::base_gamma_builder::base_gamma_builder ( const std::string &  id_ = "anonymous")

Default constructor.

◆ ~base_gamma_builder()

virtual snemo::processing::base_gamma_builder::~base_gamma_builder ( )
virtual

Destructor.

Member Function Documentation

◆ _clear_working_arrays()

void snemo::processing::base_gamma_builder::_clear_working_arrays ( )
protected

Clear working arrays.

◆ _initialize()

void snemo::processing::base_gamma_builder::_initialize ( const datatools::properties setup_)
protected

Initialize the clusterizer through configuration properties.

◆ _post_process()

virtual int snemo::processing::base_gamma_builder::_post_process ( const base_gamma_builder::hit_collection_type calo_hits_,
snemo::datamodel::particle_track_data ptd_ 
)
protectedvirtual

Post processing.

◆ _prepare_process()

virtual int snemo::processing::base_gamma_builder::_prepare_process ( const base_gamma_builder::hit_collection_type calo_hits_,
snemo::datamodel::particle_track_data ptd_ 
)
protectedvirtual

Prepare data for processing.

◆ _process_algo()

virtual int snemo::processing::base_gamma_builder::_process_algo ( const base_gamma_builder::hit_collection_type calo_hits_,
snemo::datamodel::particle_track_data ptd_ 
)
protectedpure virtual

Specific algorithm.

◆ _reset()

void snemo::processing::base_gamma_builder::_reset ( )
protected

Reset the clusterizer.

◆ _set_defaults()

void snemo::processing::base_gamma_builder::_set_defaults ( )
protected

Set default attribute values.

◆ _set_initialized()

void snemo::processing::base_gamma_builder::_set_initialized ( bool  )
protected

Set the initialization flag.

◆ get_calo_locator()

const snemo::geometry::calo_locator& snemo::processing::base_gamma_builder::get_calo_locator ( ) const

Return the main wall calorimeter locator.

◆ get_geometry_manager()

const geomtools::manager& snemo::processing::base_gamma_builder::get_geometry_manager ( ) const

Return a non-mutable reference to the geometry manager.

◆ get_gveto_locator()

const snemo::geometry::gveto_locator& snemo::processing::base_gamma_builder::get_gveto_locator ( ) const

Return the gamma veto calorimeter locator.

◆ get_id()

const std::string& snemo::processing::base_gamma_builder::get_id ( ) const

Return the gamma builder ID.

◆ get_logging_priority()

datatools::logger::priority snemo::processing::base_gamma_builder::get_logging_priority ( ) const

Get logging priority.

◆ get_xcalo_locator()

const snemo::geometry::xcalo_locator& snemo::processing::base_gamma_builder::get_xcalo_locator ( ) const

Return the X-wall calorimeter locator.

◆ has_geometry_manager()

bool snemo::processing::base_gamma_builder::has_geometry_manager ( ) const

Check the geometry manager.

◆ initialize()

virtual void snemo::processing::base_gamma_builder::initialize ( const datatools::properties setup_)
pure virtual

Initialize the tracker trajectory fitter through configuration properties.

◆ is_initialized()

bool snemo::processing::base_gamma_builder::is_initialized ( ) const

Check if theclusterizer is initialized.

◆ ocd_support()

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

OCD support.

◆ process()

int snemo::processing::base_gamma_builder::process ( const base_gamma_builder::hit_collection_type calo_hits_,
snemo::datamodel::particle_track_data ptd_ 
)

Main tracker trajectory driver.

◆ reset()

virtual void snemo::processing::base_gamma_builder::reset ( )
pure virtual

Reset the tracker trajectory fitter.

◆ set_geometry_manager()

void snemo::processing::base_gamma_builder::set_geometry_manager ( const geomtools::manager gmgr_)

Address the geometry manager.

◆ set_logging_priority()

void snemo::processing::base_gamma_builder::set_logging_priority ( datatools::logger::priority  logging_priority_)

Set logging priority level.

◆ tree_dump()

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

Smart print.

Member Data Documentation

◆ _logging_priority

datatools::logger::priority snemo::processing::base_gamma_builder::_logging_priority
protected

Logging priority threshold.


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