lar_content::SimpleClusterMergingAlgorithm Class Reference

SimpleClusterMergingAlgorithm class. More...

#include <SimpleClusterMergingAlgorithm.h>

Inheritance diagram for lar_content::SimpleClusterMergingAlgorithm:

Public Member Functions
	SimpleClusterMergingAlgorithm ()
	Default constructor. 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...

Additional Inherited Members
Protected Types inherited from lar_content::ClusterMergingAlgorithm
typedef std::unordered_map < const pandora::Cluster *, pandora::ClusterList >	ClusterMergeMap
Protected Member Functions inherited from lar_content::ClusterMergingAlgorithm
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 inherited from lar_content::ClusterMergingAlgorithm
std::string	m_inputClusterListName
	The name of the input cluster list. If not specified, will access current list. More...

Detailed Description

SimpleClusterMergingAlgorithm class.

Definition at line 21 of file SimpleClusterMergingAlgorithm.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::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 26 of file SimpleClusterMergingAlgorithm.cc.

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

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

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

    return true;
}

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

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

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

Member Data Documentation

float lar_content::SimpleClusterMergingAlgorithm::m_maxClusterSeparation

private

Maximum distance at which clusters can be joined.

Definition at line 46 of file SimpleClusterMergingAlgorithm.h.

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.

---

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

• SimpleClusterMergingAlgorithm.h
• SimpleClusterMergingAlgorithm.cc