Project
Loading...
Searching...
No Matches
o2::emcal::Clusterizer< InputType > Class Template Reference

Meta class for recursive clusterizer. More...

#include <Clusterizer.h>

Public Member Functions

 Clusterizer (double timeCut, double timeMin, double timeMax, double gradientCut, bool doEnergyGradientCut, double thresholdSeedE, double thresholdCellE)
 Main constructor.
 
 Clusterizer ()
 Default constructor.
 
 ~Clusterizer ()=default
 Destructor.
 
void clear ()
 Clear internal buffers of found clusters and cell indices.
 
void initialize (double timeCut, double timeMin, double timeMax, double gradientCut, bool doEnergyGradientCut, double thresholdSeedE, double thresholdCellE)
 Initialize class member vars if not done in constructor.
 
void findClusters (const gsl::span< InputType const > &inputArray)
 Find clusters based on a give input collection.
 
const std::vector< Cluster > * getFoundClusters () const
 Get list of found clusters.
 
const std::vector< ClusterIndex > * getFoundClustersInputIndices () const
 Get list of found cell indices.
 
void setGeometry (Geometry *geometry)
 Set EMCAL geometry.
 
GeometrygetGeometry ()
 Get pointer to geometry.
 

Detailed Description

template<class InputType>
class o2::emcal::Clusterizer< InputType >

Meta class for recursive clusterizer.

Author
Rudiger Haake (Yale)

Implementation of same algorithm version as in AliEMCALClusterizerv2, but optimized.

Definition at line 46 of file Clusterizer.h.

Constructor & Destructor Documentation

◆ Clusterizer() [1/2]

template<class InputType >
Clusterizer::Clusterizer ( double  timeCut,
double  timeMin,
double  timeMax,
double  gradientCut,
bool  doEnergyGradientCut,
double  thresholdSeedE,
double  thresholdCellE 
)

Main constructor.

Parameters
timeCutMax. time difference of cells in cluster in ns
timeMinMin. accepted cell time in ns
timeMaxMax. accepted cell time in ns
gradientCutMin. gradient value allowed in cluster splitting
doEnergyGradientCutApply gradient cut
thresholdSeedEMin. energy of seed cells in GeV
thresholdCellEMin. energy of associated cells in GeV

Definition at line 23 of file Clusterizer.cxx.

◆ Clusterizer() [2/2]

template<class InputType >
Clusterizer::Clusterizer ( )

Default constructor.

Definition at line 29 of file Clusterizer.cxx.

◆ ~Clusterizer()

template<class InputType >
o2::emcal::Clusterizer< InputType >::~Clusterizer ( )
default

Destructor.

Member Function Documentation

◆ clear()

template<class InputType >
void o2::emcal::Clusterizer< InputType >::clear ( )
inline

Clear internal buffers of found clusters and cell indices.

Definition at line 102 of file Clusterizer.h.

◆ findClusters()

template<class InputType >
void Clusterizer::findClusters ( const gsl::span< InputType const > &  inputArray)

Find clusters based on a give input collection.

Start clustering from highest energy cell.

Parameters
inputArrayInput collection of cells/digits

Definition at line 114 of file Clusterizer.cxx.

◆ getFoundClusters()

template<class InputType >
const std::vector< Cluster > * o2::emcal::Clusterizer< InputType >::getFoundClusters ( ) const
inline

Get list of found clusters.

Returns
List of found clusters

Definition at line 127 of file Clusterizer.h.

◆ getFoundClustersInputIndices()

template<class InputType >
const std::vector< ClusterIndex > * o2::emcal::Clusterizer< InputType >::getFoundClustersInputIndices ( ) const
inline

Get list of found cell indices.

Returns
List of found cell indices

Definition at line 131 of file Clusterizer.h.

◆ getGeometry()

template<class InputType >
Geometry * o2::emcal::Clusterizer< InputType >::getGeometry ( )
inline

Get pointer to geometry.

Returns
EMCAL geometry

Definition at line 139 of file Clusterizer.h.

◆ initialize()

template<class InputType >
void Clusterizer::initialize ( double  timeCut,
double  timeMin,
double  timeMax,
double  gradientCut,
bool  doEnergyGradientCut,
double  thresholdSeedE,
double  thresholdCellE 
)

Initialize class member vars if not done in constructor.

Parameters
timeCutMax. time difference of cells in cluster in ns
timeMinMin. accepted cell time in ns
timeMaxMax. accepted cell time in ns
gradientCutMin. gradient value allowed in cluster splitting
doEnergyGradientCutApply gradient cut
thresholdSeedEMin. energy of seed cells in GeV
thresholdCellEMin. energy of associated cells in GeV

Definition at line 35 of file Clusterizer.cxx.

◆ setGeometry()

template<class InputType >
void o2::emcal::Clusterizer< InputType >::setGeometry ( Geometry geometry)
inline

Set EMCAL geometry.

Parameters
geometryGeometry pointer

Definition at line 135 of file Clusterizer.h.


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