#include "Cluster.h"

Collaboration diagram for pandora::Cluster:

[legend]

Classes
class	SimplePoint
	SimplePoint class. More...

Public Member Functions
const OrderedCaloHitList &	GetOrderedCaloHitList () const
	Get the ordered calo hit list.

const CaloHitList &	GetIsolatedCaloHitList () const
	Get the isolated calo hit list.

unsigned int	GetNCaloHits () const
	Get the number of calo hits in the cluster.

unsigned int	GetNIsolatedCaloHits () const
	Get the number of isolated calo hits in the cluster.

unsigned int	GetNPossibleMipHits () const
	Get the number of calo hits in the cluster that have been flagged as possible mip hits.

float	GetMipFraction () const
	Get fraction of constituent calo hits that have been flagged as possible mip hits.

unsigned int	GetNHitsInOuterLayer () const
	Get the number of hits in the outer sampling layers.

float	GetElectromagneticEnergy () const
	Get the sum of electromagnetic energy measures of all constituent calo hits, units GeV.

float	GetHadronicEnergy () const
	Get the sum of hadronic energy measures of all constituent calo hits, units GeV.

float	GetIsolatedElectromagneticEnergy () const
	Get the sum of electromagnetic energy measures of isolated constituent calo hits, units GeV.

float	GetIsolatedHadronicEnergy () const
	Get the sum of hadronic energy measures of isolated constituent calo hits, units GeV.

int	GetParticleId () const
	Get the particle id flag.

bool	IsTrackSeeded () const
	Whether the cluster is track seeded.

const Track *	GetTrackSeed () const
	Get the address of the track with which the cluster is seeded.

unsigned int	GetInnerPseudoLayer () const
	Get the innermost pseudo layer in the cluster.

unsigned int	GetOuterPseudoLayer () const
	Get the outermost pseudo layer in the cluster.

const CartesianVector	GetCentroid (const unsigned int pseudoLayer) const
	Get unweighted centroid for cluster at a particular pseudo layer, calculated using cached values of hit coordinate sums.

const CartesianVector &	GetInitialDirection () const
	Get the initial direction of the cluster.

const ClusterFitResult &	GetFitToAllHitsResult () const
	Get the result of a linear fit to all calo hits in the cluster.

HitType	GetInnerLayerHitType () const
	Get the typical inner layer hit type.

HitType	GetOuterLayerHitType () const
	Get the typical outer layer hit type.

const TrackList &	GetAssociatedTrackList () const
	Get the list of tracks associated with the cluster.

bool	IsAvailable () const
	Whether the cluster is available to be added to a particle flow object.

float	GetCorrectedElectromagneticEnergy (const Pandora &pandora) const
	Get the corrected electromagnetic estimate of the cluster energy, units GeV.

float	GetCorrectedHadronicEnergy (const Pandora &pandora) const
	Get the corrected hadronic estimate of the cluster energy, units GeV.

float	GetTrackComparisonEnergy (const Pandora &pandora) const
	Get the best energy estimate to use when comparing cluster energy to associated track momentum, units GeV. For clusters identified as electromagnetic showers, the corrected electromagnetic energy will be returned. For all other clusters, the corrected hadronic energy will be returned.

bool	PassPhotonId (const Pandora &pandora) const
	Whether the cluster passes the photon id.

unsigned int	GetShowerStartLayer (const Pandora &pandora) const
	Get the pseudo layer at which shower commences.

float	GetShowerProfileStart (const Pandora &pandora) const
	Get the cluster shower profile start, units radiation lengths.

float	GetShowerProfileDiscrepancy (const Pandora &pandora) const
	Get the cluster shower profile discrepancy.

void	GetClusterSpanX (float &xmin, float &xmax) const
	Get minimum and maximum X positions of the calo hits in this cluster.

void	GetClusterSpanZ (const float xmin, const float xmax, float &zmin, float &zmax) const
	Get upper and lower Z positions of the calo hits in a cluster in range xmin to xmax.

Protected Types
typedef std::map< unsigned int, SimplePoint >	PointByPseudoLayerMap
	The point by pseudo layer typedef.

typedef std::map< HitType, float >	HitTypeToEnergyMap
	The hit type to energy map typedef.

Protected Member Functions
	Cluster (const object_creation::Cluster::Parameters &parameters)
	Constructor.

virtual	~Cluster ()
	Destructor.

StatusCode	AlterMetadata (const object_creation::Cluster::Metadata &metadata)
	Alter the metadata information stored in a cluster.

StatusCode	AddCaloHit (const CaloHit *const pCaloHit)
	Add a calo hit to the cluster.

StatusCode	RemoveCaloHit (const CaloHit *const pCaloHit)
	Remove a calo hit from the cluster.

StatusCode	AddIsolatedCaloHit (const CaloHit *const pCaloHit)
	Add an isolated calo hit to the cluster.

StatusCode	RemoveIsolatedCaloHit (const CaloHit *const pCaloHit)
	Remove an isolated calo hit from the cluster.

void	UpdateFitToAllHitsCache () const
	Update result of linear fit to all calo hits in cluster.

void	UpdateInitialDirectionCache () const
	Update cluster initial direction.

void	UpdateLayerHitTypeCache (const unsigned int pseudoLayer, InputHitType &layerHitType) const
	Update typical hit type for specified layer.

void	UpdateEnergyCorrectionsCache (const Pandora &pandora) const
	Update cluster corrected energy values.

void	UpdatePhotonIdCache (const Pandora &pandora) const
	Update photon if flag.

void	UpdateShowerLayerCache (const Pandora &pandora) const
	Update the pseudo layer at which shower commences.

void	UpdateShowerProfileCache (const Pandora &pandora) const
	Update shower profile and comparison with expectation for a photon.

StatusCode	ResetProperties ()
	Reset all cluster properties.

void	ResetOutdatedProperties ()
	Reset those cluster properties that must be recalculated upon addition/removal of a calo hit.

StatusCode	AddHitsFromSecondCluster (const Cluster *const pCluster)
	Add the calo hits from a second cluster to this.

StatusCode	AddTrackAssociation (const Track *const pTrack)
	Add an association between the cluster and a track.

StatusCode	RemoveTrackAssociation (const Track *const pTrack)
	Remove an association between the cluster and a track.

void	RemoveTrackSeed ()
	Remove the track seed, changing the initial direction measurement.

void	SetAvailability (bool isAvailable)
	Set availability of cluster to be added to a particle flow object.

Protected Attributes
OrderedCaloHitList	m_orderedCaloHitList
	The ordered calo hit list.

CaloHitList	m_isolatedCaloHitList
	The list of isolated hits, which contribute only towards cluster energy.

unsigned int	m_nCaloHits
	The number of calo hits.

unsigned int	m_nPossibleMipHits
	The number of calo hits that have been flagged as possible mip hits.

unsigned int	m_nCaloHitsInOuterLayer
	Keep track of the number of calo hits in the outermost layers.

double	m_electromagneticEnergy
	The sum of electromagnetic energy measures of constituent calo hits, units GeV.

double	m_hadronicEnergy
	The sum of hadronic energy measures of constituent calo hits, units GeV.

double	m_isolatedElectromagneticEnergy
	Sum of electromagnetic energy measures of isolated calo hits, units GeV.

double	m_isolatedHadronicEnergy
	Sum of hadronic energy measures of isolated calo hits, units GeV.

int	m_particleId
	The particle id flag.

const Track *	m_pTrackSeed
	Address of the track with which the cluster is seeded.

PointByPseudoLayerMap	m_sumXYZByPseudoLayer
	Construct to allow rapid calculation of centroid in each pseudolayer.

InputUInt	m_innerPseudoLayer
	The innermost pseudo layer in the cluster.

InputUInt	m_outerPseudoLayer
	The outermost pseudo layer in the cluster.

CartesianVector	m_initialDirection
	The initial direction of the cluster.

bool	m_isDirectionUpToDate
	Whether the initial direction of the cluster is up to date.

ClusterFitResult	m_fitToAllHitsResult
	The result of a linear fit to all calo hits in the cluster.

bool	m_isFitUpToDate
	Whether the fit to all calo hits is up to date.

InputFloat	m_correctedElectromagneticEnergy
	The corrected electromagnetic estimate of the cluster energy, units GeV.

InputFloat	m_correctedHadronicEnergy
	The corrected hadronic estimate of the cluster energy, units GeV.

InputFloat	m_trackComparisonEnergy
	The appropriate corrected energy to use in comparisons with track momentum, units GeV.

InputBool	m_passPhotonId
	Whether the cluster passes the photon id.

InputUInt	m_showerStartLayer
	The pseudo layer at which shower commences.

InputFloat	m_showerProfileStart
	The cluster shower profile start, units radiation lengths.

InputFloat	m_showerProfileDiscrepancy
	The cluster shower profile discrepancy.

InputHitType	m_innerLayerHitType
	The typical inner layer hit type.

InputHitType	m_outerLayerHitType
	The typical outer layer hit type.

InputFloat	m_xMin
	Cached cluster minimum in x.

InputFloat	m_xMax
	Cached cluster maximum in x.

TrackList	m_associatedTrackList
	The list of tracks associated with the cluster.

bool	m_isAvailable
	Whether the cluster is available to be added to a particle flow object.

Friends
class	ClusterManager

class	AlgorithmObjectManager< Cluster >

class	PandoraObjectFactory< object_creation::Cluster::Parameters, object_creation::Cluster::Object >

Detailed Description

Cluster class.

Definition at line 30 of file Cluster.h.

Class Documentation

◆ pandora::Cluster::SimplePoint

class pandora::Cluster::SimplePoint

SimplePoint class.

Definition at line 419 of file Cluster.h.

Class Members
unsigned int	m_nHits	The number of hits in the pseudo layer.
double	m_xyzPositionSums[3]	The sum of the x, y and z hit positions in the pseudo layer.

Member Typedef Documentation

◆ HitTypeToEnergyMap

typedef std::map<HitType, float> pandora::Cluster::HitTypeToEnergyMap

protected

The hit type to energy map typedef.

Definition at line 427 of file Cluster.h.

◆ PointByPseudoLayerMap

typedef std::map<unsigned int, SimplePoint> pandora::Cluster::PointByPseudoLayerMap

protected

The point by pseudo layer typedef.

Definition at line 426 of file Cluster.h.

Constructor & Destructor Documentation

◆ Cluster()

pandora::Cluster::Cluster ( const object_creation::Cluster::Parameters & parameters )

protected

Constructor.

Parameters

parameters the cluster parameters

Definition at line 232 of file Cluster.cc.

Here is the call graph for this function:

◆ ~Cluster()

pandora::Cluster::~Cluster ( )

protectedvirtual

Destructor.

Definition at line 269 of file Cluster.cc.

Member Function Documentation

◆ AddCaloHit()

StatusCode pandora::Cluster::AddCaloHit ( const CaloHit *const pCaloHit )

protected

Add a calo hit to the cluster.

Parameters

pCaloHit the address of the calo hit

Definition at line 288 of file Cluster.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ AddHitsFromSecondCluster()

StatusCode pandora::Cluster::AddHitsFromSecondCluster ( const Cluster *const pCluster )

protected

Add the calo hits from a second cluster to this.

Parameters

pCluster the address of the second cluster

Definition at line 608 of file Cluster.cc.

Here is the call graph for this function:

◆ AddIsolatedCaloHit()

StatusCode pandora::Cluster::AddIsolatedCaloHit ( const CaloHit *const pCaloHit )

protected

Add an isolated calo hit to the cluster.

Parameters

pCaloHit the address of the isolated calo hit

Definition at line 390 of file Cluster.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ AddTrackAssociation()

StatusCode pandora::Cluster::AddTrackAssociation ( const Track *const pTrack )

protected

Add an association between the cluster and a track.

Parameters

pTrack the address of the track with which the cluster is associated

Definition at line 666 of file Cluster.cc.

Here is the caller graph for this function:

◆ AlterMetadata()

StatusCode pandora::Cluster::AlterMetadata ( const object_creation::Cluster::Metadata & metadata )

protected

Alter the metadata information stored in a cluster.

Parameters

metaData the metadata (only populated metadata fields will be propagated to the object)

Definition at line 275 of file Cluster.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetAssociatedTrackList()

const TrackList & pandora::Cluster::GetAssociatedTrackList ( ) const

inline

Get the list of tracks associated with the cluster.

Returns: Address of the list of associated tracks

Definition at line 575 of file Cluster.h.

◆ GetCentroid()

const CartesianVector pandora::Cluster::GetCentroid ( const unsigned int pseudoLayer ) const

Get unweighted centroid for cluster at a particular pseudo layer, calculated using cached values of hit coordinate sums.

Parameters

pseudoLayer the pseudo layer of interest

Returns: The unweighted centroid, returned by value

Definition at line 37 of file Cluster.cc.

Here is the caller graph for this function:

◆ GetClusterSpanX()

void pandora::Cluster::GetClusterSpanX	(	float &	xmin,
		float &	xmax
	)		const

Get minimum and maximum X positions of the calo hits in this cluster.

Parameters

the	minimum position of x
the	maximum position of x

Definition at line 169 of file Cluster.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetClusterSpanZ()

void pandora::Cluster::GetClusterSpanZ	(	const float	xmin,
		const float	xmax,
		float &	zmin,
		float &	zmax
	)		const

Get upper and lower Z positions of the calo hits in a cluster in range xmin to xmax.

Parameters

xmin	for range in x
xmax	for range in x
zmin	the lower z for this range of x
zmax	the upper z for this range in x

Definition at line 198 of file Cluster.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetCorrectedElectromagneticEnergy()

float pandora::Cluster::GetCorrectedElectromagneticEnergy ( const Pandora & pandora ) const

Get the corrected electromagnetic estimate of the cluster energy, units GeV.

Parameters

pandora the associated pandora instance

Returns: The corrected electromagnetic energy estimate

Definition at line 96 of file Cluster.cc.

Here is the call graph for this function:

◆ GetCorrectedHadronicEnergy()

float pandora::Cluster::GetCorrectedHadronicEnergy ( const Pandora & pandora ) const

Get the corrected hadronic estimate of the cluster energy, units GeV.

Parameters

pandora the associated pandora instance

Returns: The corrected hadronic energy estimate

Definition at line 106 of file Cluster.cc.

Here is the call graph for this function:

◆ GetElectromagneticEnergy()

float pandora::Cluster::GetElectromagneticEnergy ( ) const

inline

Get the sum of electromagnetic energy measures of all constituent calo hits, units GeV.

Returns: The electromagnetic energy measure

Definition at line 519 of file Cluster.h.

Here is the caller graph for this function:

◆ GetFitToAllHitsResult()

const ClusterFitResult & pandora::Cluster::GetFitToAllHitsResult ( ) const

Get the result of a linear fit to all calo hits in the cluster.

Returns: The cluster fit result

Definition at line 66 of file Cluster.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetHadronicEnergy()

float pandora::Cluster::GetHadronicEnergy ( ) const

inline

Get the sum of hadronic energy measures of all constituent calo hits, units GeV.

Returns: The hadronic energy measure

Definition at line 526 of file Cluster.h.

Here is the caller graph for this function:

◆ GetInitialDirection()

const CartesianVector & pandora::Cluster::GetInitialDirection ( ) const

Get the initial direction of the cluster.

Returns: The initial direction of the cluster

Definition at line 56 of file Cluster.cc.

Here is the call graph for this function:

◆ GetInnerLayerHitType()

HitType pandora::Cluster::GetInnerLayerHitType ( ) const

Get the typical inner layer hit type.

Returns: The typical inner layer hit type

Definition at line 76 of file Cluster.cc.

Here is the call graph for this function:

◆ GetInnerPseudoLayer()

unsigned int pandora::Cluster::GetInnerPseudoLayer ( ) const

inline

Get the innermost pseudo layer in the cluster.

Returns: The innermost pseudo layer in the cluster

Definition at line 561 of file Cluster.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetIsolatedCaloHitList()

const CaloHitList & pandora::Cluster::GetIsolatedCaloHitList ( ) const

inline

Get the isolated calo hit list.

Returns: The isolated calo hit list by reference

Definition at line 477 of file Cluster.h.

Here is the caller graph for this function:

◆ GetIsolatedElectromagneticEnergy()

float pandora::Cluster::GetIsolatedElectromagneticEnergy ( ) const

inline

Get the sum of electromagnetic energy measures of isolated constituent calo hits, units GeV.

Returns: The electromagnetic energy measure

Definition at line 533 of file Cluster.h.

◆ GetIsolatedHadronicEnergy()

float pandora::Cluster::GetIsolatedHadronicEnergy ( ) const

inline

Get the sum of hadronic energy measures of isolated constituent calo hits, units GeV.

Returns: The hadronic energy measure

Definition at line 540 of file Cluster.h.

◆ GetMipFraction()

float pandora::Cluster::GetMipFraction ( ) const

inline

Get fraction of constituent calo hits that have been flagged as possible mip hits.

Returns: The mip fraction

Definition at line 505 of file Cluster.h.

◆ GetNCaloHits()

unsigned int pandora::Cluster::GetNCaloHits ( ) const

inline

Get the number of calo hits in the cluster.

Returns: The number of calo hits

Definition at line 484 of file Cluster.h.

Here is the caller graph for this function:

◆ GetNHitsInOuterLayer()

unsigned int pandora::Cluster::GetNHitsInOuterLayer ( ) const

inline

Get the number of hits in the outer sampling layers.

Returns: The number of hits in this cluster in the outermost sampling layer

Definition at line 512 of file Cluster.h.

Here is the caller graph for this function:

◆ GetNIsolatedCaloHits()

unsigned int pandora::Cluster::GetNIsolatedCaloHits ( ) const

inline

Get the number of isolated calo hits in the cluster.

Returns: The number of isolated calo hits

Definition at line 491 of file Cluster.h.

Here is the call graph for this function:

◆ GetNPossibleMipHits()

unsigned int pandora::Cluster::GetNPossibleMipHits ( ) const

inline

Get the number of calo hits in the cluster that have been flagged as possible mip hits.

Returns: The number of possible mip hits

Definition at line 498 of file Cluster.h.

Here is the caller graph for this function:

◆ GetOrderedCaloHitList()

const OrderedCaloHitList & pandora::Cluster::GetOrderedCaloHitList ( ) const

inline

Get the ordered calo hit list.

Returns: The ordered calo hit list by reference

Definition at line 470 of file Cluster.h.

◆ GetOuterLayerHitType()

HitType pandora::Cluster::GetOuterLayerHitType ( ) const

Get the typical outer layer hit type.

Returns: The typical outer layer hit type

Definition at line 86 of file Cluster.cc.

Here is the call graph for this function:

◆ GetOuterPseudoLayer()

unsigned int pandora::Cluster::GetOuterPseudoLayer ( ) const

inline

Get the outermost pseudo layer in the cluster.

Returns: The outermost pseudo layer in the cluster

Definition at line 568 of file Cluster.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetParticleId()

int pandora::Cluster::GetParticleId ( ) const

inline

Get the particle id flag.

Returns: The particle id flag

Definition at line 547 of file Cluster.h.

Here is the caller graph for this function:

◆ GetShowerProfileDiscrepancy()

float pandora::Cluster::GetShowerProfileDiscrepancy ( const Pandora & pandora ) const

Get the cluster shower profile discrepancy.

Parameters

pandora the associated pandora instance

Returns: The cluster shower profile discrepancy

Definition at line 159 of file Cluster.cc.

Here is the call graph for this function:

◆ GetShowerProfileStart()

float pandora::Cluster::GetShowerProfileStart ( const Pandora & pandora ) const

Get the cluster shower profile start, units radiation lengths.

Parameters

pandora the associated pandora instance

Returns: The cluster shower profile start

Definition at line 149 of file Cluster.cc.

Here is the call graph for this function:

◆ GetShowerStartLayer()

unsigned int pandora::Cluster::GetShowerStartLayer ( const Pandora & pandora ) const

Get the pseudo layer at which shower commences.

Parameters

pandora the associated pandora instance

Returns: The pseudo layer at which shower commences

Definition at line 139 of file Cluster.cc.

Here is the call graph for this function:

◆ GetTrackComparisonEnergy()

float pandora::Cluster::GetTrackComparisonEnergy ( const Pandora & pandora ) const

Get the best energy estimate to use when comparing cluster energy to associated track momentum, units GeV. For clusters identified as electromagnetic showers, the corrected electromagnetic energy will be returned. For all other clusters, the corrected hadronic energy will be returned.

Parameters

pandora the associated pandora instance

Returns: The track comparison energy estimate

Definition at line 116 of file Cluster.cc.

Here is the call graph for this function:

◆ GetTrackSeed()

const Track * pandora::Cluster::GetTrackSeed ( ) const

Get the address of the track with which the cluster is seeded.

Returns: address of the track seed

Definition at line 27 of file Cluster.cc.

◆ IsAvailable()

bool pandora::Cluster::IsAvailable ( ) const

inline

Whether the cluster is available to be added to a particle flow object.

Returns: boolean

Definition at line 582 of file Cluster.h.

Here is the caller graph for this function:

◆ IsTrackSeeded()

bool pandora::Cluster::IsTrackSeeded ( ) const

inline

Whether the cluster is track seeded.

Returns: boolean

Definition at line 554 of file Cluster.h.

◆ PassPhotonId()

bool pandora::Cluster::PassPhotonId ( const Pandora & pandora ) const

Whether the cluster passes the photon id.

Parameters

pandora the associated pandora instance

Returns: boolean

Definition at line 126 of file Cluster.cc.

Here is the call graph for this function:

◆ RemoveCaloHit()

StatusCode pandora::Cluster::RemoveCaloHit ( const CaloHit *const pCaloHit )

protected

Remove a calo hit from the cluster.

Parameters

pCaloHit the address of the calo hit

Definition at line 340 of file Cluster.cc.

Here is the call graph for this function:

◆ RemoveIsolatedCaloHit()

StatusCode pandora::Cluster::RemoveIsolatedCaloHit ( const CaloHit *const pCaloHit )

protected

Remove an isolated calo hit from the cluster.

Parameters

pCaloHit the address of the isolated calo hit

Definition at line 409 of file Cluster.cc.

Here is the call graph for this function:

◆ RemoveTrackAssociation()

StatusCode pandora::Cluster::RemoveTrackAssociation ( const Track *const pTrack )

protected

Remove an association between the cluster and a track.

Parameters

pTrack the address of the track with which the cluster is no longer associated

Definition at line 680 of file Cluster.cc.

◆ RemoveTrackSeed()

void pandora::Cluster::RemoveTrackSeed ( )

protected

Remove the track seed, changing the initial direction measurement.

Definition at line 693 of file Cluster.cc.

Here is the call graph for this function:

◆ ResetOutdatedProperties()

void pandora::Cluster::ResetOutdatedProperties ( )

protected

Reset those cluster properties that must be recalculated upon addition/removal of a calo hit.

Definition at line 587 of file Cluster.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ResetProperties()

StatusCode pandora::Cluster::ResetProperties ( )

protected

Reset all cluster properties.

Definition at line 560 of file Cluster.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetAvailability()

void pandora::Cluster::SetAvailability ( bool isAvailable )

inlineprotected

Set availability of cluster to be added to a particle flow object.

Parameters

isAvailable the cluster availability

Definition at line 589 of file Cluster.h.

◆ UpdateEnergyCorrectionsCache()

void pandora::Cluster::UpdateEnergyCorrectionsCache ( const Pandora & pandora ) const

protected

Update cluster corrected energy values.

Parameters

pandora the associated pandora instance

Definition at line 497 of file Cluster.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ UpdateFitToAllHitsCache()

void pandora::Cluster::UpdateFitToAllHitsCache ( ) const

protected

Update result of linear fit to all calo hits in cluster.

Definition at line 431 of file Cluster.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ UpdateInitialDirectionCache()

void pandora::Cluster::UpdateInitialDirectionCache ( ) const

protected

Update cluster initial direction.

Definition at line 439 of file Cluster.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ UpdateLayerHitTypeCache()

void pandora::Cluster::UpdateLayerHitTypeCache	(	const unsigned int	pseudoLayer,
		InputHitType &	layerHitType
	)		const

protected

Update typical hit type for specified layer.

Parameters

pseudoLayer	the pseudo layer
layerHitType	to receive the typical layer hit type

Definition at line 460 of file Cluster.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ UpdatePhotonIdCache()

void pandora::Cluster::UpdatePhotonIdCache ( const Pandora & pandora ) const

protected

Update photon if flag.

Parameters

pandora the associated pandora instance

Definition at line 524 of file Cluster.cc.

Here is the caller graph for this function:

◆ UpdateShowerLayerCache()

void pandora::Cluster::UpdateShowerLayerCache ( const Pandora & pandora ) const

protected

Update the pseudo layer at which shower commences.

Parameters

pandora the associated pandora instance

Definition at line 534 of file Cluster.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ UpdateShowerProfileCache()

void pandora::Cluster::UpdateShowerProfileCache ( const Pandora & pandora ) const

protected

Update shower profile and comparison with expectation for a photon.

Parameters

pandora the associated pandora instance

Definition at line 547 of file Cluster.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

Friends And Related Symbol Documentation

◆ AlgorithmObjectManager< Cluster >

friend class AlgorithmObjectManager< Cluster >

friend

Definition at line 463 of file Cluster.h.

◆ ClusterManager

friend class ClusterManager

friend

Definition at line 463 of file Cluster.h.

◆ PandoraObjectFactory< object_creation::Cluster::Parameters, object_creation::Cluster::Object >

friend class PandoraObjectFactory< object_creation::Cluster::Parameters, object_creation::Cluster::Object >

friend

Definition at line 463 of file Cluster.h.

Member Data Documentation

◆ m_associatedTrackList

TrackList pandora::Cluster::m_associatedTrackList

protected

The list of tracks associated with the cluster.

Definition at line 460 of file Cluster.h.

◆ m_correctedElectromagneticEnergy

InputFloat pandora::Cluster::m_correctedElectromagneticEnergy

mutableprotected

The corrected electromagnetic estimate of the cluster energy, units GeV.

Definition at line 448 of file Cluster.h.

◆ m_correctedHadronicEnergy

InputFloat pandora::Cluster::m_correctedHadronicEnergy

mutableprotected

The corrected hadronic estimate of the cluster energy, units GeV.

Definition at line 449 of file Cluster.h.

◆ m_electromagneticEnergy

double pandora::Cluster::m_electromagneticEnergy

protected

The sum of electromagnetic energy measures of constituent calo hits, units GeV.

Definition at line 434 of file Cluster.h.

◆ m_fitToAllHitsResult

ClusterFitResult pandora::Cluster::m_fitToAllHitsResult

mutableprotected

The result of a linear fit to all calo hits in the cluster.

Definition at line 446 of file Cluster.h.

◆ m_hadronicEnergy

double pandora::Cluster::m_hadronicEnergy

protected

The sum of hadronic energy measures of constituent calo hits, units GeV.

Definition at line 435 of file Cluster.h.

◆ m_initialDirection

CartesianVector pandora::Cluster::m_initialDirection

mutableprotected

The initial direction of the cluster.

Definition at line 444 of file Cluster.h.

◆ m_innerLayerHitType

InputHitType pandora::Cluster::m_innerLayerHitType

mutableprotected

The typical inner layer hit type.

Definition at line 455 of file Cluster.h.

◆ m_innerPseudoLayer

InputUInt pandora::Cluster::m_innerPseudoLayer

protected

The innermost pseudo layer in the cluster.

Definition at line 441 of file Cluster.h.

◆ m_isAvailable

bool pandora::Cluster::m_isAvailable

protected

Whether the cluster is available to be added to a particle flow object.

Definition at line 461 of file Cluster.h.

◆ m_isDirectionUpToDate

bool pandora::Cluster::m_isDirectionUpToDate

mutableprotected

Whether the initial direction of the cluster is up to date.

Definition at line 445 of file Cluster.h.

◆ m_isFitUpToDate

bool pandora::Cluster::m_isFitUpToDate

mutableprotected

Whether the fit to all calo hits is up to date.

Definition at line 447 of file Cluster.h.

◆ m_isolatedCaloHitList

CaloHitList pandora::Cluster::m_isolatedCaloHitList

protected

The list of isolated hits, which contribute only towards cluster energy.

Definition at line 430 of file Cluster.h.

◆ m_isolatedElectromagneticEnergy

double pandora::Cluster::m_isolatedElectromagneticEnergy

protected

Sum of electromagnetic energy measures of isolated calo hits, units GeV.

Definition at line 436 of file Cluster.h.

◆ m_isolatedHadronicEnergy

double pandora::Cluster::m_isolatedHadronicEnergy

protected

Sum of hadronic energy measures of isolated calo hits, units GeV.

Definition at line 437 of file Cluster.h.

◆ m_nCaloHits

unsigned int pandora::Cluster::m_nCaloHits

protected

The number of calo hits.

Definition at line 431 of file Cluster.h.

◆ m_nCaloHitsInOuterLayer

unsigned int pandora::Cluster::m_nCaloHitsInOuterLayer

protected

Keep track of the number of calo hits in the outermost layers.

Definition at line 433 of file Cluster.h.

◆ m_nPossibleMipHits

unsigned int pandora::Cluster::m_nPossibleMipHits

protected

The number of calo hits that have been flagged as possible mip hits.

Definition at line 432 of file Cluster.h.

◆ m_orderedCaloHitList

OrderedCaloHitList pandora::Cluster::m_orderedCaloHitList

protected

The ordered calo hit list.

Definition at line 429 of file Cluster.h.

◆ m_outerLayerHitType

InputHitType pandora::Cluster::m_outerLayerHitType

mutableprotected

The typical outer layer hit type.

Definition at line 456 of file Cluster.h.

◆ m_outerPseudoLayer

InputUInt pandora::Cluster::m_outerPseudoLayer

protected

The outermost pseudo layer in the cluster.

Definition at line 442 of file Cluster.h.

◆ m_particleId

int pandora::Cluster::m_particleId

protected

The particle id flag.

Definition at line 438 of file Cluster.h.

◆ m_passPhotonId

InputBool pandora::Cluster::m_passPhotonId

mutableprotected

Whether the cluster passes the photon id.

Definition at line 451 of file Cluster.h.

◆ m_pTrackSeed

const Track* pandora::Cluster::m_pTrackSeed

protected

Address of the track with which the cluster is seeded.

Definition at line 439 of file Cluster.h.

◆ m_showerProfileDiscrepancy

InputFloat pandora::Cluster::m_showerProfileDiscrepancy

mutableprotected

The cluster shower profile discrepancy.

Definition at line 454 of file Cluster.h.

◆ m_showerProfileStart

InputFloat pandora::Cluster::m_showerProfileStart

mutableprotected

The cluster shower profile start, units radiation lengths.

Definition at line 453 of file Cluster.h.

◆ m_showerStartLayer

InputUInt pandora::Cluster::m_showerStartLayer

mutableprotected

The pseudo layer at which shower commences.

Definition at line 452 of file Cluster.h.

◆ m_sumXYZByPseudoLayer

PointByPseudoLayerMap pandora::Cluster::m_sumXYZByPseudoLayer

protected

Construct to allow rapid calculation of centroid in each pseudolayer.

Definition at line 440 of file Cluster.h.

◆ m_trackComparisonEnergy

InputFloat pandora::Cluster::m_trackComparisonEnergy

mutableprotected

The appropriate corrected energy to use in comparisons with track momentum, units GeV.

Definition at line 450 of file Cluster.h.

◆ m_xMax

InputFloat pandora::Cluster::m_xMax

mutableprotected

Cached cluster maximum in x.

Definition at line 458 of file Cluster.h.

◆ m_xMin

InputFloat pandora::Cluster::m_xMin

mutableprotected

Cached cluster minimum in x.

Definition at line 457 of file Cluster.h.

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

PandoraSDK/include/Objects/Cluster.h
PandoraSDK/src/Objects/Cluster.cc

Classes

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Class Documentation

◆ pandora::Cluster::SimplePoint

Member Typedef Documentation

◆ HitTypeToEnergyMap

◆ PointByPseudoLayerMap

Constructor & Destructor Documentation

◆ Cluster()

◆ ~Cluster()

Member Function Documentation

◆ AddCaloHit()

◆ AddHitsFromSecondCluster()

◆ AddIsolatedCaloHit()

◆ AddTrackAssociation()

◆ AlterMetadata()

◆ GetAssociatedTrackList()

◆ GetCentroid()

◆ GetClusterSpanX()

◆ GetClusterSpanZ()

◆ GetCorrectedElectromagneticEnergy()

◆ GetCorrectedHadronicEnergy()

◆ GetElectromagneticEnergy()

◆ GetFitToAllHitsResult()

◆ GetHadronicEnergy()

◆ GetInitialDirection()

◆ GetInnerLayerHitType()

◆ GetInnerPseudoLayer()

◆ GetIsolatedCaloHitList()

◆ GetIsolatedElectromagneticEnergy()

◆ GetIsolatedHadronicEnergy()

◆ GetMipFraction()

◆ GetNCaloHits()

◆ GetNHitsInOuterLayer()

◆ GetNIsolatedCaloHits()

◆ GetNPossibleMipHits()

◆ GetOrderedCaloHitList()

◆ GetOuterLayerHitType()

◆ GetOuterPseudoLayer()

◆ GetParticleId()

◆ GetShowerProfileDiscrepancy()

◆ GetShowerProfileStart()

◆ GetShowerStartLayer()

◆ GetTrackComparisonEnergy()

◆ GetTrackSeed()

◆ IsAvailable()

◆ IsTrackSeeded()

◆ PassPhotonId()

◆ RemoveCaloHit()

◆ RemoveIsolatedCaloHit()

◆ RemoveTrackAssociation()

◆ RemoveTrackSeed()

◆ ResetOutdatedProperties()

◆ ResetProperties()

◆ SetAvailability()

◆ UpdateEnergyCorrectionsCache()

◆ UpdateFitToAllHitsCache()

◆ UpdateInitialDirectionCache()

◆ UpdateLayerHitTypeCache()

◆ UpdatePhotonIdCache()

◆ UpdateShowerLayerCache()

◆ UpdateShowerProfileCache()

Friends And Related Symbol Documentation

◆ AlgorithmObjectManager< Cluster >

◆ ClusterManager

◆ PandoraObjectFactory< object_creation::Cluster::Parameters, object_creation::Cluster::Object >

Member Data Documentation

◆ m_associatedTrackList

◆ m_correctedElectromagneticEnergy

◆ m_correctedHadronicEnergy

◆ m_electromagneticEnergy

◆ m_fitToAllHitsResult

◆ m_hadronicEnergy

◆ m_initialDirection

◆ m_innerLayerHitType