LongitudinalExtensionAlgorithm class. More...

#include <LongitudinalExtensionAlgorithm.h>

Inheritance diagram for lar_content::LongitudinalExtensionAlgorithm:

Public Member Functions
	LongitudinalExtensionAlgorithm ()
	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	FillClusterAssociationMatrix (const LArPointingCluster &clusterI, const LArPointingCluster &clusterJ, ClusterAssociationMatrix &clusterAssociationMatrix) const
	Form association between two pointing clusters. More...

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

Private Attributes
float	m_clusterMinLength

float	m_clusterMinLayerOccupancy

float	m_nodeMaxDisplacement

float	m_nodeMaxCosRelativeAngle

float	m_emissionMaxLongitudinalDisplacement

float	m_emissionMaxTransverseDisplacement

float	m_emissionMaxCosRelativeAngle

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

LongitudinalExtensionAlgorithm class.

Definition at line 21 of file LongitudinalExtensionAlgorithm.h.

Constructor & Destructor Documentation

lar_content::LongitudinalExtensionAlgorithm::LongitudinalExtensionAlgorithm ( )

Default constructor.

Definition at line 21 of file LongitudinalExtensionAlgorithm.cc.

                                                                :
     m_clusterMinLength(5.f),
     m_clusterMinLayerOccupancy(0.75f),
     m_nodeMaxDisplacement(1.5f),
     m_nodeMaxCosRelativeAngle(0.906f),
     m_emissionMaxLongitudinalDisplacement(15.f),
     m_emissionMaxTransverseDisplacement(2.5f),
     m_emissionMaxCosRelativeAngle(0.985f)
 {
 }

Member Function Documentation

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

void lar_content::LongitudinalExtensionAlgorithm::FillClusterAssociationMatrix	(	const LArPointingCluster &	clusterI,
		const LArPointingCluster &	clusterJ,
		ClusterAssociationMatrix &	clusterAssociationMatrix
	)		const

private

Form association between two pointing clusters.

Parameters

clusterI	the first pointing cluster
clusterJ	the second pointing cluster
clusterAssociationMatrix	the matrix of cluster associations

Definition at line 89 of file LongitudinalExtensionAlgorithm.cc.

 {
     const Cluster *const pClusterI(clusterI.GetCluster());
     const Cluster *const pClusterJ(clusterJ.GetCluster());
 
     if (pClusterI == pClusterJ)
         return;
 
     // Check that new layer occupancy would be reasonable
     if (LArClusterHelper::GetLayerOccupancy(pClusterI, pClusterJ) < m_clusterMinLayerOccupancy)
         return;
 
     // Identify closest pair of vertices
     LArPointingCluster::Vertex targetVertexI, targetVertexJ;
 
     try
     {
         LArPointingClusterHelper::GetClosestVertices(clusterI, clusterJ, targetVertexI, targetVertexJ);
     }
     catch (StatusCodeException &)
     {
         return;
     }
 
     // (Just in case...)
     if (!(targetVertexI.IsInitialized() && targetVertexJ.IsInitialized()))
         throw StatusCodeException(STATUS_CODE_FAILURE);
 
     const CartesianVector &vertexPositionI(targetVertexI.GetPosition());
     const CartesianVector &vertexPositionJ(targetVertexJ.GetPosition());
     const CartesianVector &vertexDirectionI(targetVertexI.GetDirection());
     const CartesianVector &vertexDirectionJ(targetVertexJ.GetDirection());
 
     // Check for reasonable proximity between vertices
     const float distanceSquared((vertexPositionI - vertexPositionJ).GetMagnitudeSquared());
 
     if (distanceSquared > m_emissionMaxLongitudinalDisplacement * m_emissionMaxLongitudinalDisplacement)
         return;
 
     // Check that vertices have a reasonable linear fit
     if (targetVertexI.GetRms() > 1.f || targetVertexJ.GetRms() > 1.f)
         return;
 
     // Association type
     ClusterAssociation::AssociationType associationType(ClusterAssociation::NONE);
 
     // Requirements for Nodes
     if (distanceSquared < 2.f * m_nodeMaxDisplacement * m_nodeMaxDisplacement)
     {
         associationType = ClusterAssociation::WEAK;
 
         if (distanceSquared < m_nodeMaxDisplacement * m_nodeMaxDisplacement)
         {
             const float cosTheta(-vertexDirectionI.GetDotProduct(vertexDirectionJ));
 
             if (cosTheta > m_nodeMaxCosRelativeAngle)
             {
                 associationType = ClusterAssociation::STRONG;
             }
         }
     }
 
     // Requirements for Emissions
     const float clusterLengthI(LArPointingClusterHelper::GetLength(clusterI));
     const float clusterLengthJ(LArPointingClusterHelper::GetLength(clusterJ));
 
     if (associationType < ClusterAssociation::STRONG)
     {
         const float cosTheta(-vertexDirectionI.GetDotProduct(vertexDirectionJ));
         const float cosThetaI((vertexPositionI - vertexPositionJ).GetUnitVector().GetDotProduct(vertexDirectionI));
         const float cosThetaJ((vertexPositionJ - vertexPositionI).GetUnitVector().GetDotProduct(vertexDirectionJ));
 
         float rT1(0.f), rL1(0.f), rT2(0.f), rL2(0.f);
         LArPointingClusterHelper::GetImpactParameters(vertexPositionI, vertexDirectionI, vertexPositionJ, rL1, rT1);
         LArPointingClusterHelper::GetImpactParameters(vertexPositionJ, vertexDirectionJ, vertexPositionI, rL2, rT2);
 
         if ((rL1 > -2.5f && rL1 < std::min(0.66f * clusterLengthJ, m_emissionMaxLongitudinalDisplacement)) &&
             (rL2 > -2.5f && rL2 < std::min(0.66f * clusterLengthI, m_emissionMaxLongitudinalDisplacement)) && (rT1 < m_emissionMaxTransverseDisplacement) &&
             (rT2 < m_emissionMaxTransverseDisplacement) && (targetVertexI.GetRms() < 0.5f && targetVertexJ.GetRms() < 0.5f) &&
             (cosTheta > m_emissionMaxCosRelativeAngle) && (std::fabs(cosThetaI) > 0.25f) && (std::fabs(cosThetaJ) > 0.25f))
         {
             associationType = ClusterAssociation::STRONG;
         }
     }
 
     // Record the association
     if (ClusterAssociation::NONE != associationType)
     {
         const ClusterAssociation::VertexType vertexTypeI(targetVertexI.IsInnerVertex() ? ClusterAssociation::INNER : ClusterAssociation::OUTER);
         const ClusterAssociation::VertexType vertexTypeJ(targetVertexJ.IsInnerVertex() ? ClusterAssociation::INNER : ClusterAssociation::OUTER);
         (void)clusterAssociationMatrix[pClusterI].insert(
             ClusterAssociationMap::value_type(pClusterJ, ClusterAssociation(vertexTypeI, vertexTypeJ, associationType, clusterLengthJ)));
         (void)clusterAssociationMatrix[pClusterJ].insert(
             ClusterAssociationMap::value_type(pClusterI, ClusterAssociation(vertexTypeJ, vertexTypeI, associationType, clusterLengthI)));
         return;
     }
 }

void lar_content::LongitudinalExtensionAlgorithm::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 190 of file LongitudinalExtensionAlgorithm.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;
 
                     if (clusterAssociation.GetAssociation() == ClusterAssociation::STRONG)
                         pBestClusterInner = pDaughterCluster;
                     else
                         pBestClusterInner = nullptr;
                 }
             }
 
             // Outer associations
             if (clusterAssociation.GetParent() == ClusterAssociation::OUTER)
             {
                 if (clusterAssociation.GetFigureOfMerit() > bestAssociationOuter.GetFigureOfMerit())
                 {
                     bestAssociationOuter = clusterAssociation;
 
                     if (clusterAssociation.GetAssociation() == ClusterAssociation::STRONG)
                         pBestClusterOuter = pDaughterCluster;
                     else
                         pBestClusterOuter = nullptr;
                 }
             }
         }
 
         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::LongitudinalExtensionAlgorithm::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 34 of file LongitudinalExtensionAlgorithm.cc.

 {
     for (ClusterList::const_iterator iter = pClusterList->begin(), iterEnd = pClusterList->end(); iter != iterEnd; ++iter)
     {
         const Cluster *const pCluster = *iter;
 
         if (LArClusterHelper::GetLengthSquared(pCluster) < m_clusterMinLength * m_clusterMinLength)
             continue;
 
         if (LArClusterHelper::GetLayerOccupancy(pCluster) < m_clusterMinLayerOccupancy)
             continue;
 
         clusterVector.push_back(pCluster);
     }
 
     std::sort(clusterVector.begin(), clusterVector.end(), LArClusterHelper::SortByNHits);
 }

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

privatevirtual

Reimplemented from lar_content::ClusterMergingAlgorithm.

Definition at line 370 of file LongitudinalExtensionAlgorithm.cc.

 {
     PANDORA_RETURN_RESULT_IF_AND_IF(
         STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "ClusterMinLength", m_clusterMinLength));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=,
         XmlHelper::ReadValue(xmlHandle, "ClusterMinLayerOccupancy", m_clusterMinLayerOccupancy));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(
         STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "NodeMaxDisplacement", m_nodeMaxDisplacement));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=,
         XmlHelper::ReadValue(xmlHandle, "NodeMaxCosRelativeAngle", m_nodeMaxCosRelativeAngle));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=,
         XmlHelper::ReadValue(xmlHandle, "EmissionMaxLongitudinalDisplacement", m_emissionMaxLongitudinalDisplacement));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=,
         XmlHelper::ReadValue(xmlHandle, "EmissionMaxTransverseDisplacement", m_emissionMaxTransverseDisplacement));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=,
         XmlHelper::ReadValue(xmlHandle, "EmissionMaxCosRelativeAngle", m_emissionMaxCosRelativeAngle));
 
     return ClusterExtensionAlgorithm::ReadSettings(xmlHandle);
 }