#include "MopUpRemnantsTool.h"

Inheritance diagram for lar_content::MopUpRemnantsTool:

[legend]

Collaboration diagram for lar_content::MopUpRemnantsTool:

[legend]

Public Types
typedef ThreeViewRemnantsAlgorithm::MatchingType::TensorType	TensorType

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

Public Member Functions
	MopUpRemnantsTool ()
	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	FindBestShowers (const TensorType &overlapTensor, ProtoParticleVector &protoParticleVector) const
	Identify candidate particles.

void	GetUsedClusters (const TensorType::ElementList &elementList, pandora::ClusterSet &usedClusters) const
	Copy used clusters into cluster list.

void	SelectBestElement (const TensorType::ElementList &elementList, const pandora::ClusterSet &usedClusters, TensorType::ElementList::const_iterator &bestIter) const
	Select the best triplet of clusters.

Detailed Description

MopUpRemnantsTool class.

Definition at line 19 of file MopUpRemnantsTool.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

◆ MopUpRemnantsTool()

lar_content::MopUpRemnantsTool::MopUpRemnantsTool ( )

Default constructor.

Definition at line 18 of file MopUpRemnantsTool.cc.

Member Function Documentation

◆ FindBestShowers()

void lar_content::MopUpRemnantsTool::FindBestShowers	(	const TensorType &	overlapTensor,
		ProtoParticleVector &	protoParticleVector
	)		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 38 of file MopUpRemnantsTool.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.

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

◆ GetUsedClusters()

void lar_content::MopUpRemnantsTool::GetUsedClusters	(	const TensorType::ElementList &	elementList,
		pandora::ClusterSet &	usedClusters
	)		const

private

Copy used clusters into cluster list.

Parameters

elementList	the input list of elements
usedClusters	to receive the list of used clusters

Definition at line 69 of file MopUpRemnantsTool.cc.

Here is the caller graph for this function:

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

◆ ReadSettings()

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

privatevirtual

Read the algorithm settings.

Parameters

xmlHandle the relevant xml handle

Implements pandora::Process.

Definition at line 107 of file MopUpRemnantsTool.cc.

◆ 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::MopUpRemnantsTool::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 24 of file MopUpRemnantsTool.cc.

Here is the call graph for this function:

◆ SelectBestElement()

void lar_content::MopUpRemnantsTool::SelectBestElement	(	const TensorType::ElementList &	elementList,
		const pandora::ClusterSet &	usedClusters,
		TensorType::ElementList::const_iterator &	bestIter
	)		const

private

Select the best triplet of clusters.

Parameters

elementList	the input list of elements
usedClusters	the list of cluster analysed so far
bestIter	iterator to the best element in the list

Definition at line 81 of file MopUpRemnantsTool.cc.

Here is the call graph for this function:

Here is the caller 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_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/MopUpRemnantsTool.h
LArContent/larpandoracontent/LArThreeDReco/LArShowerFragments/MopUpRemnantsTool.cc

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Member Typedef Documentation

◆ IteratorList

◆ TensorType

Constructor & Destructor Documentation

◆ MopUpRemnantsTool()

Member Function Documentation

◆ FindBestShowers()

◆ GetInstanceName()

◆ GetPandora()

◆ GetType()

◆ GetUsedClusters()

◆ Initialize()

◆ ReadSettings()

◆ RegisterDetails()

◆ Reset()

◆ Run()

◆ SelectBestElement()

Member Data Documentation

◆ m_instanceName

◆ m_pPandora

◆ m_type