DeltaRayExtensionAlgorithm class. More...

#include "DeltaRayExtensionAlgorithm.h"

Inheritance diagram for lar_content::DeltaRayExtensionAlgorithm:

[legend]

Collaboration diagram for lar_content::DeltaRayExtensionAlgorithm:

[legend]

Public Member Functions
	DeltaRayExtensionAlgorithm ()
	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 Types
typedef std::unordered_map< const pandora::Cluster *, pandora::CartesianVector >	ClusterToCoordinateMap

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	GetExtremalCoordinatesFromCache (const pandora::Cluster *const pCluster, ClusterToCoordinateMap &innerCoordinateMap, ClusterToCoordinateMap &outerCoordinateMap, pandora::CartesianVector &innerCoordinate, pandora::CartesianVector &outerCoordinate) const
	Reduce number of extremal coordinates calculations by caching results when they are first obtained.

void	FillClusterAssociationMatrix (const pandora::Cluster const pParentCluster, const pandora::Cluster const pDaughterCluster, ClusterToCoordinateMap &innerCoordinateMap, ClusterToCoordinateMap &outerCoordinateMap, ClusterAssociationMatrix &clusterAssociationMatrix) const
	Form association between two clusters.

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

Private Attributes
float	m_minClusterLength

float	m_maxClusterLength

float	m_maxLongitudinalDisplacement

float	m_maxTransverseDisplacement

Detailed Description

DeltaRayExtensionAlgorithm class.

Definition at line 21 of file DeltaRayExtensionAlgorithm.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.

◆ ClusterToCoordinateMap

typedef std::unordered_map<const pandora::Cluster *, pandora::CartesianVector> lar_content::DeltaRayExtensionAlgorithm::ClusterToCoordinateMap

private

Definition at line 34 of file DeltaRayExtensionAlgorithm.h.

Constructor & Destructor Documentation

◆ DeltaRayExtensionAlgorithm()

lar_content::DeltaRayExtensionAlgorithm::DeltaRayExtensionAlgorithm ( )

Default constructor.

Definition at line 20 of file DeltaRayExtensionAlgorithm.cc.

Member Function Documentation

◆ 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() [1/2]

void lar_content::DeltaRayExtensionAlgorithm::FillClusterAssociationMatrix	(	const pandora::Cluster *const	pParentCluster,
		const pandora::Cluster *const	pDaughterCluster,
		ClusterToCoordinateMap &	innerCoordinateMap,
		ClusterToCoordinateMap &	outerCoordinateMap,
		ClusterAssociationMatrix &	clusterAssociationMatrix
	)		const

private

Form association between two clusters.

Parameters

pParentCluster	the parent cluster
pDaughterCluster	the daughter cluster
innerCoordinateMap	the map from cluster to inner extremal coordinate
outerCoordinateMap	the map from cluster to outer extremal coordinate
clusterAssociationMatrix	the matrix of cluster associations

Definition at line 86 of file DeltaRayExtensionAlgorithm.cc.

Here is the call graph for this function:

◆ FillClusterAssociationMatrix() [2/2]

void lar_content::DeltaRayExtensionAlgorithm::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 47 of file DeltaRayExtensionAlgorithm.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ FillClusterMergeMap()

void lar_content::DeltaRayExtensionAlgorithm::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 177 of file DeltaRayExtensionAlgorithm.cc.

Here is the call graph for this function:

◆ GetExtremalCoordinatesFromCache()

void lar_content::DeltaRayExtensionAlgorithm::GetExtremalCoordinatesFromCache	(	const pandora::Cluster *const	pCluster,
		ClusterToCoordinateMap &	innerCoordinateMap,
		ClusterToCoordinateMap &	outerCoordinateMap,
		pandora::CartesianVector &	innerCoordinate,
		pandora::CartesianVector &	outerCoordinate
	)		const

private

Reduce number of extremal coordinates calculations by caching results when they are first obtained.

Parameters

pParentCluster	the cluster
innerCoordinateMap	the map from cluster to inner extremal coordinate
outerCoordinateMap	the map from cluster to outer extremal coordinate
innerCoordinate	to receive the inner coordinate
outerCoordinate	to receive the outer coordinate

Definition at line 65 of file DeltaRayExtensionAlgorithm.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.

◆ GetListOfCleanClusters()

void lar_content::DeltaRayExtensionAlgorithm::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 30 of file DeltaRayExtensionAlgorithm.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:

◆ 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::DeltaRayExtensionAlgorithm::ReadSettings ( const pandora::TiXmlHandle xmlHandle )

privatevirtual

Read the algorithm settings.

Parameters

xmlHandle the relevant xml handle

Reimplemented from lar_content::ClusterMergingAlgorithm.

Definition at line 392 of file DeltaRayExtensionAlgorithm.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_maxClusterLength

float lar_content::DeltaRayExtensionAlgorithm::m_maxClusterLength

private

Definition at line 63 of file DeltaRayExtensionAlgorithm.h.

◆ m_maxLongitudinalDisplacement

float lar_content::DeltaRayExtensionAlgorithm::m_maxLongitudinalDisplacement

private

Definition at line 65 of file DeltaRayExtensionAlgorithm.h.

◆ m_maxTransverseDisplacement

float lar_content::DeltaRayExtensionAlgorithm::m_maxTransverseDisplacement

private

Definition at line 66 of file DeltaRayExtensionAlgorithm.h.

◆ m_minClusterLength

float lar_content::DeltaRayExtensionAlgorithm::m_minClusterLength

private

Definition at line 62 of file DeltaRayExtensionAlgorithm.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/LArCosmicRay/DeltaRayExtensionAlgorithm.h
LArContent/larpandoracontent/LArTwoDReco/LArCosmicRay/DeltaRayExtensionAlgorithm.cc

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ ClusterAssociationMap

◆ ClusterAssociationMatrix

◆ ClusterMergeMap

◆ ClusterToCoordinateMap

Constructor & Destructor Documentation

◆ DeltaRayExtensionAlgorithm()

Member Function Documentation

◆ CollectAssociatedClusters() [1/2]

◆ CollectAssociatedClusters() [2/2]

◆ FillClusterAssociationMatrix() [1/2]

◆ FillClusterAssociationMatrix() [2/2]

◆ FillClusterMergeMap()

◆ GetExtremalCoordinatesFromCache()

◆ GetInstanceName()

◆ GetListOfCleanClusters()

◆ GetPandora()

◆ GetSortedListOfCleanClusters()

◆ GetType()

◆ Initialize()

◆ MergeClusters()

◆ PopulateClusterMergeMap()

◆ ReadSettings()

◆ RegisterDetails()

◆ Reset()

◆ Run()

Member Data Documentation

◆ m_inputClusterListName

◆ m_instanceName

◆ m_maxClusterLength

◆ m_maxLongitudinalDisplacement

◆ m_maxTransverseDisplacement

◆ m_minClusterLength

◆ m_pPandora

◆ m_type