VertexBasedPfoMopUpAlgorithm class. More...

#include "VertexBasedPfoMopUpAlgorithm.h"

Inheritance diagram for lar_content::VertexBasedPfoMopUpAlgorithm:

[legend]

Collaboration diagram for lar_content::VertexBasedPfoMopUpAlgorithm:

[legend]

Classes
class	ClusterAssociation
	ClusterAssociation class. More...

class	ConeParameters
	ConeParameters class. More...

class	PfoAssociation
	PfoAssociation class. More...

Public Member Functions
	VertexBasedPfoMopUpAlgorithm ()
	Default constructor.

virtual void	MergeAndDeletePfos (const pandora::ParticleFlowObject const pPfoToEnlarge, const pandora::ParticleFlowObject const pPfoToDelete) const
	Merge and delete a pair of pfos, with a specific set of conventions for cluster merging, vertex use, etc.

template<typename T >
const std::string	GetListName (const T *const pT) const
	Find the name of the list hosting a specific object.

const std::string &	GetType () const
	Get the type.

const std::string &	GetInstanceName () const
	Get the instance name.

const Pandora &	GetPandora () const
	Get the associated pandora instance.

Static Public Member Functions
static const pandora::Cluster *	GetParentCluster (const pandora::ClusterList &clusterList, const pandora::HitType hitType)
	Select the parent cluster (same hit type and most hits) using a provided cluster list and hit type.

Protected Types
typedef std::vector< PfoAssociation >	PfoAssociationList

typedef std::map< pandora::HitType, ClusterAssociation >	HitTypeToAssociationMap

typedef std::set< pandora::HitType >	HitTypeSet

typedef std::map< pandora::HitType, const pandora::Cluster * >	HitTypeToClusterMap

Protected Member Functions
pandora::StatusCode	Run ()
	Run the algorithm.

virtual bool	IsVertexAssociated (const pandora::CartesianVector &vertex2D, const LArPointingCluster &pointingCluster) const
	Whether a specified pfo is associated with a specified vertex.

virtual PfoAssociation	GetPfoAssociation (const pandora::Pfo const pVertexPfo, const pandora::Pfo const pDaughterPfo, HitTypeToAssociationMap &hitTypeToAssociationMap) const
	Get pfo association details between a vertex-associated pfo and a non-vertex associated daughter candidate pfo.

void	GetInputPfos (const pandora::Vertex *const pVertex, pandora::PfoList &vertexPfos, pandora::PfoList &nonVertexPfos) const
	Get the list of input pfos and divide them into vertex-associated and non-vertex-associated lists.

bool	IsVertexAssociated (const pandora::Pfo const pPfo, const pandora::Vertex const pVertex) const
	Whether a specified pfo is associated with a specified vertex.

void	GetPfoAssociations (const pandora::Vertex *const pVertex, const pandora::PfoList &vertexPfos, const pandora::PfoList &nonVertexPfos, PfoAssociationList &pfoAssociationList) const
	Get the list of associations between vertex-associated pfos and non-vertex-associated pfos.

PfoAssociation	GetPfoAssociation (const pandora::Vertex const pVertex, const pandora::Pfo const pVertexPfo, const pandora::Pfo *const pDaughterPfo) const
	Get pfo association details between a vertex-associated pfo and a non-vertex associated daughter candidate pfo.

ClusterAssociation	GetClusterAssociation (const pandora::Vertex const pVertex, const pandora::Cluster const pVertexCluster, const pandora::Cluster *const pDaughterCluster) const
	Get cluster association details between a vertex-associated cluster and a non-vertex associated daughter candidate cluster.

bool	ProcessPfoAssociations (const PfoAssociationList &pfoAssociationList) const
	Process the list of pfo associations, merging the best-matching pfo.

void	MergePfos (const PfoAssociation &pfoAssociation) const
	Merge the vertex and daughter pfos (deleting daughter pfo, merging clusters, etc.) described in the specified pfoAssociation.

pandora::StatusCode	ReadSettings (const pandora::TiXmlHandle xmlHandle)
	Read the algorithm settings.

virtual StatusCode	Initialize ()
	Perform any operations that must occur after reading settings, but before running the process.

virtual StatusCode	Reset ()
	Perform any operations when pandora is reset, typically at the end of each event.

StatusCode	RegisterDetails (const Pandora *const pPandora, const std::string &type, const std::string &instanceName)
	Register i) the pandora instance that will run the process and ii) the process type.

Protected Attributes
std::string	m_trackPfoListName
	The input track pfo list name.

std::string	m_showerPfoListName
	The input shower pfo list name.

float	m_minVertexLongitudinalDistance
	Vertex association check: min longitudinal distance cut.

float	m_maxVertexTransverseDistance
	Vertex association check: max transverse distance cut.

unsigned int	m_minVertexAssociatedHitTypes
	The min number of vertex associated hit types for a vertex associated pfo.

float	m_coneAngleCentile
	Cluster cone angle is defined using specified centile of distribution of hit half angles.

float	m_maxConeCosHalfAngle
	Maximum value for cosine of cone half angle.

float	m_maxConeLengthMultiplier
	Consider hits as bound if inside cone, with projected distance less than N times cone length.

float	m_directionTanAngle
	Direction determination, look for vertex inside triangle with apex shifted along the cluster length.

float	m_directionApexShift
	Direction determination, look for vertex inside triangle with apex shifted along the cluster length.

float	m_meanBoundedFractionCut
	Cut on association info (mean bounded fraction) for determining pfo merges.

float	m_maxBoundedFractionCut
	Cut on association info (max bounded fraction) for determining pfo merges.

float	m_minBoundedFractionCut
	Cut on association info (min bounded fraction) for determining pfo merges.

unsigned int	m_minConsistentDirections
	The minimum number of consistent cluster directions to allow a pfo merge.

unsigned int	m_minConsistentDirectionsTrack
	The minimum number of consistent cluster directions to allow a merge involving a track pfo.

pandora::StringVector	m_daughterListNames
	The list of potential daughter object list names.

const Pandora *	m_pPandora
	The pandora object that will run the process.

std::string	m_type
	The process type.

std::string	m_instanceName
	The process instance name.

Detailed Description

VertexBasedPfoMopUpAlgorithm class.

Definition at line 21 of file VertexBasedPfoMopUpAlgorithm.h.

Member Typedef Documentation

◆ HitTypeSet

typedef std::set<pandora::HitType> lar_content::VertexBasedPfoMopUpAlgorithm::HitTypeSet

protected

Definition at line 344 of file VertexBasedPfoMopUpAlgorithm.h.

◆ HitTypeToAssociationMap

typedef std::map<pandora::HitType, ClusterAssociation> lar_content::VertexBasedPfoMopUpAlgorithm::HitTypeToAssociationMap

protected

Definition at line 258 of file VertexBasedPfoMopUpAlgorithm.h.

◆ HitTypeToClusterMap

typedef std::map<pandora::HitType, const pandora::Cluster *> lar_content::VertexBasedPfoMopUpAlgorithm::HitTypeToClusterMap

protected

Definition at line 345 of file VertexBasedPfoMopUpAlgorithm.h.

◆ PfoAssociationList

typedef std::vector<PfoAssociation> lar_content::VertexBasedPfoMopUpAlgorithm::PfoAssociationList

protected

Definition at line 186 of file VertexBasedPfoMopUpAlgorithm.h.

Constructor & Destructor Documentation

◆ VertexBasedPfoMopUpAlgorithm()

lar_content::VertexBasedPfoMopUpAlgorithm::VertexBasedPfoMopUpAlgorithm ( )

Default constructor.

Definition at line 26 of file VertexBasedPfoMopUpAlgorithm.cc.

Member Function Documentation

◆ GetClusterAssociation()

VertexBasedPfoMopUpAlgorithm::ClusterAssociation lar_content::VertexBasedPfoMopUpAlgorithm::GetClusterAssociation	(	const pandora::Vertex *const	pVertex,
		const pandora::Cluster *const	pVertexCluster,
		const pandora::Cluster *const	pDaughterCluster
	)		const

protected

Get cluster association details between a vertex-associated cluster and a non-vertex associated daughter candidate cluster.

Parameters

pVertex	the address of the vertex
pVertexCluster	the address of the vertex-associated cluster
pDaughterCluster	the address of the non-vertex-associated cluster

Returns: the cluster association details

Definition at line 208 of file VertexBasedPfoMopUpAlgorithm.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetInputPfos()

void lar_content::VertexBasedPfoMopUpAlgorithm::GetInputPfos	(	const pandora::Vertex *const	pVertex,
		pandora::PfoList &	vertexPfos,
		pandora::PfoList &	nonVertexPfos
	)		const

protected

Get the list of input pfos and divide them into vertex-associated and non-vertex-associated lists.

Parameters

pVertex	the address of the 3d vertex
vertexPfos	to receive the list of vertex-associated pfos
nonVertexPfos	to receive the list of nonvertex-associated pfos

Definition at line 101 of file VertexBasedPfoMopUpAlgorithm.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetInstanceName()

const std::string & pandora::Process::GetInstanceName ( ) const

inlineinherited

Get the instance name.

Returns: The instance name

Definition at line 109 of file Process.h.

◆ GetListName()

template<typename T >

template const std::string lar_content::MopUpBaseAlgorithm::GetListName ( const T *const pT ) const

inherited

Find the name of the list hosting a specific object.

Parameters

pT	the address of the object

Returns: the name of the list

Definition at line 19 of file MopUpBaseAlgorithm.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetPandora()

const Pandora & pandora::Process::GetPandora ( ) const

inlineinherited

Get the associated pandora instance.

Returns: the associated pandora instance

Definition at line 116 of file Process.h.

◆ GetParentCluster()

const Cluster * lar_content::PfoMopUpBaseAlgorithm::GetParentCluster	(	const pandora::ClusterList &	clusterList,
		const pandora::HitType	hitType
	)

staticinherited

Select the parent cluster (same hit type and most hits) using a provided cluster list and hit type.

Parameters

clusterList	the cluster list
hitType	the hit type

Returns: the address of the parent cluster

Definition at line 61 of file PfoMopUpBaseAlgorithm.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetPfoAssociation() [1/2]

VertexBasedPfoMopUpAlgorithm::PfoAssociation lar_content::VertexBasedPfoMopUpAlgorithm::GetPfoAssociation	(	const pandora::Pfo *const	pVertexPfo,
		const pandora::Pfo *const	pDaughterPfo,
		HitTypeToAssociationMap &	hitTypeToAssociationMap
	)		const

protectedvirtual

Get pfo association details between a vertex-associated pfo and a non-vertex associated daughter candidate pfo.

Parameters

pVertexPfo	the address of the vertex-associated pfo
pDaughterPfo	the address of the non-vertex-associated pfo
hitTypeToAssociationMap	the hit type to association map

Returns: the pfo association details

Reimplemented in lar_content::ShowerPfoMopUpAlgorithm.

Definition at line 89 of file VertexBasedPfoMopUpAlgorithm.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetPfoAssociation() [2/2]

VertexBasedPfoMopUpAlgorithm::PfoAssociation lar_content::VertexBasedPfoMopUpAlgorithm::GetPfoAssociation	(	const pandora::Vertex *const	pVertex,
		const pandora::Pfo *const	pVertexPfo,
		const pandora::Pfo *const	pDaughterPfo
	)		const

protected

Get pfo association details between a vertex-associated pfo and a non-vertex associated daughter candidate pfo.

Parameters

pVertex	the address of the 3d vertex
pVertexPfo	the address of the vertex-associated pfo
pDaughterPfo	the address of the non-vertex-associated pfo

Returns: the pfo association details

Definition at line 179 of file VertexBasedPfoMopUpAlgorithm.cc.

Here is the call graph for this function:

◆ GetPfoAssociations()

void lar_content::VertexBasedPfoMopUpAlgorithm::GetPfoAssociations	(	const pandora::Vertex *const	pVertex,
		const pandora::PfoList &	vertexPfos,
		const pandora::PfoList &	nonVertexPfos,
		PfoAssociationList &	pfoAssociationList
	)		const

protected

Get the list of associations between vertex-associated pfos and non-vertex-associated pfos.

Parameters

pVertex	the address of the 3d vertex
vertexPfos	the list of vertex-associated pfos
nonVertexPfos	the list of nonvertex-associated pfos
pfoAssociationList	to receive the pfo association list

Definition at line 158 of file VertexBasedPfoMopUpAlgorithm.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetType()

const std::string & pandora::Process::GetType ( ) const

inlineinherited

Get the type.

Returns: The type

Definition at line 102 of file Process.h.

◆ Initialize()

StatusCode pandora::Process::Initialize ( )

inlineprotectedvirtualinherited

Perform any operations that must occur after reading settings, but before running the process.

Reimplemented in lar_content::BdtBeamParticleIdTool, lar_content::BeamParticleIdTool, lar_content::CosmicRayTaggingTool, lar_content::EventReadingAlgorithm, lar_content::EventWritingAlgorithm, lar_content::LArPseudoLayerPlugin, lar_content::LArRotationalTransformationPlugin, EventReadingAlgorithm, and EventWritingAlgorithm.

Definition at line 126 of file Process.h.

Here is the caller graph for this function:

◆ IsVertexAssociated() [1/2]

bool lar_content::VertexBasedPfoMopUpAlgorithm::IsVertexAssociated	(	const pandora::CartesianVector &	vertex2D,
		const LArPointingCluster &	pointingCluster
	)		const

protectedvirtual

Whether a specified pfo is associated with a specified vertex.

Parameters

vertex2D	the 2d vertex position
pointingCluster	the pointing cluster

Returns: boolean

Reimplemented in lar_content::ShowerPfoMopUpAlgorithm.

Definition at line 81 of file VertexBasedPfoMopUpAlgorithm.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ IsVertexAssociated() [2/2]

bool lar_content::VertexBasedPfoMopUpAlgorithm::IsVertexAssociated	(	const pandora::Pfo *const	pPfo,
		const pandora::Vertex *const	pVertex
	)		const

protected

Whether a specified pfo is associated with a specified vertex.

Parameters

pPfo	the address of the pfo
pVertex	the address of the 3d vertex

Returns: boolean

Definition at line 124 of file VertexBasedPfoMopUpAlgorithm.cc.

Here is the call graph for this function:

◆ MergeAndDeletePfos()

void lar_content::PfoMopUpBaseAlgorithm::MergeAndDeletePfos	(	const pandora::ParticleFlowObject *const	pPfoToEnlarge,
		const pandora::ParticleFlowObject *const	pPfoToDelete
	)		const

virtualinherited

Merge and delete a pair of pfos, with a specific set of conventions for cluster merging, vertex use, etc.

Parameters

pPfoToEnlarge	the address of the pfo to enlarge
pPfoToDelete	the address of the pfo to delete (will become a dangling pointer)

Definition at line 20 of file PfoMopUpBaseAlgorithm.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ MergePfos()

void lar_content::VertexBasedPfoMopUpAlgorithm::MergePfos ( const PfoAssociation & pfoAssociation ) const

protected

Merge the vertex and daughter pfos (deleting daughter pfo, merging clusters, etc.) described in the specified pfoAssociation.

Parameters

pfoAssociation the pfo association details

Definition at line 267 of file VertexBasedPfoMopUpAlgorithm.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ProcessPfoAssociations()

bool lar_content::VertexBasedPfoMopUpAlgorithm::ProcessPfoAssociations ( const PfoAssociationList & pfoAssociationList ) const

protected

Process the list of pfo associations, merging the best-matching pfo.

Parameters

pfoAssociationList the pfo association list

Returns: whether a pfo merge was made

Definition at line 228 of file VertexBasedPfoMopUpAlgorithm.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ReadSettings()

StatusCode lar_content::VertexBasedPfoMopUpAlgorithm::ReadSettings ( const pandora::TiXmlHandle xmlHandle )

protectedvirtual

Read the algorithm settings.

Parameters

xmlHandle the relevant xml handle

Reimplemented from lar_content::PfoMopUpBaseAlgorithm.

Definition at line 508 of file VertexBasedPfoMopUpAlgorithm.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ RegisterDetails()

StatusCode pandora::Process::RegisterDetails	(	const Pandora *const	pPandora,
		const std::string &	type,
		const std::string &	instanceName
	)

inlineprotectedinherited

Register i) the pandora instance that will run the process and ii) the process type.

Parameters

pPandora	address of the pandora object that will run the process
type	the process type
instanceName	the process instance name

Definition at line 146 of file Process.h.

Here is the caller graph for this function:

◆ Reset()

StatusCode pandora::Process::Reset ( )

inlineprotectedvirtualinherited

Perform any operations when pandora is reset, typically at the end of each event.

Reimplemented in lar_content::MasterAlgorithm, lar_content::PostProcessingAlgorithm, and lar_content::PreProcessingAlgorithm.

Definition at line 133 of file Process.h.

Here is the caller graph for this function:

◆ Run()

StatusCode lar_content::VertexBasedPfoMopUpAlgorithm::Run ( )

protectedvirtual

Run the algorithm.

Implements pandora::Algorithm.

Definition at line 45 of file VertexBasedPfoMopUpAlgorithm.cc.

Here is the call graph for this function:

Member Data Documentation

◆ m_coneAngleCentile

float lar_content::VertexBasedPfoMopUpAlgorithm::m_coneAngleCentile

protected

Cluster cone angle is defined using specified centile of distribution of hit half angles.

Definition at line 354 of file VertexBasedPfoMopUpAlgorithm.h.

◆ m_daughterListNames

pandora::StringVector lar_content::MopUpBaseAlgorithm::m_daughterListNames

protectedinherited

The list of potential daughter object list names.

Definition at line 35 of file MopUpBaseAlgorithm.h.

◆ m_directionApexShift

float lar_content::VertexBasedPfoMopUpAlgorithm::m_directionApexShift

protected

Direction determination, look for vertex inside triangle with apex shifted along the cluster length.

Definition at line 359 of file VertexBasedPfoMopUpAlgorithm.h.

◆ m_directionTanAngle

float lar_content::VertexBasedPfoMopUpAlgorithm::m_directionTanAngle

protected

Direction determination, look for vertex inside triangle with apex shifted along the cluster length.

Definition at line 358 of file VertexBasedPfoMopUpAlgorithm.h.

◆ m_instanceName

std::string pandora::Process::m_instanceName

protectedinherited

The process instance name.

Definition at line 89 of file Process.h.

◆ m_maxBoundedFractionCut

float lar_content::VertexBasedPfoMopUpAlgorithm::m_maxBoundedFractionCut

protected

Cut on association info (max bounded fraction) for determining pfo merges.

Definition at line 362 of file VertexBasedPfoMopUpAlgorithm.h.

◆ m_maxConeCosHalfAngle

float lar_content::VertexBasedPfoMopUpAlgorithm::m_maxConeCosHalfAngle

protected

Maximum value for cosine of cone half angle.

Definition at line 355 of file VertexBasedPfoMopUpAlgorithm.h.

◆ m_maxConeLengthMultiplier

float lar_content::VertexBasedPfoMopUpAlgorithm::m_maxConeLengthMultiplier

protected

Consider hits as bound if inside cone, with projected distance less than N times cone length.

Definition at line 356 of file VertexBasedPfoMopUpAlgorithm.h.

◆ m_maxVertexTransverseDistance

float lar_content::VertexBasedPfoMopUpAlgorithm::m_maxVertexTransverseDistance

protected

Vertex association check: max transverse distance cut.

Definition at line 351 of file VertexBasedPfoMopUpAlgorithm.h.

◆ m_meanBoundedFractionCut

float lar_content::VertexBasedPfoMopUpAlgorithm::m_meanBoundedFractionCut

protected

Cut on association info (mean bounded fraction) for determining pfo merges.

Definition at line 361 of file VertexBasedPfoMopUpAlgorithm.h.

◆ m_minBoundedFractionCut

float lar_content::VertexBasedPfoMopUpAlgorithm::m_minBoundedFractionCut

protected

Cut on association info (min bounded fraction) for determining pfo merges.

Definition at line 363 of file VertexBasedPfoMopUpAlgorithm.h.

◆ m_minConsistentDirections

unsigned int lar_content::VertexBasedPfoMopUpAlgorithm::m_minConsistentDirections

protected

The minimum number of consistent cluster directions to allow a pfo merge.

Definition at line 365 of file VertexBasedPfoMopUpAlgorithm.h.

◆ m_minConsistentDirectionsTrack

unsigned int lar_content::VertexBasedPfoMopUpAlgorithm::m_minConsistentDirectionsTrack

protected

The minimum number of consistent cluster directions to allow a merge involving a track pfo.

Definition at line 366 of file VertexBasedPfoMopUpAlgorithm.h.

◆ m_minVertexAssociatedHitTypes

unsigned int lar_content::VertexBasedPfoMopUpAlgorithm::m_minVertexAssociatedHitTypes

protected

The min number of vertex associated hit types for a vertex associated pfo.

Definition at line 352 of file VertexBasedPfoMopUpAlgorithm.h.

◆ m_minVertexLongitudinalDistance

float lar_content::VertexBasedPfoMopUpAlgorithm::m_minVertexLongitudinalDistance

protected

Vertex association check: min longitudinal distance cut.

Definition at line 350 of file VertexBasedPfoMopUpAlgorithm.h.

◆ m_pPandora

const Pandora* pandora::Process::m_pPandora

protectedinherited

The pandora object that will run the process.

Definition at line 87 of file Process.h.

◆ m_showerPfoListName

std::string lar_content::VertexBasedPfoMopUpAlgorithm::m_showerPfoListName

protected

The input shower pfo list name.

Definition at line 348 of file VertexBasedPfoMopUpAlgorithm.h.

◆ m_trackPfoListName

std::string lar_content::VertexBasedPfoMopUpAlgorithm::m_trackPfoListName

protected

The input track pfo list name.

Definition at line 347 of file VertexBasedPfoMopUpAlgorithm.h.

◆ m_type

std::string pandora::Process::m_type

protectedinherited

The process type.

Definition at line 88 of file Process.h.

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

LArContent/larpandoracontent/LArThreeDReco/LArPfoMopUp/VertexBasedPfoMopUpAlgorithm.h
LArContent/larpandoracontent/LArThreeDReco/LArPfoMopUp/VertexBasedPfoMopUpAlgorithm.cc

Classes

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ HitTypeSet

◆ HitTypeToAssociationMap

◆ HitTypeToClusterMap

◆ PfoAssociationList

Constructor & Destructor Documentation

◆ VertexBasedPfoMopUpAlgorithm()

Member Function Documentation

◆ GetClusterAssociation()

◆ GetInputPfos()

◆ GetInstanceName()

◆ GetListName()

◆ GetPandora()

◆ GetParentCluster()

◆ GetPfoAssociation() [1/2]

◆ GetPfoAssociation() [2/2]

◆ GetPfoAssociations()

◆ GetType()

◆ Initialize()

◆ IsVertexAssociated() [1/2]

◆ IsVertexAssociated() [2/2]

◆ MergeAndDeletePfos()

◆ MergePfos()

◆ ProcessPfoAssociations()

◆ ReadSettings()

◆ RegisterDetails()

◆ Reset()

◆ Run()

Member Data Documentation

◆ m_coneAngleCentile

◆ m_daughterListNames

◆ m_directionApexShift

◆ m_directionTanAngle

◆ m_instanceName

◆ m_maxBoundedFractionCut

◆ m_maxConeCosHalfAngle

◆ m_maxConeLengthMultiplier

◆ m_maxVertexTransverseDistance

◆ m_meanBoundedFractionCut

◆ m_minBoundedFractionCut

◆ m_minConsistentDirections

◆ m_minConsistentDirectionsTrack

◆ m_minVertexAssociatedHitTypes

◆ m_minVertexLongitudinalDistance

◆ m_pPandora

◆ m_showerPfoListName

◆ m_trackPfoListName

◆ m_type