ClusterMopUpBaseAlgorithm class. More...

#include "ClusterMopUpBaseAlgorithm.h"

Inheritance diagram for lar_content::ClusterMopUpBaseAlgorithm:

[legend]

Collaboration diagram for lar_content::ClusterMopUpBaseAlgorithm:

[legend]

Public Member Functions
	ClusterMopUpBaseAlgorithm ()
	Default constructor.

template<typename T >
const std::string	GetListName (const T *const pT) const
	Find the name of the list hosting a specific object.

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 *, float >	AssociationDetails

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

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

virtual void	GetPfoClusterLists (pandora::ClusterList &clusterListU, pandora::ClusterList &clusterListV, pandora::ClusterList &clusterListW) const
	Get the two dimensional clusters contained in the input pfo list, divided into three different views.

virtual void	GetDaughterClusterLists (pandora::ClusterList &clusterListU, pandora::ClusterList &clusterListV, pandora::ClusterList &clusterListW) const
	Get the two dimensional clusters contained in the input remant/daughter cluster lists, divided into three different views.

virtual void	GetClusterLists (const pandora::ClusterList &inputClusterList, const bool availabilityFlag, pandora::ClusterList &clusterListU, pandora::ClusterList &clusterListV, pandora::ClusterList &clusterListW) const
	Get the two dimensional clusters contained in an input cluster list, divided into three different views.

virtual void	ClusterMopUp (const pandora::ClusterList &pfoClusters, const pandora::ClusterList &remnantClusters) const =0
	Cluster mop up for a single view. This function is responsible for instructing pandora to make cluster alterations.

virtual void	MakeClusterMerges (const ClusterAssociationMap &clusterAssociationMap) const
	Make the cluster merges specified in the cluster association map, using list name information in the cluster list name map.

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

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
pandora::StringVector	m_pfoListNames
	The list of pfo list names.

bool	m_excludePfosContainingTracks
	Whether to exclude any pfos containing clusters flagged as fixed tracks.

pandora::StringVector	m_daughterListNames
	The list of potential daughter object list names.

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.

Detailed Description

ClusterMopUpBaseAlgorithm class.

Definition at line 22 of file ClusterMopUpBaseAlgorithm.h.

Member Typedef Documentation

◆ AssociationDetails

typedef std::unordered_map<const pandora::Cluster *, float> lar_content::ClusterMopUpBaseAlgorithm::AssociationDetails

protected

Definition at line 71 of file ClusterMopUpBaseAlgorithm.h.

◆ ClusterAssociationMap

typedef std::unordered_map<const pandora::Cluster *, AssociationDetails> lar_content::ClusterMopUpBaseAlgorithm::ClusterAssociationMap

protected

Definition at line 72 of file ClusterMopUpBaseAlgorithm.h.

Constructor & Destructor Documentation

◆ ClusterMopUpBaseAlgorithm()

lar_content::ClusterMopUpBaseAlgorithm::ClusterMopUpBaseAlgorithm ( )

Default constructor.

Definition at line 21 of file ClusterMopUpBaseAlgorithm.cc.

Member Function Documentation

◆ ClusterMopUp()

virtual void lar_content::ClusterMopUpBaseAlgorithm::ClusterMopUp	(	const pandora::ClusterList &	pfoClusters,
		const pandora::ClusterList &	remnantClusters
	)		const

protectedpure virtual

Cluster mop up for a single view. This function is responsible for instructing pandora to make cluster alterations.

Parameters

pfoClusters	the list of pfo clusters
remnantClusters	the list of remnant clusters

Implemented in lar_content::BoundedClusterMopUpAlgorithm, lar_content::ConeClusterMopUpAlgorithm, lar_content::IsolatedClusterMopUpAlgorithm, and lar_content::NearbyClusterMopUpAlgorithm.

Here is the caller graph for this function:

◆ GetClusterLists()

void lar_content::ClusterMopUpBaseAlgorithm::GetClusterLists	(	const pandora::ClusterList &	inputClusterList,
		const bool	availabilityFlag,
		pandora::ClusterList &	clusterListU,
		pandora::ClusterList &	clusterListV,
		pandora::ClusterList &	clusterListW
	)		const

protectedvirtual

Get the two dimensional clusters contained in an input cluster list, divided into three different views.

Parameters

inputClusterList	the input cluster list
availabilityFlag	only clusters with matching availability will be considered
clusterListU	to receive the list of clusters in the u view
clusterListV	to receive the list of clusters in the v view
clusterListW	to receive the list of clusters in the w view

Definition at line 81 of file ClusterMopUpBaseAlgorithm.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetDaughterClusterLists()

void lar_content::ClusterMopUpBaseAlgorithm::GetDaughterClusterLists	(	pandora::ClusterList &	clusterListU,
		pandora::ClusterList &	clusterListV,
		pandora::ClusterList &	clusterListW
	)		const

protectedvirtual

Get the two dimensional clusters contained in the input remant/daughter cluster lists, divided into three different views.

Parameters

clusterListU	to receive the list of clusters in the u view
clusterListV	to receive the list of clusters in the v view
clusterListW	to receive the list of clusters in the w view

Definition at line 66 of file ClusterMopUpBaseAlgorithm.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.

◆ GetListName()

template<typename T >

template const std::string lar_content::MopUpBaseAlgorithm::GetListName ( const T *const pT ) const

inherited

Find the name of the list hosting a specific object.

Parameters

pT	the address of the object

Returns: the name of the list

Definition at line 19 of file MopUpBaseAlgorithm.cc.

Here is the call graph for this function:

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.

◆ GetPfoClusterLists()

void lar_content::ClusterMopUpBaseAlgorithm::GetPfoClusterLists	(	pandora::ClusterList &	clusterListU,
		pandora::ClusterList &	clusterListV,
		pandora::ClusterList &	clusterListW
	)		const

protectedvirtual

Get the two dimensional clusters contained in the input pfo list, divided into three different views.

Parameters

clusterListU	to receive the list of clusters in the u view
clusterListV	to receive the list of clusters in the v view
clusterListW	to receive the list of clusters in the w view

Definition at line 44 of file ClusterMopUpBaseAlgorithm.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:

◆ MakeClusterMerges()

void lar_content::ClusterMopUpBaseAlgorithm::MakeClusterMerges ( const ClusterAssociationMap & clusterAssociationMap ) const

protectedvirtual

Make the cluster merges specified in the cluster association map, using list name information in the cluster list name map.

Parameters

clusterAssociationMap the cluster association map

Definition at line 103 of file ClusterMopUpBaseAlgorithm.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ReadSettings()

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

protectedvirtual

Read the algorithm settings.

Parameters

xmlHandle the relevant xml handle

Reimplemented from lar_content::MopUpBaseAlgorithm.

Reimplemented in lar_content::BoundedClusterMopUpAlgorithm, lar_content::ConeClusterMopUpAlgorithm, lar_content::IsolatedClusterMopUpAlgorithm, and lar_content::NearbyClusterMopUpAlgorithm.

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

protectedvirtual

Run the algorithm.

Implements pandora::Algorithm.

Definition at line 27 of file ClusterMopUpBaseAlgorithm.cc.

Here is the call graph for this function:

Member Data Documentation

◆ m_daughterListNames

pandora::StringVector lar_content::MopUpBaseAlgorithm::m_daughterListNames

protectedinherited

The list of potential daughter object list names.

Definition at line 35 of file MopUpBaseAlgorithm.h.

◆ m_excludePfosContainingTracks

bool lar_content::ClusterMopUpBaseAlgorithm::m_excludePfosContainingTracks

protected

Whether to exclude any pfos containing clusters flagged as fixed tracks.

Definition at line 84 of file ClusterMopUpBaseAlgorithm.h.

◆ m_instanceName

std::string pandora::Process::m_instanceName

protectedinherited

The process instance name.

Definition at line 89 of file Process.h.

◆ m_pfoListNames

pandora::StringVector lar_content::ClusterMopUpBaseAlgorithm::m_pfoListNames

protected

The list of pfo list names.

Definition at line 83 of file ClusterMopUpBaseAlgorithm.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/LArClusterMopUp/ClusterMopUpBaseAlgorithm.h
LArContent/larpandoracontent/LArTwoDReco/LArClusterMopUp/ClusterMopUpBaseAlgorithm.cc

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ AssociationDetails

◆ ClusterAssociationMap

Constructor & Destructor Documentation

◆ ClusterMopUpBaseAlgorithm()

Member Function Documentation

◆ ClusterMopUp()

◆ GetClusterLists()

◆ GetDaughterClusterLists()

◆ GetInstanceName()

◆ GetListName()

◆ GetPandora()

◆ GetPfoClusterLists()

◆ GetType()

◆ Initialize()

◆ MakeClusterMerges()

◆ ReadSettings()

◆ RegisterDetails()

◆ Reset()

◆ Run()

Member Data Documentation

◆ m_daughterListNames

◆ m_excludePfosContainingTracks

◆ m_instanceName

◆ m_pfoListNames

◆ m_pPandora

◆ m_type