ClusteringParentAlgorithm class. More...

#include "ClusteringParentAlgorithm.h"

Inheritance diagram for lar_content::ClusteringParentAlgorithm:

[legend]

Collaboration diagram for lar_content::ClusteringParentAlgorithm:

[legend]

Public Member Functions
	ClusteringParentAlgorithm ()
	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 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	Run ()
	Run the algorithm.

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

Private Attributes
std::string	m_clusteringAlgorithmName
	The name of the clustering algorithm to run.

std::string	m_associationAlgorithmName
	The name of the topological association algorithm to run.

std::string	m_inputCaloHitListName
	The name of the input calo hit list, containing the hits to be clustered.

bool	m_replaceCurrentCaloHitList
	Whether to permanently replace the original calo hit list as the "current" list upon completion.

std::string	m_clusterListName
	The name under which to save the new cluster list.

bool	m_replaceCurrentClusterList
	Whether to subsequently use the new cluster list as the "current" list.

Detailed Description

ClusteringParentAlgorithm class.

Definition at line 19 of file ClusteringParentAlgorithm.h.

Constructor & Destructor Documentation

◆ ClusteringParentAlgorithm()

lar_content::ClusteringParentAlgorithm::ClusteringParentAlgorithm ( )

Default constructor.

Definition at line 18 of file ClusteringParentAlgorithm.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.

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

◆ ReadSettings()

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

privatevirtual

Read the algorithm settings.

Parameters

xmlHandle the relevant xml handle

Implements pandora::Process.

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

privatevirtual

Run the algorithm.

Implements pandora::Algorithm.

Definition at line 24 of file ClusteringParentAlgorithm.cc.

Here is the call graph for this function:

Member Data Documentation

◆ m_associationAlgorithmName

std::string lar_content::ClusteringParentAlgorithm::m_associationAlgorithmName

private

The name of the topological association algorithm to run.

Definition at line 32 of file ClusteringParentAlgorithm.h.

◆ m_clusteringAlgorithmName

std::string lar_content::ClusteringParentAlgorithm::m_clusteringAlgorithmName

private

The name of the clustering algorithm to run.

Definition at line 31 of file ClusteringParentAlgorithm.h.

◆ m_clusterListName

std::string lar_content::ClusteringParentAlgorithm::m_clusterListName

private

The name under which to save the new cluster list.

Definition at line 37 of file ClusteringParentAlgorithm.h.

◆ m_inputCaloHitListName

std::string lar_content::ClusteringParentAlgorithm::m_inputCaloHitListName

private

The name of the input calo hit list, containing the hits to be clustered.

Definition at line 34 of file ClusteringParentAlgorithm.h.

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

bool lar_content::ClusteringParentAlgorithm::m_replaceCurrentCaloHitList

private

Whether to permanently replace the original calo hit list as the "current" list upon completion.

Definition at line 35 of file ClusteringParentAlgorithm.h.

◆ m_replaceCurrentClusterList

bool lar_content::ClusteringParentAlgorithm::m_replaceCurrentClusterList

private

Whether to subsequently use the new cluster list as the "current" list.

Definition at line 38 of file ClusteringParentAlgorithm.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/LArClusterCreation/ClusteringParentAlgorithm.h
LArContent/larpandoracontent/LArTwoDReco/LArClusterCreation/ClusteringParentAlgorithm.cc

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ClusteringParentAlgorithm()

Member Function Documentation

◆ GetInstanceName()

◆ GetPandora()

◆ GetType()

◆ Initialize()

◆ ReadSettings()

◆ RegisterDetails()

◆ Reset()

◆ Run()

Member Data Documentation

◆ m_associationAlgorithmName

◆ m_clusteringAlgorithmName

◆ m_clusterListName

◆ m_inputCaloHitListName

◆ m_instanceName

◆ m_pPandora

◆ m_replaceCurrentCaloHitList

◆ m_replaceCurrentClusterList

◆ m_type