#include "ConnectedRemnantsTool.h"

Inheritance diagram for lar_content::ConnectedRemnantsTool:

[legend]

Collaboration diagram for lar_content::ConnectedRemnantsTool:

[legend]

Public Types
typedef ThreeViewRemnantsAlgorithm::MatchingType::TensorType	TensorType

typedef std::vector< TensorType::ElementList::const_iterator >	IteratorList

Public Member Functions
	ConnectedRemnantsTool ()
	Default constructor.

bool	Run (ThreeViewRemnantsAlgorithm *const pAlgorithm, TensorType &overlapTensor)
	Run the algorithm tool.

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 Member Functions
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
pandora::StatusCode	ReadSettings (const pandora::TiXmlHandle xmlHandle)
	Read the algorithm settings.

void	FindConnectedShowers (const TensorType &overlapTensor, ProtoParticleVector &protoParticleVector, ClusterMergeMap &clusterMergeMap) const
	Identify candidate particles.

void	GetClusters (const TensorType::ElementList &connectedElements, const pandora::ClusterSet &usedClusters, pandora::ClusterVector &clusterVectorU, pandora::ClusterVector &clusterVectorV, pandora::ClusterVector &clusterVectorW) const
	Separate connected clusters into cluster lists by view.

void	FillMergeMap (const pandora::Cluster *const pCluster, const pandora::ClusterVector &clusterVector, ClusterMergeMap &clusterMergeMap) const
	Fill map of clusters to be merged.

bool	IsConnected (const pandora::ClusterVector &clusterVector) const
	Check whether all clusters in a list are spatially connected.

Private Attributes
float	m_maxClusterSeparation

Detailed Description

ConnectedRemnantsTool class.

Definition at line 19 of file ConnectedRemnantsTool.h.

Member Typedef Documentation

◆ IteratorList

typedef std::vector<TensorType::ElementList::const_iterator> lar_content::RemnantTensorTool::IteratorList

inherited

Definition at line 63 of file ThreeViewRemnantsAlgorithm.h.

◆ TensorType

typedef ThreeViewRemnantsAlgorithm::MatchingType::TensorType lar_content::RemnantTensorTool::TensorType

inherited

Definition at line 62 of file ThreeViewRemnantsAlgorithm.h.

Constructor & Destructor Documentation

◆ ConnectedRemnantsTool()

lar_content::ConnectedRemnantsTool::ConnectedRemnantsTool ( )

Default constructor.

Definition at line 20 of file ConnectedRemnantsTool.cc.

Member Function Documentation

◆ FillMergeMap()

void lar_content::ConnectedRemnantsTool::FillMergeMap	(	const pandora::Cluster *const	pCluster,
		const pandora::ClusterVector &	clusterVector,
		ClusterMergeMap &	clusterMergeMap
	)		const

private

Fill map of clusters to be merged.

Parameters

clusterVector	the input vector of clusters
clusterMergeMap	the output map of cluster merges

Definition at line 105 of file ConnectedRemnantsTool.cc.

Here is the caller graph for this function:

◆ FindConnectedShowers()

void lar_content::ConnectedRemnantsTool::FindConnectedShowers	(	const TensorType &	overlapTensor,
		ProtoParticleVector &	protoParticleVector,
		ClusterMergeMap &	clusterMergeMap
	)		const

private

Identify candidate particles.

Parameters

overlapTensor	the input overlap tensor
protoParticleVector	the output vector of candidate particles
clusterMergeMap	the output map of clusters to be merged

Definition at line 43 of file ConnectedRemnantsTool.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetClusters()

void lar_content::ConnectedRemnantsTool::GetClusters	(	const TensorType::ElementList &	connectedElements,
		const pandora::ClusterSet &	usedClusters,
		pandora::ClusterVector &	clusterVectorU,
		pandora::ClusterVector &	clusterVectorV,
		pandora::ClusterVector &	clusterVectorW
	)		const

private

Separate connected clusters into cluster lists by view.

Parameters

connectedElements	the input list of connected elements
usedClusters	the list of clusters already analysed
clusterVectorU	the output vector of clusters for the U view
clusterVectorV	the output vector of clusters for the V view
clusterVectorW	the output vector of clusters for the W view

Definition at line 89 of file ConnectedRemnantsTool.cc.

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.

◆ 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:

◆ IsConnected()

bool lar_content::ConnectedRemnantsTool::IsConnected ( const pandora::ClusterVector & clusterVector ) const

private

Check whether all clusters in a list are spatially connected.

Parameters

clusterVector the input cluster vector

Definition at line 124 of file ConnectedRemnantsTool.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ReadSettings()

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

privatevirtual

Read the algorithm settings.

Parameters

xmlHandle the relevant xml handle

Implements pandora::Process.

Definition at line 143 of file ConnectedRemnantsTool.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()

bool lar_content::ConnectedRemnantsTool::Run	(	ThreeViewRemnantsAlgorithm *const	pAlgorithm,
		TensorType &	overlapTensor
	)

virtual

Run the algorithm tool.

Parameters

pAlgorithm	address of the calling algorithm
overlapTensor	the overlap tensor

Returns: whether changes have been made by the tool

Implements lar_content::RemnantTensorTool.

Definition at line 26 of file ConnectedRemnantsTool.cc.

Here is the call graph for this function:

Member Data Documentation

◆ 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::ConnectedRemnantsTool::m_maxClusterSeparation

private

Definition at line 68 of file ConnectedRemnantsTool.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/LArThreeDReco/LArShowerFragments/ConnectedRemnantsTool.h
LArContent/larpandoracontent/LArThreeDReco/LArShowerFragments/ConnectedRemnantsTool.cc

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ IteratorList

◆ TensorType

Constructor & Destructor Documentation

◆ ConnectedRemnantsTool()

Member Function Documentation

◆ FillMergeMap()

◆ FindConnectedShowers()

◆ GetClusters()

◆ GetInstanceName()

◆ GetPandora()

◆ GetType()

◆ Initialize()

◆ IsConnected()

◆ ReadSettings()

◆ RegisterDetails()

◆ Reset()

◆ Run()

Member Data Documentation

◆ m_instanceName

◆ m_maxClusterSeparation

◆ m_pPandora

◆ m_type