LongitudinalAssociationAlgorithm class. More...

#include "LongitudinalAssociationAlgorithm.h"

Inheritance diagram for lar_content::LongitudinalAssociationAlgorithm:

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

Protected Types
typedef std::unordered_map< const pandora::Cluster *, ClusterAssociation >	ClusterAssociationMap

Protected Member Functions
virtual pandora::StatusCode	Run ()

Private Member Functions
pandora::StatusCode	ReadSettings (const pandora::TiXmlHandle xmlHandle)

void	GetListOfCleanClusters (const pandora::ClusterList *const pClusterList, pandora::ClusterVector &clusterVector) const
	Populate cluster vector with subset of cluster list, containing clusters judged to be clean. More...

void	PopulateClusterAssociationMap (const pandora::ClusterVector &clusterVector, ClusterAssociationMap &clusterAssociationMap) const
	Populate the cluster association map. More...

bool	IsExtremalCluster (const bool isForward, const pandora::Cluster const pCurrentCluster, const pandora::Cluster const pTestCluster) const
	Determine which of two clusters is extremal. More...

bool	AreClustersAssociated (const pandora::Cluster const pInnerCluster, const pandora::Cluster const pOuterCluster) const
	Determine whether two clusters are associated. More...

bool	AreClustersAssociated (const pandora::CartesianVector &innerClusterEnd, const pandora::CartesianVector &outerClusterStart, const pandora::ClusterFitResult &innerFit, const pandora::ClusterFitResult &outerFit) const
	Determine whether two clusters are associated. More...

Private Attributes
unsigned int	m_minClusterLayers
	minimum allowed number of layers for a clean cluster More...

unsigned int	m_maxGapLayers
	maximum allowed number of layers between associated clusters More...

unsigned int	m_fitLayers
	number of layers to fit at start and end of cluster More...

float	m_maxGapDistanceSquared
	maximum allowed distance (squared) between associated clusters More...

float	m_minCosRelativeAngle
	maximum allowed relative angle between associated clusters More...

float	m_maxTransverseDisplacement
	maximum allowed transverse displacement after extrapolation (normalised to cell size) More...

float	m_maxLongitudinalDisplacement
	maximum allowed longitudinal displacement after extrapolation (normalised to cell size) More...

float	m_hitSizeZ
	estimated hit size in z (wire number) dimension, units cm More...

float	m_hitSizeX
	estimated hit size in x (drift time) dimension, units cm More...

pandora::HitType	m_view
	The view to which the hits under consideration belong. More...

Detailed Description

LongitudinalAssociationAlgorithm class.

Definition at line 23 of file LongitudinalAssociationAlgorithm.h.

Member Typedef Documentation

typedef std::unordered_map<const pandora::Cluster *, ClusterAssociation> lar_content::ClusterAssociationAlgorithm::ClusterAssociationMap

protectedinherited

Definition at line 43 of file ClusterAssociationAlgorithm.h.

Constructor & Destructor Documentation

lar_content::LongitudinalAssociationAlgorithm::LongitudinalAssociationAlgorithm ( )

Default constructor.

Definition at line 21 of file LongitudinalAssociationAlgorithm.cc.

                                                                    :
     m_minClusterLayers(4),
     m_maxGapLayers(7),
     m_fitLayers(30),
     m_maxGapDistanceSquared(10.f),
     m_minCosRelativeAngle(0.985f),
     m_maxTransverseDisplacement(2.f),
     m_maxLongitudinalDisplacement(2.f),
     m_hitSizeZ(0.3f),
     m_hitSizeX(0.5f),
     m_view(TPC_3D)
 {
 }

Member Function Documentation

bool lar_content::LongitudinalAssociationAlgorithm::AreClustersAssociated	(	const pandora::Cluster *const	pInnerCluster,
		const pandora::Cluster *const	pOuterCluster
	)		const

private

Determine whether two clusters are associated.

Parameters

pInnerCluster	address of the inner cluster
pOuterCluster	address of the outer cluster

Returns: whether the clusters are associated

Referenced by IsExtremalCluster(), and PopulateClusterAssociationMap().

bool lar_content::LongitudinalAssociationAlgorithm::AreClustersAssociated	(	const pandora::CartesianVector &	innerClusterEnd,
		const pandora::CartesianVector &	outerClusterStart,
		const pandora::ClusterFitResult &	innerFit,
		const pandora::ClusterFitResult &	outerFit
	)		const

private

Determine whether two clusters are associated.

Parameters

innerClusterEnd	inner cluster end position
outerClusterStart	outer cluster start position
innerFit	inner cluster fit result
outerFit	outer cluster fit result

Returns: whether the clusters are associated

void lar_content::LongitudinalAssociationAlgorithm::GetListOfCleanClusters	(	const pandora::ClusterList *const	pClusterList,
		pandora::ClusterVector &	clusterVector
	)		const

privatevirtual

Populate cluster vector with subset of cluster list, containing clusters judged to be clean.

Parameters

pClusterList	address of the cluster list
clusterVector	to receive the populated cluster vector

Implements lar_content::ClusterAssociationAlgorithm.

Definition at line 37 of file LongitudinalAssociationAlgorithm.cc.

References lar_content::LArClusterHelper::GetClusterHitType(), m_minClusterLayers, m_view, and lar_content::LArClusterHelper::SortByInnerLayer().

 {
     if (!pClusterList->empty())
         m_view = LArClusterHelper::GetClusterHitType(pClusterList->front());
 
     for (ClusterList::const_iterator iter = pClusterList->begin(), iterEnd = pClusterList->end(); iter != iterEnd; ++iter)
     {
         const Cluster *const pCluster = *iter;
 
         if (1 + pCluster->GetOuterPseudoLayer() - pCluster->GetInnerPseudoLayer() < m_minClusterLayers)
             continue;
 
         clusterVector.push_back(pCluster);
     }
 
     std::sort(clusterVector.begin(), clusterVector.end(), LArClusterHelper::SortByInnerLayer);
 }

bool lar_content::LongitudinalAssociationAlgorithm::IsExtremalCluster	(	const bool	isForward,
		const pandora::Cluster *const	pCurrentCluster,
		const pandora::Cluster *const	pTestCluster
	)		const

privatevirtual

Determine which of two clusters is extremal.

Parameters

isForward	whether propagation direction is forward
pCurrentCluster	current extremal cluster
pTestCluster	potential extremal cluster

Returns: boolean

Implements lar_content::ClusterAssociationAlgorithm.

Definition at line 82 of file LongitudinalAssociationAlgorithm.cc.

References AreClustersAssociated(), lar_content::LArGeometryHelper::GetWirePitchRatio(), m_fitLayers, m_hitSizeX, m_hitSizeZ, m_maxGapDistanceSquared, m_maxGapLayers, m_maxLongitudinalDisplacement, m_maxTransverseDisplacement, m_minCosRelativeAngle, m_view, and lar_content::LArClusterHelper::SortByNHits().

 {
     const unsigned int currentLayer(isForward ? pCurrentCluster->GetOuterPseudoLayer() : pCurrentCluster->GetInnerPseudoLayer());
     const unsigned int testLayer(isForward ? pTestCluster->GetOuterPseudoLayer() : pTestCluster->GetInnerPseudoLayer());
 
     if (isForward && ((testLayer > currentLayer) || ((testLayer == currentLayer) && LArClusterHelper::SortByNHits(pTestCluster, pCurrentCluster))))
         return true;
 
     if (!isForward && ((testLayer < currentLayer) || ((testLayer == currentLayer) && LArClusterHelper::SortByNHits(pTestCluster, pCurrentCluster))))
         return true;
 
     return false;
 }

void lar_content::LongitudinalAssociationAlgorithm::PopulateClusterAssociationMap	(	const pandora::ClusterVector &	clusterVector,
		ClusterAssociationMap &	clusterAssociationMap
	)		const

privatevirtual

Populate the cluster association map.

Parameters

clusterVector	the cluster vector
clusterAssociationMap	to receive the populated cluster association map

Implements lar_content::ClusterAssociationAlgorithm.

Definition at line 57 of file LongitudinalAssociationAlgorithm.cc.

References AreClustersAssociated().

 {
     // ATTN This method assumes that clusters have been sorted by layer
     for (ClusterVector::const_iterator iterI = clusterVector.begin(), iterIEnd = clusterVector.end(); iterI != iterIEnd; ++iterI)
     {
         const Cluster *const pInnerCluster = *iterI;
 
         for (ClusterVector::const_iterator iterJ = iterI, iterJEnd = clusterVector.end(); iterJ != iterJEnd; ++iterJ)
         {
             const Cluster *const pOuterCluster = *iterJ;
 
             if (pInnerCluster == pOuterCluster)
                 continue;
 
             if (!this->AreClustersAssociated(pInnerCluster, pOuterCluster))
                 continue;
 
             clusterAssociationMap[pInnerCluster].m_forwardAssociations.insert(pOuterCluster);
             clusterAssociationMap[pOuterCluster].m_backwardAssociations.insert(pInnerCluster);
         }
     }
 }

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

privatevirtual

Reimplemented from lar_content::ClusterAssociationAlgorithm.

Definition at line 195 of file LongitudinalAssociationAlgorithm.cc.

References m_fitLayers, m_hitSizeX, m_hitSizeZ, m_maxGapDistanceSquared, m_maxGapLayers, m_maxLongitudinalDisplacement, m_maxTransverseDisplacement, m_minClusterLayers, m_minCosRelativeAngle, and lar_content::ClusterAssociationAlgorithm::ReadSettings().

 {
     PANDORA_RETURN_RESULT_IF_AND_IF(
         STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "MinClusterLayers", m_minClusterLayers));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "MaxGapLayers", m_maxGapLayers));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "FitLayers", m_fitLayers));
 
     float maxGapDistance = std::sqrt(m_maxGapDistanceSquared);
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "MaxGapDistance", maxGapDistance));
     m_maxGapDistanceSquared = maxGapDistance * maxGapDistance;
 
     PANDORA_RETURN_RESULT_IF_AND_IF(
         STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "MinCosRelativeAngle", m_minCosRelativeAngle));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=,
         XmlHelper::ReadValue(xmlHandle, "MaxTransverseDisplacement", m_maxTransverseDisplacement));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=,
         XmlHelper::ReadValue(xmlHandle, "MaxLongitudinalDisplacement", m_maxLongitudinalDisplacement));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "HitSizeZ", m_hitSizeZ));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "HitSizeX", m_hitSizeX));
 
     return ClusterAssociationAlgorithm::ReadSettings(xmlHandle);
 }

StatusCode lar_content::ClusterAssociationAlgorithm::Run ( )

protectedvirtualinherited

Definition at line 28 of file ClusterAssociationAlgorithm.cc.

References lar_content::ClusterAssociationAlgorithm::AmbiguousPropagation(), lar_content::ClusterAssociationAlgorithm::GetListOfCleanClusters(), lar_content::ClusterAssociationAlgorithm::m_mergeMade, lar_content::ClusterAssociationAlgorithm::m_resolveAmbiguousAssociations, lar_content::ClusterAssociationAlgorithm::PopulateClusterAssociationMap(), and lar_content::ClusterAssociationAlgorithm::UnambiguousPropagation().

 {
     const ClusterList *pClusterList = NULL;
     PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::GetCurrentList(*this, pClusterList));
 
     ClusterVector clusterVector;
     this->GetListOfCleanClusters(pClusterList, clusterVector);
 
     ClusterAssociationMap clusterAssociationMap;
     this->PopulateClusterAssociationMap(clusterVector, clusterAssociationMap);
 
     m_mergeMade = true;
 
     while (m_mergeMade)
     {
         // Unambiguous propagation
         while (m_mergeMade)
         {
             m_mergeMade = false;
 
             for (const Cluster *const pCluster : clusterVector)
             {
                 // ATTN The clusterVector may end up with dangling pointers; only protected by this check against managed cluster list
                 if (pClusterList->end() == std::find(pClusterList->begin(), pClusterList->end(), pCluster))
                     continue;
 
                 this->UnambiguousPropagation(pCluster, true, clusterAssociationMap);
                 this->UnambiguousPropagation(pCluster, false, clusterAssociationMap);
             }
         }
 
         if (!m_resolveAmbiguousAssociations)
             continue;
 
         // Propagation with ambiguities
         for (const Cluster *const pCluster : clusterVector)
         {
             // ATTN The clusterVector may end up with dangling pointers; only protected by this check against up-to-date association list
             ClusterAssociationMap::const_iterator mapIterFwd = clusterAssociationMap.find(pCluster);
 
             if (clusterAssociationMap.end() == mapIterFwd)
                 continue;
 
             if (mapIterFwd->second.m_backwardAssociations.empty() && !mapIterFwd->second.m_forwardAssociations.empty())
                 this->AmbiguousPropagation(pCluster, true, clusterAssociationMap);
 
             ClusterAssociationMap::const_iterator mapIterBwd = clusterAssociationMap.find(pCluster);
 
             if (clusterAssociationMap.end() == mapIterBwd)
                 continue;
 
             if (mapIterBwd->second.m_forwardAssociations.empty() && !mapIterBwd->second.m_backwardAssociations.empty())
                 this->AmbiguousPropagation(pCluster, false, clusterAssociationMap);
         }
     }
 
     return STATUS_CODE_SUCCESS;
 }

Member Data Documentation

unsigned int lar_content::LongitudinalAssociationAlgorithm::m_fitLayers

private

number of layers to fit at start and end of cluster

Definition at line 62 of file LongitudinalAssociationAlgorithm.h.

Referenced by IsExtremalCluster(), and ReadSettings().

float lar_content::LongitudinalAssociationAlgorithm::m_hitSizeX

private

estimated hit size in x (drift time) dimension, units cm

Definition at line 68 of file LongitudinalAssociationAlgorithm.h.

Referenced by IsExtremalCluster(), and ReadSettings().

float lar_content::LongitudinalAssociationAlgorithm::m_hitSizeZ

private

estimated hit size in z (wire number) dimension, units cm

Definition at line 67 of file LongitudinalAssociationAlgorithm.h.

Referenced by IsExtremalCluster(), and ReadSettings().

float lar_content::LongitudinalAssociationAlgorithm::m_maxGapDistanceSquared

private

maximum allowed distance (squared) between associated clusters

Definition at line 63 of file LongitudinalAssociationAlgorithm.h.

Referenced by IsExtremalCluster(), and ReadSettings().

unsigned int lar_content::LongitudinalAssociationAlgorithm::m_maxGapLayers

private

maximum allowed number of layers between associated clusters

Definition at line 61 of file LongitudinalAssociationAlgorithm.h.

Referenced by IsExtremalCluster(), and ReadSettings().

float lar_content::LongitudinalAssociationAlgorithm::m_maxLongitudinalDisplacement

private

maximum allowed longitudinal displacement after extrapolation (normalised to cell size)

Definition at line 66 of file LongitudinalAssociationAlgorithm.h.

Referenced by IsExtremalCluster(), and ReadSettings().

float lar_content::LongitudinalAssociationAlgorithm::m_maxTransverseDisplacement

private

maximum allowed transverse displacement after extrapolation (normalised to cell size)

Definition at line 65 of file LongitudinalAssociationAlgorithm.h.

Referenced by IsExtremalCluster(), and ReadSettings().

unsigned int lar_content::LongitudinalAssociationAlgorithm::m_minClusterLayers

private

minimum allowed number of layers for a clean cluster

Definition at line 60 of file LongitudinalAssociationAlgorithm.h.

Referenced by GetListOfCleanClusters(), and ReadSettings().

float lar_content::LongitudinalAssociationAlgorithm::m_minCosRelativeAngle

private

maximum allowed relative angle between associated clusters

Definition at line 64 of file LongitudinalAssociationAlgorithm.h.

Referenced by IsExtremalCluster(), and ReadSettings().

pandora::HitType lar_content::LongitudinalAssociationAlgorithm::m_view

mutableprivate

The view to which the hits under consideration belong.

Definition at line 69 of file LongitudinalAssociationAlgorithm.h.

Referenced by GetListOfCleanClusters(), and IsExtremalCluster().

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

larpandoracontent/v04_08_01/source/larpandoracontent/LArTwoDReco/LArClusterAssociation/LongitudinalAssociationAlgorithm.h
larpandoracontent/v04_08_01/source/larpandoracontent/LArTwoDReco/LArClusterAssociation/LongitudinalAssociationAlgorithm.cc

Public Member Functions

Protected Types

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation