SimpleClusterMergingAlgorithm class. More...

#include "SimpleClusterMergingAlgorithm.h"

Inheritance diagram for lar_content::SimpleClusterMergingAlgorithm:

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

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

Protected Member Functions
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	PopulateClusterMergeMap (const pandora::ClusterVector &clusterVector, ClusterMergeMap &clusterMergeMap) const
	Form associations between pointing clusters. More...

bool	IsAssociated (const pandora::Cluster const pClusterI, const pandora::Cluster const pClusterJ) const
	Decide whether two clusters are associated. More...

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

Private Attributes
unsigned int	m_minCaloHitsPerCluster
	The min number of calo hits per candidate cluster. More...

float	m_maxClusterSeparation
	Maximum distance at which clusters can be joined. More...

Detailed Description

SimpleClusterMergingAlgorithm class.

Definition at line 21 of file SimpleClusterMergingAlgorithm.h.

Member Typedef Documentation

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::SimpleClusterMergingAlgorithm::SimpleClusterMergingAlgorithm ( )

Default constructor.

Definition at line 20 of file SimpleClusterMergingAlgorithm.cc.

                                                              :
     m_minCaloHitsPerCluster(5),
     m_maxClusterSeparation(2.5f)
 {
 }

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::SimpleClusterMergingAlgorithm::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 28 of file SimpleClusterMergingAlgorithm.cc.

References m_minCaloHitsPerCluster, and lar_content::LArClusterHelper::SortByNHits().

 {
     for (ClusterList::const_iterator iter = pClusterList->begin(), iterEnd = pClusterList->end(); iter != iterEnd; ++iter)
     {
         const Cluster *const pCluster = *iter;
 
         if (!pCluster->IsAvailable())
             continue;
 
         if (pCluster->GetNCaloHits() < m_minCaloHitsPerCluster)
             continue;
 
         clusterVector.push_back(pCluster);
     }
 
     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());
 }

bool lar_content::SimpleClusterMergingAlgorithm::IsAssociated	(	const pandora::Cluster *const	pClusterI,
		const pandora::Cluster *const	pClusterJ
	)		const

private

Decide whether two clusters are associated.

Parameters

pClusterI	the address of the first cluster
pClusterJ	the address of the second cluster

Returns: boolean

Definition at line 72 of file SimpleClusterMergingAlgorithm.cc.

References lar_content::LArClusterHelper::GetClosestDistance(), and m_maxClusterSeparation.

Referenced by PopulateClusterMergeMap().

 {
     if (LArClusterHelper::GetClosestDistance(pClusterI,pClusterJ) > m_maxClusterSeparation)
         return false;
 
     return true;
 }

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::SimpleClusterMergingAlgorithm::PopulateClusterMergeMap	(	const pandora::ClusterVector &	clusterVector,
		ClusterMergeMap &	clusterMergeMap
	)		const

privatevirtual

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 48 of file SimpleClusterMergingAlgorithm.cc.

References IsAssociated().

 {
     for (ClusterVector::const_iterator iterI = clusterVector.begin(), iterEndI = clusterVector.end(); iterI != iterEndI; ++iterI)
     {
         const Cluster *const pClusterI = *iterI;
 
         for (ClusterVector::const_iterator iterJ = iterI, iterEndJ = clusterVector.end(); iterJ != iterEndJ; ++iterJ)
         {
             const Cluster *const pClusterJ = *iterJ;
 
             if (pClusterI == pClusterJ)
                 continue;
 
             if (this->IsAssociated(pClusterI, pClusterJ))
             {
                 clusterMergeMap[pClusterI].push_back(pClusterJ);
                 clusterMergeMap[pClusterJ].push_back(pClusterI);
             }
         }
     }
 }

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

privatevirtual

Reimplemented from lar_content::ClusterMergingAlgorithm.

Definition at line 82 of file SimpleClusterMergingAlgorithm.cc.

References m_maxClusterSeparation, m_minCaloHitsPerCluster, and lar_content::ClusterMergingAlgorithm::ReadSettings().

 {
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle,
         "MinCaloHitsPerCluster", m_minCaloHitsPerCluster));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle,
         "MaxClusterSeparation", m_maxClusterSeparation));
 
     return ClusterMergingAlgorithm::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::SimpleClusterMergingAlgorithm::m_maxClusterSeparation

private

Maximum distance at which clusters can be joined.

Definition at line 46 of file SimpleClusterMergingAlgorithm.h.

Referenced by IsAssociated(), and ReadSettings().

unsigned int lar_content::SimpleClusterMergingAlgorithm::m_minCaloHitsPerCluster

private

The min number of calo hits per candidate cluster.

Definition at line 45 of file SimpleClusterMergingAlgorithm.h.

Referenced by GetListOfCleanClusters(), and ReadSettings().

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

larpandoracontent/v03_13_02/source/larpandoracontent/LArTwoDReco/LArClusterAssociation/SimpleClusterMergingAlgorithm.h
larpandoracontent/v03_13_02/source/larpandoracontent/LArTwoDReco/LArClusterAssociation/SimpleClusterMergingAlgorithm.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