TransverseExtensionAlgorithm class. More...

#include "TransverseExtensionAlgorithm.h"

Inheritance diagram for lar_content::TransverseExtensionAlgorithm:

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

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

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

typedef std::unordered_map< const pandora::Cluster *, pandora::ClusterList >	ClusterMergeMap

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

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
std::string	m_inputClusterListName
	The name of the input cluster list. If not specified, will access current list. 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 &parentCluster, const pandora::Cluster *const pDaughterCluster, ClusterAssociationMatrix &clusterAssociationMatrix) const
	Form associations between parent and daughter clusters. More...

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

Private Attributes
float	m_minClusterLength

float	m_maxLongitudinalDisplacement

float	m_maxTransverseDisplacement

Detailed Description

TransverseExtensionAlgorithm class.

Definition at line 23 of file TransverseExtensionAlgorithm.h.

Member Typedef Documentation

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

protectedinherited

Definition at line 97 of file ClusterExtensionAlgorithm.h.

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

protectedinherited

Definition at line 98 of file ClusterExtensionAlgorithm.h.

typedef std::unordered_map<const pandora::Cluster*, pandora::ClusterList> lar_content::ClusterMergingAlgorithm::ClusterMergeMap

protectedinherited

Definition at line 27 of file ClusterMergingAlgorithm.h.

Constructor & Destructor Documentation

lar_content::TransverseExtensionAlgorithm::TransverseExtensionAlgorithm ( )

Default constructor.

Definition at line 21 of file TransverseExtensionAlgorithm.cc.

                                                            :
     m_minClusterLength(5.f),
     m_maxLongitudinalDisplacement(10.f),
     m_maxTransverseDisplacement(1.f)
 {
 }

Member Function Documentation

void lar_content::ClusterMergingAlgorithm::CollectAssociatedClusters	(	const pandora::Cluster *const	pSeedCluster,
		const ClusterMergeMap &	clusterMergeMap,
		pandora::ClusterList &	associatedClusterList
	)		const

protectedinherited

Collect up all clusters associations related to a given seed cluster.

Parameters

pSeedCluster	pointer to the initial cluster
clusterMergeMap	the map of cluster associations
associatedClusterList	the output list of associated clusters

void lar_content::ClusterMergingAlgorithm::CollectAssociatedClusters	(	const pandora::Cluster *const	pSeedCluster,
		const pandora::Cluster *const	pCurrentCluster,
		const ClusterMergeMap &	clusterMergeMap,
		const pandora::ClusterSet &	clusterVetoList,
		pandora::ClusterList &	associatedClusterList
	)		const

protectedinherited

Collect up all clusters associations related to a given seed cluster.

Parameters

pSeedCluster	pointer to the initial cluster
pCurrentCluster	pointer to the current cluster
clusterMergeMap	the map of cluster associations
clusterVetoList	the list of clusters that have already been merged
associatedClusterList	the output list of associated clusters

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

Referenced by GetListOfCleanClusters().

void lar_content::TransverseExtensionAlgorithm::FillClusterAssociationMatrix	(	const LArPointingCluster &	parentCluster,
		const pandora::Cluster *const	pDaughterCluster,
		ClusterAssociationMatrix &	clusterAssociationMatrix
	)		const

private

Form associations between parent and daughter clusters.

Parameters

parentCluster	the parent pointing cluster
pDaughterCluster	the address of the daughter cluster
clusterAssociationMatrix	the matrix of cluster associations

void lar_content::TransverseExtensionAlgorithm::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 130 of file TransverseExtensionAlgorithm.cc.

References lar_content::ClusterExtensionAlgorithm::ClusterAssociation::GetFigureOfMerit(), lar_content::ClusterExtensionAlgorithm::ClusterAssociation::INNER, max, lar_content::ClusterExtensionAlgorithm::ClusterAssociation::OUTER, lar_content::LArClusterHelper::SortByNHits(), lar_content::ClusterExtensionAlgorithm::ClusterAssociation::STRONG, and lar_content::ClusterExtensionAlgorithm::ClusterAssociation::WEAK.

 {
     ClusterAssociationMatrix daughterToParentMatrix;
 
     // Loop over parent clusters and select nearby daughter clusters that are closer than another parent cluster
     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));
 
         float maxDisplacementInner(std::numeric_limits<float>::max());
         float maxDisplacementOuter(std::numeric_limits<float>::max());
 
         // Find the nearest parent cluster
         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.GetAssociation() == ClusterAssociation::WEAK)
             {
                 if (clusterAssociation.GetParent() == ClusterAssociation::INNER && clusterAssociation.GetFigureOfMerit() < maxDisplacementInner)
                     maxDisplacementInner = clusterAssociation.GetFigureOfMerit();
 
                 if (clusterAssociation.GetParent() == ClusterAssociation::OUTER && clusterAssociation.GetFigureOfMerit() < maxDisplacementOuter)
                     maxDisplacementOuter = clusterAssociation.GetFigureOfMerit();
             }
         }
 
         // Select daughter clusters that are closer than the nearest parent cluster
         for (const Cluster *const pDaughterCluster : sortedLocalDaughterClusters)
         {
             const ClusterAssociation &clusterAssociation(daughterToAssociationMap.at(pDaughterCluster));
 
             if (clusterAssociation.GetAssociation() == ClusterAssociation::STRONG)
             {
                 if (clusterAssociation.GetParent() == ClusterAssociation::INNER && clusterAssociation.GetFigureOfMerit() < maxDisplacementInner)
                     (void) daughterToParentMatrix[pDaughterCluster].insert(ClusterAssociationMap::value_type(pParentCluster, clusterAssociation));
 
                 if (clusterAssociation.GetParent() == ClusterAssociation::OUTER && clusterAssociation.GetFigureOfMerit() < maxDisplacementOuter)
                     (void) daughterToParentMatrix[pDaughterCluster].insert(ClusterAssociationMap::value_type(pParentCluster, clusterAssociation));
             }
         }
     }
 
     // Loop over daughter clusters and select the nearest parent clusters
     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 *pParentCluster(nullptr);
         float minDisplacement(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 pCandidateParentCluster : sortedLocalParentClusters)
         {
             const ClusterAssociation &clusterAssociation(parentToAssociationMap.at(pCandidateParentCluster));
 
             if (clusterAssociation.GetFigureOfMerit() < minDisplacement)
             {
                 minDisplacement = clusterAssociation.GetFigureOfMerit();
                 pParentCluster = pCandidateParentCluster;
             }
         }
 
         if (pParentCluster)
         {
             ClusterList &parentList(clusterMergeMap[pParentCluster]);
 
             if (parentList.end() == std::find(parentList.begin(), parentList.end(), pDaughterCluster))
                 parentList.push_back(pDaughterCluster);
 
             ClusterList &daughterList(clusterMergeMap[pDaughterCluster]);
 
             if (daughterList.end() == std::find(daughterList.begin(), daughterList.end(), pParentCluster))
                 daughterList.push_back(pParentCluster);
         }
     }
 }

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

References f, FillClusterAssociationMatrix(), lar_content::LArClusterHelper::GetClosestDistance(), lar_content::LArPointingCluster::GetCluster(), lar_content::LArClusterHelper::GetExtremalCoordinates(), lar_content::LArPointingClusterHelper::GetImpactParameters(), lar_content::LArPointingCluster::GetInnerVertex(), lar_content::LArClusterHelper::GetLengthSquared(), lar_content::LArPointingCluster::GetOuterVertex(), lar_content::ClusterExtensionAlgorithm::ClusterAssociation::INNER, m_maxLongitudinalDisplacement, m_maxTransverseDisplacement, m_minClusterLength, lar_content::ClusterExtensionAlgorithm::ClusterAssociation::OUTER, lar_content::LArClusterHelper::SortByNHits(), lar_content::ClusterExtensionAlgorithm::ClusterAssociation::STRONG, and lar_content::ClusterExtensionAlgorithm::ClusterAssociation::WEAK.

 {
     for (ClusterList::const_iterator iter = pClusterList->begin(), iterEnd = pClusterList->end(); iter != iterEnd; ++iter)
         clusterVector.push_back(*iter);
 
     std::sort(clusterVector.begin(), clusterVector.end(), LArClusterHelper::SortByNHits);
 }

void lar_content::ClusterMergingAlgorithm::GetSortedListOfCleanClusters	(	const pandora::ClusterVector &	inputClusters,
		pandora::ClusterVector &	outputClusters
	)		const

protectedinherited

Sort the selected clusters, so that they have a well-defined ordering.

Parameters

inputClusters	the input vector of clusters
outputClusters	the output vector of clusters

Definition at line 133 of file ClusterMergingAlgorithm.cc.

 {
     ClusterVector pfoClusters, availableClusters;
 
     for (ClusterVector::const_iterator iter = inputClusters.begin(), iterEnd = inputClusters.end(); iter != iterEnd; ++iter)
     {
         const Cluster *const pCluster = *iter;
 
         if (!pCluster->IsAvailable())
         {
             pfoClusters.push_back(pCluster);
         }
         else
         {
             availableClusters.push_back(pCluster);
         }
     }
 
     std::sort(pfoClusters.begin(), pfoClusters.end(), LArClusterHelper::SortByNHits);
     std::sort(availableClusters.begin(), availableClusters.end(), LArClusterHelper::SortByNHits);
 
     outputClusters.insert(outputClusters.end(), pfoClusters.begin(), pfoClusters.end());
     outputClusters.insert(outputClusters.end(), availableClusters.begin(), availableClusters.end());
 }

void lar_content::ClusterMergingAlgorithm::MergeClusters	(	pandora::ClusterVector &	clusterVector,
		ClusterMergeMap &	clusterMergeMap
	)		const

protectedinherited

Merge associated clusters.

Parameters

clusterVector	the vector of clean clusters
clusterMergeMap	the matrix of cluster associations

Definition at line 61 of file ClusterMergingAlgorithm.cc.

 {
     ClusterSet clusterVetoList;
 
     for (const Cluster *const pSeedCluster : clusterVector)
     {
         ClusterList mergeList;
         this->CollectAssociatedClusters(pSeedCluster, pSeedCluster, clusterMergeMap, clusterVetoList, mergeList);
         mergeList.sort(LArClusterHelper::SortByNHits);
 
         for (const Cluster *const pAssociatedCluster : mergeList)
         {
             if (clusterVetoList.count(pAssociatedCluster))
                 throw StatusCodeException(STATUS_CODE_FAILURE);
 
             if (!pAssociatedCluster->IsAvailable())
                 throw StatusCodeException(STATUS_CODE_FAILURE);
 
             (void) clusterVetoList.insert(pAssociatedCluster);
 
             if (m_inputClusterListName.empty())
             {
                 PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::MergeAndDeleteClusters(*this, pSeedCluster, pAssociatedCluster));
             }
             else
             {
                 PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::MergeAndDeleteClusters(*this, pSeedCluster, pAssociatedCluster,
                     m_inputClusterListName, m_inputClusterListName));
             }
         }
     }
 }

void lar_content::ClusterExtensionAlgorithm::PopulateClusterMergeMap	(	const pandora::ClusterVector &	clusterVector,
		ClusterMergeMap &	clusterMergeMap
	)		const

protectedvirtualinherited

Form associations between pointing clusters.

Parameters

clusterVector	the vector of clean clusters
clusterMergeMap	the matrix of cluster associations

Implements lar_content::ClusterMergingAlgorithm.

Definition at line 18 of file ClusterExtensionAlgorithm.cc.

 {
     ClusterAssociationMatrix clusterAssociationMatrix;
     this->FillClusterAssociationMatrix(clusterVector, clusterAssociationMatrix);
     this->FillClusterMergeMap(clusterAssociationMatrix, clusterMergeMap);
 }

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

privatevirtual

Reimplemented from lar_content::ClusterMergingAlgorithm.

Definition at line 226 of file TransverseExtensionAlgorithm.cc.

References m_maxLongitudinalDisplacement, m_maxTransverseDisplacement, m_minClusterLength, and lar_content::ClusterMergingAlgorithm::ReadSettings().

 {
     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,
     "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);
 }

StatusCode lar_content::ClusterMergingAlgorithm::Run ( )

protectedvirtualinherited

Definition at line 20 of file ClusterMergingAlgorithm.cc.

 {
     const ClusterList *pClusterList = NULL;
 
     if (m_inputClusterListName.empty())
     {
         PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::GetCurrentList(*this, pClusterList));
     }
     else
     {
         PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_INITIALIZED, !=, PandoraContentApi::GetList(*this, m_inputClusterListName, pClusterList));
     }
 
     if (!pClusterList || pClusterList->empty())
     {
         if (PandoraContentApi::GetSettings(*this)->ShouldDisplayAlgorithmInfo())
             std::cout << "ClusterMergingAlgorithm: unable to find cluster list " << m_inputClusterListName << std::endl;
 
         return STATUS_CODE_SUCCESS;
     }
 
     while (true)
     {
         ClusterVector unsortedVector, clusterVector;
         this->GetListOfCleanClusters(pClusterList, unsortedVector);
         this->GetSortedListOfCleanClusters(unsortedVector, clusterVector);
 
         ClusterMergeMap clusterMergeMap;
         this->PopulateClusterMergeMap(clusterVector, clusterMergeMap);
 
         if (clusterMergeMap.empty())
             break;
 
         this->MergeClusters(clusterVector, clusterMergeMap);
     }
 
     return STATUS_CODE_SUCCESS;
 }

Member Data Documentation

std::string lar_content::ClusterMergingAlgorithm::m_inputClusterListName

protectedinherited

The name of the input cluster list. If not specified, will access current list.

Definition at line 82 of file ClusterMergingAlgorithm.h.

float lar_content::TransverseExtensionAlgorithm::m_maxLongitudinalDisplacement

private

Definition at line 48 of file TransverseExtensionAlgorithm.h.

Referenced by GetListOfCleanClusters(), and ReadSettings().

float lar_content::TransverseExtensionAlgorithm::m_maxTransverseDisplacement

private

Definition at line 49 of file TransverseExtensionAlgorithm.h.

Referenced by GetListOfCleanClusters(), and ReadSettings().

float lar_content::TransverseExtensionAlgorithm::m_minClusterLength

private

Definition at line 47 of file TransverseExtensionAlgorithm.h.

Referenced by GetListOfCleanClusters(), 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/TransverseExtensionAlgorithm.h
/cvmfs/larsoft.opensciencegrid.org/products/larpandoracontent/v03_14_03/source/larpandoracontent/LArTwoDReco/LArClusterAssociation/TransverseExtensionAlgorithm.cc

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation