OverlapMatrix class. More...

#include "LArOverlapMatrix.h"

Classes
class	Element
	Element class. More...

Public Types
typedef T	OverlapResult

typedef std::vector< Element >	ElementList

typedef std::unordered_map< const pandora::Cluster *, pandora::ClusterList >	ClusterNavigationMap

typedef std::unordered_map< const pandora::Cluster *, OverlapResult >	OverlapList

typedef std::unordered_map< const pandora::Cluster *, OverlapList >	TheMatrix

typedef TheMatrix::const_iterator	const_iterator

Public Member Functions
void	GetUnambiguousElements (const bool ignoreUnavailable, ElementList &elementList) const
	Get unambiguous elements. More...

bool	DefaultAmbiguityFunction (const pandora::ClusterList &clusterList1, const pandora::ClusterList &clusterList2, const pandora::Cluster &pCluster1, const pandora::Cluster &pCluster2) const
	Default ambiguity function, checking that only one cluster from view 1 and view 2 is found. More...

void	GetNConnections (const pandora::Cluster *const pCluster, const bool ignoreUnavailable, unsigned int &n1, unsigned int &n2) const
	Get the number of connections for a specified cluster. More...

void	GetConnectedElements (const pandora::Cluster *const pCluster, const bool ignoreUnavailable, ElementList &elementList) const
	Get a list of elements connected to a specified cluster. More...

void	GetConnectedElements (const pandora::Cluster *const pCluster, const bool ignoreUnavailable, ElementList &elementList, unsigned int &n1, unsigned int &n2) const
	Get a list of elements connected to a specified cluster. More...

const_iterator	begin () const
	Returns an iterator referring to the first element in the overlap matrix. More...

const_iterator	end () const
	Returns an iterator referring to the past-the-end element in the overlap matrix. More...

void	GetSortedKeyClusters (pandora::ClusterVector &sortedKeyClusters) const
	Get a sorted vector of key clusters (view 1 clusters with current implementation) More...

const OverlapResult &	GetOverlapResult (const pandora::Cluster const pCluster1, const pandora::Cluster const pCluster2) const
	Get the overlap result for a specified pair of clusters. More...

const OverlapList &	GetOverlapList (const pandora::Cluster *const pCluster1) const
	Get the overlap list for a specified cluster. More...

const ClusterNavigationMap &	GetClusterNavigationMap12 () const
	Get the cluster navigation map 1->2. More...

const ClusterNavigationMap &	GetClusterNavigationMap21 () const
	Get the cluster navigation map 2->1. More...

void	SetOverlapResult (const pandora::Cluster const pCluster1, const pandora::Cluster const pCluster2, const OverlapResult &overlapResult)
	Set overlap result. More...

void	ReplaceOverlapResult (const pandora::Cluster const pCluster1, const pandora::Cluster const pCluster2, const OverlapResult &overlapResult)
	SetReplace an existing overlap result. More...

void	RemoveCluster (const pandora::Cluster *const pCluster)
	Remove entries from matrix corresponding to specified cluster. More...

void	Clear ()
	Clear overlap matrix. More...

Private Member Functions
void	GetConnectedElements (const pandora::Cluster *const pCluster, const bool ignoreUnavailable, ElementList &elementList, pandora::ClusterList &clusterList1, pandora::ClusterList &clusterList2) const
	Get elements connected to a specified cluster. More...

void	ExploreConnections (const pandora::Cluster *const pCluster, const bool ignoreUnavailable, pandora::ClusterList &clusterList1, pandora::ClusterList &clusterList2) const
	Explore connections associated with a given cluster. More...

Private Attributes
TheMatrix	m_overlapMatrix
	The overlap matrix. More...

ClusterNavigationMap	m_clusterNavigationMap12
	The cluster navigation map 1->2. More...

ClusterNavigationMap	m_clusterNavigationMap21
	The cluster navigation map 2->1. More...

Detailed Description

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

OverlapMatrix class.

Definition at line 23 of file LArOverlapMatrix.h.

Member Typedef Documentation

template<typename T>

typedef std::unordered_map<const pandora::Cluster *, pandora::ClusterList> lar_content::OverlapMatrix< T >::ClusterNavigationMap

Definition at line 131 of file LArOverlapMatrix.h.

template<typename T>

typedef TheMatrix::const_iterator lar_content::OverlapMatrix< T >::const_iterator

Definition at line 135 of file LArOverlapMatrix.h.

template<typename T>

typedef std::vector<Element> lar_content::OverlapMatrix< T >::ElementList

Definition at line 77 of file LArOverlapMatrix.h.

template<typename T>

typedef std::unordered_map<const pandora::Cluster *, OverlapResult> lar_content::OverlapMatrix< T >::OverlapList

Definition at line 132 of file LArOverlapMatrix.h.

template<typename T>

typedef T lar_content::OverlapMatrix< T >::OverlapResult

Definition at line 26 of file LArOverlapMatrix.h.

template<typename T>

typedef std::unordered_map<const pandora::Cluster *, OverlapList> lar_content::OverlapMatrix< T >::TheMatrix

Definition at line 133 of file LArOverlapMatrix.h.

Member Function Documentation

template<typename T >

OverlapMatrix< T >::const_iterator lar_content::OverlapMatrix< T >::begin ( ) const

inline

Returns an iterator referring to the first element in the overlap matrix.

Definition at line 265 of file LArOverlapMatrix.h.

References lar_content::OverlapMatrix< T >::m_overlapMatrix.

 {
     return m_overlapMatrix.begin();
 }

template<typename T >

void lar_content::OverlapMatrix< T >::Clear ( )

inline

Clear overlap matrix.

Definition at line 325 of file LArOverlapMatrix.h.

References lar_content::OverlapMatrix< T >::m_clusterNavigationMap12, lar_content::OverlapMatrix< T >::m_clusterNavigationMap21, and lar_content::OverlapMatrix< T >::m_overlapMatrix.

Referenced by lar_content::TwoViewMatchingControl< T >::TidyUp().

 {
     m_overlapMatrix.clear();
     m_clusterNavigationMap12.clear();
     m_clusterNavigationMap21.clear();
 }

template<typename T>

bool lar_content::OverlapMatrix< T >::DefaultAmbiguityFunction	(	const pandora::ClusterList &	clusterList1,
		const pandora::ClusterList &	clusterList2,
		const pandora::Cluster *&	pCluster1,
		const pandora::Cluster *&	pCluster2
	)		const

Default ambiguity function, checking that only one cluster from view 1 and view 2 is found.

Parameters

clusterList1	cluster list 1
clusterList2	cluster list 2
pCluster1	to receive the address of the unambiguous cluster 1
pCluster2	to receive the address of the unambiguous cluster 2

Returns: boolean

Definition at line 63 of file LArOverlapMatrix.cc.

 {
     if ((1 != clusterList1.size()) || (1 != clusterList2.size()))
         return false;
 
     pCluster1 = *(clusterList1.begin());
     pCluster2 = *(clusterList2.begin());
 
     return true;
 }

template<typename T >

OverlapMatrix< T >::const_iterator lar_content::OverlapMatrix< T >::end ( ) const

inline

Returns an iterator referring to the past-the-end element in the overlap matrix.

Definition at line 273 of file LArOverlapMatrix.h.

References lar_content::OverlapMatrix< T >::m_overlapMatrix.

 {
     return m_overlapMatrix.end();
 }

template<typename T>

void lar_content::OverlapMatrix< T >::ExploreConnections	(	const pandora::Cluster *const	pCluster,
		const bool	ignoreUnavailable,
		pandora::ClusterList &	clusterList1,
		pandora::ClusterList &	clusterList2
	)		const

private

Explore connections associated with a given cluster.

Parameters

pCluster	address of the cluster
clusterList1	connected view 1 clusters
clusterList2	connected view 2 clusters

Definition at line 235 of file LArOverlapMatrix.cc.

 {
     if (ignoreUnavailable && !pCluster->IsAvailable())
         return;
 
     const HitType hitType(LArClusterHelper::GetClusterHitType(pCluster));
     const bool clusterFromView1(
         !m_clusterNavigationMap12.empty() && (LArClusterHelper::GetClusterHitType(m_clusterNavigationMap12.begin()->first) == hitType));
     const bool clusterFromView2(
         !m_clusterNavigationMap21.empty() && (LArClusterHelper::GetClusterHitType(m_clusterNavigationMap21.begin()->first) == hitType));
 
     if (clusterFromView1 == clusterFromView2)
         throw StatusCodeException(STATUS_CODE_FAILURE);
 
     ClusterList &clusterList(clusterFromView1 ? clusterList1 : clusterList2);
     const ClusterNavigationMap &navigationMap(clusterFromView1 ? m_clusterNavigationMap12 : m_clusterNavigationMap21);
 
     if (clusterList.end() != std::find(clusterList.begin(), clusterList.end(), pCluster))
         return;
 
     clusterList.push_back(pCluster);
     ClusterNavigationMap::const_iterator iter = navigationMap.find(pCluster);
 
     if (navigationMap.end() == iter)
         throw StatusCodeException(STATUS_CODE_FAILURE);
 
     for (ClusterList::const_iterator cIter = iter->second.begin(), cIterEnd = iter->second.end(); cIter != cIterEnd; ++cIter)
         this->ExploreConnections(*cIter, ignoreUnavailable, clusterList1, clusterList2);
 }

template<typename T >

const OverlapMatrix< T >::ClusterNavigationMap & lar_content::OverlapMatrix< T >::GetClusterNavigationMap12 ( ) const

inline

Get the cluster navigation map 1->2.

Returns: the cluster navigation map 1->2

Definition at line 309 of file LArOverlapMatrix.h.

References lar_content::OverlapMatrix< T >::m_clusterNavigationMap12.

 {
     return m_clusterNavigationMap12;
 }

template<typename T >

const OverlapMatrix< T >::ClusterNavigationMap & lar_content::OverlapMatrix< T >::GetClusterNavigationMap21 ( ) const

inline

Get the cluster navigation map 2->1.

Returns: the cluster navigation map 2->1

Definition at line 317 of file LArOverlapMatrix.h.

References lar_content::OverlapMatrix< T >::m_clusterNavigationMap21.

 {
     return m_clusterNavigationMap21;
 }

template<typename T >

void lar_content::OverlapMatrix< T >::GetConnectedElements	(	const pandora::Cluster *const	pCluster,
		const bool	ignoreUnavailable,
		ElementList &	elementList
	)		const

inline

Get a list of elements connected to a specified cluster.

Parameters

pCluster	address of a cluster
ignoreUnavailable	whether to ignore unavailable clusters
elementList	to receive the connected element list

Definition at line 256 of file LArOverlapMatrix.h.

Referenced by lar_content::TwoViewAmbiguousDeltaRayTool::ExamineConnectedElements(), lar_content::TwoViewSimpleTracksTool::FindBestTrack(), lar_content::TwoViewLongTracksTool::FindLongTracks(), lar_content::TwoViewThreeDKinkTool::GetModifications(), lar_content::OverlapMatrix< T >::GetNConnections(), lar_content::TransverseMatrixVisualizationTool::Run(), and lar_content::TwoViewCosmicRayRemovalTool::Run().

 {
     unsigned int n1(0), n2(0);
     this->GetConnectedElements(pCluster, ignoreUnavailable, elementList, n1, n2);
 }

template<typename T >

void lar_content::OverlapMatrix< T >::GetConnectedElements	(	const pandora::Cluster *const	pCluster,
		const bool	ignoreUnavailable,
		ElementList &	elementList,
		unsigned int &	n1,
		unsigned int &	n2
	)		const

Get a list of elements connected to a specified cluster.

Parameters

pCluster	address of a cluster
ignoreUnavailable	whether to ignore unavailable clusters
elementList	to receive the connected element list
n1	to receive the number of view 1 connections
n2	to receive the number of view 2 connections

Definition at line 78 of file LArOverlapMatrix.cc.

 {
     ClusterList clusterList1, clusterList2;
     this->GetConnectedElements(pCluster, ignoreUnavailable, elementList, clusterList1, clusterList2);
     n1 = clusterList1.size();
     n2 = clusterList2.size();
 }

template<typename T>

void lar_content::OverlapMatrix< T >::GetConnectedElements	(	const pandora::Cluster *const	pCluster,
		const bool	ignoreUnavailable,
		ElementList &	elementList,
		pandora::ClusterList &	clusterList1,
		pandora::ClusterList &	clusterList2
	)		const

private

Get elements connected to a specified cluster.

Parameters

pCluster	address of the cluster
elementList	the element list
clusterList1	connected view 1 clusters
clusterList2	connected view 2 clusters

template<typename T >

void lar_content::OverlapMatrix< T >::GetNConnections	(	const pandora::Cluster *const	pCluster,
		const bool	ignoreUnavailable,
		unsigned int &	n1,
		unsigned int &	n2
	)		const

inline

Get the number of connections for a specified cluster.

Parameters

pCluster	address of a cluster
ignoreUnavailable	whether to ignore unavailable clusters
n1	to receive the number of view 1 connections
n2	to receive the number of view 2 connections

Definition at line 247 of file LArOverlapMatrix.h.

References lar_content::OverlapMatrix< T >::GetConnectedElements().

 {
     ElementList elementList;
     this->GetConnectedElements(pCluster, ignoreUnavailable, elementList, n1, n2);
 }

template<typename T >

const OverlapMatrix< T >::OverlapList & lar_content::OverlapMatrix< T >::GetOverlapList ( const pandora::Cluster *const pCluster1 ) const

inline

Get the overlap list for a specified cluster.

Parameters

pCluster1 address of cluster 1

Returns: the cluster overlap list

Definition at line 296 of file LArOverlapMatrix.h.

References lar_content::OverlapMatrix< T >::m_overlapMatrix.

Referenced by lar_content::OverlapMatrix< T >::GetOverlapResult().

 {
     typename TheMatrix::const_iterator iter = m_overlapMatrix.find(pCluster1);
 
     if (m_overlapMatrix.end() == iter)
         throw pandora::StatusCodeException(pandora::STATUS_CODE_NOT_FOUND);
 
     return iter->second;
 }

template<typename T >

const OverlapMatrix< T >::OverlapResult & lar_content::OverlapMatrix< T >::GetOverlapResult	(	const pandora::Cluster *const	pCluster1,
		const pandora::Cluster *const	pCluster2
	)		const

inline

Get the overlap result for a specified pair of clusters.

Parameters

pCluster1	address of cluster 1
pCluster2	address of cluster 2

Returns: the address of the overlap result

Definition at line 281 of file LArOverlapMatrix.h.

References lar_content::OverlapMatrix< T >::GetOverlapList().

 {
     const OverlapList &overlapList(this->GetOverlapList(pCluster1));
     typename OverlapList::const_iterator iter = overlapList.find(pCluster2);
 
     if (overlapList.end() == iter)
         throw pandora::StatusCodeException(pandora::STATUS_CODE_NOT_FOUND);
 
     return iter->second;
 }

template<typename T>

void lar_content::OverlapMatrix< T >::GetSortedKeyClusters ( pandora::ClusterVector & sortedKeyClusters ) const

Get a sorted vector of key clusters (view 1 clusters with current implementation)

Parameters

sortedKeyClusters to receive the sorted vector of key clusters

Definition at line 90 of file LArOverlapMatrix.cc.

References util::begin(), and util::end().

Referenced by lar_content::TwoViewAmbiguousDeltaRayTool::ExamineConnectedElements(), lar_content::TwoViewSimpleTracksTool::FindBestTrack(), lar_content::TwoViewLongTracksTool::FindLongTracks(), lar_content::TwoViewThreeDKinkTool::GetModifications(), lar_content::TransverseMatrixVisualizationTool::Run(), and lar_content::TwoViewCosmicRayRemovalTool::Run().

 {
     for (typename TheMatrix::const_iterator iter1 = this->begin(), iter1End = this->end(); iter1 != iter1End; ++iter1)
         sortedKeyClusters.push_back(iter1->first);
 
     std::sort(sortedKeyClusters.begin(), sortedKeyClusters.end(), LArClusterHelper::SortByNHits);
 }

template<typename T >

void lar_content::OverlapMatrix< T >::GetUnambiguousElements	(	const bool	ignoreUnavailable,
		ElementList &	elementList
	)		const

Get unambiguous elements.

Parameters

ignoreUnavailable	whether to ignore unavailable clusters
elementList	to receive the unambiguous element list

Definition at line 30 of file LArOverlapMatrix.cc.

References util::begin(), and util::end().

Referenced by lar_content::TwoViewClearTracksTool::Run().

 {
     for (typename TheMatrix::const_iterator iter1 = this->begin(), iter1End = this->end(); iter1 != iter1End; ++iter1)
     {
         ElementList tempElementList;
         ClusterList clusterList1, clusterList2;
         this->GetConnectedElements(iter1->first, ignoreUnavailable, tempElementList, clusterList1, clusterList2);
 
         const Cluster *pCluster1(nullptr), *pCluster2(nullptr);
         if (!this->DefaultAmbiguityFunction(clusterList1, clusterList2, pCluster1, pCluster2))
             continue;
 
         // ATTN With HIT_CUSTOM definitions, it is possible to navigate from different view 1 clusters to same combination
         if (iter1->first != pCluster1)
             continue;
 
         if (!pCluster1 || !pCluster2)
             continue;
 
         typename OverlapList::const_iterator iter2 = iter1->second.find(pCluster2);
         if (iter1->second.end() == iter2)
             throw StatusCodeException(STATUS_CODE_FAILURE);
 
         Element element(pCluster1, pCluster2, iter2->second);
         elementList.push_back(element);
     }
 
     std::sort(elementList.begin(), elementList.end());
 }

template<typename T >

void lar_content::OverlapMatrix< T >::RemoveCluster ( const pandora::Cluster *const pCluster )

Remove entries from matrix corresponding to specified cluster.

Parameters

pCluster address of the cluster

Definition at line 142 of file LArOverlapMatrix.cc.

References util::begin(), and util::end().

Referenced by lar_content::TwoViewMatchingControl< T >::UpdateUponDeletion().

 {
     ClusterList additionalRemovals;
 
     if (m_clusterNavigationMap12.erase(pCluster) > 0)
     {
         typename TheMatrix::iterator iter = m_overlapMatrix.find(pCluster);
 
         if (m_overlapMatrix.end() != iter)
             m_overlapMatrix.erase(iter);
 
         for (ClusterNavigationMap::iterator navIter = m_clusterNavigationMap21.begin(); navIter != m_clusterNavigationMap21.end();)
         {
             ClusterNavigationMap::iterator thisIter = navIter++;
             ClusterList::iterator listIter = std::find(thisIter->second.begin(), thisIter->second.end(), pCluster);
 
             if (thisIter->second.end() != listIter)
                 thisIter->second.erase(listIter);
 
             if (thisIter->second.empty())
                 additionalRemovals.push_back(thisIter->first);
         }
     }
 
     if (m_clusterNavigationMap21.erase(pCluster) > 0)
     {
         for (typename TheMatrix::iterator iter1 = m_overlapMatrix.begin(), iter1End = m_overlapMatrix.end(); iter1 != iter1End; ++iter1)
         {
             typename OverlapList::iterator iter = iter1->second.find(pCluster);
 
             if (iter1->second.end() != iter)
                 iter1->second.erase(iter);
         }
 
         for (ClusterNavigationMap::iterator navIter = m_clusterNavigationMap12.begin(); navIter != m_clusterNavigationMap12.end();)
         {
             ClusterNavigationMap::iterator thisIter = navIter++;
             ClusterList::iterator listIter = std::find(thisIter->second.begin(), thisIter->second.end(), pCluster);
 
             if (thisIter->second.end() != listIter)
                 thisIter->second.erase(listIter);
 
             if (thisIter->second.empty())
                 additionalRemovals.push_back(thisIter->first);
         }
     }
 
     additionalRemovals.sort(LArClusterHelper::SortByNHits);
 
     for (ClusterList::const_iterator iter = additionalRemovals.begin(), iterEnd = additionalRemovals.end(); iter != iterEnd; ++iter)
         this->RemoveCluster(*iter);
 }

template<typename T >

void lar_content::OverlapMatrix< T >::ReplaceOverlapResult	(	const pandora::Cluster *const	pCluster1,
		const pandora::Cluster *const	pCluster2,
		const OverlapResult &	overlapResult
	)

SetReplace an existing overlap result.

Parameters

pCluster1	address of cluster 1
pCluster2	address of cluster 2
overlapResult	the overlap result

Definition at line 124 of file LArOverlapMatrix.cc.

 {
     typename TheMatrix::iterator iter1 = m_overlapMatrix.find(pCluster1);
 
     if (m_overlapMatrix.end() == iter1)
         throw pandora::StatusCodeException(pandora::STATUS_CODE_INVALID_PARAMETER);
 
     typename OverlapList::iterator iter2 = iter1->second.find(pCluster2);
 
     if (iter1->second.end() == iter2)
         throw pandora::StatusCodeException(pandora::STATUS_CODE_INVALID_PARAMETER);
 
     iter2->second = overlapResult;
 }

template<typename T >

void lar_content::OverlapMatrix< T >::SetOverlapResult	(	const pandora::Cluster *const	pCluster1,
		const pandora::Cluster *const	pCluster2,
		const OverlapResult &	overlapResult
	)

Set overlap result.

Parameters

pCluster1	address of cluster 1
pCluster2	address of cluster 2
overlapResult	the overlap result

Definition at line 101 of file LArOverlapMatrix.cc.

Referenced by lar_content::TwoViewDeltaRayMatchingAlgorithm::DoesClusterPassTensorThreshold(), and lar_content::TwoViewTransverseTracksAlgorithm::TwoViewTransverseTracksAlgorithm().

 {
     OverlapList &overlapList = m_overlapMatrix[pCluster1];
     typename OverlapList::const_iterator iter = overlapList.find(pCluster2);
 
     if (overlapList.end() != iter)
         throw pandora::StatusCodeException(pandora::STATUS_CODE_ALREADY_PRESENT);
 
     if (!overlapList.insert(typename OverlapList::value_type(pCluster2, overlapResult)).second)
         throw pandora::StatusCodeException(pandora::STATUS_CODE_FAILURE);
 
     ClusterList &navigation12(m_clusterNavigationMap12[pCluster1]);
     ClusterList &navigation21(m_clusterNavigationMap21[pCluster2]);
 
     if (navigation12.end() == std::find(navigation12.begin(), navigation12.end(), pCluster2))
         navigation12.push_back(pCluster2);
     if (navigation21.end() == std::find(navigation21.begin(), navigation21.end(), pCluster1))
         navigation21.push_back(pCluster1);
 }

Member Data Documentation

template<typename T>

ClusterNavigationMap lar_content::OverlapMatrix< T >::m_clusterNavigationMap12

private

The cluster navigation map 1->2.

Definition at line 240 of file LArOverlapMatrix.h.

Referenced by lar_content::OverlapMatrix< T >::Clear(), and lar_content::OverlapMatrix< T >::GetClusterNavigationMap12().

template<typename T>

ClusterNavigationMap lar_content::OverlapMatrix< T >::m_clusterNavigationMap21

private

The cluster navigation map 2->1.

Definition at line 241 of file LArOverlapMatrix.h.

Referenced by lar_content::OverlapMatrix< T >::Clear(), and lar_content::OverlapMatrix< T >::GetClusterNavigationMap21().

template<typename T>

TheMatrix lar_content::OverlapMatrix< T >::m_overlapMatrix

private

The overlap matrix.

Definition at line 239 of file LArOverlapMatrix.h.

Referenced by lar_content::OverlapMatrix< T >::begin(), lar_content::OverlapMatrix< T >::Clear(), lar_content::OverlapMatrix< T >::end(), and lar_content::OverlapMatrix< T >::GetOverlapList().

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

larpandoracontent/v04_08_01/source/larpandoracontent/LArObjects/LArOverlapMatrix.h
larpandoracontent/v04_08_01/source/larpandoracontent/LArObjects/LArOverlapMatrix.cc

Classes

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

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

Member Typedef Documentation

Member Function Documentation

Member Data Documentation

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