#include "ThreeDBaseAlgorithm.h"

Inheritance diagram for lar_content::ThreeDBaseAlgorithm< T >:

Public Types
typedef OverlapTensor< T >	TensorType

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

virtual	~ThreeDBaseAlgorithm ()
	Destructor. 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 =0
	Calculate Pfo properties from proto particle. More...

virtual bool	MakeClusterMerges (const ClusterMergeMap &clusterMergeMap)
	Merge clusters together. More...

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

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

virtual void	RemoveUnavailableTensorElements ()
	Update tensor to remove all elements that have been added to pfos and so are unavailable. More...

const pandora::ClusterList &	GetInputClusterListU () const
	Get the input u cluster list. More...

const pandora::ClusterList &	GetInputClusterListV () const
	Get the input v cluster list. More...

const pandora::ClusterList &	GetInputClusterListW () const
	Get the input w cluster list. More...

const pandora::ClusterList &	GetSelectedClusterListU () const
	Get the selected u cluster list. More...

const pandora::ClusterList &	GetSelectedClusterListV () const
	Get the selected v cluster list. More...

const pandora::ClusterList &	GetSelectedClusterListW () const
	Get the selected w cluster list. More...

const std::string &	GetClusterListNameU () const
	Get the name of the u cluster list. More...

const std::string &	GetClusterListNameV () const
	Get the name of the v cluster list. More...

const std::string &	GetClusterListNameW () const
	Get the name of the w cluster list. More...

virtual void	SelectInputClusters (const pandora::ClusterList *const pInputClusterList, pandora::ClusterList &selectedClusterList) const =0
	Select a subset of input clusters for processing in this algorithm. More...

Protected Member Functions
virtual pandora::StatusCode	ReadSettings (const pandora::TiXmlHandle xmlHandle)

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

virtual void	PreparationStep ()
	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 tensor. Responsible for calling CalculateOverlapResult. More...

virtual void	CalculateOverlapResult (const pandora::Cluster const pClusterU, const pandora::Cluster const pClusterV, const pandora::Cluster *const pClusterW)=0
	Calculate cluster overlap result and store in tensor. More...

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

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

Protected Attributes
const pandora::ClusterList *	m_pInputClusterListU
	Address of the input cluster list U. More...

const pandora::ClusterList *	m_pInputClusterListV
	Address of the input cluster list V. More...

const pandora::ClusterList *	m_pInputClusterListW
	Address of the input cluster list W. More...

pandora::ClusterList	m_clusterListU
	The selected modified cluster list U. More...

pandora::ClusterList	m_clusterListV
	The selected modified cluster list V. More...

pandora::ClusterList	m_clusterListW
	The selected modified cluster list W. More...

TensorType	m_overlapTensor
	The overlap tensor. More...

Private Member Functions
pandora::StatusCode	Run ()

Private Attributes
std::string	m_inputClusterListNameU
	The name of the view U cluster list. More...

std::string	m_inputClusterListNameV
	The name of the view V cluster list. More...

std::string	m_inputClusterListNameW
	The name of the view W cluster list. More...

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

Detailed Description

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

ThreeDBaseAlgorithm class.

Definition at line 42 of file ThreeDBaseAlgorithm.h.

Member Typedef Documentation

template<typename T>

typedef OverlapTensor<T> lar_content::ThreeDBaseAlgorithm< T >::TensorType

Definition at line 45 of file ThreeDBaseAlgorithm.h.

Constructor & Destructor Documentation

template<typename T >

lar_content::ThreeDBaseAlgorithm< T >::ThreeDBaseAlgorithm ( )

Default constructor.

Definition at line 25 of file ThreeDBaseAlgorithm.cc.

                                             :
     m_pInputClusterListU(NULL),
     m_pInputClusterListV(NULL),
     m_pInputClusterListW(NULL)
 {
 }

template<typename T >

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

virtual

Destructor.

Definition at line 35 of file ThreeDBaseAlgorithm.cc.

36 {

37 }

Member Function Documentation

template<typename T>

virtual void lar_content::ThreeDBaseAlgorithm< T >::CalculateOverlapResult	(	const pandora::Cluster *const	pClusterU,
		const pandora::Cluster *const	pClusterV,
		const pandora::Cluster *const	pClusterW
	)

protectedpure virtual

Calculate cluster overlap result and store in tensor.

Parameters

pClusterU	address of U view cluster
pClusterV	address of V view cluster
pClusterW	address of W view cluster

Implemented in lar_content::ThreeDShowersAlgorithm, lar_content::ThreeDTrackFragmentsAlgorithm, lar_content::ThreeDTransverseTracksAlgorithm, lar_content::ThreeDRemnantsAlgorithm, and lar_content::ThreeDLongitudinalTracksAlgorithm.

Referenced by lar_content::ThreeDBaseAlgorithm< T >::PerformMainLoop(), and lar_content::ThreeDBaseAlgorithm< T >::UpdateForNewCluster().

template<typename T >

bool lar_content::ThreeDBaseAlgorithm< T >::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 42 of file ThreeDBaseAlgorithm.cc.

References lar_content::ThreeDBaseAlgorithm< T >::m_outputPfoListName, and lar_content::ThreeDBaseAlgorithm< T >::SetPfoParameters().

Referenced by lar_content::ClearRemnantsTool::CreateThreeDParticles(), lar_content::ClearTracksTool::CreateThreeDParticles(), lar_content::ClearLongitudinalTracksTool::CreateThreeDParticles(), lar_content::ClearTrackFragmentsTool::FindTrackFragments(), lar_content::ConnectedRemnantsTool::Run(), lar_content::MatchedEndPointsTool::Run(), lar_content::MopUpRemnantsTool::Run(), lar_content::SimpleShowersTool::Run(), lar_content::MissingTrackTool::Run(), lar_content::TracksCrossingGapsTool::Run(), lar_content::MissingTrackSegmentTool::Run(), lar_content::LongTracksTool::Run(), and lar_content::ClearShowersTool::Run().

 {
     bool particlesMade(false);
     const PfoList *pPfoList = NULL; std::string pfoListName;
     PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::CreateTemporaryListAndSetCurrent(*this, pPfoList, pfoListName));
 
     for (typename ProtoParticleVector::const_iterator iter = protoParticleVector.begin(), iterEnd = protoParticleVector.end(); iter != iterEnd; ++iter)
     {
         PandoraContentApi::ParticleFlowObject::Parameters pfoParameters;
         this->SetPfoParameters(*iter, pfoParameters);
 
         const ParticleFlowObject *pPfo(NULL);
         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;
 }

template<typename T>

virtual void lar_content::ThreeDBaseAlgorithm< T >::ExamineTensor ( )

protectedpure virtual

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

Implemented in lar_content::ThreeDShowersAlgorithm, lar_content::ThreeDTrackFragmentsAlgorithm, lar_content::ThreeDTransverseTracksAlgorithm, lar_content::ThreeDLongitudinalTracksAlgorithm, and lar_content::ThreeDRemnantsAlgorithm.

Referenced by lar_content::ThreeDBaseAlgorithm< T >::Run().

template<typename T >

const std::string & lar_content::ThreeDBaseAlgorithm< T >::GetClusterListNameU ( ) const

inline

Get the name of the u cluster list.

Definition at line 271 of file ThreeDBaseAlgorithm.h.

Referenced by lar_content::ThreeDBaseAlgorithm< T >::MakeClusterMerges(), lar_content::ThreeDTracksBaseAlgorithm< T >::MakeClusterSplits(), and lar_content::ClearTrackFragmentsTool::ProcessTensorElement().

 {
     return m_inputClusterListNameU;
 }

template<typename T >

const std::string & lar_content::ThreeDBaseAlgorithm< T >::GetClusterListNameV ( ) const

inline

Get the name of the v cluster list.

Definition at line 279 of file ThreeDBaseAlgorithm.h.

Referenced by lar_content::ThreeDBaseAlgorithm< T >::MakeClusterMerges(), lar_content::ThreeDTracksBaseAlgorithm< T >::MakeClusterSplits(), and lar_content::ClearTrackFragmentsTool::ProcessTensorElement().

 {
     return m_inputClusterListNameV;
 }

template<typename T >

const std::string & lar_content::ThreeDBaseAlgorithm< T >::GetClusterListNameW ( ) const

inline

Get the name of the w cluster list.

Definition at line 287 of file ThreeDBaseAlgorithm.h.

Referenced by lar_content::ThreeDBaseAlgorithm< T >::MakeClusterMerges(), lar_content::ThreeDTracksBaseAlgorithm< T >::MakeClusterSplits(), and lar_content::ClearTrackFragmentsTool::ProcessTensorElement().

 {
     return m_inputClusterListNameW;
 }

template<typename T >

const pandora::ClusterList & lar_content::ThreeDBaseAlgorithm< T >::GetInputClusterListU ( ) const

inline

Get the input u cluster list.

Definition at line 214 of file ThreeDBaseAlgorithm.h.

Referenced by lar_content::MissingTrackSegmentTool::GetCandidateClusters(), lar_content::ShowerTensorVisualizationTool::Run(), and lar_content::TransverseTensorVisualizationTool::Run().

 {
     if (NULL == m_pInputClusterListU)
         throw pandora::StatusCodeException(pandora::STATUS_CODE_NOT_INITIALIZED);
 
     return (*m_pInputClusterListU);
 }

template<typename T >

const pandora::ClusterList & lar_content::ThreeDBaseAlgorithm< T >::GetInputClusterListV ( ) const

inline

Get the input v cluster list.

Definition at line 225 of file ThreeDBaseAlgorithm.h.

Referenced by lar_content::MissingTrackSegmentTool::GetCandidateClusters(), lar_content::ShowerTensorVisualizationTool::Run(), and lar_content::TransverseTensorVisualizationTool::Run().

 {
     if (NULL == m_pInputClusterListV)
         throw pandora::StatusCodeException(pandora::STATUS_CODE_NOT_INITIALIZED);
 
     return (*m_pInputClusterListV);
 }

template<typename T >

const pandora::ClusterList & lar_content::ThreeDBaseAlgorithm< T >::GetInputClusterListW ( ) const

inline

Get the input w cluster list.

Definition at line 236 of file ThreeDBaseAlgorithm.h.

Referenced by lar_content::MissingTrackSegmentTool::GetCandidateClusters(), lar_content::ShowerTensorVisualizationTool::Run(), and lar_content::TransverseTensorVisualizationTool::Run().

 {
     if (NULL == m_pInputClusterListW)
         throw pandora::StatusCodeException(pandora::STATUS_CODE_NOT_INITIALIZED);
 
     return (*m_pInputClusterListW);
 }

template<typename T >

const pandora::ClusterList & lar_content::ThreeDBaseAlgorithm< T >::GetSelectedClusterListU ( ) const

inline

Get the selected u cluster list.

Definition at line 247 of file ThreeDBaseAlgorithm.h.

References lar_content::ProtoParticle::m_clusterListU.

 {
     return m_clusterListU;
 }

template<typename T >

const pandora::ClusterList & lar_content::ThreeDBaseAlgorithm< T >::GetSelectedClusterListV ( ) const

inline

Get the selected v cluster list.

Definition at line 255 of file ThreeDBaseAlgorithm.h.

References lar_content::ProtoParticle::m_clusterListV.

 {
     return m_clusterListV;
 }

template<typename T >

const pandora::ClusterList & lar_content::ThreeDBaseAlgorithm< T >::GetSelectedClusterListW ( ) const

inline

Get the selected w cluster list.

Definition at line 263 of file ThreeDBaseAlgorithm.h.

References lar_content::ProtoParticle::m_clusterListW.

 {
     return m_clusterListW;
 }

template<typename T >

bool lar_content::ThreeDBaseAlgorithm< T >::MakeClusterMerges ( const ClusterMergeMap & clusterMergeMap )

virtual

Merge clusters together.

Parameters

clusterMergeMap the cluster merge map

Returns: whether changes to the tensor have been made

Definition at line 70 of file ThreeDBaseAlgorithm.cc.

References lar_content::LArClusterHelper::GetClusterHitType(), lar_content::ThreeDBaseAlgorithm< T >::GetClusterListNameU(), lar_content::ThreeDBaseAlgorithm< T >::GetClusterListNameV(), lar_content::ThreeDBaseAlgorithm< T >::GetClusterListNameW(), lar_content::LArClusterHelper::SortByNHits(), lar_content::ThreeDBaseAlgorithm< T >::UpdateForNewCluster(), and lar_content::ThreeDBaseAlgorithm< T >::UpdateUponDeletion().

Referenced by lar_content::SplitShowersTool::ApplyChanges(), lar_content::ThreeDKinkBaseTool::ApplyChanges(), lar_content::ConnectedRemnantsTool::Run(), and lar_content::MissingTrackSegmentTool::Run().

 {
     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((TPC_VIEW_U == hitType) ? this->GetClusterListNameU() : (TPC_VIEW_V == hitType) ? this->GetClusterListNameV() : this->GetClusterListNameW());
 
         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());
 }

template<typename T >

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

protectedvirtual

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

Reimplemented in lar_content::ThreeDTrackFragmentsAlgorithm.

Definition at line 280 of file ThreeDBaseAlgorithm.cc.

References lar_content::ThreeDBaseAlgorithm< T >::CalculateOverlapResult(), lar_content::ThreeDBaseAlgorithm< T >::m_clusterListU, lar_content::ThreeDBaseAlgorithm< T >::m_clusterListV, lar_content::ThreeDBaseAlgorithm< T >::m_clusterListW, and lar_content::LArClusterHelper::SortByNHits().

Referenced by lar_content::ThreeDBaseAlgorithm< T >::Run().

 {
     ClusterVector clusterVectorU(m_clusterListU.begin(), m_clusterListU.end());
     ClusterVector clusterVectorV(m_clusterListV.begin(), m_clusterListV.end());
     ClusterVector clusterVectorW(m_clusterListW.begin(), m_clusterListW.end());
     std::sort(clusterVectorU.begin(), clusterVectorU.end(), LArClusterHelper::SortByNHits);
     std::sort(clusterVectorV.begin(), clusterVectorV.end(), LArClusterHelper::SortByNHits);
     std::sort(clusterVectorW.begin(), clusterVectorW.end(), LArClusterHelper::SortByNHits);
 
     for (const Cluster *const pClusterU : clusterVectorU)
     {
         for (const Cluster *const pClusterV : clusterVectorV)
         {
             for (const Cluster *const pClusterW : clusterVectorW)
                 this->CalculateOverlapResult(pClusterU, pClusterV, pClusterW);
         }
     }
 }

template<typename T >

void lar_content::ThreeDBaseAlgorithm< T >::PreparationStep ( )

protectedvirtual

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

Reimplemented in lar_content::ThreeDTracksBaseAlgorithm< T >, lar_content::ThreeDTracksBaseAlgorithm< TransverseOverlapResult >, lar_content::ThreeDTracksBaseAlgorithm< FragmentOverlapResult >, lar_content::ThreeDTracksBaseAlgorithm< LongitudinalOverlapResult >, and lar_content::ThreeDShowersAlgorithm.

Definition at line 219 of file ThreeDBaseAlgorithm.cc.

Referenced by lar_content::ThreeDBaseAlgorithm< T >::Run().

220 {

221 }

template<typename T>

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

protectedvirtual

Reimplemented in lar_content::ThreeDShowersAlgorithm, lar_content::ThreeDTrackFragmentsAlgorithm, lar_content::ThreeDTracksBaseAlgorithm< T >, lar_content::ThreeDTracksBaseAlgorithm< TransverseOverlapResult >, lar_content::ThreeDTracksBaseAlgorithm< FragmentOverlapResult >, lar_content::ThreeDTracksBaseAlgorithm< LongitudinalOverlapResult >, lar_content::ThreeDTransverseTracksAlgorithm, lar_content::ThreeDLongitudinalTracksAlgorithm, and lar_content::ThreeDRemnantsAlgorithm.

Definition at line 302 of file ThreeDBaseAlgorithm.cc.

References lar_content::ThreeDBaseAlgorithm< T >::m_inputClusterListNameU, lar_content::ThreeDBaseAlgorithm< T >::m_inputClusterListNameV, lar_content::ThreeDBaseAlgorithm< T >::m_inputClusterListNameW, and lar_content::ThreeDBaseAlgorithm< T >::m_outputPfoListName.

Referenced by lar_content::ThreeDRemnantsAlgorithm::ReadSettings(), lar_content::ThreeDTracksBaseAlgorithm< T >::ReadSettings(), and lar_content::ThreeDShowersAlgorithm::ReadSettings().

 {
     PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, XmlHelper::ReadValue(xmlHandle, "InputClusterListNameU", m_inputClusterListNameU));
     PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, XmlHelper::ReadValue(xmlHandle, "InputClusterListNameV", m_inputClusterListNameV));
     PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, XmlHelper::ReadValue(xmlHandle, "InputClusterListNameW", m_inputClusterListNameW));
     PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, XmlHelper::ReadValue(xmlHandle, "OutputPfoListName", m_outputPfoListName));
 
     return STATUS_CODE_SUCCESS;
 }

template<typename T >

void lar_content::ThreeDBaseAlgorithm< T >::RemoveUnavailableTensorElements ( )

virtual

Update tensor to remove all elements that have been added to pfos and so are unavailable.

Definition at line 175 of file ThreeDBaseAlgorithm.cc.

References lar_content::OverlapTensor< T >::GetClusterNavigationMapUV(), lar_content::OverlapTensor< T >::GetClusterNavigationMapVW(), lar_content::OverlapTensor< T >::GetClusterNavigationMapWU(), lar_content::ThreeDBaseAlgorithm< T >::m_overlapTensor, lar_content::LArClusterHelper::SortByNHits(), and lar_content::ThreeDBaseAlgorithm< T >::UpdateUponDeletion().

 {
     const typename TensorType::ClusterNavigationMap &navigationMapUV(m_overlapTensor.GetClusterNavigationMapUV());
     const typename TensorType::ClusterNavigationMap &navigationMapVW(m_overlapTensor.GetClusterNavigationMapVW());
     const typename TensorType::ClusterNavigationMap &navigationMapWU(m_overlapTensor.GetClusterNavigationMapWU());
     ClusterList usedClusters;
 
     for (typename TensorType::ClusterNavigationMap::const_iterator iter = navigationMapUV.begin(), iterEnd = navigationMapUV.end(); iter != iterEnd; ++iter)
     {
         if (!(iter->first->IsAvailable()))
             usedClusters.push_back(iter->first);
     }
 
     for (typename TensorType::ClusterNavigationMap::const_iterator iter = navigationMapVW.begin(), iterEnd = navigationMapVW.end(); iter != iterEnd; ++iter)
     {
         if (!(iter->first->IsAvailable()))
             usedClusters.push_back(iter->first);
     }
 
     for (typename TensorType::ClusterNavigationMap::const_iterator iter = navigationMapWU.begin(), iterEnd = navigationMapWU.end(); iter != iterEnd; ++iter)
     {
         if (!(iter->first->IsAvailable()))
             usedClusters.push_back(iter->first);
     }
 
     usedClusters.sort(LArClusterHelper::SortByNHits);
 
     for (ClusterList::const_iterator iter = usedClusters.begin(), iterEnd = usedClusters.end(); iter != iterEnd; ++iter)
         this->UpdateUponDeletion(*iter);
 }

template<typename T >

StatusCode lar_content::ThreeDBaseAlgorithm< T >::Run ( )

private

Definition at line 242 of file ThreeDBaseAlgorithm.cc.

 {
     try
     {
         PANDORA_THROW_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_INITIALIZED, !=, PandoraContentApi::GetList(*this,
             m_inputClusterListNameU, m_pInputClusterListU));
         PANDORA_THROW_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_INITIALIZED, !=, PandoraContentApi::GetList(*this,
             m_inputClusterListNameV, m_pInputClusterListV));
         PANDORA_THROW_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_INITIALIZED, !=, PandoraContentApi::GetList(*this,
             m_inputClusterListNameW, m_pInputClusterListW));
 
         if ((NULL == m_pInputClusterListU) || (NULL == m_pInputClusterListV) || (NULL == m_pInputClusterListW))
         {
             if (PandoraContentApi::GetSettings(*this)->ShouldDisplayAlgorithmInfo())
                 std::cout << "ThreeDBaseAlgorithm: one or more input cluster lists unavailable." << std::endl;
             throw StatusCodeException(STATUS_CODE_SUCCESS);
         }
 
         this->SelectAllInputClusters();
         this->PreparationStep();
         this->PerformMainLoop();
         this->ExamineTensor();
         this->TidyUp();
     }
     catch (StatusCodeException &statusCodeException)
     {
         this->TidyUp();
 
         if (STATUS_CODE_SUCCESS != statusCodeException.GetStatusCode())
             throw statusCodeException;
     }
 
     return STATUS_CODE_SUCCESS;
 }

template<typename T >

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

protectedvirtual

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

Definition at line 209 of file ThreeDBaseAlgorithm.cc.

References lar_content::ThreeDBaseAlgorithm< T >::m_clusterListU, lar_content::ThreeDBaseAlgorithm< T >::m_clusterListV, lar_content::ThreeDBaseAlgorithm< T >::m_clusterListW, lar_content::ThreeDBaseAlgorithm< T >::m_pInputClusterListU, lar_content::ThreeDBaseAlgorithm< T >::m_pInputClusterListV, lar_content::ThreeDBaseAlgorithm< T >::m_pInputClusterListW, and lar_content::ThreeDBaseAlgorithm< T >::SelectInputClusters().

Referenced by lar_content::ThreeDBaseAlgorithm< T >::Run().

 {
     this->SelectInputClusters(m_pInputClusterListU, m_clusterListU);
     this->SelectInputClusters(m_pInputClusterListV, m_clusterListV);
     this->SelectInputClusters(m_pInputClusterListW, m_clusterListW);
 }

template<typename T>

virtual void lar_content::ThreeDBaseAlgorithm< T >::SelectInputClusters	(	const pandora::ClusterList *const	pInputClusterList,
		pandora::ClusterList &	selectedClusterList
	)		const

pure 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

Implemented in lar_content::ThreeDTracksBaseAlgorithm< T >, lar_content::ThreeDTracksBaseAlgorithm< TransverseOverlapResult >, lar_content::ThreeDTracksBaseAlgorithm< FragmentOverlapResult >, lar_content::ThreeDTracksBaseAlgorithm< LongitudinalOverlapResult >, lar_content::ThreeDShowersAlgorithm, and lar_content::ThreeDRemnantsAlgorithm.

Referenced by lar_content::ThreeDBaseAlgorithm< T >::SelectAllInputClusters().

template<typename T>

virtual void lar_content::ThreeDBaseAlgorithm< T >::SetPfoParameters	(	const ProtoParticle &	protoParticle,
		PandoraContentApi::ParticleFlowObject::Parameters &	pfoParameters
	)		const

pure virtual

Calculate Pfo properties from proto particle.

Parameters

protoParticle	the input proto particle
pfoParameters	the output pfo parameters

Implemented in lar_content::ThreeDTracksBaseAlgorithm< T >, lar_content::ThreeDTracksBaseAlgorithm< TransverseOverlapResult >, lar_content::ThreeDTracksBaseAlgorithm< FragmentOverlapResult >, lar_content::ThreeDTracksBaseAlgorithm< LongitudinalOverlapResult >, lar_content::ThreeDShowersAlgorithm, and lar_content::ThreeDRemnantsAlgorithm.

Referenced by lar_content::ThreeDBaseAlgorithm< T >::CreateThreeDParticles().

template<typename T >

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

protectedvirtual

Tidy member variables in derived class.

Reimplemented in lar_content::ThreeDTracksBaseAlgorithm< T >, lar_content::ThreeDTracksBaseAlgorithm< TransverseOverlapResult >, lar_content::ThreeDTracksBaseAlgorithm< FragmentOverlapResult >, lar_content::ThreeDTracksBaseAlgorithm< LongitudinalOverlapResult >, and lar_content::ThreeDShowersAlgorithm.

Definition at line 226 of file ThreeDBaseAlgorithm.cc.

References lar_content::OverlapTensor< T >::Clear(), lar_content::ThreeDBaseAlgorithm< T >::m_clusterListU, lar_content::ThreeDBaseAlgorithm< T >::m_clusterListV, lar_content::ThreeDBaseAlgorithm< T >::m_clusterListW, lar_content::ThreeDBaseAlgorithm< T >::m_overlapTensor, lar_content::ThreeDBaseAlgorithm< T >::m_pInputClusterListU, lar_content::ThreeDBaseAlgorithm< T >::m_pInputClusterListV, and lar_content::ThreeDBaseAlgorithm< T >::m_pInputClusterListW.

Referenced by lar_content::ThreeDBaseAlgorithm< T >::Run(), lar_content::ThreeDShowersAlgorithm::TidyUp(), and lar_content::ThreeDTracksBaseAlgorithm< T >::TidyUp().

 {
     m_overlapTensor.Clear();
 
     m_pInputClusterListU = NULL;
     m_pInputClusterListV = NULL;
     m_pInputClusterListW = NULL;
 
     m_clusterListU.clear();
     m_clusterListV.clear();
     m_clusterListW.clear();
 }

template<typename T>

void lar_content::ThreeDBaseAlgorithm< 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

Reimplemented in lar_content::ThreeDTracksBaseAlgorithm< T >, lar_content::ThreeDTracksBaseAlgorithm< TransverseOverlapResult >, lar_content::ThreeDTracksBaseAlgorithm< FragmentOverlapResult >, lar_content::ThreeDTracksBaseAlgorithm< LongitudinalOverlapResult >, lar_content::ThreeDShowersAlgorithm, and lar_content::ThreeDTrackFragmentsAlgorithm.

Definition at line 109 of file ThreeDBaseAlgorithm.cc.

References lar_content::ThreeDBaseAlgorithm< T >::CalculateOverlapResult(), lar_content::LArClusterHelper::GetClusterHitType(), lar_content::ThreeDBaseAlgorithm< T >::m_clusterListU, lar_content::ThreeDBaseAlgorithm< T >::m_clusterListV, lar_content::ThreeDBaseAlgorithm< T >::m_clusterListW, and lar_content::LArClusterHelper::SortByNHits().

Referenced by lar_content::ThreeDBaseAlgorithm< T >::MakeClusterMerges(), lar_content::ThreeDShowersAlgorithm::UpdateForNewCluster(), and lar_content::ThreeDTracksBaseAlgorithm< T >::UpdateForNewCluster().

 {
     const HitType hitType(LArClusterHelper::GetClusterHitType(pNewCluster));
 
     if (!((TPC_VIEW_U == hitType) || (TPC_VIEW_V == hitType) || (TPC_VIEW_W == hitType)))
         throw StatusCodeException(STATUS_CODE_FAILURE);
 
     ClusterList &clusterList((TPC_VIEW_U == hitType) ? m_clusterListU : (TPC_VIEW_V == hitType) ? m_clusterListV : m_clusterListW);
 
     if (clusterList.end() != std::find(clusterList.begin(), clusterList.end(), pNewCluster))
         throw StatusCodeException(STATUS_CODE_ALREADY_PRESENT);
 
     clusterList.push_back(pNewCluster);
 
     const ClusterList &clusterList1((TPC_VIEW_U == hitType) ? m_clusterListV : m_clusterListU);
     const ClusterList &clusterList2((TPC_VIEW_W == hitType) ? m_clusterListV : m_clusterListW);
 
     ClusterVector clusterVector1(clusterList1.begin(), clusterList1.end());
     ClusterVector clusterVector2(clusterList2.begin(), clusterList2.end());
     std::sort(clusterVector1.begin(), clusterVector1.end(), LArClusterHelper::SortByNHits);
     std::sort(clusterVector2.begin(), clusterVector2.end(), LArClusterHelper::SortByNHits);
 
     for (const Cluster *const pCluster1 : clusterVector1)
     {
         for (const Cluster *const pCluster2 : clusterVector2)
         {
             if (TPC_VIEW_U == hitType)
             {
                 this->CalculateOverlapResult(pNewCluster, pCluster1, pCluster2);
             }
             else if (TPC_VIEW_V == hitType)
             {
                 this->CalculateOverlapResult(pCluster1, pNewCluster, pCluster2);
             }
             else
             {
                 this->CalculateOverlapResult(pCluster1, pCluster2, pNewCluster);
             }
         }
     }
 }

template<typename T>

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

virtual

Update to reflect cluster deletion.

Parameters

pDeletedCluster address of the deleted cluster

Reimplemented in lar_content::ThreeDTracksBaseAlgorithm< T >, lar_content::ThreeDTracksBaseAlgorithm< TransverseOverlapResult >, lar_content::ThreeDTracksBaseAlgorithm< FragmentOverlapResult >, lar_content::ThreeDTracksBaseAlgorithm< LongitudinalOverlapResult >, and lar_content::ThreeDShowersAlgorithm.

Definition at line 154 of file ThreeDBaseAlgorithm.cc.

References lar_content::ThreeDBaseAlgorithm< T >::m_clusterListU, lar_content::ThreeDBaseAlgorithm< T >::m_clusterListV, lar_content::ThreeDBaseAlgorithm< T >::m_clusterListW, lar_content::ThreeDBaseAlgorithm< T >::m_overlapTensor, and lar_content::OverlapTensor< T >::RemoveCluster().

Referenced by lar_content::ThreeDBaseAlgorithm< T >::MakeClusterMerges(), lar_content::ThreeDBaseAlgorithm< T >::RemoveUnavailableTensorElements(), lar_content::ThreeDShowersAlgorithm::UpdateUponDeletion(), and lar_content::ThreeDTracksBaseAlgorithm< T >::UpdateUponDeletion().

 {
     ClusterList::iterator iterU = std::find(m_clusterListU.begin(), m_clusterListU.end(), pDeletedCluster);
     ClusterList::iterator iterV = std::find(m_clusterListV.begin(), m_clusterListV.end(), pDeletedCluster);
     ClusterList::iterator iterW = std::find(m_clusterListW.begin(), m_clusterListW.end(), pDeletedCluster);
 
     if (m_clusterListU.end() != iterU)
         m_clusterListU.erase(iterU);
 
     if (m_clusterListV.end() != iterV)
         m_clusterListV.erase(iterV);
 
     if (m_clusterListW.end() != iterW)
         m_clusterListW.erase(iterW);
 
     m_overlapTensor.RemoveCluster(pDeletedCluster);
 }

Member Data Documentation

template<typename T>

pandora::ClusterList lar_content::ThreeDBaseAlgorithm< T >::m_clusterListU

protected

The selected modified cluster list U.

Definition at line 196 of file ThreeDBaseAlgorithm.h.

Referenced by lar_content::ThreeDBaseAlgorithm< T >::PerformMainLoop(), lar_content::ThreeDTracksBaseAlgorithm< T >::PreparationStep(), lar_content::ThreeDBaseAlgorithm< T >::SelectAllInputClusters(), lar_content::ThreeDBaseAlgorithm< T >::TidyUp(), lar_content::ThreeDBaseAlgorithm< T >::UpdateForNewCluster(), and lar_content::ThreeDBaseAlgorithm< T >::UpdateUponDeletion().

template<typename T>

pandora::ClusterList lar_content::ThreeDBaseAlgorithm< T >::m_clusterListV

protected

The selected modified cluster list V.

Definition at line 197 of file ThreeDBaseAlgorithm.h.

Referenced by lar_content::ThreeDBaseAlgorithm< T >::PerformMainLoop(), lar_content::ThreeDTracksBaseAlgorithm< T >::PreparationStep(), lar_content::ThreeDBaseAlgorithm< T >::SelectAllInputClusters(), lar_content::ThreeDBaseAlgorithm< T >::TidyUp(), lar_content::ThreeDBaseAlgorithm< T >::UpdateForNewCluster(), and lar_content::ThreeDBaseAlgorithm< T >::UpdateUponDeletion().

template<typename T>

pandora::ClusterList lar_content::ThreeDBaseAlgorithm< T >::m_clusterListW

protected

The selected modified cluster list W.

Definition at line 198 of file ThreeDBaseAlgorithm.h.

Referenced by lar_content::ThreeDBaseAlgorithm< T >::PerformMainLoop(), lar_content::ThreeDTracksBaseAlgorithm< T >::PreparationStep(), lar_content::ThreeDBaseAlgorithm< T >::SelectAllInputClusters(), lar_content::ThreeDBaseAlgorithm< T >::TidyUp(), lar_content::ThreeDBaseAlgorithm< T >::UpdateForNewCluster(), and lar_content::ThreeDBaseAlgorithm< T >::UpdateUponDeletion().

template<typename T>

std::string lar_content::ThreeDBaseAlgorithm< T >::m_inputClusterListNameU

private

The name of the view U cluster list.

Definition at line 205 of file ThreeDBaseAlgorithm.h.

Referenced by lar_content::ThreeDBaseAlgorithm< T >::ReadSettings(), and lar_content::ThreeDBaseAlgorithm< T >::Run().

template<typename T>

std::string lar_content::ThreeDBaseAlgorithm< T >::m_inputClusterListNameV

private

The name of the view V cluster list.

Definition at line 206 of file ThreeDBaseAlgorithm.h.

Referenced by lar_content::ThreeDBaseAlgorithm< T >::ReadSettings(), and lar_content::ThreeDBaseAlgorithm< T >::Run().

template<typename T>

std::string lar_content::ThreeDBaseAlgorithm< T >::m_inputClusterListNameW

private

The name of the view W cluster list.

Definition at line 207 of file ThreeDBaseAlgorithm.h.

Referenced by lar_content::ThreeDBaseAlgorithm< T >::ReadSettings(), and lar_content::ThreeDBaseAlgorithm< T >::Run().

template<typename T>

std::string lar_content::ThreeDBaseAlgorithm< T >::m_outputPfoListName

private

The output pfo list name.

Definition at line 208 of file ThreeDBaseAlgorithm.h.

Referenced by lar_content::ThreeDBaseAlgorithm< T >::CreateThreeDParticles(), and lar_content::ThreeDBaseAlgorithm< T >::ReadSettings().

template<typename T>

TensorType lar_content::ThreeDBaseAlgorithm< T >::m_overlapTensor

protected

The overlap tensor.

Definition at line 200 of file ThreeDBaseAlgorithm.h.

Referenced by lar_content::ThreeDBaseAlgorithm< T >::RemoveUnavailableTensorElements(), lar_content::ThreeDBaseAlgorithm< T >::TidyUp(), and lar_content::ThreeDBaseAlgorithm< T >::UpdateUponDeletion().

template<typename T>

const pandora::ClusterList* lar_content::ThreeDBaseAlgorithm< T >::m_pInputClusterListU

protected

Address of the input cluster list U.

Definition at line 192 of file ThreeDBaseAlgorithm.h.

Referenced by lar_content::ThreeDBaseAlgorithm< T >::Run(), lar_content::ThreeDBaseAlgorithm< T >::SelectAllInputClusters(), and lar_content::ThreeDBaseAlgorithm< T >::TidyUp().

template<typename T>

const pandora::ClusterList* lar_content::ThreeDBaseAlgorithm< T >::m_pInputClusterListV

protected

Address of the input cluster list V.

Definition at line 193 of file ThreeDBaseAlgorithm.h.

Referenced by lar_content::ThreeDBaseAlgorithm< T >::Run(), lar_content::ThreeDBaseAlgorithm< T >::SelectAllInputClusters(), and lar_content::ThreeDBaseAlgorithm< T >::TidyUp().

template<typename T>

const pandora::ClusterList* lar_content::ThreeDBaseAlgorithm< T >::m_pInputClusterListW

protected

Address of the input cluster list W.

Definition at line 194 of file ThreeDBaseAlgorithm.h.

Referenced by lar_content::ThreeDBaseAlgorithm< T >::Run(), lar_content::ThreeDBaseAlgorithm< T >::SelectAllInputClusters(), and lar_content::ThreeDBaseAlgorithm< T >::TidyUp().

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

larpandoracontent/v03_13_02/source/larpandoracontent/LArThreeDReco/LArThreeDBase/ThreeDBaseAlgorithm.h
larpandoracontent/v03_13_02/source/larpandoracontent/LArThreeDReco/LArThreeDBase/ThreeDBaseAlgorithm.cc

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

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

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

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