ECLClusteringParameters Class Reference

DB object to parameters that store clustering behaviour in ECLCRFinder and ECLLocalMaximumFinder. More...

#include <ECLClusteringParameters.h>

Inheritance diagram for ECLClusteringParameters:

Public Member Functions
	ECLClusteringParameters ()
	Constructor.
double	getLMEnergyCut () const
	Get the energy threshold for seeds in ECLLocalMaximumFinder [MeV].
const std::array< double, 3 > &	getCRFEnergyCut () const
	Get the three energy thresholds for ECLCRFinder [MeV].
const std::array< double, 3 > &	getCRFTimeCut () const
	Get the three time cuts for ECLCRFinder [ns].
const std::array< double, 3 > &	getCRFTimeCutMaxEnergy () const
	Get the three max energies for time cuts for ECLCRFinder [MeV].
void	setLMEnergyCut (const double LM_energy_cut)
	Set the energy threshold in ECLLocalMaximumFinder [MeV].
void	setCRFEnergyCut (const std::array< double, 3 > &CRF_energy_cut)
	Set the three energy thresholds in ECLCRFinder [MeV].
void	setCRFTimeCut (const std::array< double, 3 > &CRF_time_cut)
	Set the three time cuts in ECLCRFinder [ns].
void	setCRFTimeCutMaxEnergy (const std::array< double, 3 > &CRF_timeCutMaxEnergy)
	Set the three time cuts in ECLCRFinder [ns].

Private Member Functions
	ClassDef (ECLClusteringParameters, 1)
	ClassDef.

Private Attributes
double	m_LM_energyCut
	energy cut for ECLLocalMaximumFinder seed [MeV]
std::array< double, 3 >	m_CRF_energyCut
	energy cuts for ECLCRFinder [MeV]
std::array< double, 3 >	m_CRF_timeCut
	time cuts for ECLCRFinder [ns]
std::array< double, 3 >	m_CRF_timeCutMaxEnergy
	time cuts are only applied below these energies [MeV]

Detailed Description

DB object to parameters that store clustering behaviour in ECLCRFinder and ECLLocalMaximumFinder.

Definition at line 21 of file ECLClusteringParameters.h.

Constructor & Destructor Documentation

ECLClusteringParameters()

ECLClusteringParameters ( )

inline

Constructor.

Definition at line 28 of file ECLClusteringParameters.h.

                              :
      m_LM_energyCut(),
      m_CRF_energyCut(),
      m_CRF_timeCut(),
      m_CRF_timeCutMaxEnergy()
    { };

Member Function Documentation

getCRFEnergyCut()

const std::array< double, 3 > & getCRFEnergyCut ( ) const

inline

Get the three energy thresholds for ECLCRFinder [MeV].

Definition at line 43 of file ECLClusteringParameters.h.

{return m_CRF_energyCut;}

getCRFTimeCut()

const std::array< double, 3 > & getCRFTimeCut ( ) const

inline

Get the three time cuts for ECLCRFinder [ns].

Definition at line 46 of file ECLClusteringParameters.h.

{return m_CRF_timeCut;}

getCRFTimeCutMaxEnergy()

const std::array< double, 3 > & getCRFTimeCutMaxEnergy ( ) const

inline

Get the three max energies for time cuts for ECLCRFinder [MeV].

Definition at line 49 of file ECLClusteringParameters.h.

{return m_CRF_timeCutMaxEnergy;}

getLMEnergyCut()

double getLMEnergyCut ( ) const

inline

Get the energy threshold for seeds in ECLLocalMaximumFinder [MeV].

Definition at line 40 of file ECLClusteringParameters.h.

{return m_LM_energyCut;}

setCRFEnergyCut()

void setCRFEnergyCut ( const std::array< double, 3 > & CRF_energy_cut )

inline

Set the three energy thresholds in ECLCRFinder [MeV].

Definition at line 59 of file ECLClusteringParameters.h.

{m_CRF_energyCut = CRF_energy_cut;}

setCRFTimeCut()

void setCRFTimeCut ( const std::array< double, 3 > & CRF_time_cut )

inline

Set the three time cuts in ECLCRFinder [ns].

Definition at line 62 of file ECLClusteringParameters.h.

{m_CRF_timeCut = CRF_time_cut;}

setCRFTimeCutMaxEnergy()

void setCRFTimeCutMaxEnergy ( const std::array< double, 3 > & CRF_timeCutMaxEnergy )

inline

Set the three time cuts in ECLCRFinder [ns].

Definition at line 65 of file ECLClusteringParameters.h.

{m_CRF_timeCutMaxEnergy = CRF_timeCutMaxEnergy;}

setLMEnergyCut()

void setLMEnergyCut ( const double LM_energy_cut )

inline

Set the energy threshold in ECLLocalMaximumFinder [MeV].

Definition at line 56 of file ECLClusteringParameters.h.

{m_LM_energyCut = LM_energy_cut;}

Member Data Documentation

m_CRF_energyCut

std::array<double, 3> m_CRF_energyCut

private

energy cuts for ECLCRFinder [MeV]

Definition at line 71 of file ECLClusteringParameters.h.

m_CRF_timeCut

std::array<double, 3> m_CRF_timeCut

private

time cuts for ECLCRFinder [ns]

Definition at line 72 of file ECLClusteringParameters.h.

m_CRF_timeCutMaxEnergy

std::array<double, 3> m_CRF_timeCutMaxEnergy

private

time cuts are only applied below these energies [MeV]

Definition at line 73 of file ECLClusteringParameters.h.

m_LM_energyCut

double m_LM_energyCut

private

energy cut for ECLLocalMaximumFinder seed [MeV]

Definition at line 70 of file ECLClusteringParameters.h.

---

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

• ecl/dbobjects/include/ECLClusteringParameters.h