Getters

Functions
virtual RawClusterDefs::keytype	RawCluster::get_id () const
	cluster ID
virtual float	RawCluster::get_energy () const
	total energy
virtual size_t	RawCluster::getNTowers () const
	Tower operations.
virtual TowerConstRange	RawCluster::get_towers () const
virtual const TowerMap &	RawCluster::get_towermap () const
	return tower map for c++11 range-based for-loop
virtual CLHEP::Hep3Vector	RawCluster::get_position () const
virtual float	RawCluster::get_phi () const
	access to intrinsic cylindrical coordinate system
virtual float	RawCluster::get_r () const
virtual float	RawCluster::get_z () const
virtual float	RawCluster::get_x () const
	access Cartesian coordinate system
virtual float	RawCluster::get_y () const
virtual float	RawCluster::get_ecore () const
virtual float	RawCluster::get_chi2 () const
	reduced chi2 for EM shower
virtual float	RawCluster::get_prob () const
	cluster template probability for EM shower
virtual float	RawCluster::get_et_iso () const
	isolation ET default
virtual float	RawCluster::get_et_iso (const int, bool, bool) const
	isolation ET the radius and hueristic can be specified
RawClusterDefs::keytype	RawClusterv1::get_id () const override
	cluster ID
float	RawClusterv1::get_energy () const override
	total energy
size_t	RawClusterv1::getNTowers () const override
	Tower operations.
RawCluster::TowerConstRange	RawClusterv1::get_towers () const override
const TowerMap &	RawClusterv1::get_towermap () const override
	return tower map for c++11 range-based for-loop
CLHEP::Hep3Vector	RawClusterv1::get_position () const override
	cluster position in 3D
float	RawClusterv1::get_phi () const override
	access to intrinsic cylindrical coordinate system
float	RawClusterv1::get_r () const override
float	RawClusterv1::get_z () const override
float	RawClusterv1::get_x () const override
	access Cartesian coordinate system
float	RawClusterv1::get_y () const override
float	RawClusterv1::get_ecore () const override
float	RawClusterv1::get_chi2 () const override
	reduced chi2 for EM shower
float	RawClusterv1::get_prob () const override
	cluster template probability for EM shower
float	RawClusterv1::get_et_iso () const override
	isolation ET default
float	RawClusterv1::get_et_iso (const int radiusx10, bool subtracted, bool clusterTower) const override
	isolation ET the radius and hueristic can be specified

Detailed Description

is RawCluster::get_eta() ?

get_eta() is retired! eta does not have meaning for cluster unless user choose a vertex, which is totally up to user in case of multiple collision, and therefore not an intrinsic property of clusterizer. The goal is to force people to calculate it based on r/z and the vertex of choice.There is a utility to help you calculate, a concise example is here to get energy 3-vector: https://www.phenix.bnl.gov/WWW/sPHENIX/doxygen/html/dc/d23/ClusterJetInput_8C_source.html#l00045 Or this one if you only interest in eta: https://www.phenix.bnl.gov/WWW/sPHENIX/doxygen/html/d7/daf/CaloEvaluator_8C_source.html#l00487Older code is commented out here://! convert cluster location to psuedo-rapidity given a user chosen z-location virtual float get_eta() const { PHOOL_VIRTUAL_WARN("get_eta()"); return NAN; } //! convert cluster E_T given a user chosen z-location virtual float get_et() const { PHOOL_VIRTUAL_WARN("get_et()"); return NAN; }

Function Documentation

float RawClusterv1::get_chi2 ( ) const

inlineoverridevirtual

reduced chi2 for EM shower

Reimplemented from RawCluster.

Definition at line 64 of file RawClusterv1.h.

View newest version in sPHENIX GitHub at line 64 of file RawClusterv1.h

References RawClusterv1::get_property_float(), and RawCluster::prop_chi2.

Here is the call graph for this function:

virtual float RawCluster::get_chi2 ( ) const

inlinevirtual

reduced chi2 for EM shower

Reimplemented in RawClusterv1.

Definition at line 148 of file RawCluster.h.

View newest version in sPHENIX GitHub at line 148 of file RawCluster.h

References PHOOL_VIRTUAL_WARN.

float RawClusterv1::get_ecore ( ) const

inlineoverridevirtual

access additional optional properties cluster core energy for EM shower

Reimplemented from RawCluster.

Definition at line 62 of file RawClusterv1.h.

View newest version in sPHENIX GitHub at line 62 of file RawClusterv1.h

References RawClusterv1::get_property_float(), and RawCluster::prop_ecore.

Here is the call graph for this function:

virtual float RawCluster::get_ecore ( ) const

inlinevirtual

access additional optional properties cluster core energy for EM shower

Reimplemented in RawClusterv1.

Definition at line 142 of file RawCluster.h.

View newest version in sPHENIX GitHub at line 142 of file RawCluster.h

References PHOOL_VIRTUAL_WARN.

Referenced by RawClusterUtility::GetECoreVec(), RawClusterUtility::GetETCore(), and RawClusterPositionCorrection::process_event().

Here is the caller graph for this function:

float RawClusterv1::get_energy ( ) const

inlineoverridevirtual

total energy

Reimplemented from RawCluster.

Definition at line 34 of file RawClusterv1.h.

View newest version in sPHENIX GitHub at line 34 of file RawClusterv1.h

References RawClusterv1::_energy.

Referenced by RawClusterv1::identify().

Here is the caller graph for this function:

virtual float RawCluster::get_energy ( ) const

inlinevirtual

total energy

Reimplemented in RawClusterv1.

Definition at line 51 of file RawCluster.h.

View newest version in sPHENIX GitHub at line 51 of file RawCluster.h

References PHOOL_VIRTUAL_WARN.

Referenced by RawClusterBuilderFwd::CorrectPhi(), CaloEvaluator::fillOutputNtuples(), EventEvaluator::fillOutputNtuples(), EventEvaluatorEIC::fillOutputNtuples(), JetRecoEval::get_energy_contribution(), ClusterJetInput::get_input(), RawClusterUtility::GetET(), RawClusterUtility::GetEVec(), CaloEvaluator::printOutputInfo(), RawClusterPositionCorrection::process_event(), CaloCalibEmc_Pi0::process_event(), PHGenFitTrackProjection::process_event(), QAG4SimulationCalorimeter::process_event_Cluster(), and QAG4SimulationCalorimeterSum::process_event_Cluster().

Here is the caller graph for this function:

float RawClusterv1::get_et_iso ( ) const

inlineoverridevirtual

isolation ET default

Reimplemented from RawCluster.

Definition at line 68 of file RawClusterv1.h.

View newest version in sPHENIX GitHub at line 68 of file RawClusterv1.h

References RawClusterv1::get_property_float(), and RawCluster::prop_et_iso_calotower_R03.

Here is the call graph for this function:

float RawClusterv1::get_et_iso ( const int  radiusx10 = 3, bool  subtracted = 0, bool  clusterTower = 1  ) const

overridevirtual

isolation ET the radius and hueristic can be specified

Reimplemented from RawCluster.

Definition at line 250 of file RawClusterv1.cc.

View newest version in sPHENIX GitHub at line 250 of file RawClusterv1.cc

References RawClusterv1::get_property_float(), PHOOL_VIRTUAL_WARN, RawCluster::prop_et_iso_calotower_R01, RawCluster::prop_et_iso_calotower_R02, RawCluster::prop_et_iso_calotower_R03, RawCluster::prop_et_iso_calotower_R04, RawCluster::prop_et_iso_calotower_sub_R01, RawCluster::prop_et_iso_calotower_sub_R02, RawCluster::prop_et_iso_calotower_sub_R03, RawCluster::prop_et_iso_calotower_sub_R04, r, and nlohmann::to_string().

Here is the call graph for this function:

virtual float RawCluster::get_et_iso ( ) const

inlinevirtual

isolation ET default

Reimplemented in RawClusterv1.

Definition at line 160 of file RawCluster.h.

View newest version in sPHENIX GitHub at line 160 of file RawCluster.h

References PHOOL_VIRTUAL_WARN.

virtual float RawCluster::get_et_iso ( const int  , bool  , bool    ) const

inlinevirtual

isolation ET the radius and hueristic can be specified

Reimplemented in RawClusterv1.

Definition at line 166 of file RawCluster.h.

View newest version in sPHENIX GitHub at line 166 of file RawCluster.h

References PHOOL_VIRTUAL_WARN.

RawClusterDefs::keytype RawClusterv1::get_id ( ) const

inlineoverridevirtual

cluster ID

Reimplemented from RawCluster.

Definition at line 32 of file RawClusterv1.h.

View newest version in sPHENIX GitHub at line 32 of file RawClusterv1.h

References RawClusterv1::clusterid.

Referenced by RawClusterv1::identify().

Here is the caller graph for this function:

virtual RawClusterDefs::keytype RawCluster::get_id ( ) const

inlinevirtual

cluster ID

Reimplemented in RawClusterv1.

Definition at line 45 of file RawCluster.h.

View newest version in sPHENIX GitHub at line 45 of file RawCluster.h

References PHOOL_VIRTUAL_WARN.

Referenced by CaloEvaluator::fillOutputNtuples(), ClusterJetInput::get_input(), CaloEvaluator::printOutputInfo(), RawClusterBuilderGraph::process_event(), RawClusterDeadAreaMask::process_event(), RawClusterBuilderFwd::process_event(), RawClusterBuilderHelper::process_event(), and CaloCalibEmc_Pi0::process_event().

Here is the caller graph for this function:

float RawClusterv1::get_phi ( ) const

inlineoverridevirtual

access to intrinsic cylindrical coordinate system

Reimplemented from RawCluster.

Definition at line 47 of file RawClusterv1.h.

View newest version in sPHENIX GitHub at line 47 of file RawClusterv1.h

References RawClusterv1::_phi.

Referenced by RawClusterv1::get_x(), RawClusterv1::get_y(), and RawClusterv1::identify().

Here is the caller graph for this function:

virtual float RawCluster::get_phi ( ) const

inlinevirtual

access to intrinsic cylindrical coordinate system

Reimplemented in RawClusterv1.

Definition at line 83 of file RawCluster.h.

View newest version in sPHENIX GitHub at line 83 of file RawCluster.h

References PHOOL_VIRTUAL_WARN.

Referenced by CaloEvaluator::fillOutputNtuples(), EventEvaluator::fillOutputNtuples(), EventEvaluatorEIC::fillOutputNtuples(), CaloEvaluator::printOutputInfo(), and PHGenFitTrackProjection::process_event().

Here is the caller graph for this function:

CLHEP::Hep3Vector RawClusterv1::get_position ( ) const

inlineoverridevirtual

cluster position in 3D

Reimplemented from RawCluster.

Definition at line 42 of file RawClusterv1.h.

View newest version in sPHENIX GitHub at line 42 of file RawClusterv1.h

References RawClusterv1::get_x(), RawClusterv1::get_y(), and RawClusterv1::get_z().

Here is the call graph for this function:

virtual CLHEP::Hep3Vector RawCluster::get_position ( ) const

inlinevirtual

Reimplemented in RawClusterv1.

Definition at line 76 of file RawCluster.h.

View newest version in sPHENIX GitHub at line 76 of file RawCluster.h

References PHOOL_VIRTUAL_WARN.

Referenced by RawClusterUtility::GetAzimuthAngle(), RawClusterUtility::GetECoreVec(), RawClusterUtility::GetET(), RawClusterUtility::GetETCore(), RawClusterUtility::GetEVec(), RawClusterUtility::GetPolarAngle(), RawClusterUtility::GetPseudorapidity(), and QAG4SimulationCalorimeter::process_event_Cluster().

Here is the caller graph for this function:

float RawClusterv1::get_prob ( ) const

inlineoverridevirtual

cluster template probability for EM shower

Reimplemented from RawCluster.

Definition at line 66 of file RawClusterv1.h.

View newest version in sPHENIX GitHub at line 66 of file RawClusterv1.h

References RawClusterv1::get_property_float(), and RawCluster::prop_prob.

Here is the call graph for this function:

virtual float RawCluster::get_prob ( ) const

inlinevirtual

cluster template probability for EM shower

Reimplemented in RawClusterv1.

Definition at line 154 of file RawCluster.h.

View newest version in sPHENIX GitHub at line 154 of file RawCluster.h

References PHOOL_VIRTUAL_WARN.

float RawClusterv1::get_r ( ) const

inlineoverridevirtual

Reimplemented from RawCluster.

Definition at line 48 of file RawClusterv1.h.

View newest version in sPHENIX GitHub at line 48 of file RawClusterv1.h

References RawClusterv1::_r.

Referenced by RawClusterv1::get_x(), RawClusterv1::get_y(), and RawClusterv1::identify().

Here is the caller graph for this function:

virtual float RawCluster::get_r ( ) const

inlinevirtual

Reimplemented in RawClusterv1.

Definition at line 88 of file RawCluster.h.

View newest version in sPHENIX GitHub at line 88 of file RawCluster.h

References PHOOL_VIRTUAL_WARN.

const TowerMap& RawClusterv1::get_towermap ( ) const

inlineoverridevirtual

return tower map for c++11 range-based for-loop

Reimplemented from RawCluster.

Definition at line 39 of file RawClusterv1.h.

View newest version in sPHENIX GitHub at line 39 of file RawClusterv1.h

References RawClusterv1::towermap.

virtual const TowerMap& RawCluster::get_towermap ( ) const

inlinevirtual

return tower map for c++11 range-based for-loop

Reimplemented in RawClusterv1.

Definition at line 69 of file RawCluster.h.

View newest version in sPHENIX GitHub at line 69 of file RawCluster.h

References PHOOL_VIRTUAL_WARN.

Referenced by RawClusterBuilderGraph::process_event(), RawClusterBuilderFwd::process_event(), and RawClusterBuilderHelper::process_event().

Here is the caller graph for this function:

RawCluster::TowerConstRange RawClusterv1::get_towers ( ) const

inlineoverridevirtual

Reimplemented from RawCluster.

Definition at line 37 of file RawClusterv1.h.

View newest version in sPHENIX GitHub at line 37 of file RawClusterv1.h

References RawClusterv1::towermap.

virtual TowerConstRange RawCluster::get_towers ( ) const

inlinevirtual

Reimplemented in RawClusterv1.

Definition at line 62 of file RawCluster.h.

View newest version in sPHENIX GitHub at line 62 of file RawCluster.h

References PHOOL_VIRTUAL_WARN.

Referenced by CaloRawClusterEval::all_truth_hits(), CaloRawClusterEval::all_truth_primary_showers(), RawClusterBuilderFwd::CorrectPhi(), CaloRawClusterEval::get_energy_contribution(), RawClusterDeadAreaMask::process_event(), RawClusterPositionCorrection::process_event(), and CaloCalibEmc_Pi0::process_event().

Here is the caller graph for this function:

float RawClusterv1::get_x ( ) const

inlineoverridevirtual

access Cartesian coordinate system

Reimplemented from RawCluster.

Definition at line 57 of file RawClusterv1.h.

View newest version in sPHENIX GitHub at line 57 of file RawClusterv1.h

References RawClusterv1::get_phi(), and RawClusterv1::get_r().

Referenced by RawClusterv1::get_position(), and RawClusterv1::identify().

Here is the call graph for this function:

Here is the caller graph for this function:

virtual float RawCluster::get_x ( ) const

inlinevirtual

access Cartesian coordinate system

Reimplemented in RawClusterv1.

Definition at line 129 of file RawCluster.h.

View newest version in sPHENIX GitHub at line 129 of file RawCluster.h

References PHOOL_VIRTUAL_WARN.

Referenced by CaloEvaluator::fillOutputNtuples(), and CaloEvaluator::printOutputInfo().

Here is the caller graph for this function:

float RawClusterv1::get_y ( ) const

inlineoverridevirtual

Reimplemented from RawCluster.

Definition at line 58 of file RawClusterv1.h.

View newest version in sPHENIX GitHub at line 58 of file RawClusterv1.h

References RawClusterv1::get_phi(), and RawClusterv1::get_r().

Referenced by RawClusterv1::get_position(), and RawClusterv1::identify().

Here is the call graph for this function:

Here is the caller graph for this function:

virtual float RawCluster::get_y ( ) const

inlinevirtual

Reimplemented in RawClusterv1.

Definition at line 134 of file RawCluster.h.

View newest version in sPHENIX GitHub at line 134 of file RawCluster.h

References PHOOL_VIRTUAL_WARN.

Referenced by CaloEvaluator::fillOutputNtuples(), and CaloEvaluator::printOutputInfo().

Here is the caller graph for this function:

float RawClusterv1::get_z ( ) const

inlineoverridevirtual

Reimplemented from RawCluster.

Definition at line 49 of file RawClusterv1.h.

View newest version in sPHENIX GitHub at line 49 of file RawClusterv1.h

References RawClusterv1::_z.

Referenced by RawClusterv1::get_position(), and RawClusterv1::identify().

Here is the caller graph for this function:

virtual float RawCluster::get_z ( ) const

inlinevirtual

Reimplemented in RawClusterv1.

Definition at line 93 of file RawCluster.h.

View newest version in sPHENIX GitHub at line 93 of file RawCluster.h

References PHOOL_VIRTUAL_WARN.

Referenced by CaloEvaluator::fillOutputNtuples(), and CaloEvaluator::printOutputInfo().

Here is the caller graph for this function:

size_t RawClusterv1::getNTowers ( ) const

inlineoverridevirtual

Tower operations.

Reimplemented from RawCluster.

Definition at line 36 of file RawClusterv1.h.

View newest version in sPHENIX GitHub at line 36 of file RawClusterv1.h

References RawClusterv1::towermap.

Referenced by RawClusterv1::identify().

Here is the caller graph for this function:

virtual size_t RawCluster::getNTowers ( ) const

inlinevirtual

Tower operations.

Reimplemented in RawClusterv1.

Definition at line 57 of file RawCluster.h.

View newest version in sPHENIX GitHub at line 57 of file RawCluster.h

References PHOOL_VIRTUAL_WARNING.

Referenced by CaloEvaluator::fillOutputNtuples(), EventEvaluator::fillOutputNtuples(), EventEvaluatorEIC::fillOutputNtuples(), and CaloEvaluator::printOutputInfo().

Here is the caller graph for this function: