#include "ClusterGrowingAlgorithm.h"

Inheritance diagram for lar_content::ClusterGrowingAlgorithm:

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

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

Protected Member Functions
virtual pandora::StatusCode	Run ()

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

virtual void	GetListOfCleanClusters (const pandora::ClusterList *const pClusterList, pandora::ClusterVector &cleanClusters) const =0
	Populate cluster vector with the subset of clusters judged to be clean. More...

virtual void	GetListOfSeedClusters (const pandora::ClusterVector &cleanClusters, pandora::ClusterVector &seedClusters) const =0
	Select seed clusters for growing. More...

Private Member Functions
void	GetListOfNonSeedClusters (const pandora::ClusterVector &inputClusters, const pandora::ClusterVector &seedClusters, pandora::ClusterVector &nonSeedClusters) const
	Get List of non-seed clusters. More...

void	PopulateClusterMergeMap (const pandora::ClusterVector &seedClusters, const pandora::ClusterVector &nonSeedClusters, ClusterMergeMap &clusterMergeMap) const
	Identify a set of cluster merges. More...

void	MergeClusters (const ClusterMergeMap &clusterMergeMap) const
	Merge clusters. More...

Private Attributes
std::string	m_inputClusterListName
	The name of the input cluster list. If not specified, will access current list. More...

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

Detailed Description

ClusterGrowingAlgorithm class.

Definition at line 21 of file ClusterGrowingAlgorithm.h.

Member Typedef Documentation

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

protected

Definition at line 33 of file ClusterGrowingAlgorithm.h.

Constructor & Destructor Documentation

lar_content::ClusterGrowingAlgorithm::ClusterGrowingAlgorithm ( )

Default constructor.

Definition at line 20 of file ClusterGrowingAlgorithm.cc.

                                                  :
     m_maxClusterSeparation(2.5f)
 {
 }

Member Function Documentation

virtual void lar_content::ClusterGrowingAlgorithm::GetListOfCleanClusters	(	const pandora::ClusterList *const	pClusterList,
		pandora::ClusterVector &	cleanClusters
	)		const

protectedpure virtual

Populate cluster vector with the subset of clusters judged to be clean.

Parameters

pClusterList	address of the cluster list
cleanClusters	the output vector of clean clusters

Implemented in lar_content::SimpleClusterGrowingAlgorithm, and lar_content::DeltaRayGrowingAlgorithm.

Referenced by Run().

void lar_content::ClusterGrowingAlgorithm::GetListOfNonSeedClusters	(	const pandora::ClusterVector &	inputClusters,
		const pandora::ClusterVector &	seedClusters,
		pandora::ClusterVector &	nonSeedClusters
	)		const

private

Get List of non-seed clusters.

Parameters

inputClusters	the input vector of clean clusters
seedClusters	the input vector of seed clusters
nonSeedClusters	the output vector of non-seed clusters

Definition at line 73 of file ClusterGrowingAlgorithm.cc.

References lar_content::LArClusterHelper::SortByNHits().

Referenced by Run().

 {
     for (ClusterVector::const_iterator iter = inputClusters.begin(), iterEnd = inputClusters.end(); iter != iterEnd; ++iter)
     {
         const Cluster *const pCluster = *iter;
 
         if (seedClusters.end() != std::find(seedClusters.begin(), seedClusters.end(), pCluster))
             continue;
 
         nonSeedClusters.push_back(pCluster);
     }
 
     std::sort(nonSeedClusters.begin(), nonSeedClusters.end(), LArClusterHelper::SortByNHits);
 }

virtual void lar_content::ClusterGrowingAlgorithm::GetListOfSeedClusters	(	const pandora::ClusterVector &	cleanClusters,
		pandora::ClusterVector &	seedClusters
	)		const

protectedpure virtual

Select seed clusters for growing.

Parameters

cleanClusters	the input vector of clean clusters
seedClusters	the output vector of seed clusters

Implemented in lar_content::SimpleClusterGrowingAlgorithm, and lar_content::DeltaRayGrowingAlgorithm.

Referenced by Run().

void lar_content::ClusterGrowingAlgorithm::MergeClusters ( const ClusterMergeMap & clusterMergeMap ) const

private

Merge clusters.

Parameters

clusterMergeMap the map of clusters to be merged

Definition at line 120 of file ClusterGrowingAlgorithm.cc.

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

Referenced by Run().

 {
     ClusterList parentClusterList;
     for (const auto &mapEntry : clusterMergeMap)
         parentClusterList.push_back(mapEntry.first);
     parentClusterList.sort(LArClusterHelper::SortByNHits);
 
     for (const Cluster *const pParentCluster : parentClusterList)
     {
         const ClusterList &clusterList(clusterMergeMap.at(pParentCluster));
 
         if (clusterList.empty())
             throw StatusCodeException(STATUS_CODE_FAILURE);
 
         for (const Cluster *const pAssociatedCluster : clusterList)
         {
             if (m_inputClusterListName.empty())
             {
                 PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::MergeAndDeleteClusters(*this, pParentCluster, pAssociatedCluster));
             }
             else
             {
                 PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=,
                     PandoraContentApi::MergeAndDeleteClusters(*this, pParentCluster, pAssociatedCluster, m_inputClusterListName, m_inputClusterListName));
             }
         }
     }
 }

void lar_content::ClusterGrowingAlgorithm::PopulateClusterMergeMap	(	const pandora::ClusterVector &	seedClusters,
		const pandora::ClusterVector &	nonSeedClusters,
		ClusterMergeMap &	clusterMergeMap
	)		const

private

Identify a set of cluster merges.

Parameters

seedClusters	the input vector of seed clusters
nonSeedClusters	the input vector of non-seed clusters
clusterMergeMap	the output map of cluster merges

Definition at line 91 of file ClusterGrowingAlgorithm.cc.

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

Referenced by Run().

 {
     for (ClusterVector::const_iterator nIter = nonSeedClusters.begin(), nIterEnd = nonSeedClusters.end(); nIter != nIterEnd; ++nIter)
     {
         const Cluster *const pNonSeedCluster = *nIter;
 
         const Cluster *pBestSeedCluster(NULL);
         float bestDistance(m_maxClusterSeparation);
 
         for (ClusterVector::const_iterator sIter = seedClusters.begin(), sIterEnd = seedClusters.end(); sIter != sIterEnd; ++sIter)
         {
             const Cluster *const pThisSeedCluster = *sIter;
             const float thisDistance(LArClusterHelper::GetClosestDistance(pNonSeedCluster, pThisSeedCluster));
 
             if (thisDistance < bestDistance)
             {
                 pBestSeedCluster = pThisSeedCluster;
                 bestDistance = thisDistance;
             }
         }
 
         if (pBestSeedCluster)
             clusterMergeMap[pBestSeedCluster].push_back(pNonSeedCluster);
     }
 }

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

protectedvirtual

Reimplemented in lar_content::DeltaRayGrowingAlgorithm, and lar_content::SimpleClusterGrowingAlgorithm.

Definition at line 151 of file ClusterGrowingAlgorithm.cc.

References m_inputClusterListName, and m_maxClusterSeparation.

Referenced by lar_content::SimpleClusterGrowingAlgorithm::ReadSettings(), and lar_content::DeltaRayGrowingAlgorithm::ReadSettings().

 {
     PANDORA_RETURN_RESULT_IF_AND_IF(
         STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "InputClusterListName", m_inputClusterListName));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(
         STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "MaxClusterSeparation", m_maxClusterSeparation));
 
     return STATUS_CODE_SUCCESS;
 }

StatusCode lar_content::ClusterGrowingAlgorithm::Run ( )

protectedvirtual

Definition at line 27 of file ClusterGrowingAlgorithm.cc.

References GetListOfCleanClusters(), GetListOfNonSeedClusters(), GetListOfSeedClusters(), m_inputClusterListName, MergeClusters(), and PopulateClusterMergeMap().

 {
     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 << "ClusterGrowingAlgorithm: unable to find cluster list " << m_inputClusterListName << std::endl;
 
         return STATUS_CODE_SUCCESS;
     }
 
     ClusterVector inputClusters, seedClusters;
     this->GetListOfCleanClusters(pClusterList, inputClusters);
     this->GetListOfSeedClusters(inputClusters, seedClusters);
 
     while (true)
     {
         ClusterVector currentClusters, nonSeedClusters;
         this->GetListOfCleanClusters(pClusterList, currentClusters);
         this->GetListOfNonSeedClusters(currentClusters, seedClusters, nonSeedClusters);
 
         ClusterMergeMap clusterMergeMap;
         this->PopulateClusterMergeMap(seedClusters, nonSeedClusters, clusterMergeMap);
 
         if (clusterMergeMap.empty())
             break;
 
         this->MergeClusters(clusterMergeMap);
     }
 
     return STATUS_CODE_SUCCESS;
 }

Member Data Documentation

std::string lar_content::ClusterGrowingAlgorithm::m_inputClusterListName

private

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

Definition at line 79 of file ClusterGrowingAlgorithm.h.

Referenced by MergeClusters(), ReadSettings(), and Run().

float lar_content::ClusterGrowingAlgorithm::m_maxClusterSeparation

private

Maximum distance at which clusters can be joined.

Definition at line 81 of file ClusterGrowingAlgorithm.h.

Referenced by PopulateClusterMergeMap(), and ReadSettings().

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

larpandoracontent/v04_08_01/source/larpandoracontent/LArTwoDReco/LArClusterAssociation/ClusterGrowingAlgorithm.h
larpandoracontent/v04_08_01/source/larpandoracontent/LArTwoDReco/LArClusterAssociation/ClusterGrowingAlgorithm.cc

Public Member Functions

Protected Types

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation