CrossGapsAssociationAlgorithm class. More...

#include "CrossGapsAssociationAlgorithm.h"

Inheritance diagram for lar_content::CrossGapsAssociationAlgorithm:

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

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

Protected Member Functions
virtual pandora::StatusCode	Run ()

Private Member Functions
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 TwoDSlidingFitResult &innerFitResult, const TwoDSlidingFitResult &outerFitResult) const
	Determine whether two clusters are associated. More...

bool	IsAssociated (const pandora::CartesianVector &startPosition, const pandora::CartesianVector &startDirection, const TwoDSlidingFitResult &targetFitResult) const
	Sample points along the extrapolation from a starting position to a target fit result to declare cluster association. More...

bool	IsNearCluster (const pandora::CartesianVector &samplingPoint, const TwoDSlidingFitResult &targetFitResult) const
	Whether a sampling point lies near a target 2d sliding fit result. More...

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

Private Attributes
unsigned int	m_minClusterHits
	The minimum allowed number of hits in a clean cluster. More...

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

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

unsigned int	m_maxSamplingPoints
	The maximum number of extension sampling points considered per association check. More...

float	m_sampleStepSize
	The sampling step size used in association checks, units cm. More...

unsigned int	m_maxUnmatchedSampleRun
	The maximum run of unmatched (and non-gap) samples to consider before stopping. More...

float	m_maxOnClusterDistance
	The maximum distance between a sampling point and sliding fit to target cluster. More...

unsigned int	m_minMatchedSamplingPoints
	Minimum number of matched sampling points to declare association. More...

float	m_minMatchedSamplingFraction
	Minimum ratio between matched sampling points and expectation to declare association. More...

float	m_gapTolerance
	The tolerance to use when querying whether a sampling point is in a gap, units cm. More...

Detailed Description

CrossGapsAssociationAlgorithm class.

Definition at line 23 of file CrossGapsAssociationAlgorithm.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::CrossGapsAssociationAlgorithm::CrossGapsAssociationAlgorithm ( )

Default constructor.

Definition at line 21 of file CrossGapsAssociationAlgorithm.cc.

                                                              :
     m_minClusterHits(10),
     m_minClusterLayers(6),
     m_slidingFitWindow(20),
     m_maxSamplingPoints(1000),
     m_sampleStepSize(0.5f),
     m_maxUnmatchedSampleRun(8),
     m_maxOnClusterDistance(1.5f),
     m_minMatchedSamplingPoints(10),
     m_minMatchedSamplingFraction(0.5f),
     m_gapTolerance(0.f)
 {
 }

Member Function Documentation

bool lar_content::CrossGapsAssociationAlgorithm::AreClustersAssociated	(	const TwoDSlidingFitResult &	innerFitResult,
		const TwoDSlidingFitResult &	outerFitResult
	)		const

private

Determine whether two clusters are associated.

Parameters

innerFitResult	two dimensional sliding fit result for the inner cluster
outerFitResult	two dimensional sliding fit result for the outer cluster

Returns: boolean

Definition at line 118 of file CrossGapsAssociationAlgorithm.cc.

References lar_content::TwoDSlidingFitResult::GetCluster(), lar_content::TwoDSlidingFitResult::GetGlobalMaxLayerDirection(), lar_content::TwoDSlidingFitResult::GetGlobalMaxLayerPosition(), lar_content::TwoDSlidingFitResult::GetGlobalMinLayerDirection(), lar_content::TwoDSlidingFitResult::GetGlobalMinLayerPosition(), and IsAssociated().

Referenced by PopulateClusterAssociationMap().

 {
     if (outerFitResult.GetCluster()->GetInnerPseudoLayer() < innerFitResult.GetCluster()->GetInnerPseudoLayer())
         throw pandora::StatusCodeException(STATUS_CODE_NOT_ALLOWED);
 
     if (outerFitResult.GetCluster()->GetInnerPseudoLayer() < innerFitResult.GetCluster()->GetOuterPseudoLayer())
         return false;
 
     return (this->IsAssociated(innerFitResult.GetGlobalMaxLayerPosition(), innerFitResult.GetGlobalMaxLayerDirection(), outerFitResult) &&
         this->IsAssociated(outerFitResult.GetGlobalMinLayerPosition(), outerFitResult.GetGlobalMinLayerDirection() * -1.f, innerFitResult));
 }

void lar_content::CrossGapsAssociationAlgorithm::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 CrossGapsAssociationAlgorithm.cc.

References m_minClusterHits, m_minClusterLayers, and lar_content::LArClusterHelper::SortByInnerLayer().

 {
     // ATTN May want to opt-out completely if no gap information available
     // if (PandoraContentApi::GetGeometry(*this)->GetDetectorGapList().empty())
     //     return;
 
     for (const Cluster *const pCluster : *pClusterList)
     {
         if (pCluster->GetNCaloHits() < m_minClusterHits)
             continue;
 
         if (1 + pCluster->GetOuterPseudoLayer() - pCluster->GetInnerPseudoLayer() < m_minClusterLayers)
             continue;
 
         clusterVector.push_back(pCluster);
     }
 
     std::sort(clusterVector.begin(), clusterVector.end(), LArClusterHelper::SortByInnerLayer);
 }

bool lar_content::CrossGapsAssociationAlgorithm::IsAssociated	(	const pandora::CartesianVector &	startPosition,
		const pandora::CartesianVector &	startDirection,
		const TwoDSlidingFitResult &	targetFitResult
	)		const

private

Sample points along the extrapolation from a starting position to a target fit result to declare cluster association.

Parameters

startPosition	the start position
startDirection	the start direction
targetFitResult	the target fit result

Returns: boolean

Definition at line 132 of file CrossGapsAssociationAlgorithm.cc.

References f, lar_content::TwoDSlidingFitResult::GetCluster(), lar_content::LArClusterHelper::GetClusterHitType(), lar_content::TwoDSlidingFitResult::GetGlobalMaxLayerPosition(), lar_content::TwoDSlidingFitResult::GetGlobalMinLayerPosition(), lar_content::LArGeometryHelper::IsInGap(), IsNearCluster(), m_gapTolerance, m_maxSamplingPoints, m_maxUnmatchedSampleRun, m_minMatchedSamplingFraction, m_minMatchedSamplingPoints, and m_sampleStepSize.

Referenced by AreClustersAssociated().

 {
     const HitType hitType(LArClusterHelper::GetClusterHitType(targetFitResult.GetCluster()));
     unsigned int nSamplingPoints(0), nGapSamplingPoints(0), nMatchedSamplingPoints(0), nUnmatchedSampleRun(0);
 
     for (unsigned int iSample = 0; iSample < m_maxSamplingPoints; ++iSample)
     {
         ++nSamplingPoints;
         const CartesianVector samplingPoint(startPosition + startDirection * static_cast<float>(iSample) * m_sampleStepSize);
 
         if (LArGeometryHelper::IsInGap(this->GetPandora(), samplingPoint, hitType, m_gapTolerance))
         {
             ++nGapSamplingPoints;
             nUnmatchedSampleRun = 0; // ATTN Choose to also reset run when entering gap region
             continue;
         }
 
         if (this->IsNearCluster(samplingPoint, targetFitResult))
         {
             ++nMatchedSamplingPoints;
             nUnmatchedSampleRun = 0;
         }
         else if (++nUnmatchedSampleRun > m_maxUnmatchedSampleRun)
         {
             break;
         }
     }
 
     const float expectation((targetFitResult.GetGlobalMaxLayerPosition() - targetFitResult.GetGlobalMinLayerPosition()).GetMagnitude() / m_sampleStepSize);
     const float matchedSamplingFraction(expectation > 0.f ? static_cast<float>(nMatchedSamplingPoints) / expectation : 0.f);
 
     if ((nMatchedSamplingPoints > m_minMatchedSamplingPoints) || (matchedSamplingFraction > m_minMatchedSamplingFraction))
         return true;
 
     return false;
 }

bool lar_content::CrossGapsAssociationAlgorithm::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 102 of file CrossGapsAssociationAlgorithm.cc.

References 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;
 }

bool lar_content::CrossGapsAssociationAlgorithm::IsNearCluster	(	const pandora::CartesianVector &	samplingPoint,
		const TwoDSlidingFitResult &	targetFitResult
	)		const

private

Whether a sampling point lies near a target 2d sliding fit result.

Parameters

samplingPoint	the sampling point
targetFitResult	the target fit result

Returns: boolean

Definition at line 172 of file CrossGapsAssociationAlgorithm.cc.

References f, lar_content::TwoDSlidingFitResult::GetGlobalFitPosition(), lar_content::TwoDSlidingFitResult::GetGlobalFitPositionAtX(), lar_content::TwoDSlidingFitResult::GetLocalPosition(), m_maxOnClusterDistance, and max.

Referenced by IsAssociated().

 {
     float rL(std::numeric_limits<float>::max()), rT(std::numeric_limits<float>::max());
     targetFitResult.GetLocalPosition(samplingPoint, rL, rT);
 
     CartesianVector fitPosition(0.f, 0.f, 0.f);
 
     if (STATUS_CODE_SUCCESS == targetFitResult.GetGlobalFitPosition(rL, fitPosition))
     {
         if ((fitPosition - samplingPoint).GetMagnitudeSquared() < m_maxOnClusterDistance * m_maxOnClusterDistance)
             return true;
     }
 
     CartesianVector fitPositionAtX(0.f, 0.f, 0.f);
 
     if (STATUS_CODE_SUCCESS == targetFitResult.GetGlobalFitPositionAtX(samplingPoint.GetX(), fitPositionAtX))
     {
         if ((fitPositionAtX - samplingPoint).GetMagnitudeSquared() < m_maxOnClusterDistance * m_maxOnClusterDistance)
             return true;
     }
 
     return false;
 }

void lar_content::CrossGapsAssociationAlgorithm::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 59 of file CrossGapsAssociationAlgorithm.cc.

References AreClustersAssociated(), lar_content::LArGeometryHelper::GetWireZPitch(), and m_slidingFitWindow.

 {
     TwoDSlidingFitResultMap slidingFitResultMap;
     const float slidingFitPitch(LArGeometryHelper::GetWireZPitch(this->GetPandora()));
 
     for (const Cluster *const pCluster : clusterVector)
     {
         try {(void) slidingFitResultMap.insert(TwoDSlidingFitResultMap::value_type(pCluster, TwoDSlidingFitResult(pCluster, m_slidingFitWindow, slidingFitPitch)));}
         catch (StatusCodeException &) {}
     }
 
     // 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;
         TwoDSlidingFitResultMap::const_iterator fitIterI = slidingFitResultMap.find(pInnerCluster);
 
         if (slidingFitResultMap.end() == fitIterI)
             continue;
 
         for (ClusterVector::const_iterator iterJ = iterI, iterJEnd = clusterVector.end(); iterJ != iterJEnd; ++iterJ)
         {
             const Cluster *const pOuterCluster = *iterJ;
 
             if (pInnerCluster == pOuterCluster)
                 continue;
 
             TwoDSlidingFitResultMap::const_iterator fitIterJ = slidingFitResultMap.find(pOuterCluster);
 
             if (slidingFitResultMap.end() == fitIterJ)
                 continue;
 
             if (!this->AreClustersAssociated(fitIterI->second, fitIterJ->second))
                 continue;
 
             clusterAssociationMap[pInnerCluster].m_forwardAssociations.insert(pOuterCluster);
             clusterAssociationMap[pOuterCluster].m_backwardAssociations.insert(pInnerCluster);
         }
     }
 }

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

privatevirtual

Reimplemented from lar_content::ClusterAssociationAlgorithm.

Definition at line 198 of file CrossGapsAssociationAlgorithm.cc.

References m_gapTolerance, m_maxOnClusterDistance, m_maxSamplingPoints, m_maxUnmatchedSampleRun, m_minClusterHits, m_minClusterLayers, m_minMatchedSamplingFraction, m_minMatchedSamplingPoints, m_sampleStepSize, m_slidingFitWindow, and lar_content::ClusterAssociationAlgorithm::ReadSettings().

 {
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle,
         "MinClusterHits", m_minClusterHits));
 
     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,
         "SlidingFitWindow", m_slidingFitWindow));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle,
         "MaxSamplingPoints", m_maxSamplingPoints));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle,
         "SampleStepSize", m_sampleStepSize));
 
     if (m_sampleStepSize < std::numeric_limits<float>::epsilon())
     {
         std::cout << "CrossGapsAssociationAlgorithm: Invalid value for SampleStepSize " << m_sampleStepSize << std::endl;
         throw StatusCodeException(STATUS_CODE_INVALID_PARAMETER);
     }
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle,
         "MaxUnmatchedSampleRun", m_maxUnmatchedSampleRun));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle,
         "MaxOnClusterDistance", m_maxOnClusterDistance));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle,
         "MinMatchedSamplingPoints", m_minMatchedSamplingPoints));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle,
         "MinMatchedSamplingFraction", m_minMatchedSamplingFraction));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle,
         "GapTolerance", m_gapTolerance));
 
     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 mapIter = clusterAssociationMap.find(pCluster);
 
             if (clusterAssociationMap.end() == mapIter)
                 continue;
 
             if (mapIter->second.m_backwardAssociations.empty() && !mapIter->second.m_forwardAssociations.empty())
                 this->AmbiguousPropagation(pCluster, true, clusterAssociationMap);
 
             if (mapIter->second.m_forwardAssociations.empty() && !mapIter->second.m_backwardAssociations.empty())
                 this->AmbiguousPropagation(pCluster, false, clusterAssociationMap);
         }
     }
 
     return STATUS_CODE_SUCCESS;
 }

Member Data Documentation

float lar_content::CrossGapsAssociationAlgorithm::m_gapTolerance

private

The tolerance to use when querying whether a sampling point is in a gap, units cm.

Definition at line 79 of file CrossGapsAssociationAlgorithm.h.

Referenced by IsAssociated(), and ReadSettings().

float lar_content::CrossGapsAssociationAlgorithm::m_maxOnClusterDistance

private

The maximum distance between a sampling point and sliding fit to target cluster.

Definition at line 76 of file CrossGapsAssociationAlgorithm.h.

Referenced by IsNearCluster(), and ReadSettings().

unsigned int lar_content::CrossGapsAssociationAlgorithm::m_maxSamplingPoints

private

The maximum number of extension sampling points considered per association check.

Definition at line 73 of file CrossGapsAssociationAlgorithm.h.

Referenced by IsAssociated(), and ReadSettings().

unsigned int lar_content::CrossGapsAssociationAlgorithm::m_maxUnmatchedSampleRun

private

The maximum run of unmatched (and non-gap) samples to consider before stopping.

Definition at line 75 of file CrossGapsAssociationAlgorithm.h.

Referenced by IsAssociated(), and ReadSettings().

unsigned int lar_content::CrossGapsAssociationAlgorithm::m_minClusterHits

private

The minimum allowed number of hits in a clean cluster.

Definition at line 70 of file CrossGapsAssociationAlgorithm.h.

Referenced by GetListOfCleanClusters(), and ReadSettings().

unsigned int lar_content::CrossGapsAssociationAlgorithm::m_minClusterLayers

private

The minimum allowed number of layers for a clean cluster.

Definition at line 71 of file CrossGapsAssociationAlgorithm.h.

Referenced by GetListOfCleanClusters(), and ReadSettings().

float lar_content::CrossGapsAssociationAlgorithm::m_minMatchedSamplingFraction

private

Minimum ratio between matched sampling points and expectation to declare association.

Definition at line 78 of file CrossGapsAssociationAlgorithm.h.

Referenced by IsAssociated(), and ReadSettings().

unsigned int lar_content::CrossGapsAssociationAlgorithm::m_minMatchedSamplingPoints

private

Minimum number of matched sampling points to declare association.

Definition at line 77 of file CrossGapsAssociationAlgorithm.h.

Referenced by IsAssociated(), and ReadSettings().

float lar_content::CrossGapsAssociationAlgorithm::m_sampleStepSize

private

The sampling step size used in association checks, units cm.

Definition at line 74 of file CrossGapsAssociationAlgorithm.h.

Referenced by IsAssociated(), and ReadSettings().

unsigned int lar_content::CrossGapsAssociationAlgorithm::m_slidingFitWindow

private

The layer window for the sliding linear fits.

Definition at line 72 of file CrossGapsAssociationAlgorithm.h.

Referenced by PopulateClusterAssociationMap(), and ReadSettings().

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

/cvmfs/larsoft.opensciencegrid.org/products/larpandoracontent/v03_14_03/source/larpandoracontent/LArTwoDReco/LArClusterAssociation/CrossGapsAssociationAlgorithm.h
/cvmfs/larsoft.opensciencegrid.org/products/larpandoracontent/v03_14_03/source/larpandoracontent/LArTwoDReco/LArClusterAssociation/CrossGapsAssociationAlgorithm.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