IsolatedClusterMopUpAlgorithm class. More...

#include <IsolatedClusterMopUpAlgorithm.h>

Inheritance diagram for lar_content::IsolatedClusterMopUpAlgorithm:

Public Member Functions
	IsolatedClusterMopUpAlgorithm ()
	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 Types
typedef std::unordered_map < const pandora::CaloHit , const pandora::Cluster >	CaloHitToClusterMap

typedef KDTreeLinkerAlgo < const pandora::CaloHit *, 2 >	HitKDTree2D

typedef KDTreeNodeInfoT< const pandora::CaloHit *, 2 >	HitKDNode2D

typedef std::vector< HitKDNode2D >	HitKDNode2DList

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

void	DissolveClustersToHits (const pandora::ClusterList &clusterList, pandora::CaloHitList &caloHitList) const
	Examine a list of clusters, identify and delete remnants; receive the list of newly available hits. More...

void	GetCaloHitToClusterMap (const pandora::CaloHitList &caloHitList, const pandora::ClusterList &clusterList, CaloHitToClusterMap &caloHitToClusterMap) const
	Look for isolated hit additions, considering a list of candidate hits and a list of host clusters. More...

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

Private Attributes
unsigned int	m_maxCaloHitsInCluster
	The maximum number of hits in a cluster to be dissolved. More...

float	m_maxHitClusterDistance
	The maximum hit to cluster distance for isolated hit merging. More...

bool	m_addHitsAsIsolated
	Whether to add hits to clusters as "isolated" (don't contribute to spatial properties) 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

IsolatedClusterMopUpAlgorithm class.

Definition at line 30 of file IsolatedClusterMopUpAlgorithm.h.

Member Typedef Documentation

typedef std::unordered_map<const pandora::CaloHit *, const pandora::Cluster *> lar_content::IsolatedClusterMopUpAlgorithm::CaloHitToClusterMap

private

Definition at line 49 of file IsolatedClusterMopUpAlgorithm.h.

typedef KDTreeNodeInfoT<const pandora::CaloHit *, 2> lar_content::IsolatedClusterMopUpAlgorithm::HitKDNode2D

private

Definition at line 64 of file IsolatedClusterMopUpAlgorithm.h.

typedef std::vector<HitKDNode2D> lar_content::IsolatedClusterMopUpAlgorithm::HitKDNode2DList

private

Definition at line 65 of file IsolatedClusterMopUpAlgorithm.h.

typedef KDTreeLinkerAlgo<const pandora::CaloHit *, 2> lar_content::IsolatedClusterMopUpAlgorithm::HitKDTree2D

private

Definition at line 63 of file IsolatedClusterMopUpAlgorithm.h.

Constructor & Destructor Documentation

lar_content::IsolatedClusterMopUpAlgorithm::IsolatedClusterMopUpAlgorithm ( )

Default constructor.

Definition at line 22 of file IsolatedClusterMopUpAlgorithm.cc.

                                                              :
     m_maxCaloHitsInCluster(20),
     m_maxHitClusterDistance(5.f),
     m_addHitsAsIsolated(true)
 {
     // ATTN Default value differs from base class
     m_excludePfosContainingTracks = false;
 }

Member Function Documentation

void lar_content::IsolatedClusterMopUpAlgorithm::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 33 of file IsolatedClusterMopUpAlgorithm.cc.

 {
     CaloHitList caloHitList;
     this->DissolveClustersToHits(remnantClusters, caloHitList);
 
     // ATTN remnantClusters now contains dangling pointers
     CaloHitToClusterMap caloHitToClusterMap;
     this->GetCaloHitToClusterMap(caloHitList, pfoClusters, caloHitToClusterMap);
 
     CaloHitList sortedCaloHitList;
     for (const auto &mapEntry : caloHitToClusterMap)
         sortedCaloHitList.push_back(mapEntry.first);
     sortedCaloHitList.sort(LArClusterHelper::SortHitsByPosition);
 
     for (const CaloHit *pCaloHit : sortedCaloHitList)
     {
         if (m_addHitsAsIsolated)
         {
             PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::AddIsolatedToCluster(*this, caloHitToClusterMap.at(pCaloHit), pCaloHit));
         }
         else
         {
             PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::AddToCluster(*this, caloHitToClusterMap.at(pCaloHit), pCaloHit));
         }
     }
 }

void lar_content::IsolatedClusterMopUpAlgorithm::DissolveClustersToHits	(	const pandora::ClusterList &	clusterList,
		pandora::CaloHitList &	caloHitList
	)		const

private

Examine a list of clusters, identify and delete remnants; receive the list of newly available hits.

Parameters

clusterList	the list of clusters to consider
caloHitList	to receive the list of newly available hits

Definition at line 62 of file IsolatedClusterMopUpAlgorithm.cc.

 {
     for (const Cluster *const pRemnantCluster : clusterList)
     {
         if (pRemnantCluster->GetNCaloHits() < m_maxCaloHitsInCluster)
         {
             const std::string listNameR(this->GetListName(pRemnantCluster));
             pRemnantCluster->GetOrderedCaloHitList().FillCaloHitList(caloHitList);
             PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::Delete(*this, pRemnantCluster, listNameR));
         }
     }
 }

void lar_content::IsolatedClusterMopUpAlgorithm::GetCaloHitToClusterMap	(	const pandora::CaloHitList &	caloHitList,
		const pandora::ClusterList &	clusterList,
		CaloHitToClusterMap &	caloHitToClusterMap
	)		const

private

Look for isolated hit additions, considering a list of candidate hits and a list of host clusters.

Parameters

caloHitList	the list of hits to consider
clusterList	the list of clusters to consider
caloHitToClusterMap	to receive the calo hit to cluster map

Definition at line 77 of file IsolatedClusterMopUpAlgorithm.cc.

 {
     CaloHitList allCaloHits;
     CaloHitToClusterMap hitToParentClusterMap;
 
     for (const Cluster *const pCluster : clusterList)
     {
         CaloHitList daughterHits;
         pCluster->GetOrderedCaloHitList().FillCaloHitList(daughterHits);
         allCaloHits.insert(allCaloHits.end(), daughterHits.begin(), daughterHits.end());
 
         for (const CaloHit *const pCaloHit : daughterHits)
             (void)hitToParentClusterMap.insert(CaloHitToClusterMap::value_type(pCaloHit, pCluster));
     }
 
     HitKDTree2D kdTree;
     HitKDNode2DList hitKDNode2DList;
 
     KDTreeBox hitsBoundingRegion2D(fill_and_bound_2d_kd_tree(allCaloHits, hitKDNode2DList));
     kdTree.build(hitKDNode2DList, hitsBoundingRegion2D);
 
     for (const CaloHit *const pCaloHit : caloHitList)
     {
         if (!PandoraContentApi::IsAvailable(*this, pCaloHit))
             throw StatusCodeException(STATUS_CODE_FAILURE);
 
         const HitKDNode2D *pResultHit(nullptr);
         float resultDistance(std::numeric_limits<float>::max());
         const HitKDNode2D targetHit(pCaloHit, pCaloHit->GetPositionVector().GetX(), pCaloHit->GetPositionVector().GetZ());
         kdTree.findNearestNeighbour(targetHit, pResultHit, resultDistance);
 
         if (pResultHit && (resultDistance < m_maxHitClusterDistance))
             (void)caloHitToClusterMap.insert(CaloHitToClusterMap::value_type(pCaloHit, hitToParentClusterMap.at(pResultHit->data)));
     }
 }

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

privatevirtual

Reimplemented from lar_content::ClusterMopUpBaseAlgorithm.

Definition at line 116 of file IsolatedClusterMopUpAlgorithm.cc.

 {
     PANDORA_RETURN_RESULT_IF_AND_IF(
         STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "MaxCaloHitsInCluster", m_maxCaloHitsInCluster));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(
         STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "MaxHitClusterDistance", m_maxHitClusterDistance));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(
         STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "AddHitsAsIsolated", m_addHitsAsIsolated));
 
     return ClusterMopUpBaseAlgorithm::ReadSettings(xmlHandle);
 }