Pandora
Pandora source code navigator
Loading...
Searching...
No Matches
lar_content::NViewTrackMatchingAlgorithm< T > Class Template Referenceabstract

NViewTrackMatchingAlgorithm class. More...

#include "NViewTrackMatchingAlgorithm.h"

Inheritance diagram for lar_content::NViewTrackMatchingAlgorithm< T >:
Collaboration diagram for lar_content::NViewTrackMatchingAlgorithm< T >:

Public Types

typedef T MatchingType
 

Public Member Functions

 NViewTrackMatchingAlgorithm ()
 Default constructor.
 
virtual ~NViewTrackMatchingAlgorithm ()
 Destructor.
 
const TwoDSlidingFitResultGetCachedSlidingFitResult (const pandora::Cluster *const pCluster) const
 Get a sliding fit result from the algorithm cache.
 
unsigned int GetSlidingFitWindow () const
 Get the layer window for the sliding linear fits.
 
virtual bool MakeClusterSplits (const SplitPositionMap &splitPositionMap)
 Make cluster splits.
 
virtual bool MakeClusterSplit (const pandora::CartesianVector &splitPosition, const pandora::Cluster *&pCurrentCluster, const pandora::Cluster *&pLowXCluster, const pandora::Cluster *&pHighXCluster) const
 Make a cluster split.
 
virtual void UpdateForNewCluster (const pandora::Cluster *const pNewCluster)
 Update to reflect addition of a new cluster to the problem space.
 
virtual void UpdateUponDeletion (const pandora::Cluster *const pDeletedCluster)
 Update to reflect cluster deletion.
 
virtual void SelectInputClusters (const pandora::ClusterList *const pInputClusterList, pandora::ClusterList &selectedClusterList) const
 Select a subset of input clusters for processing in this algorithm.
 
virtual void PrepareInputClusters (pandora::ClusterList &preparedClusterList)
 Perform any preparatory steps required on the input clusters, e.g. caching expensive fit results.
 
virtual void SetPfoParticleId (PandoraContentApi::ParticleFlowObject::Parameters &pfoParameters) const
 Set pfo particle id.
 
const std::string & GetClusterListName (const pandora::HitType hitType) const
 Get the cluster list name corresponding to a specified hit type.
 
const pandora::ClusterListGetInputClusterList (const pandora::HitType hitType) const
 Get the input cluster list corresponding to a specified hit type.
 
const pandora::ClusterListGetSelectedClusterList (const pandora::HitType hitType) const
 Get the selected cluster list corresponding to a specified hit type.
 
virtual void CalculateOverlapResult (const pandora::Cluster *const pCluster1, const pandora::Cluster *const pCluster2, const pandora::Cluster *const pCluster3=nullptr)=0
 Calculate cluster overlap result and store in container.
 
virtual bool MakeClusterMerges (const ClusterMergeMap &clusterMergeMap)
 Merge clusters together.
 
virtual bool CreateThreeDParticles (const ProtoParticleVector &protoParticleVector)
 Create particles using findings from recent algorithm processing.
 
virtual void SetPfoParameters (const ProtoParticle &protoParticle, PandoraContentApi::ParticleFlowObject::Parameters &pfoParameters) const
 Set Pfo properties.
 
const std::string & GetType () const
 Get the type.
 
const std::string & GetInstanceName () const
 Get the instance name.
 
const PandoraGetPandora () const
 Get the associated pandora instance.
 

Static Public Member Functions

static bool SortSplitPositions (const pandora::CartesianVector &lhs, const pandora::CartesianVector &rhs)
 Sort split position cartesian vectors by increasing x coordinate.
 

Protected Member Functions

void AddToSlidingFitCache (const pandora::Cluster *const pCluster)
 Add a new sliding fit result, for the specified cluster, to the algorithm cache.
 
void RemoveFromSlidingFitCache (const pandora::Cluster *const pCluster)
 Remova an existing sliding fit result, for the specified cluster, from the algorithm cache.
 
virtual void TidyUp ()
 Tidy member variables in derived class.
 
virtual pandora::StatusCode ReadSettings (const pandora::TiXmlHandle xmlHandle)
 Read the algorithm settings.
 
MatchingTypeGetMatchingControl ()
 Get the matching control.
 
virtual void SelectAllInputClusters ()
 Select a subset of input clusters for processing in this algorithm.
 
virtual void PrepareAllInputClusters ()
 Perform any preparatory steps required, e.g. caching expensive fit results for clusters.
 
virtual void PerformMainLoop ()
 Main loop over cluster combinations in order to populate the overlap container. Responsible for calling CalculateOverlapResult.
 
virtual void ExamineOverlapContainer ()=0
 Examine contents of overlap container, collect together best-matching 2D particles and modify clusters as required.
 
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

MatchingType m_matchingControl
 The matching control.
 
const Pandoram_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

pandora::StatusCode Run ()
 Run the algorithm.
 

Private Attributes

unsigned int m_slidingFitWindow
 The layer window for the sliding linear fits.
 
TwoDSlidingFitResultMap m_slidingFitResultMap
 The sliding fit result map.
 
unsigned int m_minClusterCaloHits
 The min number of hits in base cluster selection method.
 
float m_minClusterLengthSquared
 The min length (squared) in base cluster selection method.
 
std::string m_outputPfoListName
 The output pfo list name.
 

Detailed Description

template<typename T>
class lar_content::NViewTrackMatchingAlgorithm< T >

NViewTrackMatchingAlgorithm class.

Definition at line 26 of file NViewTrackMatchingAlgorithm.h.

Member Typedef Documentation

◆ MatchingType

template<typename T >
typedef T lar_content::NViewMatchingAlgorithm< T >::MatchingType
inherited

Definition at line 23 of file NViewMatchingAlgorithm.h.

Constructor & Destructor Documentation

◆ NViewTrackMatchingAlgorithm()

template<typename T >
lar_content::NViewTrackMatchingAlgorithm< T >::NViewTrackMatchingAlgorithm ( )

Default constructor.

Definition at line 28 of file NViewTrackMatchingAlgorithm.cc.

◆ ~NViewTrackMatchingAlgorithm()

Destructor.

Definition at line 38 of file NViewTrackMatchingAlgorithm.cc.

Member Function Documentation

◆ AddToSlidingFitCache()

template<typename T >
void lar_content::NViewTrackMatchingAlgorithm< T >::AddToSlidingFitCache ( const pandora::Cluster *const  pCluster)
protected

Add a new sliding fit result, for the specified cluster, to the algorithm cache.

Parameters
pClusteraddress of the relevant cluster

Definition at line 255 of file NViewTrackMatchingAlgorithm.cc.

Here is the call graph for this function:

◆ CalculateOverlapResult()

virtual void lar_content::MatchingBaseAlgorithm::CalculateOverlapResult ( const pandora::Cluster *const  pCluster1,
const pandora::Cluster *const  pCluster2,
const pandora::Cluster *const  pCluster3 = nullptr 
)
pure virtualinherited

◆ CreateThreeDParticles()

bool lar_content::MatchingBaseAlgorithm::CreateThreeDParticles ( const ProtoParticleVector protoParticleVector)
virtualinherited

Create particles using findings from recent algorithm processing.

Parameters
protoParticleVectorthe proto particle vector
whetherparticles were created

Definition at line 88 of file MatchingBaseAlgorithm.cc.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ ExamineOverlapContainer()

virtual void lar_content::MatchingBaseAlgorithm::ExamineOverlapContainer ( )
protectedpure virtualinherited

◆ GetCachedSlidingFitResult()

template<typename T >
const TwoDSlidingFitResult & lar_content::NViewTrackMatchingAlgorithm< T >::GetCachedSlidingFitResult ( const pandora::Cluster *const  pCluster) const

Get a sliding fit result from the algorithm cache.

Parameters
pClusteraddress of the relevant cluster

Definition at line 45 of file NViewTrackMatchingAlgorithm.cc.

Here is the caller graph for this function:

◆ GetClusterListName()

template<typename T >
const std::string & lar_content::NViewMatchingAlgorithm< T >::GetClusterListName ( const pandora::HitType  hitType) const
virtualinherited

Get the cluster list name corresponding to a specified hit type.

Parameters
hitTypethe hit type
Returns
the cluster list name

Implements lar_content::MatchingBaseAlgorithm.

Definition at line 57 of file NViewMatchingAlgorithm.cc.

Here is the caller graph for this function:

◆ GetInputClusterList()

template<typename T >
const pandora::ClusterList & lar_content::NViewMatchingAlgorithm< T >::GetInputClusterList ( const pandora::HitType  hitType) const
virtualinherited

Get the input cluster list corresponding to a specified hit type.

Parameters
hitTypethe hit type
Returns
the input cluster list

Implements lar_content::MatchingBaseAlgorithm.

Definition at line 65 of file NViewMatchingAlgorithm.cc.

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.

◆ GetMatchingControl()

template<typename T >
T & lar_content::NViewMatchingAlgorithm< T >::GetMatchingControl ( )
inlineprotectedinherited

Get the matching control.

Definition at line 59 of file NViewMatchingAlgorithm.h.

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.

◆ GetSelectedClusterList()

template<typename T >
const pandora::ClusterList & lar_content::NViewMatchingAlgorithm< T >::GetSelectedClusterList ( const pandora::HitType  hitType) const
virtualinherited

Get the selected cluster list corresponding to a specified hit type.

Parameters
hitTypethe hit type
Returns
the selected cluster list

Implements lar_content::MatchingBaseAlgorithm.

Definition at line 73 of file NViewMatchingAlgorithm.cc.

Here is the caller graph for this function:

◆ GetSlidingFitWindow()

template<typename T >
unsigned int lar_content::NViewTrackMatchingAlgorithm< T >::GetSlidingFitWindow ( ) const
inline

Get the layer window for the sliding linear fits.

Returns
the layer window for the sliding linear fits

Definition at line 118 of file NViewTrackMatchingAlgorithm.h.

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:

◆ MakeClusterMerges()

bool lar_content::MatchingBaseAlgorithm::MakeClusterMerges ( const ClusterMergeMap clusterMergeMap)
virtualinherited

Merge clusters together.

Parameters
clusterMergeMapthe cluster merge map
Returns
whether changes to the overlap container have been made

Definition at line 48 of file MatchingBaseAlgorithm.cc.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ MakeClusterSplit()

template<typename T >
bool lar_content::NViewTrackMatchingAlgorithm< T >::MakeClusterSplit ( const pandora::CartesianVector splitPosition,
const pandora::Cluster *&  pCurrentCluster,
const pandora::Cluster *&  pLowXCluster,
const pandora::Cluster *&  pHighXCluster 
) const
virtual

Make a cluster split.

Parameters
splitPositionthe split position
pCurrentClusterthe cluster to split
pLowXClusterto receive the low x cluster
pHighXClusterto receive the high x cluster
Returns
whether a cluster split occurred

Definition at line 105 of file NViewTrackMatchingAlgorithm.cc.

Here is the call graph for this function:

◆ MakeClusterSplits()

template<typename T >
bool lar_content::NViewTrackMatchingAlgorithm< T >::MakeClusterSplits ( const SplitPositionMap splitPositionMap)
virtual

Make cluster splits.

Parameters
splitPositionMapthe split position map
Returns
whether changes to the overlap container have been made

Definition at line 58 of file NViewTrackMatchingAlgorithm.cc.

Here is the caller graph for this function:

◆ PerformMainLoop()

template<typename T >
void lar_content::NViewMatchingAlgorithm< T >::PerformMainLoop ( )
protectedvirtualinherited

Main loop over cluster combinations in order to populate the overlap container. Responsible for calling CalculateOverlapResult.

Implements lar_content::MatchingBaseAlgorithm.

Reimplemented in lar_content::ThreeViewTrackFragmentsAlgorithm.

Definition at line 105 of file NViewMatchingAlgorithm.cc.

◆ PrepareAllInputClusters()

template<typename T >
void lar_content::NViewMatchingAlgorithm< T >::PrepareAllInputClusters ( )
protectedvirtualinherited

Perform any preparatory steps required, e.g. caching expensive fit results for clusters.

Implements lar_content::MatchingBaseAlgorithm.

Definition at line 89 of file NViewMatchingAlgorithm.cc.

◆ PrepareInputClusters()

template<typename T >
void lar_content::NViewTrackMatchingAlgorithm< T >::PrepareInputClusters ( pandora::ClusterList preparedClusterList)
virtual

Perform any preparatory steps required on the input clusters, e.g. caching expensive fit results.

Parameters
preparedClusterListto receive the prepared cluster list, non const so as to be able to modify input selected list

Reimplemented from lar_content::MatchingBaseAlgorithm.

Definition at line 225 of file NViewTrackMatchingAlgorithm.cc.

Here is the call graph for this function:

◆ ReadSettings()

template<typename T >
StatusCode lar_content::NViewTrackMatchingAlgorithm< T >::ReadSettings ( const pandora::TiXmlHandle  xmlHandle)
protectedvirtual

Read the algorithm settings.

Parameters
xmlHandlethe relevant xml handle

Reimplemented from lar_content::NViewMatchingAlgorithm< T >.

Reimplemented in lar_content::ThreeViewLongitudinalTracksAlgorithm, lar_content::ThreeViewTrackFragmentsAlgorithm, lar_content::ThreeViewTransverseTracksAlgorithm, and lar_content::TwoViewTransverseTracksAlgorithm.

Definition at line 287 of file NViewTrackMatchingAlgorithm.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
pPandoraaddress of the pandora object that will run the process
typethe process type
instanceNamethe process instance name

Definition at line 146 of file Process.h.

Here is the caller graph for this function:

◆ RemoveFromSlidingFitCache()

template<typename T >
void lar_content::NViewTrackMatchingAlgorithm< T >::RemoveFromSlidingFitCache ( const pandora::Cluster *const  pCluster)
protected

Remova an existing sliding fit result, for the specified cluster, from the algorithm cache.

Parameters
pClusteraddress of the relevant cluster

Definition at line 267 of file NViewTrackMatchingAlgorithm.cc.

◆ 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::MatchingBaseAlgorithm::Run ( )
privatevirtualinherited

Run the algorithm.

Implements pandora::Algorithm.

Definition at line 135 of file MatchingBaseAlgorithm.cc.

Here is the call graph for this function:

◆ SelectAllInputClusters()

template<typename T >
void lar_content::NViewMatchingAlgorithm< T >::SelectAllInputClusters ( )
protectedvirtualinherited

Select a subset of input clusters for processing in this algorithm.

Implements lar_content::MatchingBaseAlgorithm.

Definition at line 81 of file NViewMatchingAlgorithm.cc.

◆ SelectInputClusters()

template<typename T >
void lar_content::NViewTrackMatchingAlgorithm< T >::SelectInputClusters ( const pandora::ClusterList *const  pInputClusterList,
pandora::ClusterList selectedClusterList 
) const
virtual

Select a subset of input clusters for processing in this algorithm.

Parameters
pInputClusterListaddress of an input cluster list
selectedClusterListto receive the selected cluster list

Reimplemented from lar_content::MatchingBaseAlgorithm.

Definition at line 205 of file NViewTrackMatchingAlgorithm.cc.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ SetPfoParameters()

void lar_content::MatchingBaseAlgorithm::SetPfoParameters ( const ProtoParticle protoParticle,
PandoraContentApi::ParticleFlowObject::Parameters &  pfoParameters 
) const
virtualinherited

Set Pfo properties.

Parameters
protoParticlethe input proto particle
pfoParametersthe output pfo parameters

Definition at line 116 of file MatchingBaseAlgorithm.cc.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ SetPfoParticleId()

template<typename T >
void lar_content::NViewTrackMatchingAlgorithm< T >::SetPfoParticleId ( PandoraContentApi::ParticleFlowObject::Parameters &  pfoParameters) const
virtual

Set pfo particle id.

Parameters
pfoParametersthe output pfo parameters

Reimplemented from lar_content::MatchingBaseAlgorithm.

Definition at line 247 of file NViewTrackMatchingAlgorithm.cc.

◆ SortSplitPositions()

template<typename T >
bool lar_content::NViewTrackMatchingAlgorithm< T >::SortSplitPositions ( const pandora::CartesianVector lhs,
const pandora::CartesianVector rhs 
)
static

Sort split position cartesian vectors by increasing x coordinate.

Parameters
lhsthe first cartesian vector
rhsthe second cartesian vector

Definition at line 168 of file NViewTrackMatchingAlgorithm.cc.

Here is the call graph for this function:

◆ TidyUp()

template<typename T >
void lar_content::NViewTrackMatchingAlgorithm< T >::TidyUp ( )
protectedvirtual

Tidy member variables in derived class.

Reimplemented from lar_content::NViewMatchingAlgorithm< T >.

Definition at line 278 of file NViewTrackMatchingAlgorithm.cc.

Here is the call graph for this function:

◆ UpdateForNewCluster()

template<typename T >
void lar_content::NViewTrackMatchingAlgorithm< T >::UpdateForNewCluster ( const pandora::Cluster *const  pNewCluster)
virtual

Update to reflect addition of a new cluster to the problem space.

Parameters
pNewClusteraddress of the new cluster

Reimplemented from lar_content::NViewMatchingAlgorithm< T >.

Reimplemented in lar_content::ThreeViewTrackFragmentsAlgorithm.

Definition at line 176 of file NViewTrackMatchingAlgorithm.cc.

Here is the call graph for this function:

◆ UpdateUponDeletion()

template<typename T >
void lar_content::NViewTrackMatchingAlgorithm< T >::UpdateUponDeletion ( const pandora::Cluster *const  pDeletedCluster)
virtual

Update to reflect cluster deletion.

Parameters
pDeletedClusteraddress of the deleted cluster

Reimplemented from lar_content::NViewMatchingAlgorithm< T >.

Definition at line 196 of file NViewTrackMatchingAlgorithm.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_matchingControl

template<typename T >
MatchingType lar_content::NViewMatchingAlgorithm< T >::m_matchingControl
protectedinherited

The matching control.

Definition at line 53 of file NViewMatchingAlgorithm.h.

◆ m_minClusterCaloHits

template<typename T >
unsigned int lar_content::NViewTrackMatchingAlgorithm< T >::m_minClusterCaloHits
private

The min number of hits in base cluster selection method.

Definition at line 111 of file NViewTrackMatchingAlgorithm.h.

◆ m_minClusterLengthSquared

template<typename T >
float lar_content::NViewTrackMatchingAlgorithm< T >::m_minClusterLengthSquared
private

The min length (squared) in base cluster selection method.

Definition at line 112 of file NViewTrackMatchingAlgorithm.h.

◆ m_outputPfoListName

std::string lar_content::MatchingBaseAlgorithm::m_outputPfoListName
privateinherited

The output pfo list name.

Definition at line 181 of file MatchingBaseAlgorithm.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_slidingFitResultMap

template<typename T >
TwoDSlidingFitResultMap lar_content::NViewTrackMatchingAlgorithm< T >::m_slidingFitResultMap
private

The sliding fit result map.

Definition at line 109 of file NViewTrackMatchingAlgorithm.h.

◆ m_slidingFitWindow

template<typename T >
unsigned int lar_content::NViewTrackMatchingAlgorithm< T >::m_slidingFitWindow
private

The layer window for the sliding linear fits.

Definition at line 108 of file NViewTrackMatchingAlgorithm.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: