#include "NViewMatchingControl.h"

Inheritance diagram for lar_content::NViewMatchingControl:

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

virtual	~NViewMatchingControl ()
	Destructor. More...

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

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

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

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

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

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

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

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

virtual void	TidyUp ()=0
	Tidy member variables. More...

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

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

Detailed Description

NViewMatchingControl class.

Definition at line 21 of file NViewMatchingControl.h.

Constructor & Destructor Documentation

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.

                                                                                          :
     m_pAlgorithm(pAlgorithm)
 {
 }

lar_content::NViewMatchingControl::~NViewMatchingControl ( )

inlinevirtual

Destructor.

Definition at line 117 of file NViewMatchingControl.h.

118 {

119 }

Member Function Documentation

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

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

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

virtual void lar_content::NViewMatchingControl::PerformMainLoop ( )

protectedpure virtual

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

virtual void lar_content::NViewMatchingControl::PrepareAllInputClusters ( )

protectedpure virtual

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

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

protectedpure virtual

Read settings from xml.

Parameters

xmlHandle the xml handle

virtual void lar_content::NViewMatchingControl::SelectAllInputClusters ( )

protectedpure virtual

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

virtual void lar_content::NViewMatchingControl::TidyUp ( )

protectedpure virtual

Tidy member variables.

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

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

Member Data Documentation

MatchingBaseAlgorithm* lar_content::NViewMatchingControl::m_pAlgorithm

protected

The address of the matching base algorithm.

Definition at line 105 of file NViewMatchingControl.h.

Referenced by lar_content::ThreeViewMatchingControl< T >::PerformMainLoop(), lar_content::TwoViewMatchingControl< T >::PerformMainLoop(), lar_content::ThreeViewMatchingControl< T >::PrepareAllInputClusters(), lar_content::TwoViewMatchingControl< T >::PrepareAllInputClusters(), lar_content::ThreeViewMatchingControl< T >::SelectAllInputClusters(), lar_content::TwoViewMatchingControl< T >::SelectAllInputClusters(), lar_content::ThreeViewMatchingControl< T >::UpdateForNewCluster(), and lar_content::TwoViewMatchingControl< T >::UpdateForNewCluster().

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

larpandoracontent/v04_08_01/source/larpandoracontent/LArThreeDReco/LArThreeDBase/NViewMatchingControl.h

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation