CrossGapsExtensionAlgorithm class. More...

#include <CrossGapsExtensionAlgorithm.h>

Inheritance diagram for lar_content::CrossGapsExtensionAlgorithm:

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

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	FillClusterAssociationMatrix (const pandora::ClusterVector &clusterVector, ClusterAssociationMatrix &clusterAssociationMatrix) const
	Fill the cluster association matrix. More...

void	FillClusterMergeMap (const ClusterAssociationMatrix &clusterAssociationMatrix, ClusterMergeMap &clusterMergeMap) const
	Fill the cluster merge map. More...

void	BuildPointingClusterList (const pandora::ClusterVector &clusterVector, LArPointingClusterList &innerPointingClusterList, LArPointingClusterList &outerPointingClusterList) const
	Build lists of pointing clusters that are adjacent to a detector gap. More...

void	BuildPointingClusterList (const bool useInner, const LArPointingClusterList &inputPointingClusterList, LArPointingClusterList &outputPointingClusterList) const
	Build a list of pointing clusters that are adjacent to a detector gap. More...

bool	IsAssociated (const LArPointingCluster::Vertex &pointingVertex1, const LArPointingCluster::Vertex &pointingVertex2) const
	Use pointing information to determine whether two clusters are associated. More...

bool	IsAcrossGap (const float minZ, const float maxZ, const pandora::HitType hitType) const
	Determine whether a start and end position sit either side of a gap. More...

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

Private Attributes
float	m_minClusterLength

float	m_minGapFraction

float	m_maxGapTolerance

float	m_maxTransverseDisplacement

float	m_maxRelativeAngle

Additional Inherited Members
Protected Types inherited from lar_content::ClusterExtensionAlgorithm
typedef std::unordered_map < const pandora::Cluster *, ClusterAssociation >	ClusterAssociationMap

typedef std::unordered_map < const pandora::Cluster *, ClusterAssociationMap >	ClusterAssociationMatrix

Protected Types inherited from lar_content::ClusterMergingAlgorithm
typedef std::unordered_map < const pandora::Cluster *, pandora::ClusterList >	ClusterMergeMap

Protected Member Functions inherited from lar_content::ClusterExtensionAlgorithm
void	PopulateClusterMergeMap (const pandora::ClusterVector &clusterVector, ClusterMergeMap &clusterMergeMatrix) const
	Form associations between pointing clusters. More...

Protected Member Functions inherited from lar_content::ClusterMergingAlgorithm
virtual pandora::StatusCode	Run ()

void	MergeClusters (pandora::ClusterVector &clusterVector, ClusterMergeMap &clusterMergeMap) const
	Merge associated clusters. More...

void	CollectAssociatedClusters (const pandora::Cluster *const pSeedCluster, const ClusterMergeMap &clusterMergeMap, pandora::ClusterList &associatedClusterList) const
	Collect up all clusters associations related to a given seed cluster. More...

void	CollectAssociatedClusters (const pandora::Cluster const pSeedCluster, const pandora::Cluster const pCurrentCluster, const ClusterMergeMap &clusterMergeMap, const pandora::ClusterSet &clusterVetoList, pandora::ClusterList &associatedClusterList) const
	Collect up all clusters associations related to a given seed cluster. More...

void	GetSortedListOfCleanClusters (const pandora::ClusterVector &inputClusters, pandora::ClusterVector &outputClusters) const
	Sort the selected clusters, so that they have a well-defined ordering. More...

Protected Attributes inherited from lar_content::ClusterMergingAlgorithm
std::string	m_inputClusterListName
	The name of the input cluster list. If not specified, will access current list. More...

Detailed Description

CrossGapsExtensionAlgorithm class.

Definition at line 21 of file CrossGapsExtensionAlgorithm.h.

Constructor & Destructor Documentation

lar_content::CrossGapsExtensionAlgorithm::CrossGapsExtensionAlgorithm ( )

Default constructor.

Definition at line 22 of file CrossGapsExtensionAlgorithm.cc.

                                                          :
     m_minClusterLength(5.f),
     m_minGapFraction(0.5f),
     m_maxGapTolerance(2.f),
     m_maxTransverseDisplacement(2.5f),
     m_maxRelativeAngle(10.f)
 {
 }

Member Function Documentation

void lar_content::CrossGapsExtensionAlgorithm::BuildPointingClusterList	(	const pandora::ClusterVector &	clusterVector,
		LArPointingClusterList &	innerPointingClusterList,
		LArPointingClusterList &	outerPointingClusterList
	)		const

private

Build lists of pointing clusters that are adjacent to a detector gap.

Parameters

clusterVector	the input vector of clusters
innerPointingClusterList	the pointing clusters whose inner vertex is close to a detector gap
outerPointingClusterList	the pointing clusters whose outer vertex is close to a detector gap

void lar_content::CrossGapsExtensionAlgorithm::BuildPointingClusterList	(	const bool	useInner,
		const LArPointingClusterList &	inputPointingClusterList,
		LArPointingClusterList &	outputPointingClusterList
	)		const

private

Build a list of pointing clusters that are adjacent to a detector gap.

Parameters

useInner	check the inner vertex
inputPointingClusterList	the input list of pointing clusters
outputPointingClusterList	the output list of pointing clusters

Definition at line 115 of file CrossGapsExtensionAlgorithm.cc.

 {
     for (const LArPointingCluster &pointingCluster : inputPointingClusterList)
     {
         const LArPointingCluster::Vertex &pointingVertex(useInner ? pointingCluster.GetInnerVertex() : pointingCluster.GetOuterVertex());
         const HitType hitType(LArClusterHelper::GetClusterHitType(pointingCluster.GetCluster()));
 
         if (LArGeometryHelper::IsInGap(this->GetPandora(), pointingVertex.GetPosition(), hitType, m_maxGapTolerance))
             outputPointingClusterList.push_back(pointingCluster);
     }
 }

void lar_content::CrossGapsExtensionAlgorithm::FillClusterAssociationMatrix	(	const pandora::ClusterVector &	clusterVector,
		ClusterAssociationMatrix &	clusterAssociationMatrix
	)		const

privatevirtual

Fill the cluster association matrix.

Parameters

clusterVector	the input vector of clusters
clusterAssociationMatrix	the matrix of associations

Implements lar_content::ClusterExtensionAlgorithm.

Definition at line 52 of file CrossGapsExtensionAlgorithm.cc.

 {
     // Build lists of pointing clusters in proximity to gaps
     LArPointingClusterList innerPointingClusterList, outerPointingClusterList;
     this->BuildPointingClusterList(clusterVector, innerPointingClusterList, outerPointingClusterList);
 
     // Form associations between pairs of pointing clusters
     for (const LArPointingCluster &pointingClusterInner : innerPointingClusterList)
     {
         const LArPointingCluster::Vertex &pointingVertexInner(pointingClusterInner.GetInnerVertex());
         const float zInner(pointingVertexInner.GetPosition().GetZ());
 
         for (const LArPointingCluster &pointingClusterOuter : outerPointingClusterList)
         {
             const LArPointingCluster::Vertex &pointingVertexOuter(pointingClusterOuter.GetOuterVertex());
             const float zOuter(pointingVertexOuter.GetPosition().GetZ());
 
             if (!this->IsAcrossGap(zOuter, zInner, LArClusterHelper::GetClusterHitType(pointingClusterInner.GetCluster())))
                 continue;
 
             if (!this->IsAssociated(pointingVertexInner, pointingVertexOuter))
                 continue;
 
             const Cluster *const pClusterInner(pointingClusterInner.GetCluster());
             const Cluster *const pClusterOuter(pointingClusterOuter.GetCluster());
 
             const float lengthSquaredInner(LArClusterHelper::GetLengthSquared(pClusterInner));
             const float lengthSquaredOuter(LArClusterHelper::GetLengthSquared(pClusterOuter));
 
             (void)clusterAssociationMatrix[pClusterInner].insert(ClusterAssociationMap::value_type(pClusterOuter,
                 ClusterAssociation(ClusterAssociation::INNER, ClusterAssociation::OUTER, ClusterAssociation::STRONG, lengthSquaredOuter)));
             (void)clusterAssociationMatrix[pClusterOuter].insert(ClusterAssociationMap::value_type(pClusterInner,
                 ClusterAssociation(ClusterAssociation::OUTER, ClusterAssociation::INNER, ClusterAssociation::STRONG, lengthSquaredInner)));
         }
     }
 }

void lar_content::CrossGapsExtensionAlgorithm::FillClusterMergeMap	(	const ClusterAssociationMatrix &	clusterAssociationMatrix,
		ClusterMergeMap &	clusterMergeMap
	)		const

privatevirtual

Fill the cluster merge map.

Parameters

clusterAssociationMatrix	the matrix of cluster associations
clusterMergeMap	the map of cluster merges

Implements lar_content::ClusterExtensionAlgorithm.

Definition at line 159 of file CrossGapsExtensionAlgorithm.cc.

 {
     // Decide which associations will become merges
     // To make the merge A <-> B, both A -> B and B -> A must be strong associations
     // with the largest figures of merit of all the A -> X and B -> Y associations
 
     // First step: remove double-counting from the map of associations
     // i.e. if the map has A <-> B, B <-> C, A <-> C, then remove A <-> C
     ClusterAssociationMatrix clusterAssociationMatrix;
 
     ClusterVector sortedInputClusters;
     for (const auto &mapEntry : inputAssociationMatrix)
         sortedInputClusters.push_back(mapEntry.first);
     std::sort(sortedInputClusters.begin(), sortedInputClusters.end(), LArClusterHelper::SortByNHits);
 
     for (const Cluster *const pCluster1 : sortedInputClusters)
     {
         const ClusterAssociationMap &associationMap1(inputAssociationMatrix.at(pCluster1));
 
         for (const Cluster *const pCluster2 : sortedInputClusters)
         {
             if (pCluster1 == pCluster2)
                 continue;
 
             const ClusterAssociationMap &associationMap2(inputAssociationMatrix.at(pCluster2));
 
             ClusterAssociationMap::const_iterator iter12 = associationMap1.find(pCluster2);
             if (associationMap1.end() == iter12)
                 continue;
 
             ClusterAssociationMap::const_iterator iter21 = associationMap2.find(pCluster1);
             if (associationMap2.end() == iter21)
                 continue;
 
             const ClusterAssociation &association12(iter12->second);
             const ClusterAssociation &association21(iter21->second);
 
             bool isAssociated(true);
 
             ClusterVector sortedAssociationClusters;
             for (const auto &mapEntry : associationMap1)
                 sortedAssociationClusters.push_back(mapEntry.first);
             std::sort(sortedAssociationClusters.begin(), sortedAssociationClusters.end(), LArClusterHelper::SortByNHits);
 
             for (const Cluster *const pCluster3 : sortedAssociationClusters)
             {
                 const ClusterAssociation &association13(associationMap1.at(pCluster3));
 
                 ClusterAssociationMap::const_iterator iter23 = associationMap2.find(pCluster3);
                 if (associationMap2.end() == iter23)
                     continue;
 
                 const ClusterAssociation &association23(iter23->second);
 
                 if (association12.GetParent() == association13.GetParent() && association23.GetParent() == association21.GetParent() &&
                     association13.GetDaughter() != association23.GetDaughter())
                 {
                     isAssociated = false;
                     break;
                 }
             }
 
             if (isAssociated)
             {
                 (void)clusterAssociationMatrix[pCluster1].insert(ClusterAssociationMap::value_type(pCluster2, association12));
                 (void)clusterAssociationMatrix[pCluster2].insert(ClusterAssociationMap::value_type(pCluster1, association21));
             }
         }
     }
 
     // Second step: find the best associations A -> X and B -> Y
     ClusterAssociationMatrix intermediateAssociationMatrix;
 
     ClusterVector sortedClusters;
     for (const auto &mapEntry : clusterAssociationMatrix)
         sortedClusters.push_back(mapEntry.first);
     std::sort(sortedClusters.begin(), sortedClusters.end(), LArClusterHelper::SortByNHits);
 
     for (const Cluster *const pParentCluster : sortedClusters)
     {
         const ClusterAssociationMap &clusterAssociationMap(clusterAssociationMatrix.at(pParentCluster));
 
         const Cluster *pBestClusterInner(nullptr);
         ClusterAssociation bestAssociationInner(ClusterAssociation::UNDEFINED, ClusterAssociation::UNDEFINED, ClusterAssociation::NONE, 0.f);
 
         const Cluster *pBestClusterOuter(nullptr);
         ClusterAssociation bestAssociationOuter(ClusterAssociation::UNDEFINED, ClusterAssociation::UNDEFINED, ClusterAssociation::NONE, 0.f);
 
         ClusterVector sortedAssociationClusters;
         for (const auto &mapEntry : clusterAssociationMap)
             sortedAssociationClusters.push_back(mapEntry.first);
         std::sort(sortedAssociationClusters.begin(), sortedAssociationClusters.end(), LArClusterHelper::SortByNHits);
 
         for (const Cluster *const pDaughterCluster : sortedAssociationClusters)
         {
             const ClusterAssociation &clusterAssociation(clusterAssociationMap.at(pDaughterCluster));
 
             // Inner associations
             if (clusterAssociation.GetParent() == ClusterAssociation::INNER)
             {
                 if (clusterAssociation.GetFigureOfMerit() > bestAssociationInner.GetFigureOfMerit())
                 {
                     bestAssociationInner = clusterAssociation;
                     pBestClusterInner = pDaughterCluster;
                 }
             }
 
             // Outer associations
             if (clusterAssociation.GetParent() == ClusterAssociation::OUTER)
             {
                 if (clusterAssociation.GetFigureOfMerit() > bestAssociationOuter.GetFigureOfMerit())
                 {
                     bestAssociationOuter = clusterAssociation;
                     pBestClusterOuter = pDaughterCluster;
                 }
             }
         }
 
         if (pBestClusterInner)
             (void)intermediateAssociationMatrix[pParentCluster].insert(ClusterAssociationMap::value_type(pBestClusterInner, bestAssociationInner));
 
         if (pBestClusterOuter)
             (void)intermediateAssociationMatrix[pParentCluster].insert(ClusterAssociationMap::value_type(pBestClusterOuter, bestAssociationOuter));
     }
 
     // Third step: make the merge if A -> X and B -> Y is in fact A -> B and B -> A
     ClusterVector intermediateSortedClusters;
     for (const auto &mapEntry : intermediateAssociationMatrix)
         intermediateSortedClusters.push_back(mapEntry.first);
     std::sort(intermediateSortedClusters.begin(), intermediateSortedClusters.end(), LArClusterHelper::SortByNHits);
 
     for (const Cluster *const pParentCluster : intermediateSortedClusters)
     {
         const ClusterAssociationMap &parentAssociationMap(intermediateAssociationMatrix.at(pParentCluster));
 
         ClusterVector sortedAssociationClusters;
         for (const auto &mapEntry : parentAssociationMap)
             sortedAssociationClusters.push_back(mapEntry.first);
         std::sort(sortedAssociationClusters.begin(), sortedAssociationClusters.end(), LArClusterHelper::SortByNHits);
 
         for (const Cluster *const pDaughterCluster : sortedAssociationClusters)
         {
             const ClusterAssociation &parentToDaughterAssociation(parentAssociationMap.at(pDaughterCluster));
 
             ClusterAssociationMatrix::const_iterator iter5 = intermediateAssociationMatrix.find(pDaughterCluster);
 
             if (intermediateAssociationMatrix.end() == iter5)
                 continue;
 
             const ClusterAssociationMap &daughterAssociationMap(iter5->second);
 
             ClusterAssociationMap::const_iterator iter6 = daughterAssociationMap.find(pParentCluster);
 
             if (daughterAssociationMap.end() == iter6)
                 continue;
 
             const ClusterAssociation &daughterToParentAssociation(iter6->second);
 
             if (parentToDaughterAssociation.GetParent() == daughterToParentAssociation.GetDaughter() &&
                 parentToDaughterAssociation.GetDaughter() == daughterToParentAssociation.GetParent())
             {
                 ClusterList &parentList(clusterMergeMap[pParentCluster]);
 
                 if (parentList.end() == std::find(parentList.begin(), parentList.end(), pDaughterCluster))
                     parentList.push_back(pDaughterCluster);
             }
         }
     }
 }

void lar_content::CrossGapsExtensionAlgorithm::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::ClusterMergingAlgorithm.

Definition at line 33 of file CrossGapsExtensionAlgorithm.cc.

 {
     // 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 (LArClusterHelper::GetLengthSquared(pCluster) < m_minClusterLength * m_minClusterLength)
             continue;
 
         clusterVector.push_back(pCluster);
     }
 
     std::sort(clusterVector.begin(), clusterVector.end(), LArClusterHelper::SortByNHits);
 }

bool lar_content::CrossGapsExtensionAlgorithm::IsAcrossGap	(	const float	minZ,
		const float	maxZ,
		const pandora::HitType	hitType
	)		const

private

Determine whether a start and end position sit either side of a gap.

Parameters

minZ	the start position
maxZ	the end position
hitType	the hitType

Definition at line 144 of file CrossGapsExtensionAlgorithm.cc.

 {
     if (maxZ - minZ < std::numeric_limits<float>::epsilon())
         return false;
 
     const float gapDeltaZ(LArGeometryHelper::CalculateGapDeltaZ(this->GetPandora(), minZ, maxZ, hitType));
 
     if (gapDeltaZ / (maxZ - minZ) < m_minGapFraction)
         return false;
 
     return true;
 }

bool lar_content::CrossGapsExtensionAlgorithm::IsAssociated	(	const LArPointingCluster::Vertex &	pointingVertex1,
		const LArPointingCluster::Vertex &	pointingVertex2
	)		const

private

Use pointing information to determine whether two clusters are associated.

Parameters

pointingVertex1	the first pointing vertex
pointingVertex2	the second pointing vertex

Definition at line 130 of file CrossGapsExtensionAlgorithm.cc.

 {
     const float maxLongitudinalDisplacement((pointingVertex2.GetPosition() - pointingVertex1.GetPosition()).GetMagnitude());
 
     const bool isAssociated1(LArPointingClusterHelper::IsEmission(pointingVertex1.GetPosition(), pointingVertex2, -1.f,
         maxLongitudinalDisplacement + 1.f, m_maxTransverseDisplacement, m_maxRelativeAngle));
     const bool isAssociated2(LArPointingClusterHelper::IsEmission(pointingVertex2.GetPosition(), pointingVertex1, -1.f,
         maxLongitudinalDisplacement + 1.f, m_maxTransverseDisplacement, m_maxRelativeAngle));
 
     return (isAssociated1 && isAssociated2);
 }

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

privatevirtual

Reimplemented from lar_content::ClusterMergingAlgorithm.

Definition at line 331 of file CrossGapsExtensionAlgorithm.cc.

 {
     PANDORA_RETURN_RESULT_IF_AND_IF(
         STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "MinClusterLength", m_minClusterLength));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "MinGapFraction", m_minGapFraction));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "MaxGapTolerance", m_maxGapTolerance));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=,
         XmlHelper::ReadValue(xmlHandle, "MaxTransverseDisplacement", m_maxTransverseDisplacement));
 
     float maxCosRelativeAngle(std::cos(m_maxRelativeAngle * M_PI / 180.0));
     PANDORA_RETURN_RESULT_IF_AND_IF(
         STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "MaxCosRelativeAngle", maxCosRelativeAngle));
     m_maxRelativeAngle = (180.0 / M_PI) * std::acos(maxCosRelativeAngle);
 
     return ClusterExtensionAlgorithm::ReadSettings(xmlHandle);
 }