BoundedRegionClusterMergingAlgorithm class. More...

#include "BoundedRegionClusterMergingAlgorithm.h"

Inheritance diagram for lar_content::BoundedRegionClusterMergingAlgorithm:

Public Member Functions
	BoundedRegionClusterMergingAlgorithm ()

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)

void	GetListOfBoundedRegionClusters (const pandora::ClusterList *const pClusterList, pandora::ClusterVector &clusterVector) const
	Populate cluster vector with all clusters starting in the defined region. More...

bool	AreClustersAssociated (const pandora::Cluster const pCluster1, const pandora::Cluster const pCluster2) const
	Compare two clusters and decide if they should be associated with each other. More...

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

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 Attributes
float	m_xRegionMin
	Minimum x value of the bounded region box. More...

float	m_xRegionMax
	Maximum x value of the bounded region box. More...

float	m_zRegionMin
	Minimum z value (wire dimension) of the bounded region box. More...

float	m_zRegionMax
	Maximum z value (wire dimension) of the bounded region box. More...

float	m_maxDistance
	Maximum distance below which clusters can be associated. More...

unsigned int	m_minClusterHits
	Threshold on the size of clusters to be considered for merging. More...

Detailed Description

BoundedRegionClusterMergingAlgorithm class.

Definition at line 22 of file BoundedRegionClusterMergingAlgorithm.h.

Member Typedef Documentation

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

protected

Definition at line 31 of file BoundedRegionClusterMergingAlgorithm.h.

Constructor & Destructor Documentation

lar_content::BoundedRegionClusterMergingAlgorithm::BoundedRegionClusterMergingAlgorithm ( )

Definition at line 20 of file BoundedRegionClusterMergingAlgorithm.cc.

                                                                            :
     m_xRegionMin(-100.f),
     m_xRegionMax(0.f),
     m_zRegionMin(235.f),
     m_zRegionMax(400.f),
     m_maxDistance(10.f),
     m_minClusterHits(2)
 {
 }

Member Function Documentation

bool lar_content::BoundedRegionClusterMergingAlgorithm::AreClustersAssociated	(	const pandora::Cluster *const	pCluster1,
		const pandora::Cluster *const	pCluster2
	)		const

protected

Compare two clusters and decide if they should be associated with each other.

Parameters

pCluster1	pointer to the first cluster
pCluster2	pointer to the second cluster

Returns: whether the clusters should be associated or not

Definition at line 125 of file BoundedRegionClusterMergingAlgorithm.cc.

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

Referenced by PopulateClusterMergeMap().

 {
     const float distance{LArClusterHelper::GetClosestDistance(pCluster1, pCluster2)};
     return distance < m_maxDistance;
 }

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::BoundedRegionClusterMergingAlgorithm::GetListOfBoundedRegionClusters	(	const pandora::ClusterList *const	pClusterList,
		pandora::ClusterVector &	clusterVector
	)		const

protected

Populate cluster vector with all clusters starting in the defined region.

Parameters

pClusterList	pointer to the list of all 2D clusters
clusterVector	to receive the clusters within the bounded region

Definition at line 72 of file BoundedRegionClusterMergingAlgorithm.cc.

References f, lar_content::LArClusterHelper::GetClusterBoundingBox(), m_minClusterHits, m_xRegionMax, m_xRegionMin, m_zRegionMax, m_zRegionMin, and lar_content::LArClusterHelper::SortByNHits().

Referenced by Run().

 {
     for (const Cluster *const pCluster : *pClusterList)
     {
         if (!pCluster->IsAvailable())
             continue;
 
         if (pCluster->GetNCaloHits() < m_minClusterHits)
             continue;
 
         CartesianVector minimumPos(0.f, 0.f, 0.f), maximumPos(0.f, 0.f, 0.f);
         LArClusterHelper::GetClusterBoundingBox(pCluster, minimumPos, maximumPos);
         (void)maximumPos; // To get rid of an unused variable warning
 
         if (minimumPos.GetX() > m_xRegionMin && minimumPos.GetX() < m_xRegionMax && minimumPos.GetZ() > m_zRegionMin && minimumPos.GetZ() < m_zRegionMax)
             clusterVector.emplace_back(pCluster);
     }
 
     if (!clusterVector.empty())
         std::sort(clusterVector.begin(), clusterVector.end(), LArClusterHelper::SortByNHits);
 }

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

protectedvirtual

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 133 of file BoundedRegionClusterMergingAlgorithm.cc.

134 {

135 }

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 135 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 62 of file ClusterMergingAlgorithm.cc.

Referenced by Run().

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

protectedvirtual

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 97 of file BoundedRegionClusterMergingAlgorithm.cc.

References AreClustersAssociated().

Referenced by Run().

 {
     ClusterVector usedClusters;
 
     for (unsigned int i = 0; i < clusterVector.size() - 1; ++i)
     {
         const Cluster *const pCluster1{clusterVector.at(i)};
 
         for (unsigned int j = i + 1; j < clusterVector.size(); ++j)
         {
             const Cluster *const pCluster2{clusterVector.at(j)};
             if (!pCluster2->IsAvailable())
                 continue;
 
             if (std::find(usedClusters.begin(), usedClusters.end(), pCluster2) != usedClusters.end())
                 continue;
 
             if (this->AreClustersAssociated(pCluster1, pCluster2))
             {
                 clusterMergeMap[pCluster1].emplace_back(pCluster2);
                 usedClusters.emplace_back(pCluster2);
             }
         }
     }
 }

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

protectedvirtual

Reimplemented from lar_content::ClusterMergingAlgorithm.

Definition at line 139 of file BoundedRegionClusterMergingAlgorithm.cc.

References m_maxDistance, m_minClusterHits, m_xRegionMax, m_xRegionMin, m_zRegionMax, m_zRegionMin, and lar_content::ClusterMergingAlgorithm::ReadSettings().

 {
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "MinimumX", m_xRegionMin));
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "MaximumX", m_xRegionMax));
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "MinimumZ", m_zRegionMin));
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "MaximumZ", m_zRegionMax));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "MaxDistance", m_maxDistance));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "MinClusterHits", m_minClusterHits));
     return ClusterMergingAlgorithm::ReadSettings(xmlHandle);
 }

StatusCode lar_content::BoundedRegionClusterMergingAlgorithm::Run ( )

protectedvirtual

Reimplemented from lar_content::ClusterMergingAlgorithm.

Definition at line 30 of file BoundedRegionClusterMergingAlgorithm.cc.

References GetListOfBoundedRegionClusters(), lar_content::ClusterMergingAlgorithm::m_inputClusterListName, lar_content::ClusterMergingAlgorithm::MergeClusters(), and PopulateClusterMergeMap().

 {
     const ClusterList *pClusterList{nullptr};
 
     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 << "BoundedRegionClusterMergingAlgorithm: unable to find cluster list " << m_inputClusterListName << std::endl;
 
         return STATUS_CODE_SUCCESS;
     }
 
     while (true)
     {
         ClusterVector clusterVector;
         ClusterMergeMap clusterMergeMap;
         this->GetListOfBoundedRegionClusters(pClusterList, clusterVector);
         if (clusterVector.size() < 2)
             break;
 
         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 83 of file ClusterMergingAlgorithm.h.

Referenced by Run().

float lar_content::BoundedRegionClusterMergingAlgorithm::m_maxDistance

private

Maximum distance below which clusters can be associated.

Definition at line 72 of file BoundedRegionClusterMergingAlgorithm.h.

Referenced by AreClustersAssociated(), and ReadSettings().

unsigned int lar_content::BoundedRegionClusterMergingAlgorithm::m_minClusterHits

private

Threshold on the size of clusters to be considered for merging.

Definition at line 73 of file BoundedRegionClusterMergingAlgorithm.h.

Referenced by GetListOfBoundedRegionClusters(), and ReadSettings().

float lar_content::BoundedRegionClusterMergingAlgorithm::m_xRegionMax

private

Maximum x value of the bounded region box.

Definition at line 69 of file BoundedRegionClusterMergingAlgorithm.h.

Referenced by GetListOfBoundedRegionClusters(), and ReadSettings().

float lar_content::BoundedRegionClusterMergingAlgorithm::m_xRegionMin

private

Minimum x value of the bounded region box.

Definition at line 68 of file BoundedRegionClusterMergingAlgorithm.h.

Referenced by GetListOfBoundedRegionClusters(), and ReadSettings().

float lar_content::BoundedRegionClusterMergingAlgorithm::m_zRegionMax

private

Maximum z value (wire dimension) of the bounded region box.

Definition at line 71 of file BoundedRegionClusterMergingAlgorithm.h.

Referenced by GetListOfBoundedRegionClusters(), and ReadSettings().

float lar_content::BoundedRegionClusterMergingAlgorithm::m_zRegionMin

private

Minimum z value (wire dimension) of the bounded region box.

Definition at line 70 of file BoundedRegionClusterMergingAlgorithm.h.

Referenced by GetListOfBoundedRegionClusters(), and ReadSettings().

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

larpandoracontent/v04_14_00/source/larpandoracontent/LArTwoDReco/LArClusterAssociation/BoundedRegionClusterMergingAlgorithm.h
larpandoracontent/v04_14_00/source/larpandoracontent/LArTwoDReco/LArClusterAssociation/BoundedRegionClusterMergingAlgorithm.cc

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation