#include "ClusterGrowingAlgorithm.h"

Inheritance diagram for lar_content::ClusterGrowingAlgorithm:

[legend]

Collaboration diagram for lar_content::ClusterGrowingAlgorithm:

[legend]

Public Member Functions
	ClusterGrowingAlgorithm ()
	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 *, pandora::ClusterList >	ClusterMergeMap

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

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

virtual void	GetListOfCleanClusters (const pandora::ClusterList *const pClusterList, pandora::ClusterVector &cleanClusters) const =0
	Populate cluster vector with the subset of clusters judged to be clean.

virtual void	GetListOfSeedClusters (const pandora::ClusterVector &cleanClusters, pandora::ClusterVector &seedClusters) const =0
	Select seed clusters for growing.

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
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	GetListOfNonSeedClusters (const pandora::ClusterVector &inputClusters, const pandora::ClusterVector &seedClusters, pandora::ClusterVector &nonSeedClusters) const
	Get List of non-seed clusters.

void	PopulateClusterMergeMap (const pandora::ClusterVector &seedClusters, const pandora::ClusterVector &nonSeedClusters, ClusterMergeMap &clusterMergeMap) const
	Identify a set of cluster merges.

void	MergeClusters (const ClusterMergeMap &clusterMergeMap) const
	Merge clusters.

Private Attributes
std::string	m_inputClusterListName
	The name of the input cluster list. If not specified, will access current list.

float	m_maxClusterSeparation
	Maximum distance at which clusters can be joined.

Detailed Description

ClusterGrowingAlgorithm class.

Definition at line 21 of file ClusterGrowingAlgorithm.h.

Member Typedef Documentation

◆ ClusterMergeMap

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

protected

Definition at line 33 of file ClusterGrowingAlgorithm.h.

Constructor & Destructor Documentation

◆ ClusterGrowingAlgorithm()

lar_content::ClusterGrowingAlgorithm::ClusterGrowingAlgorithm ( )

Default constructor.

Definition at line 20 of file ClusterGrowingAlgorithm.cc.

Member Function Documentation

◆ 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()

virtual void lar_content::ClusterGrowingAlgorithm::GetListOfCleanClusters	(	const pandora::ClusterList *const	pClusterList,
		pandora::ClusterVector &	cleanClusters
	)		const

protectedpure virtual

Populate cluster vector with the subset of clusters judged to be clean.

Parameters

pClusterList	address of the cluster list
cleanClusters	the output vector of clean clusters

Implemented in lar_content::SimpleClusterGrowingAlgorithm, and lar_content::DeltaRayGrowingAlgorithm.

Here is the caller graph for this function:

◆ GetListOfNonSeedClusters()

void lar_content::ClusterGrowingAlgorithm::GetListOfNonSeedClusters	(	const pandora::ClusterVector &	inputClusters,
		const pandora::ClusterVector &	seedClusters,
		pandora::ClusterVector &	nonSeedClusters
	)		const

private

Get List of non-seed clusters.

Parameters

inputClusters	the input vector of clean clusters
seedClusters	the input vector of seed clusters
nonSeedClusters	the output vector of non-seed clusters

Definition at line 72 of file ClusterGrowingAlgorithm.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetListOfSeedClusters()

virtual void lar_content::ClusterGrowingAlgorithm::GetListOfSeedClusters	(	const pandora::ClusterVector &	cleanClusters,
		pandora::ClusterVector &	seedClusters
	)		const

protectedpure virtual

Select seed clusters for growing.

Parameters

cleanClusters	the input vector of clean clusters
seedClusters	the output vector of seed clusters

Implemented in lar_content::SimpleClusterGrowingAlgorithm, and lar_content::DeltaRayGrowingAlgorithm.

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.

◆ 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::ClusterGrowingAlgorithm::MergeClusters ( const ClusterMergeMap & clusterMergeMap ) const

private

Merge clusters.

Parameters

clusterMergeMap the map of clusters to be merged

Definition at line 119 of file ClusterGrowingAlgorithm.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ PopulateClusterMergeMap()

void lar_content::ClusterGrowingAlgorithm::PopulateClusterMergeMap	(	const pandora::ClusterVector &	seedClusters,
		const pandora::ClusterVector &	nonSeedClusters,
		ClusterMergeMap &	clusterMergeMap
	)		const

private

Identify a set of cluster merges.

Parameters

seedClusters	the input vector of seed clusters
nonSeedClusters	the input vector of non-seed clusters
clusterMergeMap	the output map of cluster merges

Definition at line 90 of file ClusterGrowingAlgorithm.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ReadSettings()

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

protectedvirtual

Read the algorithm settings.

Parameters

xmlHandle the relevant xml handle

Implements pandora::Process.

Reimplemented in lar_content::SimpleClusterGrowingAlgorithm, and lar_content::DeltaRayGrowingAlgorithm.

Definition at line 150 of file ClusterGrowingAlgorithm.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::ClusterGrowingAlgorithm::Run ( )

protectedvirtual

Run the algorithm.

Implements pandora::Algorithm.

Definition at line 26 of file ClusterGrowingAlgorithm.cc.

Here is the call graph for this function:

Member Data Documentation

◆ m_inputClusterListName

std::string lar_content::ClusterGrowingAlgorithm::m_inputClusterListName

private

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

Definition at line 79 of file ClusterGrowingAlgorithm.h.

◆ m_instanceName

std::string pandora::Process::m_instanceName

protectedinherited

The process instance name.

Definition at line 89 of file Process.h.

◆ m_maxClusterSeparation

float lar_content::ClusterGrowingAlgorithm::m_maxClusterSeparation

private

Maximum distance at which clusters can be joined.

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

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ ClusterMergeMap

Constructor & Destructor Documentation

◆ ClusterGrowingAlgorithm()

Member Function Documentation

◆ GetInstanceName()

◆ GetListOfCleanClusters()

◆ GetListOfNonSeedClusters()

◆ GetListOfSeedClusters()

◆ GetPandora()

◆ GetType()

◆ Initialize()

◆ MergeClusters()

◆ PopulateClusterMergeMap()

◆ ReadSettings()

◆ RegisterDetails()

◆ Reset()

◆ Run()

Member Data Documentation

◆ m_inputClusterListName

◆ m_instanceName

◆ m_maxClusterSeparation

◆ m_pPandora

◆ m_type