#include <MatchingBaseAlgorithm.h>

Inheritance diagram for lar_content::MatchingBaseAlgorithm:

Public Member Functions
	MatchingBaseAlgorithm ()
	Default constructor. More...

virtual	~MatchingBaseAlgorithm ()
	Destructor. More...

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	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
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, e.g. caching expensive fit results for clusters. More...

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

virtual void	ExamineOverlapContainer ()=0
	Examine contents of overlap container, collect together best-matching 2D particles and modify clusters as required. More...

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

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

Private Member Functions
pandora::StatusCode	Run ()

Private Attributes
std::string	m_outputPfoListName
	The output pfo list name. More...

Detailed Description

MatchingBaseAlgorithm class.

Definition at line 38 of file MatchingBaseAlgorithm.h.

Constructor & Destructor Documentation

lar_content::MatchingBaseAlgorithm::MatchingBaseAlgorithm ( )

Default constructor.

Definition at line 20 of file MatchingBaseAlgorithm.cc.

21 {

22 }

lar_content::MatchingBaseAlgorithm::~MatchingBaseAlgorithm ( )

virtual

Destructor.

Definition at line 26 of file MatchingBaseAlgorithm.cc.

27 {

28 }

Member Function Documentation

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

pure virtual

Calculate cluster overlap result and store in container.

Parameters

pCluster1	address of cluster1
pCluster2	address of cluster2
pCluster3	address of cluster3

Implemented in lar_content::ThreeViewShowersAlgorithm, lar_content::TwoViewDeltaRayMatchingAlgorithm, lar_content::ThreeViewTrackFragmentsAlgorithm, lar_content::ThreeViewDeltaRayMatchingAlgorithm, lar_content::ThreeViewTransverseTracksAlgorithm, lar_content::TwoViewTransverseTracksAlgorithm, lar_content::ThreeViewLongitudinalTracksAlgorithm, and lar_content::ThreeViewRemnantsAlgorithm.

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

virtual

Create particles using findings from recent algorithm processing.

Parameters

protoParticleVector	the proto particle vector
whether	particles were created

Definition at line 88 of file MatchingBaseAlgorithm.cc.

 {
     bool particlesMade(false);
     const PfoList *pPfoList(nullptr);
     std::string pfoListName;
     PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::CreateTemporaryListAndSetCurrent(*this, pPfoList, pfoListName));
 
     for (const ProtoParticle &protoParticle : protoParticleVector)
     {
         PandoraContentApi::ParticleFlowObject::Parameters pfoParameters;
         this->SetPfoParameters(protoParticle, pfoParameters);
 
         const ParticleFlowObject *pPfo(nullptr);
         PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::ParticleFlowObject::Create(*this, pfoParameters, pPfo));
         particlesMade = true;
     }
 
     if (!pPfoList->empty())
     {
         PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::SaveList<Pfo>(*this, m_outputPfoListName));
         PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::ReplaceCurrentList<Pfo>(*this, m_outputPfoListName));
     }
 
     return particlesMade;
 }

virtual void lar_content::MatchingBaseAlgorithm::ExamineOverlapContainer ( )

protectedpure virtual

Examine contents of overlap container, collect together best-matching 2D particles and modify clusters as required.

Implemented in lar_content::TwoViewDeltaRayMatchingAlgorithm, lar_content::ThreeViewShowersAlgorithm, lar_content::ThreeViewTrackFragmentsAlgorithm, lar_content::ThreeViewTransverseTracksAlgorithm, lar_content::TwoViewTransverseTracksAlgorithm, lar_content::ThreeViewLongitudinalTracksAlgorithm, lar_content::ThreeViewDeltaRayMatchingAlgorithm, and lar_content::ThreeViewRemnantsAlgorithm.

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

pure 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::NViewMatchingAlgorithm< T >, lar_content::NViewMatchingAlgorithm< ThreeViewMatchingControl< float > >, lar_content::NViewMatchingAlgorithm< ThreeViewMatchingControl< DeltaRayOverlapResult > >, lar_content::NViewMatchingAlgorithm< TwoViewMatchingControl< TwoViewTransverseOverlapResult > >, lar_content::NViewMatchingAlgorithm< ThreeViewMatchingControl< FragmentOverlapResult > >, lar_content::NViewMatchingAlgorithm< ThreeViewMatchingControl< ShowerOverlapResult > >, lar_content::NViewMatchingAlgorithm< ThreeViewMatchingControl< TransverseOverlapResult > >, lar_content::NViewMatchingAlgorithm< TwoViewMatchingControl< TwoViewDeltaRayOverlapResult > >, and lar_content::NViewMatchingAlgorithm< ThreeViewMatchingControl< LongitudinalOverlapResult > >.

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

pure 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::NViewMatchingAlgorithm< T >, lar_content::NViewMatchingAlgorithm< ThreeViewMatchingControl< float > >, lar_content::NViewMatchingAlgorithm< ThreeViewMatchingControl< DeltaRayOverlapResult > >, lar_content::NViewMatchingAlgorithm< TwoViewMatchingControl< TwoViewTransverseOverlapResult > >, lar_content::NViewMatchingAlgorithm< ThreeViewMatchingControl< FragmentOverlapResult > >, lar_content::NViewMatchingAlgorithm< ThreeViewMatchingControl< ShowerOverlapResult > >, lar_content::NViewMatchingAlgorithm< ThreeViewMatchingControl< TransverseOverlapResult > >, lar_content::NViewMatchingAlgorithm< TwoViewMatchingControl< TwoViewDeltaRayOverlapResult > >, and lar_content::NViewMatchingAlgorithm< ThreeViewMatchingControl< LongitudinalOverlapResult > >.

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

pure 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::NViewMatchingAlgorithm< T >, lar_content::NViewMatchingAlgorithm< ThreeViewMatchingControl< float > >, lar_content::NViewMatchingAlgorithm< ThreeViewMatchingControl< DeltaRayOverlapResult > >, lar_content::NViewMatchingAlgorithm< TwoViewMatchingControl< TwoViewTransverseOverlapResult > >, lar_content::NViewMatchingAlgorithm< ThreeViewMatchingControl< FragmentOverlapResult > >, lar_content::NViewMatchingAlgorithm< ThreeViewMatchingControl< ShowerOverlapResult > >, lar_content::NViewMatchingAlgorithm< ThreeViewMatchingControl< TransverseOverlapResult > >, lar_content::NViewMatchingAlgorithm< TwoViewMatchingControl< TwoViewDeltaRayOverlapResult > >, and lar_content::NViewMatchingAlgorithm< ThreeViewMatchingControl< LongitudinalOverlapResult > >.

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

virtual

Merge clusters together.

Parameters

clusterMergeMap the cluster merge map

Returns: whether changes to the overlap container have been made

Definition at line 48 of file MatchingBaseAlgorithm.cc.

 {
     ClusterSet deletedClusters;
 
     ClusterList parentClusters;
     for (const auto &mapEntry : clusterMergeMap)
         parentClusters.push_back(mapEntry.first);
     parentClusters.sort(LArClusterHelper::SortByNHits);
 
     for (const Cluster *const pParentCluster : parentClusters)
     {
         const HitType hitType(LArClusterHelper::GetClusterHitType(pParentCluster));
         const std::string &clusterListName(this->GetClusterListName(hitType));
 
         if (!((TPC_VIEW_U == hitType) || (TPC_VIEW_V == hitType) || (TPC_VIEW_W == hitType)))
             throw StatusCodeException(STATUS_CODE_FAILURE);
 
         ClusterList daughterClusters(clusterMergeMap.at(pParentCluster));
         daughterClusters.sort(LArClusterHelper::SortByNHits);
 
         for (const Cluster *const pDaughterCluster : daughterClusters)
         {
             if (deletedClusters.count(pParentCluster) || deletedClusters.count(pDaughterCluster))
                 throw StatusCodeException(STATUS_CODE_FAILURE);
 
             this->UpdateUponDeletion(pDaughterCluster);
             this->UpdateUponDeletion(pParentCluster);
             PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=,
                 PandoraContentApi::MergeAndDeleteClusters(*this, pParentCluster, pDaughterCluster, clusterListName, clusterListName));
 
             this->UpdateForNewCluster(pParentCluster);
             deletedClusters.insert(pDaughterCluster);
         }
     }
 
     return !(deletedClusters.empty());
 }

virtual void lar_content::MatchingBaseAlgorithm::PerformMainLoop ( )

protectedpure virtual

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

virtual void lar_content::MatchingBaseAlgorithm::PrepareAllInputClusters ( )

protectedpure virtual

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

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

void lar_content::MatchingBaseAlgorithm::PrepareInputClusters ( pandora::ClusterList & preparedClusterList )

virtual

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

Parameters

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

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 42 of file MatchingBaseAlgorithm.cc.

43 {

44 }

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

protectedvirtual

Definition at line 158 of file MatchingBaseAlgorithm.cc.

 {
     PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, XmlHelper::ReadValue(xmlHandle, "OutputPfoListName", m_outputPfoListName));
 
     return STATUS_CODE_SUCCESS;
 }

StatusCode lar_content::MatchingBaseAlgorithm::Run ( )

private

Definition at line 135 of file MatchingBaseAlgorithm.cc.

 {
     try
     {
         this->SelectAllInputClusters();
         this->PrepareAllInputClusters();
         this->PerformMainLoop();
         this->ExamineOverlapContainer();
         this->TidyUp();
     }
     catch (StatusCodeException &statusCodeException)
     {
         this->TidyUp();
 
         if (STATUS_CODE_SUCCESS != statusCodeException.GetStatusCode())
             throw statusCodeException;
     }
 
     return STATUS_CODE_SUCCESS;
 }

virtual void lar_content::MatchingBaseAlgorithm::SelectAllInputClusters ( )

protectedpure virtual

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

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

void lar_content::MatchingBaseAlgorithm::SelectInputClusters	(	const pandora::ClusterList *const	pInputClusterList,
		pandora::ClusterList &	selectedClusterList
	)		const

virtual

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

Parameters

pInputClusterList	address of an input cluster list
selectedClusterList	to receive the selected cluster list

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 > >, lar_content::ThreeViewShowersAlgorithm, and lar_content::ThreeViewRemnantsAlgorithm.

Definition at line 32 of file MatchingBaseAlgorithm.cc.

 {
     if (!pInputClusterList)
         throw StatusCodeException(STATUS_CODE_INVALID_PARAMETER);
 
     selectedClusterList = *pInputClusterList;
 }

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

virtual

Set Pfo properties.

Parameters

protoParticle	the input proto particle
pfoParameters	the output pfo parameters

Definition at line 116 of file MatchingBaseAlgorithm.cc.

 {
     this->SetPfoParticleId(pfoParameters);
     pfoParameters.m_charge = PdgTable::GetParticleCharge(pfoParameters.m_particleId.Get());
     pfoParameters.m_mass = PdgTable::GetParticleMass(pfoParameters.m_particleId.Get());
     pfoParameters.m_energy = 0.f;
     pfoParameters.m_momentum = CartesianVector(0.f, 0.f, 0.f);
     pfoParameters.m_clusterList = protoParticle.m_clusterList;
 }

void lar_content::MatchingBaseAlgorithm::SetPfoParticleId ( PandoraContentApi::ParticleFlowObject::Parameters & pfoParameters ) const

virtual

Set pfo particle id.

Parameters

pfoParameters the output pfo parameters

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 128 of file MatchingBaseAlgorithm.cc.

 {
     pfoParameters.m_particleId = E_MINUS; // Shower
 }

virtual void lar_content::MatchingBaseAlgorithm::TidyUp ( )

protectedpure virtual

Tidy member variables in derived class.

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

pure virtual

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

Parameters

pNewCluster address of the new cluster

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

pure virtual

Update to reflect cluster deletion.

Parameters

pDeletedCluster address of the deleted cluster

Member Data Documentation

std::string lar_content::MatchingBaseAlgorithm::m_outputPfoListName

private

The output pfo list name.

Definition at line 181 of file MatchingBaseAlgorithm.h.

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

larpandoracontent/larpandoracontent/LArThreeDReco/LArThreeDBase/MatchingBaseAlgorithm.h
larpandoracontent/larpandoracontent/LArThreeDReco/LArThreeDBase/MatchingBaseAlgorithm.cc

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation