NearbyClusterMopUpAlgorithm class. More...

#include <NearbyClusterMopUpAlgorithm.h>

Inheritance diagram for lar_content::NearbyClusterMopUpAlgorithm:

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

Public Member Functions inherited from lar_content::ClusterMopUpBaseAlgorithm
	ClusterMopUpBaseAlgorithm ()
	Default constructor. More...

Public Member Functions inherited from lar_content::MopUpBaseAlgorithm
template<typename T >
const std::string	GetListName (const T *const pT) const
	Find the name of the list hosting a specific object. More...

Private Member Functions
void	ClusterMopUp (const pandora::ClusterList &pfoClusters, const pandora::ClusterList &remnantClusters) const
	Cluster mop up for a single view. This function is responsible for instructing pandora to make cluster alterations. More...

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

Private Attributes
unsigned int	m_minHitsInCluster
	Minimum number of hits in order to consider a cluster. More...

float	m_vertexProximity
	Distance between cluster inner/outer centroid and vtx to declare cluster vtx associated. More...

float	m_minClusterSeparation
	Minimum distance between parent and daughter clusters to declare clusters associated. More...

float	m_touchingDistance
	Threshold (small) distance below which parent and daughter clusters are declated touching. More...

Additional Inherited Members
Protected Types inherited from lar_content::ClusterMopUpBaseAlgorithm
typedef std::unordered_map < const pandora::Cluster *, float >	AssociationDetails

typedef std::unordered_map < const pandora::Cluster *, AssociationDetails >	ClusterAssociationMap

Protected Member Functions inherited from lar_content::ClusterMopUpBaseAlgorithm
virtual pandora::StatusCode	Run ()

virtual void	GetPfoClusterLists (pandora::ClusterList &clusterListU, pandora::ClusterList &clusterListV, pandora::ClusterList &clusterListW) const
	Get the two dimensional clusters contained in the input pfo list, divided into three different views. More...

virtual void	GetDaughterClusterLists (pandora::ClusterList &clusterListU, pandora::ClusterList &clusterListV, pandora::ClusterList &clusterListW) const
	Get the two dimensional clusters contained in the input remant/daughter cluster lists, divided into three different views. More...

virtual void	GetClusterLists (const pandora::ClusterList &inputClusterList, const bool availabilityFlag, pandora::ClusterList &clusterListU, pandora::ClusterList &clusterListV, pandora::ClusterList &clusterListW) const
	Get the two dimensional clusters contained in an input cluster list, divided into three different views. More...

virtual void	MakeClusterMerges (const ClusterAssociationMap &clusterAssociationMap) const
	Make the cluster merges specified in the cluster association map, using list name information in the cluster list name map. More...

Protected Attributes inherited from lar_content::ClusterMopUpBaseAlgorithm
pandora::StringVector	m_pfoListNames
	The list of pfo list names. More...

bool	m_excludePfosContainingTracks
	Whether to exclude any pfos containing clusters flagged as fixed tracks. More...

Protected Attributes inherited from lar_content::MopUpBaseAlgorithm
pandora::StringVector	m_daughterListNames
	The list of potential daughter object list names. More...

Detailed Description

NearbyClusterMopUpAlgorithm class.

Definition at line 22 of file NearbyClusterMopUpAlgorithm.h.

Constructor & Destructor Documentation

lar_content::NearbyClusterMopUpAlgorithm::NearbyClusterMopUpAlgorithm ( )

Default constructor.

Definition at line 21 of file NearbyClusterMopUpAlgorithm.cc.

                                                          :
     m_minHitsInCluster(5),
     m_vertexProximity(5.f),
     m_minClusterSeparation(2.5f),
     m_touchingDistance(0.001f)
 {
 }

Member Function Documentation

void lar_content::NearbyClusterMopUpAlgorithm::ClusterMopUp	(	const pandora::ClusterList &	pfoClusters,
		const pandora::ClusterList &	remnantClusters
	)		const

privatevirtual

Cluster mop up for a single view. This function is responsible for instructing pandora to make cluster alterations.

Parameters

pfoClusters	the list of pfo clusters
remnantClusters	the list of remnant clusters

Implements lar_content::ClusterMopUpBaseAlgorithm.

Definition at line 31 of file NearbyClusterMopUpAlgorithm.cc.

 {
     ClusterAssociationMap clusterAssociationMap;
 
     const VertexList *pVertexList(NULL);
     PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::GetCurrentList(*this, pVertexList));
     const Vertex *const pVertex(
         ((pVertexList->size() == 1) && (VERTEX_3D == (*(pVertexList->begin()))->GetVertexType())) ? *(pVertexList->begin()) : NULL);
 
     ClusterVector sortedPfoClusters(pfoClusters.begin(), pfoClusters.end());
     std::sort(sortedPfoClusters.begin(), sortedPfoClusters.end(), LArClusterHelper::SortByNHits);
 
     ClusterVector sortedRemnantClusters(remnantClusters.begin(), remnantClusters.end());
     std::sort(sortedRemnantClusters.begin(), sortedRemnantClusters.end(), LArClusterHelper::SortByNHits);
 
     for (const Cluster *const pClusterP : sortedPfoClusters)
     {
         const HitType hitType(LArClusterHelper::GetClusterHitType(pClusterP));
         const CartesianVector vertexPosition2D(
             !pVertex ? CartesianVector(0.f, 0.f, 0.f) : LArGeometryHelper::ProjectPosition(this->GetPandora(), pVertex->GetPosition(), hitType));
 
         const float innerPV((vertexPosition2D - pClusterP->GetCentroid(pClusterP->GetInnerPseudoLayer())).GetMagnitude());
         const float outerPV((vertexPosition2D - pClusterP->GetCentroid(pClusterP->GetOuterPseudoLayer())).GetMagnitude());
 
         for (const Cluster *const pClusterR : sortedRemnantClusters)
         {
             if (pClusterR->GetNCaloHits() < m_minHitsInCluster)
                 continue;
 
             const float innerRV((vertexPosition2D - pClusterR->GetCentroid(pClusterR->GetInnerPseudoLayer())).GetMagnitude());
             const float outerRV((vertexPosition2D - pClusterR->GetCentroid(pClusterR->GetOuterPseudoLayer())).GetMagnitude());
 
             // ATTN Could use pointing clusters here, for consistency with other vertex association mechanics
             if (pVertex && (((innerPV < m_vertexProximity) || (outerPV < m_vertexProximity)) &&
                                ((innerRV < m_vertexProximity) || (outerRV < m_vertexProximity))))
                 continue;
 
             const float innerRP(LArClusterHelper::GetClosestDistance(pClusterR->GetCentroid(pClusterR->GetInnerPseudoLayer()), pClusterP));
             const float outerRP(LArClusterHelper::GetClosestDistance(pClusterR->GetCentroid(pClusterR->GetOuterPseudoLayer()), pClusterP));
 
             const float minSeparation(std::min(innerRP, outerRP));
 
             if (minSeparation > m_minClusterSeparation)
                 continue;
 
             // ATTN Use of ClusterMopUp base algorithm assumes bigger figure of merit means better association
             if (m_touchingDistance < std::numeric_limits<float>::epsilon())
                 throw StatusCodeException(STATUS_CODE_INVALID_PARAMETER);
 
             AssociationDetails &associationDetails(clusterAssociationMap[pClusterR]);
             const float figureOfMerit((minSeparation < m_touchingDistance) ? 1.f / m_touchingDistance : 1.f / minSeparation);
 
             if (!associationDetails.insert(AssociationDetails::value_type(pClusterP, figureOfMerit)).second)
                 throw StatusCodeException(STATUS_CODE_ALREADY_PRESENT);
         }
     }
 
     this->MakeClusterMerges(clusterAssociationMap);
 }

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

privatevirtual

Reimplemented from lar_content::ClusterMopUpBaseAlgorithm.

Definition at line 93 of file NearbyClusterMopUpAlgorithm.cc.

 {
     PANDORA_RETURN_RESULT_IF_AND_IF(
         STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "MinHitsInCluster", m_minHitsInCluster));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "VertexProximity", m_vertexProximity));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(
         STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "MinClusterSeparation", m_minClusterSeparation));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(
         STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "TouchingDistance", m_touchingDistance));
 
     return ClusterMopUpBaseAlgorithm::ReadSettings(xmlHandle);
 }