OvershootSplittingAlgorithm class. More...

#include "OvershootSplittingAlgorithm.h"

Inheritance diagram for lar_content::OvershootSplittingAlgorithm:

[legend]

Collaboration diagram for lar_content::OvershootSplittingAlgorithm:

[legend]

Public Member Functions
	OvershootSplittingAlgorithm ()
	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::CartesianPointVector >	ClusterPositionMap

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::pair< float, pandora::CartesianVector >	MyTrajectoryPoint

typedef std::vector< MyTrajectoryPoint >	MyTrajectoryPointList

Private Member Functions
void	GetListOfCleanClusters (const pandora::ClusterList *const pClusterList, pandora::ClusterVector &clusterVector) const
	Populate cluster vector with subset of cluster list, containing clusters judged to be clean.

void	FindBestSplitPositions (const TwoDSlidingFitResultMap &slidingFitResultMap, ClusterPositionMap &clusterSplittingMap) const
	Determine best split positions based on sliding fit result.

void	BuildIntersectionMap (const TwoDSlidingFitResultMap &slidingFitResultMap, ClusterPositionMap &clusterIntersectionMap) const
	Use sliding fit results to calculate intersections of clusters.

void	BuildSortedIntersectionMap (const TwoDSlidingFitResultMap &slidingFitResultMap, const ClusterPositionMap &clusterIntersectionMap, ClusterPositionMap &sortedIntersectionMap) const
	Use intersection points to decide on splitting points.

void	PopulateSplitPositionMap (const ClusterPositionMap &sortedIntersectionMap, ClusterPositionMap &clusterSplittingMap) const
	Select split positions from sorted list of candidate positions.

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

pandora::StatusCode	Run ()
	Run the algorithm.

void	BuildSlidingFitResultMap (const pandora::ClusterVector &clusterVector, const unsigned int halfWindowLayers, TwoDSlidingFitResultMap &slidingFitResultMap) const
	Build the map of sliding fit results.

pandora::StatusCode	SplitClusters (const TwoDSlidingFitResultMap &slidingFitResultMap, const ClusterPositionMap &clusterSplittingMap) const
	Split clusters.

pandora::StatusCode	SplitCluster (const TwoDSlidingFitResult &slidingFitResult, const pandora::CartesianPointVector &splitPositionList) const
	Split cluster.

Static Private Member Functions
static bool	SortByHitProjection (const MyTrajectoryPoint &lhs, const MyTrajectoryPoint &rhs)
	Sort pfos by number of constituent hits.

Private Attributes
float	m_minClusterLength

float	m_maxClusterSeparation

float	m_minVertexDisplacement

float	m_maxIntersectDisplacement

float	m_minSplitDisplacement

unsigned int	m_slidingFitHalfWindow

std::string	m_inputClusterList

Detailed Description

OvershootSplittingAlgorithm class.

Definition at line 19 of file OvershootSplittingAlgorithm.h.

Member Typedef Documentation

◆ ClusterPositionMap

typedef std::unordered_map<const pandora::Cluster *, pandora::CartesianPointVector> lar_content::TwoDSlidingFitMultiSplitAlgorithm::ClusterPositionMap

protectedinherited

Definition at line 30 of file TwoDSlidingFitMultiSplitAlgorithm.h.

◆ MyTrajectoryPoint

typedef std::pair<float, pandora::CartesianVector> lar_content::OvershootSplittingAlgorithm::MyTrajectoryPoint

private

Definition at line 31 of file OvershootSplittingAlgorithm.h.

◆ MyTrajectoryPointList

typedef std::vector<MyTrajectoryPoint> lar_content::OvershootSplittingAlgorithm::MyTrajectoryPointList

private

Definition at line 32 of file OvershootSplittingAlgorithm.h.

Constructor & Destructor Documentation

◆ OvershootSplittingAlgorithm()

lar_content::OvershootSplittingAlgorithm::OvershootSplittingAlgorithm ( )

Default constructor.

Definition at line 23 of file OvershootSplittingAlgorithm.cc.

Member Function Documentation

◆ BuildIntersectionMap()

void lar_content::OvershootSplittingAlgorithm::BuildIntersectionMap	(	const TwoDSlidingFitResultMap &	slidingFitResultMap,
		ClusterPositionMap &	clusterIntersectionMap
	)		const

private

Use sliding fit results to calculate intersections of clusters.

Parameters

slidingFitResultMap	the sliding fit result map
clusterIntersectionMap	the map of cluster intersection points

Definition at line 68 of file OvershootSplittingAlgorithm.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ BuildSlidingFitResultMap()

void lar_content::TwoDSlidingFitMultiSplitAlgorithm::BuildSlidingFitResultMap	(	const pandora::ClusterVector &	clusterVector,
		const unsigned int	halfWindowLayers,
		TwoDSlidingFitResultMap &	slidingFitResultMap
	)		const

privateinherited

Build the map of sliding fit results.

Parameters

clusterVector	the vector of selected clusters
halfWindowLayers	the half-window to use for the sliding fits
slidingFitResultMap	the sliding fit result map

Definition at line 72 of file TwoDSlidingFitMultiSplitAlgorithm.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ BuildSortedIntersectionMap()

void lar_content::OvershootSplittingAlgorithm::BuildSortedIntersectionMap	(	const TwoDSlidingFitResultMap &	slidingFitResultMap,
		const ClusterPositionMap &	clusterIntersectionMap,
		ClusterPositionMap &	sortedIntersectionMap
	)		const

private

Use intersection points to decide on splitting points.

Parameters

slidingFitResultMap	the sliding fit result map
clusterIntersectionMap	the input map of cluster intersection points
sortedIntersectionMap	the output map of sorted cluster intersection points

Definition at line 175 of file OvershootSplittingAlgorithm.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ FindBestSplitPositions()

void lar_content::OvershootSplittingAlgorithm::FindBestSplitPositions	(	const TwoDSlidingFitResultMap &	slidingFitResultMap,
		ClusterPositionMap &	clusterSplittingMap
	)		const

privatevirtual

Determine best split positions based on sliding fit result.

Parameters

slidingFitResultMap	mapping from clusters to sliding fit results
clusterSplittingMap	mapping from clusters to split positions

Implements lar_content::TwoDSlidingFitMultiSplitAlgorithm.

Definition at line 52 of file OvershootSplittingAlgorithm.cc.

Here is the call 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.

◆ GetListOfCleanClusters()

void lar_content::OvershootSplittingAlgorithm::GetListOfCleanClusters	(	const pandora::ClusterList *const	pClusterList,
		pandora::ClusterVector &	clusterVector
	)		const

privatevirtual

Populate cluster vector with subset of cluster list, containing clusters judged to be clean.

Parameters

pClusterList	address of the cluster list
clusterVector	to receive the populated cluster vector

Implements lar_content::TwoDSlidingFitMultiSplitAlgorithm.

Definition at line 35 of file OvershootSplittingAlgorithm.cc.

Here is the call 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.

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

◆ PopulateSplitPositionMap()

void lar_content::OvershootSplittingAlgorithm::PopulateSplitPositionMap	(	const ClusterPositionMap &	sortedIntersectionMap,
		ClusterPositionMap &	clusterSplittingMap
	)		const

private

Select split positions from sorted list of candidate positions.

Parameters

sortedIntersectionMap	the input map of candidate split positions
clusterSplittingMap	the output map of selected split positions

Definition at line 220 of file OvershootSplittingAlgorithm.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ReadSettings()

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

privatevirtual

Read the algorithm settings.

Parameters

xmlHandle the relevant xml handle

Implements pandora::Process.

Definition at line 296 of file OvershootSplittingAlgorithm.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::TwoDSlidingFitMultiSplitAlgorithm::Run ( )

privatevirtualinherited

Run the algorithm.

Implements pandora::Algorithm.

Definition at line 27 of file TwoDSlidingFitMultiSplitAlgorithm.cc.

Here is the call graph for this function:

◆ SortByHitProjection()

bool lar_content::OvershootSplittingAlgorithm::SortByHitProjection	(	const MyTrajectoryPoint &	lhs,
		const MyTrajectoryPoint &	rhs
	)

staticprivate

Sort pfos by number of constituent hits.

Parameters

pLhs	address of first pfo
pRhs	address of second pfo

Definition at line 286 of file OvershootSplittingAlgorithm.cc.

Here is the caller graph for this function:

◆ SplitCluster()

StatusCode lar_content::TwoDSlidingFitMultiSplitAlgorithm::SplitCluster	(	const TwoDSlidingFitResult &	slidingFitResult,
		const pandora::CartesianPointVector &	splitPositionList
	)		const

privateinherited

Split cluster.

Parameters

slidingFitResult	input sliding fit result
splitPositionList	vector of split positions

Definition at line 131 of file TwoDSlidingFitMultiSplitAlgorithm.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SplitClusters()

StatusCode lar_content::TwoDSlidingFitMultiSplitAlgorithm::SplitClusters	(	const TwoDSlidingFitResultMap &	slidingFitResultMap,
		const ClusterPositionMap &	clusterSplittingMap
	)		const

privateinherited

Split clusters.

Parameters

slidingFitResultMap	mapping from clusters to sliding fit results
clusterSplittingMap	mapping from clusters to split positions

Definition at line 99 of file TwoDSlidingFitMultiSplitAlgorithm.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ m_inputClusterList

std::string lar_content::TwoDSlidingFitMultiSplitAlgorithm::m_inputClusterList

privateinherited

Definition at line 80 of file TwoDSlidingFitMultiSplitAlgorithm.h.

◆ m_instanceName

std::string pandora::Process::m_instanceName

protectedinherited

The process instance name.

Definition at line 89 of file Process.h.

◆ m_maxClusterSeparation

float lar_content::OvershootSplittingAlgorithm::m_maxClusterSeparation

private

Definition at line 71 of file OvershootSplittingAlgorithm.h.

◆ m_maxIntersectDisplacement

float lar_content::OvershootSplittingAlgorithm::m_maxIntersectDisplacement

private

Definition at line 73 of file OvershootSplittingAlgorithm.h.

◆ m_minClusterLength

float lar_content::OvershootSplittingAlgorithm::m_minClusterLength

private

Definition at line 70 of file OvershootSplittingAlgorithm.h.

◆ m_minSplitDisplacement

float lar_content::OvershootSplittingAlgorithm::m_minSplitDisplacement

private

Definition at line 74 of file OvershootSplittingAlgorithm.h.

◆ m_minVertexDisplacement

float lar_content::OvershootSplittingAlgorithm::m_minVertexDisplacement

private

Definition at line 72 of file OvershootSplittingAlgorithm.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_slidingFitHalfWindow

unsigned int lar_content::TwoDSlidingFitMultiSplitAlgorithm::m_slidingFitHalfWindow

privateinherited

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

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Private Types

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ ClusterPositionMap

◆ MyTrajectoryPoint

◆ MyTrajectoryPointList

Constructor & Destructor Documentation

◆ OvershootSplittingAlgorithm()

Member Function Documentation

◆ BuildIntersectionMap()

◆ BuildSlidingFitResultMap()

◆ BuildSortedIntersectionMap()

◆ FindBestSplitPositions()

◆ GetInstanceName()

◆ GetListOfCleanClusters()

◆ GetPandora()

◆ GetType()

◆ Initialize()

◆ PopulateSplitPositionMap()

◆ ReadSettings()

◆ RegisterDetails()

◆ Reset()

◆ Run()

◆ SortByHitProjection()

◆ SplitCluster()

◆ SplitClusters()

Member Data Documentation

◆ m_inputClusterList

◆ m_instanceName

◆ m_maxClusterSeparation

◆ m_maxIntersectDisplacement

◆ m_minClusterLength

◆ m_minSplitDisplacement

◆ m_minVertexDisplacement

◆ m_pPandora

◆ m_slidingFitHalfWindow

◆ m_type