ClusterSplittingAlgorithm class. More...

#include "ClusterSplittingAlgorithm.h"

Inheritance diagram for lar_content::ClusterSplittingAlgorithm:

[legend]

Collaboration diagram for lar_content::ClusterSplittingAlgorithm:

[legend]

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

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

pandora::StatusCode	RunUsingCurrentList () const
	Run the algorithm using the current cluster list as input.

virtual pandora::StatusCode	DivideCaloHits (const pandora::Cluster *const pCluster, pandora::CaloHitList &firstCaloHitList, pandora::CaloHitList &secondCaloHitList) const =0
	Divide calo hits in a cluster into two lists, each associated with a separate fragment cluster.

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	SplitCluster (const pandora::Cluster *const pCluster, pandora::ClusterList &clusterSplittingList) const
	Split cluster into two fragments.

Private Attributes
pandora::StringVector	m_inputClusterListNames
	The list of input cluster list names - if empty, use the current cluster list.

Detailed Description

ClusterSplittingAlgorithm class.

Definition at line 21 of file ClusterSplittingAlgorithm.h.

Member Function Documentation

◆ DivideCaloHits()

virtual pandora::StatusCode lar_content::ClusterSplittingAlgorithm::DivideCaloHits	(	const pandora::Cluster *const	pCluster,
		pandora::CaloHitList &	firstCaloHitList,
		pandora::CaloHitList &	secondCaloHitList
	)		const

protectedpure virtual

Divide calo hits in a cluster into two lists, each associated with a separate fragment cluster.

Parameters

pCluster	address of the cluster
firstCaloHitList	the hits in the first fragment
secondCaloHitList	the hits in the second fragment

Implemented in lar_content::LayerSplittingAlgorithm, and lar_content::TwoDSlidingFitSplittingAlgorithm.

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:

◆ ReadSettings()

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

protectedvirtual

Read the algorithm settings.

Parameters

xmlHandle the relevant xml handle

Implements pandora::Process.

Reimplemented in lar_content::KinkSplittingAlgorithm, lar_content::LayerSplittingAlgorithm, lar_content::TwoDSlidingFitSplittingAlgorithm, and lar_content::VertexSplittingAlgorithm.

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

protectedvirtual

Run the algorithm.

Implements pandora::Algorithm.

Definition at line 20 of file ClusterSplittingAlgorithm.cc.

Here is the call graph for this function:

◆ RunUsingCurrentList()

StatusCode lar_content::ClusterSplittingAlgorithm::RunUsingCurrentList ( ) const

protected

Run the algorithm using the current cluster list as input.

Definition at line 52 of file ClusterSplittingAlgorithm.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SplitCluster()

StatusCode lar_content::ClusterSplittingAlgorithm::SplitCluster	(	const pandora::Cluster *const	pCluster,
		pandora::ClusterList &	clusterSplittingList
	)		const

private

Split cluster into two fragments.

Parameters

pCluster	address of the cluster
clusterSplittingList	to receive the two cluster fragments

Definition at line 77 of file ClusterSplittingAlgorithm.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ m_inputClusterListNames

pandora::StringVector lar_content::ClusterSplittingAlgorithm::m_inputClusterListNames

private

The list of input cluster list names - if empty, use the current cluster list.

Definition at line 51 of file ClusterSplittingAlgorithm.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_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/LArClusterSplitting/ClusterSplittingAlgorithm.h
LArContent/larpandoracontent/LArTwoDReco/LArClusterSplitting/ClusterSplittingAlgorithm.cc

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Function Documentation

◆ DivideCaloHits()

◆ GetInstanceName()

◆ GetPandora()

◆ GetType()

◆ Initialize()

◆ ReadSettings()

◆ RegisterDetails()

◆ Reset()

◆ Run()

◆ RunUsingCurrentList()

◆ SplitCluster()

Member Data Documentation

◆ m_inputClusterListNames

◆ m_instanceName

◆ m_pPandora

◆ m_type