Falaise  4.0.1
SuperNEMO Software Toolkit
Public Member Functions | Static Public Attributes | Protected Member Functions | List of all members
TrackerPreClustering::pre_clusterizer Class Reference

A pre-clusterizer of Geiger hits for the SuperNEMO detector. More...

#include <falaise/TrackerPreClustering/pre_clusterizer.h>

Public Member Functions

bool is_locked () const
 Check the lock flag. More...
 
datatools::logger::priority get_logging_priority () const
 Return logging threshold. More...
 
void set_logging_priority (datatools::logger::priority logging_)
 Set logging threshold. More...
 
 pre_clusterizer ()
 Default constructor. More...
 
virtual ~pre_clusterizer ()
 Destrctuor. More...
 
int initialize (const setup_data &setup_)
 Configure and initialize the algorithm. More...
 
void reset ()
 Reset. More...
 
template<typename Hit >
int process (const input_data< Hit > &input_, output_data< Hit > &output_)
 
double get_cell_size () const
 Return the cell size. More...
 
void set_cell_size (double cell_size_)
 Set the cell size. More...
 
void set_delayed_hit_cluster_time (double)
 Set the delayed hit cluster time. More...
 
double get_delayed_hit_cluster_time () const
 Return the delayed hit cluster time. More...
 
bool is_processing_prompt_hits () const
 Check if prompt hits are processed. More...
 
void set_processing_prompt_hits (bool)
 Set the flag for prompt hits processing. More...
 
bool is_processing_delayed_hits () const
 Check if delayed hits are processed. More...
 
void set_processing_delayed_hits (bool)
 Set the flag for delayed hits processing. More...
 
bool is_split_chamber () const
 Check the flag to split the tracking chamber. More...
 
void set_split_chamber (bool)
 Set the flag to split the tracking chamber. More...
 

Static Public Attributes

static const int OK
 
static const int ERROR
 

Protected Member Functions

void _set_defaults ()
 Set defualt attribute values. More...
 

Detailed Description

A pre-clusterizer of Geiger hits for the SuperNEMO detector.

This algorithm aims to group the Geiger hits in a given SuperNEMO event record using some simple clustering criteria:

The TrackerPreClustering::pre_clusterizer object is configured through a TrackerPreClustering::setup_data object.

The input of the algorithm is implemented through the template TrackerPreClustering::input_data<> class which is basically a collection of Geiger hits.

The output of the algorithm is implemented through the template TrackerPreClustering::output_data<> class which stores collections of prompt and delayed clusters. By default the tracking chamber is considered as splitted in two parts.

Constructor & Destructor Documentation

◆ pre_clusterizer()

TrackerPreClustering::pre_clusterizer::pre_clusterizer ( )

Default constructor.

◆ ~pre_clusterizer()

virtual TrackerPreClustering::pre_clusterizer::~pre_clusterizer ( )
virtual

Destrctuor.

Member Function Documentation

◆ _set_defaults()

void TrackerPreClustering::pre_clusterizer::_set_defaults ( )
protected

Set defualt attribute values.

◆ get_cell_size()

double TrackerPreClustering::pre_clusterizer::get_cell_size ( ) const

Return the cell size.

◆ get_delayed_hit_cluster_time()

double TrackerPreClustering::pre_clusterizer::get_delayed_hit_cluster_time ( ) const

Return the delayed hit cluster time.

◆ get_logging_priority()

datatools::logger::priority TrackerPreClustering::pre_clusterizer::get_logging_priority ( ) const

Return logging threshold.

◆ initialize()

int TrackerPreClustering::pre_clusterizer::initialize ( const setup_data setup_)

Configure and initialize the algorithm.

◆ is_locked()

bool TrackerPreClustering::pre_clusterizer::is_locked ( ) const

Check the lock flag.

◆ is_processing_delayed_hits()

bool TrackerPreClustering::pre_clusterizer::is_processing_delayed_hits ( ) const

Check if delayed hits are processed.

◆ is_processing_prompt_hits()

bool TrackerPreClustering::pre_clusterizer::is_processing_prompt_hits ( ) const

Check if prompt hits are processed.

◆ is_split_chamber()

bool TrackerPreClustering::pre_clusterizer::is_split_chamber ( ) const

Check the flag to split the tracking chamber.

◆ process()

template<typename Hit >
int TrackerPreClustering::pre_clusterizer::process ( const input_data< Hit > &  input_,
output_data< Hit > &  output_ 
)

Process the list of hits A 'Hit' class must be provided with the proper interface (see the TrackerPreClustering::gg_hit mock data model)

◆ reset()

void TrackerPreClustering::pre_clusterizer::reset ( )

Reset.

◆ set_cell_size()

void TrackerPreClustering::pre_clusterizer::set_cell_size ( double  cell_size_)

Set the cell size.

◆ set_delayed_hit_cluster_time()

void TrackerPreClustering::pre_clusterizer::set_delayed_hit_cluster_time ( double  )

Set the delayed hit cluster time.

◆ set_logging_priority()

void TrackerPreClustering::pre_clusterizer::set_logging_priority ( datatools::logger::priority  logging_)

Set logging threshold.

◆ set_processing_delayed_hits()

void TrackerPreClustering::pre_clusterizer::set_processing_delayed_hits ( bool  )

Set the flag for delayed hits processing.

◆ set_processing_prompt_hits()

void TrackerPreClustering::pre_clusterizer::set_processing_prompt_hits ( bool  )

Set the flag for prompt hits processing.

◆ set_split_chamber()

void TrackerPreClustering::pre_clusterizer::set_split_chamber ( bool  )

Set the flag to split the tracking chamber.

Member Data Documentation

◆ ERROR

const int TrackerPreClustering::pre_clusterizer::ERROR
static

◆ OK

const int TrackerPreClustering::pre_clusterizer::OK
static

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