CrossGapsExtensionAlgorithm class. More...

#include "CrossGapsExtensionAlgorithm.h"

Inheritance diagram for lar_content::CrossGapsExtensionAlgorithm:

[legend]

Collaboration diagram for lar_content::CrossGapsExtensionAlgorithm:

[legend]

Public Member Functions
	CrossGapsExtensionAlgorithm ()
	Default constructor.

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.

Protected Types
typedef std::unordered_map< const pandora::Cluster *, ClusterAssociation >	ClusterAssociationMap

typedef std::unordered_map< const pandora::Cluster *, ClusterAssociationMap >	ClusterAssociationMatrix

typedef std::unordered_map< const pandora::Cluster *, pandora::ClusterList >	ClusterMergeMap

Protected Member Functions
void	PopulateClusterMergeMap (const pandora::ClusterVector &clusterVector, ClusterMergeMap &clusterMergeMatrix) const
	Form associations between pointing clusters.

virtual pandora::StatusCode	Run ()
	Run the algorithm.

void	MergeClusters (pandora::ClusterVector &clusterVector, ClusterMergeMap &clusterMergeMap) const
	Merge associated clusters.

void	CollectAssociatedClusters (const pandora::Cluster *const pSeedCluster, const ClusterMergeMap &clusterMergeMap, pandora::ClusterList &associatedClusterList) const
	Collect up all clusters associations related to a given seed cluster.

void	CollectAssociatedClusters (const pandora::Cluster const pSeedCluster, const pandora::Cluster const pCurrentCluster, const ClusterMergeMap &clusterMergeMap, const pandora::ClusterSet &clusterVetoList, pandora::ClusterList &associatedClusterList) const
	Collect up all clusters associations related to a given seed cluster.

void	GetSortedListOfCleanClusters (const pandora::ClusterVector &inputClusters, pandora::ClusterVector &outputClusters) const
	Sort the selected clusters, so that they have a well-defined ordering.

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_inputClusterListName
	The name of the input cluster list. If not specified, will access current list.

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.

Private Member Functions
void	GetListOfCleanClusters (const pandora::ClusterList *const pClusterList, pandora::ClusterVector &clusterVector) const
	Populate cluster vector with subset of cluster list, containing clusters judged to be clean.

void	FillClusterAssociationMatrix (const pandora::ClusterVector &clusterVector, ClusterAssociationMatrix &clusterAssociationMatrix) const
	Fill the cluster association matrix.

void	FillClusterMergeMap (const ClusterAssociationMatrix &clusterAssociationMatrix, ClusterMergeMap &clusterMergeMap) const
	Fill the cluster merge map.

void	BuildPointingClusterList (const pandora::ClusterVector &clusterVector, LArPointingClusterList &innerPointingClusterList, LArPointingClusterList &outerPointingClusterList) const
	Build lists of pointing clusters that are adjacent to a detector gap.

void	BuildPointingClusterList (const bool useInner, const LArPointingClusterList &inputPointingClusterList, LArPointingClusterList &outputPointingClusterList) const
	Build a list of pointing clusters that are adjacent to a detector gap.

bool	IsAssociated (const LArPointingCluster::Vertex &pointingVertex1, const LArPointingCluster::Vertex &pointingVertex2) const
	Use pointing information to determine whether two clusters are associated.

bool	IsAcrossGap (const float minZ, const float maxZ, const pandora::HitType hitType) const
	Determine whether a start and end position sit either side of a gap.

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

Private Attributes
float	m_minClusterLength

float	m_minGapFraction

float	m_maxGapTolerance

float	m_maxTransverseDisplacement

float	m_maxRelativeAngle

Detailed Description

CrossGapsExtensionAlgorithm class.

Definition at line 21 of file CrossGapsExtensionAlgorithm.h.

Member Typedef Documentation

◆ ClusterAssociationMap

typedef std::unordered_map<const pandora::Cluster *, ClusterAssociation> lar_content::ClusterExtensionAlgorithm::ClusterAssociationMap

protectedinherited

Definition at line 97 of file ClusterExtensionAlgorithm.h.

◆ ClusterAssociationMatrix

typedef std::unordered_map<const pandora::Cluster *, ClusterAssociationMap> lar_content::ClusterExtensionAlgorithm::ClusterAssociationMatrix

protectedinherited

Definition at line 98 of file ClusterExtensionAlgorithm.h.

◆ ClusterMergeMap

typedef std::unordered_map<const pandora::Cluster *, pandora::ClusterList> lar_content::ClusterMergingAlgorithm::ClusterMergeMap

protectedinherited

Definition at line 27 of file ClusterMergingAlgorithm.h.

Constructor & Destructor Documentation

◆ CrossGapsExtensionAlgorithm()

lar_content::CrossGapsExtensionAlgorithm::CrossGapsExtensionAlgorithm ( )

Default constructor.

Definition at line 22 of file CrossGapsExtensionAlgorithm.cc.

Member Function Documentation

◆ BuildPointingClusterList() [1/2]

void lar_content::CrossGapsExtensionAlgorithm::BuildPointingClusterList	(	const bool	useInner,
		const LArPointingClusterList &	inputPointingClusterList,
		LArPointingClusterList &	outputPointingClusterList
	)		const

private

Build a list of pointing clusters that are adjacent to a detector gap.

Parameters

useInner	check the inner vertex
inputPointingClusterList	the input list of pointing clusters
outputPointingClusterList	the output list of pointing clusters

Definition at line 115 of file CrossGapsExtensionAlgorithm.cc.

Here is the call graph for this function:

◆ BuildPointingClusterList() [2/2]

void lar_content::CrossGapsExtensionAlgorithm::BuildPointingClusterList	(	const pandora::ClusterVector &	clusterVector,
		LArPointingClusterList &	innerPointingClusterList,
		LArPointingClusterList &	outerPointingClusterList
	)		const

private

Build lists of pointing clusters that are adjacent to a detector gap.

Parameters

clusterVector	the input vector of clusters
innerPointingClusterList	the pointing clusters whose inner vertex is close to a detector gap
outerPointingClusterList	the pointing clusters whose outer vertex is close to a detector gap

Definition at line 91 of file CrossGapsExtensionAlgorithm.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CollectAssociatedClusters() [1/2]

void lar_content::ClusterMergingAlgorithm::CollectAssociatedClusters	(	const pandora::Cluster *const	pSeedCluster,
		const ClusterMergeMap &	clusterMergeMap,
		pandora::ClusterList &	associatedClusterList
	)		const

protectedinherited

Collect up all clusters associations related to a given seed cluster.

Parameters

pSeedCluster	pointer to the initial cluster
clusterMergeMap	the map of cluster associations
associatedClusterList	the output list of associated clusters

Definition at line 97 of file ClusterMergingAlgorithm.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CollectAssociatedClusters() [2/2]

void lar_content::ClusterMergingAlgorithm::CollectAssociatedClusters	(	const pandora::Cluster *const	pSeedCluster,
		const pandora::Cluster *const	pCurrentCluster,
		const ClusterMergeMap &	clusterMergeMap,
		const pandora::ClusterSet &	clusterVetoList,
		pandora::ClusterList &	associatedClusterList
	)		const

protectedinherited

Collect up all clusters associations related to a given seed cluster.

Parameters

pSeedCluster	pointer to the initial cluster
pCurrentCluster	pointer to the current cluster
clusterMergeMap	the map of cluster associations
clusterVetoList	the list of clusters that have already been merged
associatedClusterList	the output list of associated clusters

Definition at line 106 of file ClusterMergingAlgorithm.cc.

Here is the call graph for this function:

◆ FillClusterAssociationMatrix()

void lar_content::CrossGapsExtensionAlgorithm::FillClusterAssociationMatrix	(	const pandora::ClusterVector &	clusterVector,
		ClusterAssociationMatrix &	clusterAssociationMatrix
	)		const

privatevirtual

Fill the cluster association matrix.

Parameters

clusterVector	the input vector of clusters
clusterAssociationMatrix	the matrix of associations

Implements lar_content::ClusterExtensionAlgorithm.

Definition at line 52 of file CrossGapsExtensionAlgorithm.cc.

Here is the call graph for this function:

◆ FillClusterMergeMap()

void lar_content::CrossGapsExtensionAlgorithm::FillClusterMergeMap	(	const ClusterAssociationMatrix &	clusterAssociationMatrix,
		ClusterMergeMap &	clusterMergeMap
	)		const

privatevirtual

Fill the cluster merge map.

Parameters

clusterAssociationMatrix	the matrix of cluster associations
clusterMergeMap	the map of cluster merges

Implements lar_content::ClusterExtensionAlgorithm.

Definition at line 159 of file CrossGapsExtensionAlgorithm.cc.

Here is the call 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.

◆ GetListOfCleanClusters()

void lar_content::CrossGapsExtensionAlgorithm::GetListOfCleanClusters	(	const pandora::ClusterList *const	pClusterList,
		pandora::ClusterVector &	clusterVector
	)		const

privatevirtual

Populate cluster vector with subset of cluster list, containing clusters judged to be clean.

Parameters

pClusterList	address of the cluster list
clusterVector	to receive the populated cluster vector

Implements lar_content::ClusterMergingAlgorithm.

Definition at line 33 of file CrossGapsExtensionAlgorithm.cc.

Here is the call 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.

◆ GetSortedListOfCleanClusters()

void lar_content::ClusterMergingAlgorithm::GetSortedListOfCleanClusters	(	const pandora::ClusterVector &	inputClusters,
		pandora::ClusterVector &	outputClusters
	)		const

protectedinherited

Sort the selected clusters, so that they have a well-defined ordering.

Parameters

inputClusters	the input vector of clusters
outputClusters	the output vector of clusters

Definition at line 135 of file ClusterMergingAlgorithm.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:

◆ IsAcrossGap()

bool lar_content::CrossGapsExtensionAlgorithm::IsAcrossGap	(	const float	minZ,
		const float	maxZ,
		const pandora::HitType	hitType
	)		const

private

Determine whether a start and end position sit either side of a gap.

Parameters

minZ	the start position
maxZ	the end position
hitType	the hitType

Definition at line 144 of file CrossGapsExtensionAlgorithm.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ IsAssociated()

bool lar_content::CrossGapsExtensionAlgorithm::IsAssociated	(	const LArPointingCluster::Vertex &	pointingVertex1,
		const LArPointingCluster::Vertex &	pointingVertex2
	)		const

private

Use pointing information to determine whether two clusters are associated.

Parameters

pointingVertex1	the first pointing vertex
pointingVertex2	the second pointing vertex

Definition at line 130 of file CrossGapsExtensionAlgorithm.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ MergeClusters()

void lar_content::ClusterMergingAlgorithm::MergeClusters	(	pandora::ClusterVector &	clusterVector,
		ClusterMergeMap &	clusterMergeMap
	)		const

protectedinherited

Merge associated clusters.

Parameters

clusterVector	the vector of clean clusters
clusterMergeMap	the matrix of cluster associations

Definition at line 62 of file ClusterMergingAlgorithm.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ PopulateClusterMergeMap()

void lar_content::ClusterExtensionAlgorithm::PopulateClusterMergeMap	(	const pandora::ClusterVector &	clusterVector,
		ClusterMergeMap &	clusterMergeMap
	)		const

protectedvirtualinherited

Form associations between pointing clusters.

Parameters

clusterVector	the vector of clean clusters
clusterMergeMap	the matrix of cluster associations

Implements lar_content::ClusterMergingAlgorithm.

Definition at line 18 of file ClusterExtensionAlgorithm.cc.

Here is the call graph for this function:

◆ ReadSettings()

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

privatevirtual

Read the algorithm settings.

Parameters

xmlHandle the relevant xml handle

Reimplemented from lar_content::ClusterMergingAlgorithm.

Definition at line 331 of file CrossGapsExtensionAlgorithm.cc.

Here is the call 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::ClusterMergingAlgorithm::Run ( )

protectedvirtualinherited

Run the algorithm.

Implements pandora::Algorithm.

Definition at line 20 of file ClusterMergingAlgorithm.cc.

Here is the call graph for this function:

Member Data Documentation

◆ m_inputClusterListName

std::string lar_content::ClusterMergingAlgorithm::m_inputClusterListName

protectedinherited

The name of the input cluster list. If not specified, will access current list.

Definition at line 83 of file ClusterMergingAlgorithm.h.

◆ m_instanceName

std::string pandora::Process::m_instanceName

protectedinherited

The process instance name.

Definition at line 89 of file Process.h.

◆ m_maxGapTolerance

float lar_content::CrossGapsExtensionAlgorithm::m_maxGapTolerance

private

Definition at line 75 of file CrossGapsExtensionAlgorithm.h.

◆ m_maxRelativeAngle

float lar_content::CrossGapsExtensionAlgorithm::m_maxRelativeAngle

private

Definition at line 77 of file CrossGapsExtensionAlgorithm.h.

◆ m_maxTransverseDisplacement

float lar_content::CrossGapsExtensionAlgorithm::m_maxTransverseDisplacement

private

Definition at line 76 of file CrossGapsExtensionAlgorithm.h.

◆ m_minClusterLength

float lar_content::CrossGapsExtensionAlgorithm::m_minClusterLength

private

Definition at line 73 of file CrossGapsExtensionAlgorithm.h.

◆ m_minGapFraction

float lar_content::CrossGapsExtensionAlgorithm::m_minGapFraction

private

Definition at line 74 of file CrossGapsExtensionAlgorithm.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_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/LArTwoDReco/LArClusterAssociation/CrossGapsExtensionAlgorithm.h
LArContent/larpandoracontent/LArTwoDReco/LArClusterAssociation/CrossGapsExtensionAlgorithm.cc

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ ClusterAssociationMap

◆ ClusterAssociationMatrix

◆ ClusterMergeMap

Constructor & Destructor Documentation

◆ CrossGapsExtensionAlgorithm()

Member Function Documentation

◆ BuildPointingClusterList() [1/2]

◆ BuildPointingClusterList() [2/2]

◆ CollectAssociatedClusters() [1/2]

◆ CollectAssociatedClusters() [2/2]

◆ FillClusterAssociationMatrix()

◆ FillClusterMergeMap()

◆ GetInstanceName()

◆ GetListOfCleanClusters()

◆ GetPandora()

◆ GetSortedListOfCleanClusters()

◆ GetType()

◆ Initialize()

◆ IsAcrossGap()

◆ IsAssociated()

◆ MergeClusters()

◆ PopulateClusterMergeMap()

◆ ReadSettings()

◆ RegisterDetails()

◆ Reset()

◆ Run()

Member Data Documentation

◆ m_inputClusterListName

◆ m_instanceName

◆ m_maxGapTolerance

◆ m_maxRelativeAngle

◆ m_maxTransverseDisplacement

◆ m_minClusterLength

◆ m_minGapFraction

◆ m_pPandora

◆ m_type