#include "NViewMatchingControl.h"

Inheritance diagram for lar_content::NViewMatchingControl:

[legend]

Collaboration diagram for lar_content::NViewMatchingControl:

[legend]

Public Member Functions
	NViewMatchingControl (MatchingBaseAlgorithm *const pAlgorithm)
	Constructor.

virtual	~NViewMatchingControl ()
	Destructor.

Protected Member Functions
virtual void	UpdateForNewCluster (const pandora::Cluster *const pNewCluster)=0
	Update to reflect addition of a new cluster to the problem space.

virtual void	UpdateUponDeletion (const pandora::Cluster *const pDeletedCluster)=0
	Update to reflect cluster deletion.

virtual const std::string &	GetClusterListName (const pandora::HitType hitType) const =0
	Get the cluster list name corresponding to a specified hit type.

virtual const pandora::ClusterList &	GetInputClusterList (const pandora::HitType hitType) const =0
	Get the input cluster list corresponding to a specified hit type.

virtual const pandora::ClusterList &	GetSelectedClusterList (const pandora::HitType hitType) const =0
	Get the selected cluster list corresponding to a specified hit type.

virtual void	SelectAllInputClusters ()=0
	Select a subset of input clusters for processing in this algorithm.

virtual void	PrepareAllInputClusters ()=0
	Perform any preparatory steps required on the input clusters, e.g. caching expensive fit results.

virtual void	PerformMainLoop ()=0
	Main loop over cluster combinations in order to populate the overlap container. Responsible for calling CalculateOverlapResult.

virtual void	TidyUp ()=0
	Tidy member variables.

virtual pandora::StatusCode	ReadSettings (const pandora::TiXmlHandle xmlHandle)=0
	Read settings from xml.

Protected Attributes
MatchingBaseAlgorithm *	m_pAlgorithm
	The address of the matching base algorithm.

Detailed Description

NViewMatchingControl class.

Definition at line 21 of file NViewMatchingControl.h.

Constructor & Destructor Documentation

◆ NViewMatchingControl()

lar_content::NViewMatchingControl::NViewMatchingControl ( MatchingBaseAlgorithm *const pAlgorithm )

inline

Constructor.

Parameters

pAlgorithm address of the matching base algorithm

Definition at line 110 of file NViewMatchingControl.h.

◆ ~NViewMatchingControl()

lar_content::NViewMatchingControl::~NViewMatchingControl ( )

inlinevirtual

Destructor.

Definition at line 116 of file NViewMatchingControl.h.

Member Function Documentation

◆ GetClusterListName()

virtual const std::string & lar_content::NViewMatchingControl::GetClusterListName ( const pandora::HitType hitType ) const

protectedpure virtual

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

Parameters

hitType the hit type

Returns: the cluster list name

Implemented in lar_content::ThreeViewMatchingControl< T >, lar_content::ThreeViewMatchingControl< DeltaRayOverlapResult >, lar_content::ThreeViewMatchingControl< float >, lar_content::ThreeViewMatchingControl< FragmentOverlapResult >, lar_content::ThreeViewMatchingControl< LongitudinalOverlapResult >, lar_content::ThreeViewMatchingControl< ShowerOverlapResult >, lar_content::ThreeViewMatchingControl< TransverseOverlapResult >, lar_content::TwoViewMatchingControl< T >, lar_content::TwoViewMatchingControl< TwoViewDeltaRayOverlapResult >, and lar_content::TwoViewMatchingControl< TwoViewTransverseOverlapResult >.

◆ GetInputClusterList()

virtual const pandora::ClusterList & lar_content::NViewMatchingControl::GetInputClusterList ( const pandora::HitType hitType ) const

protectedpure virtual

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

Parameters

hitType the hit type

Returns: the input cluster list

Implemented in lar_content::ThreeViewMatchingControl< T >, lar_content::ThreeViewMatchingControl< DeltaRayOverlapResult >, lar_content::ThreeViewMatchingControl< float >, lar_content::ThreeViewMatchingControl< FragmentOverlapResult >, lar_content::ThreeViewMatchingControl< LongitudinalOverlapResult >, lar_content::ThreeViewMatchingControl< ShowerOverlapResult >, lar_content::ThreeViewMatchingControl< TransverseOverlapResult >, lar_content::TwoViewMatchingControl< T >, lar_content::TwoViewMatchingControl< TwoViewDeltaRayOverlapResult >, and lar_content::TwoViewMatchingControl< TwoViewTransverseOverlapResult >.

◆ GetSelectedClusterList()

virtual const pandora::ClusterList & lar_content::NViewMatchingControl::GetSelectedClusterList ( const pandora::HitType hitType ) const

protectedpure virtual

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

Parameters

hitType the hit type

Returns: the selected cluster list

Implemented in lar_content::ThreeViewMatchingControl< T >, lar_content::ThreeViewMatchingControl< DeltaRayOverlapResult >, lar_content::ThreeViewMatchingControl< float >, lar_content::ThreeViewMatchingControl< FragmentOverlapResult >, lar_content::ThreeViewMatchingControl< LongitudinalOverlapResult >, lar_content::ThreeViewMatchingControl< ShowerOverlapResult >, lar_content::ThreeViewMatchingControl< TransverseOverlapResult >, lar_content::TwoViewMatchingControl< T >, lar_content::TwoViewMatchingControl< TwoViewDeltaRayOverlapResult >, and lar_content::TwoViewMatchingControl< TwoViewTransverseOverlapResult >.

◆ PerformMainLoop()

virtual void lar_content::NViewMatchingControl::PerformMainLoop ( )

protectedpure virtual

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

Implemented in lar_content::ThreeViewMatchingControl< T >, lar_content::ThreeViewMatchingControl< DeltaRayOverlapResult >, lar_content::ThreeViewMatchingControl< float >, lar_content::ThreeViewMatchingControl< FragmentOverlapResult >, lar_content::ThreeViewMatchingControl< LongitudinalOverlapResult >, lar_content::ThreeViewMatchingControl< ShowerOverlapResult >, lar_content::ThreeViewMatchingControl< TransverseOverlapResult >, lar_content::TwoViewMatchingControl< T >, lar_content::TwoViewMatchingControl< TwoViewDeltaRayOverlapResult >, and lar_content::TwoViewMatchingControl< TwoViewTransverseOverlapResult >.

◆ PrepareAllInputClusters()

virtual void lar_content::NViewMatchingControl::PrepareAllInputClusters ( )

protectedpure virtual

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

Implemented in lar_content::ThreeViewMatchingControl< T >, lar_content::ThreeViewMatchingControl< DeltaRayOverlapResult >, lar_content::ThreeViewMatchingControl< float >, lar_content::ThreeViewMatchingControl< FragmentOverlapResult >, lar_content::ThreeViewMatchingControl< LongitudinalOverlapResult >, lar_content::ThreeViewMatchingControl< ShowerOverlapResult >, lar_content::ThreeViewMatchingControl< TransverseOverlapResult >, lar_content::TwoViewMatchingControl< T >, lar_content::TwoViewMatchingControl< TwoViewDeltaRayOverlapResult >, and lar_content::TwoViewMatchingControl< TwoViewTransverseOverlapResult >.

◆ ReadSettings()

virtual pandora::StatusCode lar_content::NViewMatchingControl::ReadSettings ( const pandora::TiXmlHandle xmlHandle )

protectedpure virtual

Read settings from xml.

Parameters

xmlHandle the xml handle

Implemented in lar_content::ThreeViewMatchingControl< T >, lar_content::ThreeViewMatchingControl< DeltaRayOverlapResult >, lar_content::ThreeViewMatchingControl< float >, lar_content::ThreeViewMatchingControl< FragmentOverlapResult >, lar_content::ThreeViewMatchingControl< LongitudinalOverlapResult >, lar_content::ThreeViewMatchingControl< ShowerOverlapResult >, lar_content::ThreeViewMatchingControl< TransverseOverlapResult >, lar_content::TwoViewMatchingControl< T >, lar_content::TwoViewMatchingControl< TwoViewDeltaRayOverlapResult >, and lar_content::TwoViewMatchingControl< TwoViewTransverseOverlapResult >.

◆ SelectAllInputClusters()

virtual void lar_content::NViewMatchingControl::SelectAllInputClusters ( )

protectedpure virtual

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

Implemented in lar_content::ThreeViewMatchingControl< T >, lar_content::ThreeViewMatchingControl< DeltaRayOverlapResult >, lar_content::ThreeViewMatchingControl< float >, lar_content::ThreeViewMatchingControl< FragmentOverlapResult >, lar_content::ThreeViewMatchingControl< LongitudinalOverlapResult >, lar_content::ThreeViewMatchingControl< ShowerOverlapResult >, lar_content::ThreeViewMatchingControl< TransverseOverlapResult >, lar_content::TwoViewMatchingControl< T >, lar_content::TwoViewMatchingControl< TwoViewDeltaRayOverlapResult >, and lar_content::TwoViewMatchingControl< TwoViewTransverseOverlapResult >.

◆ TidyUp()

virtual void lar_content::NViewMatchingControl::TidyUp ( )

protectedpure virtual

Tidy member variables.

Implemented in lar_content::ThreeViewMatchingControl< T >, lar_content::ThreeViewMatchingControl< DeltaRayOverlapResult >, lar_content::ThreeViewMatchingControl< float >, lar_content::ThreeViewMatchingControl< FragmentOverlapResult >, lar_content::ThreeViewMatchingControl< LongitudinalOverlapResult >, lar_content::ThreeViewMatchingControl< ShowerOverlapResult >, lar_content::ThreeViewMatchingControl< TransverseOverlapResult >, lar_content::TwoViewMatchingControl< T >, lar_content::TwoViewMatchingControl< TwoViewDeltaRayOverlapResult >, and lar_content::TwoViewMatchingControl< TwoViewTransverseOverlapResult >.

◆ UpdateForNewCluster()

virtual void lar_content::NViewMatchingControl::UpdateForNewCluster ( const pandora::Cluster *const pNewCluster )

protectedpure virtual

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

Parameters

pNewCluster address of the new cluster

Implemented in lar_content::ThreeViewMatchingControl< T >, lar_content::ThreeViewMatchingControl< DeltaRayOverlapResult >, lar_content::ThreeViewMatchingControl< float >, lar_content::ThreeViewMatchingControl< FragmentOverlapResult >, lar_content::ThreeViewMatchingControl< LongitudinalOverlapResult >, lar_content::ThreeViewMatchingControl< ShowerOverlapResult >, lar_content::ThreeViewMatchingControl< TransverseOverlapResult >, lar_content::TwoViewMatchingControl< T >, lar_content::TwoViewMatchingControl< TwoViewDeltaRayOverlapResult >, and lar_content::TwoViewMatchingControl< TwoViewTransverseOverlapResult >.

◆ UpdateUponDeletion()

virtual void lar_content::NViewMatchingControl::UpdateUponDeletion ( const pandora::Cluster *const pDeletedCluster )

protectedpure virtual

Update to reflect cluster deletion.

Parameters

pDeletedCluster address of the deleted cluster

Implemented in lar_content::ThreeViewMatchingControl< T >, lar_content::ThreeViewMatchingControl< DeltaRayOverlapResult >, lar_content::ThreeViewMatchingControl< float >, lar_content::ThreeViewMatchingControl< FragmentOverlapResult >, lar_content::ThreeViewMatchingControl< LongitudinalOverlapResult >, lar_content::ThreeViewMatchingControl< ShowerOverlapResult >, lar_content::ThreeViewMatchingControl< TransverseOverlapResult >, lar_content::TwoViewMatchingControl< T >, lar_content::TwoViewMatchingControl< TwoViewDeltaRayOverlapResult >, and lar_content::TwoViewMatchingControl< TwoViewTransverseOverlapResult >.

Member Data Documentation

◆ m_pAlgorithm

MatchingBaseAlgorithm* lar_content::NViewMatchingControl::m_pAlgorithm

protected

The address of the matching base algorithm.

Definition at line 105 of file NViewMatchingControl.h.

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

LArContent/larpandoracontent/LArThreeDReco/LArThreeDBase/NViewMatchingControl.h

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ NViewMatchingControl()

◆ ~NViewMatchingControl()

Member Function Documentation

◆ GetClusterListName()

◆ GetInputClusterList()

◆ GetSelectedClusterList()

◆ PerformMainLoop()

◆ PrepareAllInputClusters()

◆ ReadSettings()

◆ SelectAllInputClusters()

◆ TidyUp()

◆ UpdateForNewCluster()

◆ UpdateUponDeletion()

Member Data Documentation

◆ m_pAlgorithm