SimpleClusterCreationAlgorithm class. More...

#include "SimpleClusterCreationAlgorithm.h"

Inheritance diagram for lar_content::SimpleClusterCreationAlgorithm:

[legend]

Collaboration diagram for lar_content::SimpleClusterCreationAlgorithm:

[legend]

Public Member Functions
	SimpleClusterCreationAlgorithm ()
	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 Types
typedef std::unordered_map< const pandora::CaloHit *, pandora::CaloHitList >	HitAssociationMap

Private Member Functions
pandora::StatusCode	Run ()
	Run the algorithm.

void	SelectCaloHits (const pandora::CaloHitList *const pInputList, pandora::CaloHitList &outputList) const
	Select calo hits for clustering.

void	BuildAssociationMap (const pandora::CaloHitList &caloHitList, HitAssociationMap &hitAssociationMap) const
	Create map of associations between calo hits.

void	CreateClusters (const pandora::CaloHitList &caloHitList, const HitAssociationMap &hitAssociationMap) const
	Create clusters from selected calo hits and their associations.

void	CollectAssociatedHits (const pandora::CaloHit const pSeedCaloHit, const pandora::CaloHit const pCurrentCaloHit, const HitAssociationMap &hitAssociationMap, const pandora::CaloHitSet &vetoList, pandora::CaloHitList &mergeList) const
	For a given seed calo hits, collect up all the associated calo hits.

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

Private Attributes
float	m_clusteringWindowSquared
	Maximum distance (squared) for two hits to be joined.

Detailed Description

SimpleClusterCreationAlgorithm class.

Definition at line 21 of file SimpleClusterCreationAlgorithm.h.

Member Typedef Documentation

◆ HitAssociationMap

typedef std::unordered_map<const pandora::CaloHit *, pandora::CaloHitList> lar_content::SimpleClusterCreationAlgorithm::HitAssociationMap

private

Definition at line 32 of file SimpleClusterCreationAlgorithm.h.

Constructor & Destructor Documentation

◆ SimpleClusterCreationAlgorithm()

lar_content::SimpleClusterCreationAlgorithm::SimpleClusterCreationAlgorithm ( )

Default constructor.

Definition at line 20 of file SimpleClusterCreationAlgorithm.cc.

Member Function Documentation

◆ BuildAssociationMap()

void lar_content::SimpleClusterCreationAlgorithm::BuildAssociationMap	(	const pandora::CaloHitList &	caloHitList,
		HitAssociationMap &	hitAssociationMap
	)		const

private

Create map of associations between calo hits.

Parameters

caloHitList	The input list of calo hits
hitAssociationMap	The map of associations between calo hits

Definition at line 61 of file SimpleClusterCreationAlgorithm.cc.

Here is the caller graph for this function:

◆ CollectAssociatedHits()

void lar_content::SimpleClusterCreationAlgorithm::CollectAssociatedHits	(	const pandora::CaloHit *const	pSeedCaloHit,
		const pandora::CaloHit *const	pCurrentCaloHit,
		const HitAssociationMap &	hitAssociationMap,
		const pandora::CaloHitSet &	vetoList,
		pandora::CaloHitList &	mergeList
	)		const

private

For a given seed calo hits, collect up all the associated calo hits.

Parameters

pSeedCaloHit	the seed calo hits
pCurrentCaloHit	a possible associated calo hit
hitAssociationMap	the map of associations between hits
vetoList	the list of used calo hits
mergeList	the list of hits associated with the seed hit

Definition at line 118 of file SimpleClusterCreationAlgorithm.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CreateClusters()

void lar_content::SimpleClusterCreationAlgorithm::CreateClusters	(	const pandora::CaloHitList &	caloHitList,
		const HitAssociationMap &	hitAssociationMap
	)		const

private

Create clusters from selected calo hits and their associations.

Parameters

caloHitList	The input list of calo hits
hitAssociationMap	The map of associations between calo hits

Definition at line 88 of file SimpleClusterCreationAlgorithm.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.

◆ 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::SimpleClusterCreationAlgorithm::ReadSettings ( const pandora::TiXmlHandle xmlHandle )

privatevirtual

Read the algorithm settings.

Parameters

xmlHandle the relevant xml handle

Implements pandora::Process.

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

privatevirtual

Run the algorithm.

Implements pandora::Algorithm.

Definition at line 26 of file SimpleClusterCreationAlgorithm.cc.

Here is the call graph for this function:

◆ SelectCaloHits()

void lar_content::SimpleClusterCreationAlgorithm::SelectCaloHits	(	const pandora::CaloHitList *const	pInputList,
		pandora::CaloHitList &	outputList
	)		const

private

Select calo hits for clustering.

Parameters

pInputList	The input list of calo hits
outputList	The output list of selected calo hits

Definition at line 50 of file SimpleClusterCreationAlgorithm.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ m_clusteringWindowSquared

float lar_content::SimpleClusterCreationAlgorithm::m_clusteringWindowSquared

private

Maximum distance (squared) for two hits to be joined.

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

Public Member Functions

Protected Member Functions

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ HitAssociationMap

Constructor & Destructor Documentation

◆ SimpleClusterCreationAlgorithm()

Member Function Documentation

◆ BuildAssociationMap()

◆ CollectAssociatedHits()

◆ CreateClusters()

◆ GetInstanceName()

◆ GetPandora()

◆ GetType()

◆ Initialize()

◆ ReadSettings()

◆ RegisterDetails()

◆ Reset()

◆ Run()

◆ SelectCaloHits()

Member Data Documentation

◆ m_clusteringWindowSquared

◆ m_instanceName

◆ m_pPandora

◆ m_type