NViewTrackMatchingAlgorithm class. More...

#include <NViewTrackMatchingAlgorithm.h>

Inheritance diagram for lar_content::NViewTrackMatchingAlgorithm< T >:

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

virtual	~NViewTrackMatchingAlgorithm ()
	Destructor. More...

const TwoDSlidingFitResult &	GetCachedSlidingFitResult (const pandora::Cluster *const pCluster) const
	Get a sliding fit result from the algorithm cache. More...

unsigned int	GetSlidingFitWindow () const
	Get the layer window for the sliding linear fits. More...

virtual bool	MakeClusterSplits (const SplitPositionMap &splitPositionMap)
	Make cluster splits. More...

virtual bool	MakeClusterSplit (const pandora::CartesianVector &splitPosition, const pandora::Cluster &pCurrentCluster, const pandora::Cluster &pLowXCluster, const pandora::Cluster *&pHighXCluster) const
	Make a cluster split. 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	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 void	SetPfoParticleId (PandoraContentApi::ParticleFlowObject::Parameters &pfoParameters) const
	Set pfo particle id. More...

Public Member Functions inherited from lar_content::NViewMatchingAlgorithm< T >
	NViewMatchingAlgorithm ()
	Default constructor. More...

virtual	~NViewMatchingAlgorithm ()
	Destructor. 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 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...

Static Public Member Functions
static bool	SortSplitPositions (const pandora::CartesianVector &lhs, const pandora::CartesianVector &rhs)
	Sort split position cartesian vectors by increasing x coordinate. More...

Protected Member Functions
void	AddToSlidingFitCache (const pandora::Cluster *const pCluster)
	Add a new sliding fit result, for the specified cluster, to the algorithm cache. More...

void	RemoveFromSlidingFitCache (const pandora::Cluster *const pCluster)
	Remova an existing sliding fit result, for the specified cluster, from the algorithm cache. 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::NViewMatchingAlgorithm< T >
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...

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...

Private Attributes
unsigned int	m_slidingFitWindow
	The layer window for the sliding linear fits. More...

TwoDSlidingFitResultMap	m_slidingFitResultMap
	The sliding fit result map. More...

unsigned int	m_minClusterCaloHits
	The min number of hits in base cluster selection method. More...

float	m_minClusterLengthSquared
	The min length (squared) in base cluster selection method. More...

Additional Inherited Members
Public Types inherited from lar_content::NViewMatchingAlgorithm< T >
typedef T	MatchingType

Protected Attributes inherited from lar_content::NViewMatchingAlgorithm< T >
MatchingType	m_matchingControl
	The matching control. More...

Detailed Description

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

NViewTrackMatchingAlgorithm class.

Definition at line 26 of file NViewTrackMatchingAlgorithm.h.

Constructor & Destructor Documentation

template<typename T >

lar_content::NViewTrackMatchingAlgorithm< T >::NViewTrackMatchingAlgorithm ( )

Default constructor.

Definition at line 28 of file NViewTrackMatchingAlgorithm.cc.

                                                             :
     m_slidingFitWindow(20),
     m_minClusterCaloHits(5),
     m_minClusterLengthSquared(3.f * 3.f)
 {
 }

template<typename T >

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

virtual

Destructor.

Definition at line 38 of file NViewTrackMatchingAlgorithm.cc.

39 {

40 }

Member Function Documentation

template<typename T>

void lar_content::NViewTrackMatchingAlgorithm< T >::AddToSlidingFitCache ( const pandora::Cluster *const pCluster )

protected

Add a new sliding fit result, for the specified cluster, to the algorithm cache.

Parameters

pCluster address of the relevant cluster

Definition at line 255 of file NViewTrackMatchingAlgorithm.cc.

 {
     const float slidingFitPitch(LArGeometryHelper::GetWireZPitch(this->GetPandora()));
     const TwoDSlidingFitResult slidingFitResult(pCluster, m_slidingFitWindow, slidingFitPitch);
 
     if (!m_slidingFitResultMap.insert(TwoDSlidingFitResultMap::value_type(pCluster, slidingFitResult)).second)
         throw StatusCodeException(STATUS_CODE_FAILURE);
 }

template<typename T>

const TwoDSlidingFitResult & lar_content::NViewTrackMatchingAlgorithm< T >::GetCachedSlidingFitResult ( const pandora::Cluster *const pCluster ) const

Get a sliding fit result from the algorithm cache.

Parameters

pCluster address of the relevant cluster

Definition at line 45 of file NViewTrackMatchingAlgorithm.cc.

 {
     TwoDSlidingFitResultMap::const_iterator iter = m_slidingFitResultMap.find(pCluster);
 
     if (m_slidingFitResultMap.end() == iter)
         throw StatusCodeException(STATUS_CODE_NOT_FOUND);
 
     return iter->second;
 }

template<typename T >

unsigned int lar_content::NViewTrackMatchingAlgorithm< T >::GetSlidingFitWindow ( ) const

inline

Get the layer window for the sliding linear fits.

Returns: the layer window for the sliding linear fits

Definition at line 118 of file NViewTrackMatchingAlgorithm.h.

 {
     return m_slidingFitWindow;
 }

template<typename T>

bool lar_content::NViewTrackMatchingAlgorithm< T >::MakeClusterSplit	(	const pandora::CartesianVector &	splitPosition,
		const pandora::Cluster *&	pCurrentCluster,
		const pandora::Cluster *&	pLowXCluster,
		const pandora::Cluster *&	pHighXCluster
	)		const

virtual

Make a cluster split.

Parameters

splitPosition	the split position
pCurrentCluster	the cluster to split
pLowXCluster	to receive the low x cluster
pHighXCluster	to receive the high x cluster

Returns: whether a cluster split occurred

Definition at line 105 of file NViewTrackMatchingAlgorithm.cc.

 {
     CartesianVector lowXEnd(0.f, 0.f, 0.f), highXEnd(0.f, 0.f, 0.f);
 
     try
     {
         LArPointingCluster pointingCluster(pCurrentCluster);
         const bool innerIsLowX(pointingCluster.GetInnerVertex().GetPosition().GetX() < pointingCluster.GetOuterVertex().GetPosition().GetX());
         lowXEnd = (innerIsLowX ? pointingCluster.GetInnerVertex().GetPosition() : pointingCluster.GetOuterVertex().GetPosition());
         highXEnd = (innerIsLowX ? pointingCluster.GetOuterVertex().GetPosition() : pointingCluster.GetInnerVertex().GetPosition());
     }
     catch (const StatusCodeException &)
     {
         return false;
     }
 
     const CartesianVector lowXUnitVector((lowXEnd - splitPosition).GetUnitVector());
     const CartesianVector highXUnitVector((highXEnd - splitPosition).GetUnitVector());
 
     CaloHitList caloHitList;
     pCurrentCluster->GetOrderedCaloHitList().FillCaloHitList(caloHitList);
 
     std::string originalListName, fragmentListName;
     const ClusterList clusterList(1, pCurrentCluster);
     PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::InitializeFragmentation(*this, clusterList, originalListName, fragmentListName));
 
     pLowXCluster = nullptr;
     pHighXCluster = nullptr;
 
     for (const CaloHit *const pCaloHit : caloHitList)
     {
         const CartesianVector unitVector((pCaloHit->GetPositionVector() - splitPosition).GetUnitVector());
         const float dotProductLowX(unitVector.GetDotProduct(lowXUnitVector));
         const float dotProductHighX(unitVector.GetDotProduct(highXUnitVector));
 
         const Cluster *&pClusterToModify((dotProductLowX > dotProductHighX) ? pLowXCluster : pHighXCluster);
 
         if (!pClusterToModify)
         {
             PandoraContentApi::Cluster::Parameters parameters;
             parameters.m_caloHitList.push_back(pCaloHit);
             PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::Cluster::Create(*this, parameters, pClusterToModify));
         }
         else
         {
             PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::AddToCluster(*this, pClusterToModify, pCaloHit));
         }
     }
 
     if (!pLowXCluster || !pHighXCluster)
     {
         PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::EndFragmentation(*this, originalListName, fragmentListName));
         return false;
     }
 
     PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::EndFragmentation(*this, fragmentListName, originalListName));
     return true;
 }

template<typename T >

bool lar_content::NViewTrackMatchingAlgorithm< T >::MakeClusterSplits ( const SplitPositionMap & splitPositionMap )

virtual

Make cluster splits.

Parameters

splitPositionMap the split position map

Returns: whether changes to the overlap container have been made

Definition at line 58 of file NViewTrackMatchingAlgorithm.cc.

 {
     bool changesMade(false);
 
     ClusterList splitClusters;
     for (const auto &mapEntry : splitPositionMap)
         splitClusters.push_back(mapEntry.first);
     splitClusters.sort(LArClusterHelper::SortByNHits);
 
     for (const Cluster *pCurrentCluster : splitClusters)
     {
         CartesianPointVector splitPositions(splitPositionMap.at(pCurrentCluster));
         std::sort(splitPositions.begin(), splitPositions.end(), NViewTrackMatchingAlgorithm<T>::SortSplitPositions);
 
         const HitType hitType(LArClusterHelper::GetClusterHitType(pCurrentCluster));
         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);
 
         PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::ReplaceCurrentList<Cluster>(*this, clusterListName));
 
         for (const CartesianVector &splitPosition : splitPositions)
         {
             const Cluster *pLowXCluster(nullptr), *pHighXCluster(nullptr);
             this->UpdateUponDeletion(pCurrentCluster);
 
             if (this->MakeClusterSplit(splitPosition, pCurrentCluster, pLowXCluster, pHighXCluster))
             {
                 changesMade = true;
                 this->UpdateForNewCluster(pLowXCluster);
                 this->UpdateForNewCluster(pHighXCluster);
                 pCurrentCluster = pHighXCluster;
             }
             else
             {
                 this->UpdateForNewCluster(pCurrentCluster);
             }
         }
     }
 
     return changesMade;
 }

template<typename T>

void lar_content::NViewTrackMatchingAlgorithm< T >::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 from lar_content::MatchingBaseAlgorithm.

Definition at line 225 of file NViewTrackMatchingAlgorithm.cc.

 {
     for (ClusterList::iterator iter = preparedClusterList.begin(), iterEnd = preparedClusterList.end(); iter != iterEnd;)
     {
         try
         {
             this->AddToSlidingFitCache(*iter);
             ++iter;
         }
         catch (const StatusCodeException &statusCodeException)
         {
             preparedClusterList.erase(iter++);
 
             if (STATUS_CODE_FAILURE == statusCodeException.GetStatusCode())
                 throw statusCodeException;
         }
     }
 }

template<typename T>

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

protectedvirtual

Reimplemented from lar_content::NViewMatchingAlgorithm< T >.

Reimplemented in lar_content::ThreeViewTrackFragmentsAlgorithm, lar_content::ThreeViewTransverseTracksAlgorithm, lar_content::TwoViewTransverseTracksAlgorithm, and lar_content::ThreeViewLongitudinalTracksAlgorithm.

Definition at line 287 of file NViewTrackMatchingAlgorithm.cc.

 {
     PANDORA_RETURN_RESULT_IF_AND_IF(
         STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "SlidingFitWindow", m_slidingFitWindow));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(
         STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "MinClusterCaloHits", m_minClusterCaloHits));
 
     float minClusterLength = std::sqrt(m_minClusterLengthSquared);
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "MinClusterLength", minClusterLength));
     m_minClusterLengthSquared = minClusterLength * minClusterLength;
 
     return NViewMatchingAlgorithm<T>::ReadSettings(xmlHandle);
 }

template<typename T>

void lar_content::NViewTrackMatchingAlgorithm< T >::RemoveFromSlidingFitCache ( const pandora::Cluster *const pCluster )

protected

Remova an existing sliding fit result, for the specified cluster, from the algorithm cache.

Parameters

pCluster address of the relevant cluster

Definition at line 267 of file NViewTrackMatchingAlgorithm.cc.

 {
     TwoDSlidingFitResultMap::iterator iter = m_slidingFitResultMap.find(pCluster);
 
     if (m_slidingFitResultMap.end() != iter)
         m_slidingFitResultMap.erase(iter);
 }

template<typename T>

void lar_content::NViewTrackMatchingAlgorithm< T >::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 from lar_content::MatchingBaseAlgorithm.

Definition at line 205 of file NViewTrackMatchingAlgorithm.cc.

 {
     for (const Cluster *const pCluster : *pInputClusterList)
     {
         if (!pCluster->IsAvailable())
             continue;
 
         if (pCluster->GetNCaloHits() < m_minClusterCaloHits)
             continue;
 
         if (LArClusterHelper::GetLengthSquared(pCluster) < m_minClusterLengthSquared)
             continue;
 
         selectedClusterList.push_back(pCluster);
     }
 }

template<typename T >

void lar_content::NViewTrackMatchingAlgorithm< T >::SetPfoParticleId ( PandoraContentApi::ParticleFlowObject::Parameters & pfoParameters ) const

virtual

Set pfo particle id.

Parameters

pfoParameters the output pfo parameters

Reimplemented from lar_content::MatchingBaseAlgorithm.

Definition at line 247 of file NViewTrackMatchingAlgorithm.cc.

 {
     pfoParameters.m_particleId = MU_MINUS; // Track
 }

template<typename T >

bool lar_content::NViewTrackMatchingAlgorithm< T >::SortSplitPositions	(	const pandora::CartesianVector &	lhs,
		const pandora::CartesianVector &	rhs
	)

static

Sort split position cartesian vectors by increasing x coordinate.

Parameters

lhs	the first cartesian vector
rhs	the second cartesian vector

Definition at line 168 of file NViewTrackMatchingAlgorithm.cc.

 {
     return (lhs.GetX() < rhs.GetX());
 }

template<typename T >

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

protectedvirtual

Tidy member variables in derived class.

Reimplemented from lar_content::NViewMatchingAlgorithm< T >.

Definition at line 278 of file NViewTrackMatchingAlgorithm.cc.

 {
     m_slidingFitResultMap.clear();
     return NViewMatchingAlgorithm<T>::TidyUp();
 }

template<typename T>

void lar_content::NViewTrackMatchingAlgorithm< 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 from lar_content::NViewMatchingAlgorithm< T >.

Reimplemented in lar_content::ThreeViewTrackFragmentsAlgorithm.

Definition at line 176 of file NViewTrackMatchingAlgorithm.cc.

 {
     try
     {
         this->AddToSlidingFitCache(pNewCluster);
     }
     catch (const StatusCodeException &statusCodeException)
     {
         if (STATUS_CODE_FAILURE == statusCodeException.GetStatusCode())
             throw statusCodeException;
 
         return;
     }
 
     NViewMatchingAlgorithm<T>::UpdateForNewCluster(pNewCluster);
 }

template<typename T>

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

virtual

Update to reflect cluster deletion.

Parameters

pDeletedCluster address of the deleted cluster

Reimplemented from lar_content::NViewMatchingAlgorithm< T >.

Definition at line 196 of file NViewTrackMatchingAlgorithm.cc.

 {
     this->RemoveFromSlidingFitCache(pDeletedCluster);
     NViewMatchingAlgorithm<T>::UpdateUponDeletion(pDeletedCluster);
 }

Member Data Documentation

template<typename T>

unsigned int lar_content::NViewTrackMatchingAlgorithm< T >::m_minClusterCaloHits

private

The min number of hits in base cluster selection method.

Definition at line 111 of file NViewTrackMatchingAlgorithm.h.

template<typename T>

float lar_content::NViewTrackMatchingAlgorithm< T >::m_minClusterLengthSquared

private

The min length (squared) in base cluster selection method.

Definition at line 112 of file NViewTrackMatchingAlgorithm.h.

template<typename T>

TwoDSlidingFitResultMap lar_content::NViewTrackMatchingAlgorithm< T >::m_slidingFitResultMap

private

The sliding fit result map.

Definition at line 109 of file NViewTrackMatchingAlgorithm.h.

template<typename T>

unsigned int lar_content::NViewTrackMatchingAlgorithm< T >::m_slidingFitWindow

private

The layer window for the sliding linear fits.

Definition at line 108 of file NViewTrackMatchingAlgorithm.h.

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

larpandoracontent/larpandoracontent/LArThreeDReco/LArThreeDBase/NViewTrackMatchingAlgorithm.h
larpandoracontent/larpandoracontent/LArThreeDReco/LArThreeDBase/NViewTrackMatchingAlgorithm.cc

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

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

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

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