DeltaRaySplittingAlgorithm class. More...

#include "DeltaRaySplittingAlgorithm.h"

Inheritance diagram for lar_content::DeltaRaySplittingAlgorithm:

[legend]

Collaboration diagram for lar_content::DeltaRaySplittingAlgorithm:

[legend]

Public Member Functions
	DeltaRaySplittingAlgorithm ()
	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::vector< ClusterExtension >	ClusterExtensionList

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

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	FindBestSplitPosition (const TwoDSlidingFitResult &branchSlidingFit, const TwoDSlidingFitResult &replacementSlidingFit, pandora::CartesianVector &replacementStartPosition, pandora::CartesianVector &branchSplitPosition, pandora::CartesianVector &branchSplitDirection) const
	Output the best split positions in branch and replacement clusters.

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

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	BuildSlidingFitResultMap (const pandora::ClusterVector &clusterVector, const unsigned int halfWindowLayers, TwoDSlidingFitResultMap &slidingFitResultMap) const
	Build the map of sliding fit results.

void	BuildClusterExtensionList (const pandora::ClusterVector &clusterVector, const TwoDSlidingFitResultMap &branchResultMap, const TwoDSlidingFitResultMap &replacementResultMap, ClusterExtensionList &clusterExtensionList) const
	Build a list of candidate splits.

void	PruneClusterExtensionList (const ClusterExtensionList &inputList, const TwoDSlidingFitResultMap &branchResultMap, const TwoDSlidingFitResultMap &replacementResultMap, ClusterExtensionList &outputList) const
	Finalize the list of candidate splits.

float	CalculateBranchChi2 (const pandora::Cluster *const pCluster, const pandora::CartesianVector &splitPosition, const pandora::CartesianVector &splitDirection) const
	Calculate RMS deviation of branch hits relative to the split direction.

void	SplitBranchCluster (const pandora::Cluster *const pCluster, const pandora::CartesianVector &splitPosition, const pandora::CartesianVector &splitDirection, pandora::CaloHitList &principalCaloHitList, pandora::CaloHitList &branchCaloHitList) const
	Separate cluster into the branch hits to be split from the primary cluster.

pandora::StatusCode	RunSplitAndExtension (const ClusterExtensionList &splitList, TwoDSlidingFitResultMap &branchResultMap, TwoDSlidingFitResultMap &replacementResultMap) const
	Run the machinary that performs the cluster splitting and extending.

pandora::StatusCode	ReplaceBranch (const pandora::Cluster const pBranchCluster, const pandora::Cluster const pReplacementCluster, const pandora::CartesianVector &branchSplitPosition, const pandora::CartesianVector &branchSplitDirection) const
	Remove a branch from a cluster and replace it with a second cluster.

Private Attributes
float	m_stepSize

float	m_maxTransverseDisplacement

float	m_maxLongitudinalDisplacement

float	m_minCosRelativeAngle

unsigned int	m_shortHalfWindowLayers

unsigned int	m_longHalfWindowLayers

float	m_minClusterLength

float	m_vetoDisplacement

bool	m_runCosmicMode

Detailed Description

DeltaRaySplittingAlgorithm class.

Definition at line 19 of file DeltaRaySplittingAlgorithm.h.

Member Typedef Documentation

◆ ClusterExtensionList

typedef std::vector<ClusterExtension> lar_content::TwoDSlidingFitSplittingAndSplicingAlgorithm::ClusterExtensionList

protectedinherited

Definition at line 85 of file TwoDSlidingFitSplittingAndSplicingAlgorithm.h.

Constructor & Destructor Documentation

◆ DeltaRaySplittingAlgorithm()

lar_content::DeltaRaySplittingAlgorithm::DeltaRaySplittingAlgorithm ( )

Default constructor.

Definition at line 20 of file DeltaRaySplittingAlgorithm.cc.

Member Function Documentation

◆ BuildClusterExtensionList()

void lar_content::TwoDSlidingFitSplittingAndSplicingAlgorithm::BuildClusterExtensionList	(	const pandora::ClusterVector &	clusterVector,
		const TwoDSlidingFitResultMap &	branchResultMap,
		const TwoDSlidingFitResultMap &	replacementResultMap,
		ClusterExtensionList &	clusterExtensionList
	)		const

privateinherited

Build a list of candidate splits.

Parameters

clusterVector	the input cluster vector
branchResultMap	the sliding fit result map for branch clusters
replacementResultMap	the sliding fit result map for replacement clusters
clusterExtensionList	the output list of candidate splits

Definition at line 121 of file TwoDSlidingFitSplittingAndSplicingAlgorithm.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ BuildSlidingFitResultMap()

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

privateinherited

Build the map of sliding fit results.

Parameters

clusterVector	the input cluster vector
halfWindowLayers	the half-window to use for the sliding fits
slidingFitResultMap	the output sliding fit result map

Definition at line 94 of file TwoDSlidingFitSplittingAndSplicingAlgorithm.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CalculateBranchChi2()

float lar_content::TwoDSlidingFitSplittingAndSplicingAlgorithm::CalculateBranchChi2	(	const pandora::Cluster *const	pCluster,
		const pandora::CartesianVector &	splitPosition,
		const pandora::CartesianVector &	splitDirection
	)		const

privateinherited

Calculate RMS deviation of branch hits relative to the split direction.

Parameters

pCluster	the input branch cluster
splitPosition	the start position of the branch
splitDirection	the start direction of the branch

Definition at line 293 of file TwoDSlidingFitSplittingAndSplicingAlgorithm.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ FindBestSplitPosition()

void lar_content::DeltaRaySplittingAlgorithm::FindBestSplitPosition	(	const TwoDSlidingFitResult &	branchSlidingFit,
		const TwoDSlidingFitResult &	replacementSlidingFit,
		pandora::CartesianVector &	replacementStartPosition,
		pandora::CartesianVector &	branchSplitPosition,
		pandora::CartesianVector &	branchSplitDirection
	)		const

privatevirtual

Output the best split positions in branch and replacement clusters.

Parameters

branchSlidingFit	the inputted sliding fit result for possible branch cluster
pReplacementCluster	the inputted sliding fit result for possible replacement cluster
replacementStartPosition	the outputted start position of the replacement
branchSplitPosition	the outputted start position of the branch
branchSplitDirection	the outputted start direction of the branch

Implements lar_content::TwoDSlidingFitSplittingAndSplicingAlgorithm.

Definition at line 30 of file DeltaRaySplittingAlgorithm.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::TwoDSlidingFitSplittingAndSplicingAlgorithm::GetListOfCleanClusters	(	const pandora::ClusterList *const	pClusterList,
		pandora::ClusterVector &	clusterVector
	)		const

privateinherited

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

Definition at line 77 of file TwoDSlidingFitSplittingAndSplicingAlgorithm.cc.

Here is the call graph for this function:

Here is the caller 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:

◆ PruneClusterExtensionList()

void lar_content::TwoDSlidingFitSplittingAndSplicingAlgorithm::PruneClusterExtensionList	(	const ClusterExtensionList &	inputList,
		const TwoDSlidingFitResultMap &	branchResultMap,
		const TwoDSlidingFitResultMap &	replacementResultMap,
		ClusterExtensionList &	outputList
	)		const

privateinherited

Finalize the list of candidate splits.

Parameters

inputList	the input list of possible splits
branchResultMap	the sliding fit result map for branch clusters
replacementResultMap	the sliding fit result map for replacement clusters
outputList	the output list of definite splits

Definition at line 225 of file TwoDSlidingFitSplittingAndSplicingAlgorithm.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ReadSettings()

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

privatevirtual

Read the algorithm settings.

Parameters

xmlHandle the relevant xml handle

Reimplemented from lar_content::TwoDSlidingFitSplittingAndSplicingAlgorithm.

Definition at line 139 of file DeltaRaySplittingAlgorithm.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:

◆ ReplaceBranch()

StatusCode lar_content::TwoDSlidingFitSplittingAndSplicingAlgorithm::ReplaceBranch	(	const pandora::Cluster *const	pBranchCluster,
		const pandora::Cluster *const	pReplacementCluster,
		const pandora::CartesianVector &	branchSplitPosition,
		const pandora::CartesianVector &	branchSplitDirection
	)		const

privateinherited

Remove a branch from a cluster and replace it with a second cluster.

Parameters

pBranchCluster	the cluster containing a branch to be removed
pReplacementCluster	the replacement cluster
branchSplitPosition	the position at the start of the branch
branchSplitDirection	the direction at the start of the branch

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

protectedvirtualinherited

Run the algorithm.

Implements pandora::Algorithm.

Definition at line 32 of file TwoDSlidingFitSplittingAndSplicingAlgorithm.cc.

Here is the call graph for this function:

◆ RunSplitAndExtension()

StatusCode lar_content::TwoDSlidingFitSplittingAndSplicingAlgorithm::RunSplitAndExtension	(	const ClusterExtensionList &	splitList,
		TwoDSlidingFitResultMap &	branchResultMap,
		TwoDSlidingFitResultMap &	replacementResultMap
	)		const

privateinherited

Run the machinary that performs the cluster splitting and extending.

Parameters

splitList	the input list of candidate splits
branchResultMap	the sliding fit result map for branch clusters
replacementResultMap	the sliding fit result map for replacement clusters

Definition at line 349 of file TwoDSlidingFitSplittingAndSplicingAlgorithm.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SplitBranchCluster()

void lar_content::TwoDSlidingFitSplittingAndSplicingAlgorithm::SplitBranchCluster	(	const pandora::Cluster *const	pCluster,
		const pandora::CartesianVector &	splitPosition,
		const pandora::CartesianVector &	splitDirection,
		pandora::CaloHitList &	principalCaloHitList,
		pandora::CaloHitList &	branchCaloHitList
	)		const

privateinherited

Separate cluster into the branch hits to be split from the primary cluster.

Parameters

pCluster	the input branch cluster
splitPosition	the start position of the branch
splitDirection	the start direction of the branch
principalCaloHitList	the hits to be added to the principal cluster
branchCaloHitList	the hits to be split off into the output branch cluster

Definition at line 322 of file TwoDSlidingFitSplittingAndSplicingAlgorithm.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ m_instanceName

std::string pandora::Process::m_instanceName

protectedinherited

The process instance name.

Definition at line 89 of file Process.h.

◆ m_longHalfWindowLayers

unsigned int lar_content::TwoDSlidingFitSplittingAndSplicingAlgorithm::m_longHalfWindowLayers

privateinherited

Definition at line 185 of file TwoDSlidingFitSplittingAndSplicingAlgorithm.h.

◆ m_maxLongitudinalDisplacement

float lar_content::DeltaRaySplittingAlgorithm::m_maxLongitudinalDisplacement

private

Definition at line 36 of file DeltaRaySplittingAlgorithm.h.

◆ m_maxTransverseDisplacement

float lar_content::DeltaRaySplittingAlgorithm::m_maxTransverseDisplacement

private

Definition at line 35 of file DeltaRaySplittingAlgorithm.h.

◆ m_minClusterLength

float lar_content::TwoDSlidingFitSplittingAndSplicingAlgorithm::m_minClusterLength

privateinherited

Definition at line 186 of file TwoDSlidingFitSplittingAndSplicingAlgorithm.h.

◆ m_minCosRelativeAngle

float lar_content::DeltaRaySplittingAlgorithm::m_minCosRelativeAngle

private

Definition at line 37 of file DeltaRaySplittingAlgorithm.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_runCosmicMode

bool lar_content::TwoDSlidingFitSplittingAndSplicingAlgorithm::m_runCosmicMode

privateinherited

Definition at line 188 of file TwoDSlidingFitSplittingAndSplicingAlgorithm.h.

◆ m_shortHalfWindowLayers

unsigned int lar_content::TwoDSlidingFitSplittingAndSplicingAlgorithm::m_shortHalfWindowLayers

privateinherited

Definition at line 184 of file TwoDSlidingFitSplittingAndSplicingAlgorithm.h.

◆ m_stepSize

float lar_content::DeltaRaySplittingAlgorithm::m_stepSize

private

Definition at line 34 of file DeltaRaySplittingAlgorithm.h.

◆ m_type

std::string pandora::Process::m_type

protectedinherited

The process type.

Definition at line 88 of file Process.h.

◆ m_vetoDisplacement

float lar_content::TwoDSlidingFitSplittingAndSplicingAlgorithm::m_vetoDisplacement

privateinherited

Definition at line 187 of file TwoDSlidingFitSplittingAndSplicingAlgorithm.h.

The documentation for this class was generated from the following files:

LArContent/larpandoracontent/LArTwoDReco/LArClusterSplitting/DeltaRaySplittingAlgorithm.h
LArContent/larpandoracontent/LArTwoDReco/LArClusterSplitting/DeltaRaySplittingAlgorithm.cc

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ ClusterExtensionList

Constructor & Destructor Documentation

◆ DeltaRaySplittingAlgorithm()

Member Function Documentation

◆ BuildClusterExtensionList()

◆ BuildSlidingFitResultMap()

◆ CalculateBranchChi2()

◆ FindBestSplitPosition()

◆ GetInstanceName()

◆ GetListOfCleanClusters()

◆ GetPandora()

◆ GetType()

◆ Initialize()

◆ PruneClusterExtensionList()

◆ ReadSettings()

◆ RegisterDetails()

◆ ReplaceBranch()

◆ Reset()

◆ Run()

◆ RunSplitAndExtension()

◆ SplitBranchCluster()

Member Data Documentation

◆ m_instanceName

◆ m_longHalfWindowLayers

◆ m_maxLongitudinalDisplacement

◆ m_maxTransverseDisplacement

◆ m_minClusterLength

◆ m_minCosRelativeAngle

◆ m_pPandora

◆ m_runCosmicMode

◆ m_shortHalfWindowLayers

◆ m_stepSize

◆ m_type

◆ m_vetoDisplacement