#include "ThreeDKinkBaseTool.h"

Inheritance diagram for lar_content::ThreeDKinkBaseTool:

[legend]

Collaboration diagram for lar_content::ThreeDKinkBaseTool:

[legend]

Classes
class	Modification
	Modification class. More...

Public Types
typedef ThreeViewTransverseTracksAlgorithm::MatchingType::TensorType	TensorType

typedef std::vector< TensorType::ElementList::const_iterator >	IteratorList

Public Member Functions
	ThreeDKinkBaseTool (const unsigned int nCommonClusters)
	Constructor.

virtual	~ThreeDKinkBaseTool ()
	Destructor.

bool	Run (ThreeViewTransverseTracksAlgorithm *const pAlgorithm, TensorType &overlapTensor)
	Run the algorithm tool.

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< Modification >	ModificationList

Protected Member Functions
virtual bool	PassesElementCuts (TensorType::ElementList::const_iterator eIter, const pandora::ClusterSet &usedClusters) const
	Whether a provided (iterator to a) tensor element passes the selection cuts for overshoot identification.

virtual void	GetIteratorListModifications (ThreeViewTransverseTracksAlgorithm *const pAlgorithm, const IteratorList &iteratorList, ModificationList &modificationList) const =0
	Get modification objects for a specific elements of the tensor, identifying required splits and merges for clusters.

float	GetXSamplingPoint (const pandora::CartesianVector &splitPosition1, const bool isForwardInX, const TwoDSlidingFitResult &fitResult1, const TwoDSlidingFitResult &fitResult2, const TwoDSlidingFitResult &fitResult3) const
	Get a sampling point in x that is common to sliding linear fit objects in three views.

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

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.

Static Protected Member Functions
static bool	IsALowestInX (const LArPointingCluster &pointingClusterA, const LArPointingCluster &pointingClusterB)
	Whether pointing cluster labelled A extends to lowest x positions (as opposed to that labelled B)

Protected Attributes
unsigned int	m_nCommonClusters
	The number of common clusters.

bool	m_majorityRulesMode
	Whether to run in majority rules mode (always split overshoots, always merge undershoots)

float	m_minMatchedFraction
	The min matched sampling point fraction for use as a key tensor element.

unsigned int	m_minMatchedSamplingPoints
	The min number of matched sampling points for use as a key tensor element.

float	m_minLongitudinalImpactParameter
	The min longitudinal impact parameter for connecting accompanying clusters.

int	m_nLayersForKinkSearch
	The number of sliding fit layers to step in the kink search.

float	m_additionalXStepForKinkSearch
	An additional (safety) step to tack-on when choosing x sampling points.

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	GetModifications (ThreeViewTransverseTracksAlgorithm *const pAlgorithm, const TensorType &overlapTensor, ModificationList &modificationList) const
	Get modification objects, identifying required splits and merges for clusters.

void	SelectTensorElements (TensorType::ElementList::const_iterator eIter, const TensorType::ElementList &elementList, const pandora::ClusterSet &usedClusters, IteratorList &iteratorList) const
	Select elements representing possible components of interest due to overshoots or undershoots in clustering.

bool	ApplyChanges (ThreeViewTransverseTracksAlgorithm *const pAlgorithm, const ModificationList &modificationList) const
	Apply the changes cached in a modification list and update the tensor accordingly.

Detailed Description

ThreeDKinkBaseTool class.

Definition at line 21 of file ThreeDKinkBaseTool.h.

Class Documentation

◆ lar_content::ThreeDKinkBaseTool::Modification

class lar_content::ThreeDKinkBaseTool::Modification

Modification class.

Definition at line 42 of file ThreeDKinkBaseTool.h.

Class Members
ClusterList	m_affectedClusters	The list of affected clusters.
ClusterMergeMap	m_clusterMergeMap	The cluster merge map.
SplitPositionMap	m_splitPositionMap	The split position map.

Member Typedef Documentation

◆ IteratorList

typedef std::vector<TensorType::ElementList::const_iterator> lar_content::TransverseTensorTool::IteratorList

inherited

Definition at line 131 of file ThreeViewTransverseTracksAlgorithm.h.

◆ ModificationList

typedef std::vector<Modification> lar_content::ThreeDKinkBaseTool::ModificationList

protected

Definition at line 50 of file ThreeDKinkBaseTool.h.

◆ TensorType

typedef ThreeViewTransverseTracksAlgorithm::MatchingType::TensorType lar_content::TransverseTensorTool::TensorType

inherited

Definition at line 130 of file ThreeViewTransverseTracksAlgorithm.h.

Constructor & Destructor Documentation

◆ ThreeDKinkBaseTool()

lar_content::ThreeDKinkBaseTool::ThreeDKinkBaseTool ( const unsigned int nCommonClusters )

Constructor.

Parameters

nCommonClusters the number of common clusters to select

Definition at line 22 of file ThreeDKinkBaseTool.cc.

◆ ~ThreeDKinkBaseTool()

lar_content::ThreeDKinkBaseTool::~ThreeDKinkBaseTool ( )

virtual

Destructor.

Definition at line 37 of file ThreeDKinkBaseTool.cc.

Member Function Documentation

◆ ApplyChanges()

bool lar_content::ThreeDKinkBaseTool::ApplyChanges	(	ThreeViewTransverseTracksAlgorithm *const	pAlgorithm,
		const ModificationList &	modificationList
	)		const

private

Apply the changes cached in a modification list and update the tensor accordingly.

Parameters

pAlgorithm	address of the calling algorithm
modificationList	the modification list

Returns: whether changes to the tensor have been made

Definition at line 188 of file ThreeDKinkBaseTool.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.

◆ GetIteratorListModifications()

virtual void lar_content::ThreeDKinkBaseTool::GetIteratorListModifications	(	ThreeViewTransverseTracksAlgorithm *const	pAlgorithm,
		const IteratorList &	iteratorList,
		ModificationList &	modificationList
	)		const

protectedpure virtual

Get modification objects for a specific elements of the tensor, identifying required splits and merges for clusters.

Parameters

pAlgorithm	address of the calling algorithm
iteratorList	list of iterators to relevant tensor elements
modificationList	to be populated with modifications

Implemented in lar_content::OvershootTracksTool, and lar_content::UndershootTracksTool.

Here is the caller graph for this function:

◆ GetModifications()

void lar_content::ThreeDKinkBaseTool::GetModifications	(	ThreeViewTransverseTracksAlgorithm *const	pAlgorithm,
		const TensorType &	overlapTensor,
		ModificationList &	modificationList
	)		const

private

Get modification objects, identifying required splits and merges for clusters.

Parameters

pAlgorithm	address of the calling algorithm
overlapTensor	the overlap tensor
modificationList	to be populated with modifications

Definition at line 140 of file ThreeDKinkBaseTool.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.

◆ GetXSamplingPoint()

float lar_content::ThreeDKinkBaseTool::GetXSamplingPoint	(	const pandora::CartesianVector &	splitPosition1,
		const bool	isForwardInX,
		const TwoDSlidingFitResult &	fitResult1,
		const TwoDSlidingFitResult &	fitResult2,
		const TwoDSlidingFitResult &	fitResult3
	)		const

protected

Get a sampling point in x that is common to sliding linear fit objects in three views.

Parameters

splitPosition1	the split position in view 1
isForwardInX	whether to work forwards (or backwards) in x
fitResult1	the sliding fit result in view 1
fitResult2	the sliding fit result in view 2
fitResult3	the sliding fit result in view 3

Returns: the sampling point

Definition at line 59 of file ThreeDKinkBaseTool.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

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

◆ IsALowestInX()

bool lar_content::ThreeDKinkBaseTool::IsALowestInX	(	const LArPointingCluster &	pointingClusterA,
		const LArPointingCluster &	pointingClusterB
	)

staticprotected

Whether pointing cluster labelled A extends to lowest x positions (as opposed to that labelled B)

Parameters

pointingClusterA	pointing cluster A
pointingClusterB	pointing cluster B

Definition at line 107 of file ThreeDKinkBaseTool.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ PassesElementCuts()

bool lar_content::ThreeDKinkBaseTool::PassesElementCuts	(	TensorType::ElementList::const_iterator	eIter,
		const pandora::ClusterSet &	usedClusters
	)		const

protectedvirtual

Whether a provided (iterator to a) tensor element passes the selection cuts for overshoot identification.

Parameters

eIter	the iterator to the tensor element
usedClusters	the list of used clusters

Definition at line 43 of file ThreeDKinkBaseTool.cc.

Here is the caller graph for this function:

◆ ReadSettings()

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

protectedvirtual

Read the algorithm settings.

Parameters

xmlHandle the relevant xml handle

Implements pandora::Process.

Reimplemented in lar_content::UndershootTracksTool.

Definition at line 277 of file ThreeDKinkBaseTool.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()

bool lar_content::ThreeDKinkBaseTool::Run	(	ThreeViewTransverseTracksAlgorithm *const	pAlgorithm,
		TensorType &	overlapTensor
	)

virtual

Run the algorithm tool.

Parameters

pAlgorithm	address of the calling algorithm
overlapTensor	the overlap tensor

Returns: whether changes have been made by the tool

Implements lar_content::TransverseTensorTool.

Definition at line 126 of file ThreeDKinkBaseTool.cc.

Here is the call graph for this function:

◆ SelectTensorElements()

void lar_content::ThreeDKinkBaseTool::SelectTensorElements	(	TensorType::ElementList::const_iterator	eIter,
		const TensorType::ElementList &	elementList,
		const pandora::ClusterSet &	usedClusters,
		IteratorList &	iteratorList
	)		const

private

Select elements representing possible components of interest due to overshoots or undershoots in clustering.

Parameters

eIter	iterator to a candidate element
elementList	the provided element list
usedClusters	the list of used clusters
iteratorList	to receive a list of iterators to relevant elements

Definition at line 237 of file ThreeDKinkBaseTool.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ m_additionalXStepForKinkSearch

float lar_content::ThreeDKinkBaseTool::m_additionalXStepForKinkSearch

protected

An additional (safety) step to tack-on when choosing x sampling points.

Definition at line 100 of file ThreeDKinkBaseTool.h.

◆ m_instanceName

std::string pandora::Process::m_instanceName

protectedinherited

The process instance name.

Definition at line 89 of file Process.h.

◆ m_majorityRulesMode

bool lar_content::ThreeDKinkBaseTool::m_majorityRulesMode

protected

Whether to run in majority rules mode (always split overshoots, always merge undershoots)

Definition at line 95 of file ThreeDKinkBaseTool.h.

◆ m_minLongitudinalImpactParameter

float lar_content::ThreeDKinkBaseTool::m_minLongitudinalImpactParameter

protected

The min longitudinal impact parameter for connecting accompanying clusters.

Definition at line 98 of file ThreeDKinkBaseTool.h.

◆ m_minMatchedFraction

float lar_content::ThreeDKinkBaseTool::m_minMatchedFraction

protected

The min matched sampling point fraction for use as a key tensor element.

Definition at line 96 of file ThreeDKinkBaseTool.h.

◆ m_minMatchedSamplingPoints

unsigned int lar_content::ThreeDKinkBaseTool::m_minMatchedSamplingPoints

protected

The min number of matched sampling points for use as a key tensor element.

Definition at line 97 of file ThreeDKinkBaseTool.h.

◆ m_nCommonClusters

unsigned int lar_content::ThreeDKinkBaseTool::m_nCommonClusters

protected

The number of common clusters.

Definition at line 94 of file ThreeDKinkBaseTool.h.

◆ m_nLayersForKinkSearch

int lar_content::ThreeDKinkBaseTool::m_nLayersForKinkSearch

protected

The number of sliding fit layers to step in the kink search.

Definition at line 99 of file ThreeDKinkBaseTool.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/LArThreeDReco/LArTransverseTrackMatching/ThreeDKinkBaseTool.h
LArContent/larpandoracontent/LArThreeDReco/LArTransverseTrackMatching/ThreeDKinkBaseTool.cc

Classes

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Class Documentation

◆ lar_content::ThreeDKinkBaseTool::Modification

Member Typedef Documentation

◆ IteratorList

◆ ModificationList

◆ TensorType

Constructor & Destructor Documentation

◆ ThreeDKinkBaseTool()

◆ ~ThreeDKinkBaseTool()

Member Function Documentation

◆ ApplyChanges()

◆ GetInstanceName()

◆ GetIteratorListModifications()

◆ GetModifications()

◆ GetPandora()

◆ GetType()

◆ GetXSamplingPoint()

◆ Initialize()

◆ IsALowestInX()

◆ PassesElementCuts()

◆ ReadSettings()

◆ RegisterDetails()

◆ Reset()

◆ Run()

◆ SelectTensorElements()

Member Data Documentation

◆ m_additionalXStepForKinkSearch

◆ m_instanceName

◆ m_majorityRulesMode

◆ m_minLongitudinalImpactParameter

◆ m_minMatchedFraction

◆ m_minMatchedSamplingPoints

◆ m_nCommonClusters

◆ m_nLayersForKinkSearch

◆ m_pPandora

◆ m_type