lar_content::NViewMatchingAlgorithm< T > Class Template Reference

NViewMatchingAlgorithm class. More...

#include <NViewMatchingAlgorithm.h>

Inheritance diagram for lar_content::NViewMatchingAlgorithm< T >:

Public Types
typedef T	MatchingType

Public Member Functions
	NViewMatchingAlgorithm ()
	Default constructor. More...
virtual	~NViewMatchingAlgorithm ()
	Destructor. More...
void	UpdateForNewCluster (const pandora::Cluster *const pNewCluster)
	Update to reflect addition of a new cluster to the problem space. More...
void	UpdateUponDeletion (const pandora::Cluster *const pDeletedCluster)
	Update to reflect cluster deletion. More...
const std::string &	GetClusterListName (const pandora::HitType hitType) const
	Get the cluster list name corresponding to a specified hit type. More...
const pandora::ClusterList &	GetInputClusterList (const pandora::HitType hitType) const
	Get the input cluster list corresponding to a specified hit type. More...
const pandora::ClusterList &	GetSelectedClusterList (const pandora::HitType hitType) const
	Get the selected cluster list corresponding to a specified hit type. More...
Public Member Functions inherited from lar_content::MatchingBaseAlgorithm
	MatchingBaseAlgorithm ()
	Default constructor. More...
virtual	~MatchingBaseAlgorithm ()
	Destructor. More...
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. More...
virtual void	SelectInputClusters (const pandora::ClusterList *const pInputClusterList, pandora::ClusterList &selectedClusterList) const
	Select a subset of input clusters for processing in this algorithm. More...
virtual void	PrepareInputClusters (pandora::ClusterList &preparedClusterList)
	Perform any preparatory steps required on the input clusters, e.g. caching expensive fit results. More...
virtual bool	MakeClusterMerges (const ClusterMergeMap &clusterMergeMap)
	Merge clusters together. More...
virtual bool	CreateThreeDParticles (const ProtoParticleVector &protoParticleVector)
	Create particles using findings from recent algorithm processing. More...
virtual void	SetPfoParameters (const ProtoParticle &protoParticle, PandoraContentApi::ParticleFlowObject::Parameters &pfoParameters) const
	Set Pfo properties. More...
virtual void	SetPfoParticleId (PandoraContentApi::ParticleFlowObject::Parameters &pfoParameters) const
	Set pfo particle id. More...

Protected Member Functions
MatchingType &	GetMatchingControl ()
	Get the matching control. More...
virtual void	SelectAllInputClusters ()
	Select a subset of input clusters for processing in this algorithm. More...
virtual void	PrepareAllInputClusters ()
	Perform any preparatory steps required, e.g. caching expensive fit results for clusters. More...
virtual void	PerformMainLoop ()
	Main loop over cluster combinations in order to populate the overlap container. Responsible for calling CalculateOverlapResult. More...
virtual void	TidyUp ()
	Tidy member variables in derived class. More...
virtual pandora::StatusCode	ReadSettings (const pandora::TiXmlHandle xmlHandle)
Protected Member Functions inherited from lar_content::MatchingBaseAlgorithm
virtual void	ExamineOverlapContainer ()=0
	Examine contents of overlap container, collect together best-matching 2D particles and modify clusters as required. More...

Protected Attributes
MatchingType	m_matchingControl
	The matching control. More...

Detailed Description

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

NViewMatchingAlgorithm class.

Definition at line 20 of file NViewMatchingAlgorithm.h.

Member Typedef Documentation

template<typename T>

typedef T lar_content::NViewMatchingAlgorithm< T >::MatchingType

Definition at line 23 of file NViewMatchingAlgorithm.h.

Constructor & Destructor Documentation

template<typename T >

lar_content::NViewMatchingAlgorithm< T >::NViewMatchingAlgorithm

(

)

Default constructor.

Definition at line 27 of file NViewMatchingAlgorithm.cc.

                                                  : m_matchingControl(this)
{
}

template<typename T >

lar_content::NViewMatchingAlgorithm< T >::~NViewMatchingAlgorithm ( )

virtual

Destructor.

Definition at line 34 of file NViewMatchingAlgorithm.cc.

{
}

Member Function Documentation

template<typename T>

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

virtual

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

Parameters

hitType

the hit type

Returns

the cluster list name

Implements lar_content::MatchingBaseAlgorithm.

Definition at line 57 of file NViewMatchingAlgorithm.cc.

{
    return m_matchingControl.GetClusterListName(hitType);
}

template<typename T>

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

virtual

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

Parameters

hitType

the hit type

Returns

the input cluster list

Implements lar_content::MatchingBaseAlgorithm.

Definition at line 65 of file NViewMatchingAlgorithm.cc.

{
    return m_matchingControl.GetInputClusterList(hitType);
}

template<typename T >

T & lar_content::NViewMatchingAlgorithm< T >::GetMatchingControl ( )

inlineprotected

Get the matching control.

Definition at line 59 of file NViewMatchingAlgorithm.h.

{
    return m_matchingControl;
}

template<typename T>

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

virtual

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

Parameters

hitType

the hit type

Returns

the selected cluster list

Implements lar_content::MatchingBaseAlgorithm.

Definition at line 73 of file NViewMatchingAlgorithm.cc.

{
    return m_matchingControl.GetSelectedClusterList(hitType);
}

template<typename T >

void lar_content::NViewMatchingAlgorithm< T >::PerformMainLoop ( )

protectedvirtual

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.

{
    m_matchingControl.PerformMainLoop();
}

template<typename T >

void lar_content::NViewMatchingAlgorithm< T >::PrepareAllInputClusters ( )

protectedvirtual

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.

{
    m_matchingControl.PrepareAllInputClusters();
}

template<typename T>

StatusCode lar_content::NViewMatchingAlgorithm< T >::ReadSettings ( const pandora::TiXmlHandle  xmlHandle )

protectedvirtual

Reimplemented from lar_content::MatchingBaseAlgorithm.

Reimplemented in lar_content::NViewDeltaRayMatchingAlgorithm< T >, lar_content::NViewDeltaRayMatchingAlgorithm< ThreeViewMatchingControl< DeltaRayOverlapResult > >, lar_content::NViewDeltaRayMatchingAlgorithm< TwoViewMatchingControl< TwoViewDeltaRayOverlapResult > >, lar_content::TwoViewDeltaRayMatchingAlgorithm, lar_content::ThreeViewShowersAlgorithm, lar_content::ThreeViewTrackFragmentsAlgorithm, lar_content::ThreeViewTransverseTracksAlgorithm, lar_content::NViewTrackMatchingAlgorithm< T >, lar_content::NViewTrackMatchingAlgorithm< TwoViewMatchingControl< TwoViewTransverseOverlapResult > >, lar_content::NViewTrackMatchingAlgorithm< ThreeViewMatchingControl< FragmentOverlapResult > >, lar_content::NViewTrackMatchingAlgorithm< ThreeViewMatchingControl< TransverseOverlapResult > >, lar_content::NViewTrackMatchingAlgorithm< ThreeViewMatchingControl< LongitudinalOverlapResult > >, lar_content::TwoViewTransverseTracksAlgorithm, lar_content::ThreeViewLongitudinalTracksAlgorithm, lar_content::ThreeViewDeltaRayMatchingAlgorithm, and lar_content::ThreeViewRemnantsAlgorithm.

Definition at line 113 of file NViewMatchingAlgorithm.cc.

{
    PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, m_matchingControl.ReadSettings(xmlHandle));

    return MatchingBaseAlgorithm::ReadSettings(xmlHandle);
}

template<typename T >

void lar_content::NViewMatchingAlgorithm< T >::SelectAllInputClusters ( )

protectedvirtual

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

Implements lar_content::MatchingBaseAlgorithm.

Definition at line 81 of file NViewMatchingAlgorithm.cc.

{
    m_matchingControl.SelectAllInputClusters();
}

template<typename T >

void lar_content::NViewMatchingAlgorithm< T >::TidyUp ( )

protectedvirtual

Tidy member variables in derived class.

Implements lar_content::MatchingBaseAlgorithm.

Reimplemented in lar_content::NViewDeltaRayMatchingAlgorithm< T >, lar_content::NViewDeltaRayMatchingAlgorithm< ThreeViewMatchingControl< DeltaRayOverlapResult > >, lar_content::NViewDeltaRayMatchingAlgorithm< TwoViewMatchingControl< TwoViewDeltaRayOverlapResult > >, lar_content::NViewTrackMatchingAlgorithm< T >, lar_content::NViewTrackMatchingAlgorithm< TwoViewMatchingControl< TwoViewTransverseOverlapResult > >, lar_content::NViewTrackMatchingAlgorithm< ThreeViewMatchingControl< FragmentOverlapResult > >, lar_content::NViewTrackMatchingAlgorithm< ThreeViewMatchingControl< TransverseOverlapResult > >, lar_content::NViewTrackMatchingAlgorithm< ThreeViewMatchingControl< LongitudinalOverlapResult > >, and lar_content::ThreeViewShowersAlgorithm.

Definition at line 97 of file NViewMatchingAlgorithm.cc.

{
    m_matchingControl.TidyUp();
}

template<typename T>

void lar_content::NViewMatchingAlgorithm< T >::UpdateForNewCluster ( const pandora::Cluster *const  pNewCluster )

virtual

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

Parameters

pNewCluster

address of the new cluster

Implements lar_content::MatchingBaseAlgorithm.

Reimplemented in lar_content::NViewTrackMatchingAlgorithm< T >, lar_content::NViewTrackMatchingAlgorithm< TwoViewMatchingControl< TwoViewTransverseOverlapResult > >, lar_content::NViewTrackMatchingAlgorithm< ThreeViewMatchingControl< FragmentOverlapResult > >, lar_content::NViewTrackMatchingAlgorithm< ThreeViewMatchingControl< TransverseOverlapResult > >, and lar_content::NViewTrackMatchingAlgorithm< ThreeViewMatchingControl< LongitudinalOverlapResult > >.

Definition at line 41 of file NViewMatchingAlgorithm.cc.

{
    m_matchingControl.UpdateForNewCluster(pNewCluster);
}

template<typename T>

void lar_content::NViewMatchingAlgorithm< T >::UpdateUponDeletion ( const pandora::Cluster *const  pDeletedCluster )

virtual

Update to reflect cluster deletion.

Parameters

pDeletedCluster

address of the deleted cluster

Implements lar_content::MatchingBaseAlgorithm.

Reimplemented in lar_content::NViewTrackMatchingAlgorithm< T >, lar_content::NViewTrackMatchingAlgorithm< TwoViewMatchingControl< TwoViewTransverseOverlapResult > >, lar_content::NViewTrackMatchingAlgorithm< ThreeViewMatchingControl< FragmentOverlapResult > >, lar_content::NViewTrackMatchingAlgorithm< ThreeViewMatchingControl< TransverseOverlapResult > >, and lar_content::NViewTrackMatchingAlgorithm< ThreeViewMatchingControl< LongitudinalOverlapResult > >.

Definition at line 49 of file NViewMatchingAlgorithm.cc.

{
    m_matchingControl.UpdateUponDeletion(pDeletedCluster);
}

Member Data Documentation

template<typename T>

MatchingType lar_content::NViewMatchingAlgorithm< T >::m_matchingControl

protected

The matching control.

Definition at line 53 of file NViewMatchingAlgorithm.h.

---

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

• larpandoracontent/larpandoracontent/LArThreeDReco/LArThreeDBase/NViewMatchingAlgorithm.h
• larpandoracontent/larpandoracontent/LArThreeDReco/LArThreeDBase/NViewMatchingAlgorithm.cc