#include "ClusterMergingAlgorithm.h"

Inheritance diagram for lar_content::ClusterMergingAlgorithm:

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 &clusterVector) const =0
	Populate cluster vector with subset of cluster list, containing clusters judged to be clean. More...

virtual void	PopulateClusterMergeMap (const pandora::ClusterVector &clusterVector, ClusterMergeMap &clusterMergeMap) const =0
	Form associations between pointing clusters. More...

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...

Detailed Description

ClusterMergingAlgorithm class.

Definition at line 21 of file ClusterMergingAlgorithm.h.

Member Typedef Documentation

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

protected

Definition at line 27 of file ClusterMergingAlgorithm.h.

Member Function Documentation

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

protected

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

protected

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

virtual void lar_content::ClusterMergingAlgorithm::GetListOfCleanClusters	(	const pandora::ClusterList *const	pClusterList,
		pandora::ClusterVector &	clusterVector
	)		const

protectedpure virtual

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

Implemented in lar_content::TransverseExtensionAlgorithm, lar_content::CosmicRayExtensionAlgorithm, lar_content::CrossGapsExtensionAlgorithm, lar_content::LongitudinalExtensionAlgorithm, lar_content::SimpleClusterMergingAlgorithm, and lar_content::DeltaRayExtensionAlgorithm.

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

protected

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

protected

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));
             }
         }
     }
 }

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

protectedpure virtual

Form associations between pointing clusters.

Parameters

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

Implemented in lar_content::SimpleClusterMergingAlgorithm, and lar_content::ClusterExtensionAlgorithm.

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

protectedvirtual

Reimplemented in lar_content::CrossGapsExtensionAlgorithm, lar_content::DeltaRayExtensionAlgorithm, lar_content::CosmicRayExtensionAlgorithm, lar_content::TransverseExtensionAlgorithm, lar_content::LongitudinalExtensionAlgorithm, and lar_content::SimpleClusterMergingAlgorithm.

Definition at line 160 of file ClusterMergingAlgorithm.cc.

Referenced by lar_content::LongitudinalExtensionAlgorithm::ReadSettings(), lar_content::SimpleClusterMergingAlgorithm::ReadSettings(), lar_content::TransverseExtensionAlgorithm::ReadSettings(), lar_content::CosmicRayExtensionAlgorithm::ReadSettings(), lar_content::DeltaRayExtensionAlgorithm::ReadSettings(), and lar_content::CrossGapsExtensionAlgorithm::ReadSettings().

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

StatusCode lar_content::ClusterMergingAlgorithm::Run ( )

protectedvirtual

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

protected

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

Definition at line 82 of file ClusterMergingAlgorithm.h.

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

/cvmfs/larsoft.opensciencegrid.org/products/larpandoracontent/v03_14_03/source/larpandoracontent/LArTwoDReco/LArClusterAssociation/ClusterMergingAlgorithm.h
/cvmfs/larsoft.opensciencegrid.org/products/larpandoracontent/v03_14_03/source/larpandoracontent/LArTwoDReco/LArClusterAssociation/ClusterMergingAlgorithm.cc

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Member Function Documentation

Member Data Documentation