DeltaRayExtensionAlgorithm class. More...

#include <DeltaRayExtensionAlgorithm.h>

Inheritance diagram for lar_content::DeltaRayExtensionAlgorithm:

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

Private Types
typedef std::unordered_map < const pandora::Cluster *, pandora::CartesianVector >	ClusterToCoordinateMap

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	GetExtremalCoordinatesFromCache (const pandora::Cluster *const pCluster, ClusterToCoordinateMap &innerCoordinateMap, ClusterToCoordinateMap &outerCoordinateMap, pandora::CartesianVector &innerCoordinate, pandora::CartesianVector &outerCoordinate) const
	Reduce number of extremal coordinates calculations by caching results when they are first obtained. More...

void	FillClusterAssociationMatrix (const pandora::Cluster const pParentCluster, const pandora::Cluster const pDaughterCluster, ClusterToCoordinateMap &innerCoordinateMap, ClusterToCoordinateMap &outerCoordinateMap, ClusterAssociationMatrix &clusterAssociationMatrix) const
	Form association between two clusters. More...

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

Private Attributes
float	m_minClusterLength

float	m_maxClusterLength

float	m_maxLongitudinalDisplacement

float	m_maxTransverseDisplacement

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

DeltaRayExtensionAlgorithm class.

Definition at line 21 of file DeltaRayExtensionAlgorithm.h.

Member Typedef Documentation

typedef std::unordered_map<const pandora::Cluster *, pandora::CartesianVector> lar_content::DeltaRayExtensionAlgorithm::ClusterToCoordinateMap

private

Definition at line 34 of file DeltaRayExtensionAlgorithm.h.

Constructor & Destructor Documentation

lar_content::DeltaRayExtensionAlgorithm::DeltaRayExtensionAlgorithm ( )

Default constructor.

Definition at line 20 of file DeltaRayExtensionAlgorithm.cc.

                                                        :
     m_minClusterLength(1.f),
     m_maxClusterLength(10.f),
     m_maxLongitudinalDisplacement(2.5f),
     m_maxTransverseDisplacement(1.5f)
 {
 }

Member Function Documentation

void lar_content::DeltaRayExtensionAlgorithm::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::DeltaRayExtensionAlgorithm::FillClusterAssociationMatrix	(	const pandora::Cluster *const	pParentCluster,
		const pandora::Cluster *const	pDaughterCluster,
		ClusterToCoordinateMap &	innerCoordinateMap,
		ClusterToCoordinateMap &	outerCoordinateMap,
		ClusterAssociationMatrix &	clusterAssociationMatrix
	)		const

private

Form association between two clusters.

Parameters

pParentCluster	the parent cluster
pDaughterCluster	the daughter cluster
innerCoordinateMap	the map from cluster to inner extremal coordinate
outerCoordinateMap	the map from cluster to outer extremal coordinate
clusterAssociationMatrix	the matrix of cluster associations

void lar_content::DeltaRayExtensionAlgorithm::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 177 of file DeltaRayExtensionAlgorithm.cc.

 {
     // Merge parent and daughter clusters if they are strongly associated
     // and the associations have the best figures of merit
     // (i.e. the P --> D association is the best P --> X association,
     //   and the P <-- D association is the best X <-- D association).
     ClusterAssociationMatrix daughterToParentMatrix;
 
     ClusterVector sortedParentClusters;
     for (const auto &mapEntry : parentToDaughterMatrix)
         sortedParentClusters.push_back(mapEntry.first);
     std::sort(sortedParentClusters.begin(), sortedParentClusters.end(), LArClusterHelper::SortByNHits);
 
     for (const Cluster *const pParentCluster : sortedParentClusters)
     {
         const ClusterAssociationMap &daughterToAssociationMap(parentToDaughterMatrix.at(pParentCluster));
 
         ClusterVector sortedLocalDaughterClusters;
         for (const auto &mapEntry : daughterToAssociationMap)
             sortedLocalDaughterClusters.push_back(mapEntry.first);
         std::sort(sortedLocalDaughterClusters.begin(), sortedLocalDaughterClusters.end(), LArClusterHelper::SortByNHits);
 
         for (const Cluster *const pDaughterCluster : sortedLocalDaughterClusters)
         {
             const ClusterAssociation &clusterAssociation(daughterToAssociationMap.at(pDaughterCluster));
             (void)daughterToParentMatrix[pDaughterCluster].insert(ClusterAssociationMap::value_type(pParentCluster, clusterAssociation));
         }
     }
 
     ClusterAssociationMatrix reducedParentToDaughterMatrix;
 
     ClusterVector sortedDaughterClusters;
     for (const auto &mapEntry : daughterToParentMatrix)
         sortedDaughterClusters.push_back(mapEntry.first);
     std::sort(sortedDaughterClusters.begin(), sortedDaughterClusters.end(), LArClusterHelper::SortByNHits);
 
     // Loop over parent clusters and select nearby daughter clusters that are closer than another parent cluster
     for (const Cluster *const pDaughterCluster : sortedDaughterClusters)
     {
         const ClusterAssociationMap &parentToAssociationMap(daughterToParentMatrix.at(pDaughterCluster));
 
         const Cluster *pBestInner(NULL);
         const Cluster *pBestOuter(NULL);
 
         float bestFomInner(std::numeric_limits<float>::max());
         float bestFomOuter(std::numeric_limits<float>::max());
 
         ClusterVector sortedLocalParentClusters;
         for (const auto &mapEntry : parentToAssociationMap)
             sortedLocalParentClusters.push_back(mapEntry.first);
         std::sort(sortedLocalParentClusters.begin(), sortedLocalParentClusters.end(), LArClusterHelper::SortByNHits);
 
         for (const Cluster *const pParentCluster : sortedLocalParentClusters)
         {
             const ClusterAssociation &clusterAssociation(parentToAssociationMap.at(pParentCluster));
 
             if (clusterAssociation.GetParent() == ClusterAssociation::INNER)
             {
                 if (clusterAssociation.GetFigureOfMerit() < bestFomInner)
                 {
                     bestFomInner = clusterAssociation.GetFigureOfMerit();
 
                     if (clusterAssociation.GetAssociation() == ClusterAssociation::STRONG)
                     {
                         pBestInner = pParentCluster;
                     }
                     else
                     {
                         pBestInner = NULL;
                     }
                 }
             }
 
             if (clusterAssociation.GetParent() == ClusterAssociation::OUTER)
             {
                 if (clusterAssociation.GetFigureOfMerit() < bestFomOuter)
                 {
                     bestFomOuter = clusterAssociation.GetFigureOfMerit();
 
                     if (clusterAssociation.GetAssociation() == ClusterAssociation::STRONG)
                     {
                         pBestOuter = pParentCluster;
                     }
                     else
                     {
                         pBestOuter = NULL;
                     }
                 }
             }
         }
 
         if (pBestInner)
         {
             ClusterAssociationMatrix::const_iterator iter3A = parentToDaughterMatrix.find(pBestInner);
 
             if (parentToDaughterMatrix.end() == iter3A)
                 throw pandora::StatusCodeException(STATUS_CODE_FAILURE);
 
             const ClusterAssociationMap &parentToDaughterMap(iter3A->second);
             ClusterAssociationMap::const_iterator iter3B = parentToDaughterMap.find(pDaughterCluster);
 
             if (parentToDaughterMap.end() == iter3B)
                 throw pandora::StatusCodeException(STATUS_CODE_FAILURE);
 
             const ClusterAssociation &bestAssociationInner(iter3B->second);
             (void)reducedParentToDaughterMatrix[pBestInner].insert(ClusterAssociationMap::value_type(pDaughterCluster, bestAssociationInner));
         }
 
         if (pBestOuter)
         {
             ClusterAssociationMatrix::const_iterator iter3A = parentToDaughterMatrix.find(pBestOuter);
 
             if (parentToDaughterMatrix.end() == iter3A)
                 throw pandora::StatusCodeException(STATUS_CODE_FAILURE);
 
             const ClusterAssociationMap &parentToDaughterMap(iter3A->second);
             ClusterAssociationMap::const_iterator iter3B = parentToDaughterMap.find(pDaughterCluster);
 
             if (parentToDaughterMap.end() == iter3B)
                 throw pandora::StatusCodeException(STATUS_CODE_FAILURE);
 
             const ClusterAssociation &bestAssociationOuter(iter3B->second);
             (void)reducedParentToDaughterMatrix[pBestOuter].insert(ClusterAssociationMap::value_type(pDaughterCluster, bestAssociationOuter));
         }
     }
 
     ClusterVector sortedReducedParentClusters;
     for (const auto &mapEntry : reducedParentToDaughterMatrix)
         sortedReducedParentClusters.push_back(mapEntry.first);
     std::sort(sortedReducedParentClusters.begin(), sortedReducedParentClusters.end(), LArClusterHelper::SortByNHits);
 
     for (const Cluster *const pParentCluster : sortedReducedParentClusters)
     {
         const ClusterAssociationMap &daughterToAssociationMap(reducedParentToDaughterMatrix.at(pParentCluster));
 
         const Cluster *pBestInner(NULL);
         const Cluster *pBestOuter(NULL);
 
         float bestFomInner(std::numeric_limits<float>::max());
         float bestFomOuter(std::numeric_limits<float>::max());
 
         ClusterVector sortedLocalDaughterClusters;
         for (const auto &mapEntry : daughterToAssociationMap)
             sortedLocalDaughterClusters.push_back(mapEntry.first);
         std::sort(sortedLocalDaughterClusters.begin(), sortedLocalDaughterClusters.end(), LArClusterHelper::SortByNHits);
 
         for (const Cluster *const pDaughterCluster : sortedLocalDaughterClusters)
         {
             const ClusterAssociation &clusterAssociation(daughterToAssociationMap.at(pDaughterCluster));
 
             if (clusterAssociation.GetParent() == ClusterAssociation::INNER)
             {
                 if (clusterAssociation.GetFigureOfMerit() < bestFomInner)
                 {
                     bestFomInner = clusterAssociation.GetFigureOfMerit();
 
                     if (clusterAssociation.GetAssociation() == ClusterAssociation::STRONG)
                     {
                         pBestInner = pDaughterCluster;
                     }
                     else
                     {
                         pBestInner = NULL;
                     }
                 }
             }
 
             if (clusterAssociation.GetParent() == ClusterAssociation::OUTER)
             {
                 if (clusterAssociation.GetFigureOfMerit() < bestFomOuter)
                 {
                     bestFomOuter = clusterAssociation.GetFigureOfMerit();
 
                     if (clusterAssociation.GetAssociation() == ClusterAssociation::STRONG)
                     {
                         pBestOuter = pDaughterCluster;
                     }
                     else
                     {
                         pBestOuter = NULL;
                     }
                 }
             }
         }
 
         if (pBestInner)
         {
             ClusterList &parentList(clusterMergeMap[pParentCluster]);
 
             if (parentList.end() == std::find(parentList.begin(), parentList.end(), pBestInner))
                 parentList.push_back(pBestInner);
 
             ClusterList &bestInnerList(clusterMergeMap[pBestInner]);
 
             if (bestInnerList.end() == std::find(bestInnerList.begin(), bestInnerList.end(), pParentCluster))
                 bestInnerList.push_back(pParentCluster);
         }
 
         if (pBestOuter)
         {
             ClusterList &parentList(clusterMergeMap[pParentCluster]);
 
             if (parentList.end() == std::find(parentList.begin(), parentList.end(), pBestOuter))
                 parentList.push_back(pBestOuter);
 
             ClusterList &bestOuterList(clusterMergeMap[pBestOuter]);
 
             if (bestOuterList.end() == std::find(bestOuterList.begin(), bestOuterList.end(), pParentCluster))
                 bestOuterList.push_back(pParentCluster);
         }
     }
 }

void lar_content::DeltaRayExtensionAlgorithm::GetExtremalCoordinatesFromCache	(	const pandora::Cluster *const	pCluster,
		ClusterToCoordinateMap &	innerCoordinateMap,
		ClusterToCoordinateMap &	outerCoordinateMap,
		pandora::CartesianVector &	innerCoordinate,
		pandora::CartesianVector &	outerCoordinate
	)		const

private

Reduce number of extremal coordinates calculations by caching results when they are first obtained.

Parameters

pParentCluster	the cluster
innerCoordinateMap	the map from cluster to inner extremal coordinate
outerCoordinateMap	the map from cluster to outer extremal coordinate
innerCoordinate	to receive the inner coordinate
outerCoordinate	to receive the outer coordinate

Definition at line 65 of file DeltaRayExtensionAlgorithm.cc.

 {
     ClusterToCoordinateMap::const_iterator innerIter = innerCoordinateMap.find(pCluster);
     ClusterToCoordinateMap::const_iterator outerIter = outerCoordinateMap.find(pCluster);
 
     if ((innerCoordinateMap.end() == innerIter) || (outerCoordinateMap.end() == outerIter))
     {
         LArClusterHelper::GetExtremalCoordinates(pCluster, innerCoordinate, outerCoordinate);
         (void)innerCoordinateMap.insert(ClusterToCoordinateMap::value_type(pCluster, innerCoordinate));
         (void)outerCoordinateMap.insert(ClusterToCoordinateMap::value_type(pCluster, outerCoordinate));
     }
     else
     {
         innerCoordinate = innerIter->second;
         outerCoordinate = outerIter->second;
     }
 }

void lar_content::DeltaRayExtensionAlgorithm::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 30 of file DeltaRayExtensionAlgorithm.cc.

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

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

privatevirtual

Reimplemented from lar_content::ClusterMergingAlgorithm.

Definition at line 392 of file DeltaRayExtensionAlgorithm.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, "MaxClusterLength", m_maxClusterLength));
 
     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, "MaxTransverseDisplacement", m_maxTransverseDisplacement));
 
     return ClusterExtensionAlgorithm::ReadSettings(xmlHandle);
 }