TwoDSlidingFitConsolidationAlgorithm class. More...

#include "TwoDSlidingFitConsolidationAlgorithm.h"

Inheritance diagram for lar_content::TwoDSlidingFitConsolidationAlgorithm:

[legend]

Collaboration diagram for lar_content::TwoDSlidingFitConsolidationAlgorithm:

[legend]

Public Member Functions
	TwoDSlidingFitConsolidationAlgorithm ()
	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 Types
typedef std::unordered_map< const pandora::Cluster *, pandora::CaloHitList >	ClusterToHitMap

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

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

virtual void	GetReclusteredHits (const TwoDSlidingFitResultList &slidingFitResultList, const pandora::ClusterVector &showerClusters, ClusterToHitMap &caloHitsToAdd, ClusterToHitMap &caloHitsToRemove) const =0
	Get the list of hits to be added or removed from clusters.

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
void	SortInputClusters (const pandora::ClusterList *const pClusterList, pandora::ClusterVector &trackClusters, pandora::ClusterVector &showerClusters) const
	Sort input cluster list into track-like clusters and shower-like clusters.

void	BuildSlidingLinearFits (const pandora::ClusterVector &trackClusters, TwoDSlidingFitResultList &slidingFitResultList) const
	Apply sliding linear fits to track clusters.

pandora::StatusCode	RemoveHitsFromClusters (const ClusterToHitMap &clustersToRebuild, pandora::ClusterSet &unavailableClusters) const
	Remove hits from clusters.

pandora::StatusCode	AddHitsToClusters (const ClusterToHitMap &clustersToRebuild, pandora::ClusterSet &unavailableClusters) const
	Add hits to clusters.

pandora::StatusCode	RebuildClusters (const ClusterToHitMap &clustersAtStart, const pandora::ClusterSet &unavailableClusters) const
	Re-build clusters.

Private Attributes
std::string	m_reclusteringAlgorithmName
	Name of daughter algorithm to use for cluster re-building.

float	m_minTrackLength
	Minimum length of track clusters to consolidate.

float	m_maxClusterLength
	Maximum length of shower clusters to use in re-building.

unsigned int	m_halfWindowLayers
	Size of layer window for sliding fit results.

Detailed Description

TwoDSlidingFitConsolidationAlgorithm class.

Definition at line 23 of file TwoDSlidingFitConsolidationAlgorithm.h.

Member Typedef Documentation

◆ ClusterToHitMap

typedef std::unordered_map<const pandora::Cluster *, pandora::CaloHitList> lar_content::TwoDSlidingFitConsolidationAlgorithm::ClusterToHitMap

protected

Definition at line 35 of file TwoDSlidingFitConsolidationAlgorithm.h.

Constructor & Destructor Documentation

◆ TwoDSlidingFitConsolidationAlgorithm()

lar_content::TwoDSlidingFitConsolidationAlgorithm::TwoDSlidingFitConsolidationAlgorithm ( )

Default constructor.

Definition at line 21 of file TwoDSlidingFitConsolidationAlgorithm.cc.

Member Function Documentation

◆ AddHitsToClusters()

StatusCode lar_content::TwoDSlidingFitConsolidationAlgorithm::AddHitsToClusters	(	const ClusterToHitMap &	clustersToRebuild,
		pandora::ClusterSet &	unavailableClusters
	)		const

private

Add hits to clusters.

Parameters

clustersToRebuild	the list of hits to be added to clusters
unavailableClusters	the list of modified clusters

Definition at line 146 of file TwoDSlidingFitConsolidationAlgorithm.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ BuildSlidingLinearFits()

void lar_content::TwoDSlidingFitConsolidationAlgorithm::BuildSlidingLinearFits	(	const pandora::ClusterVector &	trackClusters,
		TwoDSlidingFitResultList &	slidingFitResultList
	)		const

private

Apply sliding linear fits to track clusters.

Parameters

trackClusters	the input vector of track-like clusters
slidingFitResultList	the output list of sliding linear fits

Definition at line 80 of file TwoDSlidingFitConsolidationAlgorithm.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.

◆ GetReclusteredHits()

virtual void lar_content::TwoDSlidingFitConsolidationAlgorithm::GetReclusteredHits	(	const TwoDSlidingFitResultList &	slidingFitResultList,
		const pandora::ClusterVector &	showerClusters,
		ClusterToHitMap &	caloHitsToAdd,
		ClusterToHitMap &	caloHitsToRemove
	)		const

protectedpure virtual

Get the list of hits to be added or removed from clusters.

Parameters

slidingFitResultList	the list of sliding linear fits to track clusters
showerClusters	the vector of shower clusters
caloHitsToAdd	the output map of hits to be added to clusters
caloHitsToRemove	the output map of hits to be removed from clusters

Implemented in lar_content::TrackConsolidationAlgorithm.

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:

◆ ReadSettings()

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

protectedvirtual

Read the algorithm settings.

Parameters

xmlHandle the relevant xml handle

Implements pandora::Process.

Definition at line 221 of file TwoDSlidingFitConsolidationAlgorithm.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ RebuildClusters()

StatusCode lar_content::TwoDSlidingFitConsolidationAlgorithm::RebuildClusters	(	const ClusterToHitMap &	clustersAtStart,
		const pandora::ClusterSet &	unavailableClusters
	)		const

private

Re-build clusters.

Parameters

clustersAtStart	the initial mapping of clusters to hits
unavailableClusters	the list of unavailable clusters

Definition at line 181 of file TwoDSlidingFitConsolidationAlgorithm.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:

◆ RemoveHitsFromClusters()

StatusCode lar_content::TwoDSlidingFitConsolidationAlgorithm::RemoveHitsFromClusters	(	const ClusterToHitMap &	clustersToRebuild,
		pandora::ClusterSet &	unavailableClusters
	)		const

private

Remove hits from clusters.

Parameters

clustersToRebuild	the list of hits to be removed from clusters
unavailableClusters	the list of deleted clusters

Definition at line 101 of file TwoDSlidingFitConsolidationAlgorithm.cc.

Here is the call graph for this function:

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::TwoDSlidingFitConsolidationAlgorithm::Run ( )

protectedvirtual

Run the algorithm.

Implements pandora::Algorithm.

Definition at line 30 of file TwoDSlidingFitConsolidationAlgorithm.cc.

Here is the call graph for this function:

◆ SortInputClusters()

void lar_content::TwoDSlidingFitConsolidationAlgorithm::SortInputClusters	(	const pandora::ClusterList *const	pClusterList,
		pandora::ClusterVector &	trackClusters,
		pandora::ClusterVector &	showerClusters
	)		const

private

Sort input cluster list into track-like clusters and shower-like clusters.

Parameters

pClusterList	the input cluster list
trackClusters	the output vector of track-like clusters
showerClusters	the output vector of shower-like clusters

Definition at line 58 of file TwoDSlidingFitConsolidationAlgorithm.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ m_halfWindowLayers

unsigned int lar_content::TwoDSlidingFitConsolidationAlgorithm::m_halfWindowLayers

private

Size of layer window for sliding fit results.

Definition at line 94 of file TwoDSlidingFitConsolidationAlgorithm.h.

◆ m_instanceName

std::string pandora::Process::m_instanceName

protectedinherited

The process instance name.

Definition at line 89 of file Process.h.

◆ m_maxClusterLength

float lar_content::TwoDSlidingFitConsolidationAlgorithm::m_maxClusterLength

private

Maximum length of shower clusters to use in re-building.

Definition at line 93 of file TwoDSlidingFitConsolidationAlgorithm.h.

◆ m_minTrackLength

float lar_content::TwoDSlidingFitConsolidationAlgorithm::m_minTrackLength

private

Minimum length of track clusters to consolidate.

Definition at line 92 of file TwoDSlidingFitConsolidationAlgorithm.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_reclusteringAlgorithmName

std::string lar_content::TwoDSlidingFitConsolidationAlgorithm::m_reclusteringAlgorithmName

private

Name of daughter algorithm to use for cluster re-building.

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

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ ClusterToHitMap

Constructor & Destructor Documentation

◆ TwoDSlidingFitConsolidationAlgorithm()

Member Function Documentation

◆ AddHitsToClusters()

◆ BuildSlidingLinearFits()

◆ GetInstanceName()

◆ GetPandora()

◆ GetReclusteredHits()

◆ GetType()

◆ Initialize()

◆ ReadSettings()

◆ RebuildClusters()

◆ RegisterDetails()

◆ RemoveHitsFromClusters()

◆ Reset()

◆ Run()

◆ SortInputClusters()

Member Data Documentation

◆ m_halfWindowLayers

◆ m_instanceName

◆ m_maxClusterLength

◆ m_minTrackLength

◆ m_pPandora

◆ m_reclusteringAlgorithmName

◆ m_type