DeltaRayMatchingContainers class. More...

#include <DeltaRayMatchingContainers.h>

Public Types
typedef std::map< const pandora::Cluster , const pandora::ParticleFlowObject >	ClusterToPfoMap

typedef std::map< const pandora::Cluster *, pandora::ClusterList >	ClusterProximityMap

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

const ClusterToPfoMap &	GetClusterToPfoMap (const pandora::HitType hitType) const
	Get the mapping of clusters to the pfos to which they belong. More...

const ClusterProximityMap &	GetClusterProximityMap (const pandora::HitType hitType) const
	Get the mapping of clusters to to their neighbouring clusters. More...

void	FillContainers (const pandora::PfoList &inputPfoList, const pandora::ClusterList &inputClusterList1, const pandora::ClusterList &inputClusterList2=pandora::ClusterList(), const pandora::ClusterList &inputClusterList3=pandora::ClusterList())
	Fill the HitToClusterMap, the ClusterProximityMap and the ClusterToPfoMap in all input views. More...

void	AddClustersToPfoMaps (const pandora::ParticleFlowObject *const pPfo)
	Add the clusters of a cosmic ray/delta ray pfo to the cluster to pfo maps. More...

void	AddClustersToContainers (const pandora::ClusterVector &newClusterVector, const pandora::PfoVector &pfoVector)
	Add a list of clusters to the hit to cluster and cluster proximity maps and, if appropriate, to the cluster to pfo map. More...

void	RemoveClusterFromContainers (const pandora::Cluster *const pDeletedCluster)
	Remove an input cluster's hits from the hit to cluster and cluster proximity maps and, if appropriate, from the cluster to pfo map. More...

void	ClearContainers ()
	Empty all algorithm containers. More...

Public Attributes
float	m_searchRegion1D
	Search region, applied to each dimension, for look-up from kd-tree. More...

Private Types
typedef std::map< const pandora::CaloHit , const pandora::Cluster >	HitToClusterMap

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

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

typedef std::vector< HitKDNode2D >	HitKDNode2DList

Private Member Functions
void	FillHitToClusterMap (const pandora::ClusterList &inputClusterList)
	Populate the hit to cluster map from a list of clusters. More...

void	AddToClusterMap (const pandora::Cluster *const pCluster)
	Add the hits of a given cluster to the hit to cluster map. More...

void	FillClusterToPfoMaps (const pandora::PfoList &pfoList)
	Populate all cluster to pfo maps from a list of particle flow objects. More...

void	FillClusterProximityMap (const pandora::ClusterList &inputClusterList)
	Populate the cluster proximity map from a list of clusters. More...

void	BuildKDTree (const pandora::HitType hitType)
	Build the KD tree. More...

void	AddToClusterProximityMap (const pandora::Cluster *const pCluster)
	Add a cluster to the cluster proximity map. More...

Private Attributes
HitToClusterMap	m_hitToClusterMapU
	The mapping of hits to the clusters to which they belong (in the U view) More...

HitToClusterMap	m_hitToClusterMapV
	The mapping of hits to the clusters to which they belong (in the V view) More...

HitToClusterMap	m_hitToClusterMapW
	The mapping of hits to the clusters to which they belong (in the W view) More...

HitKDTree2D	m_kdTreeU
	The KD tree (in the U view) More...

HitKDTree2D	m_kdTreeV
	The KD tree (in the V view) More...

HitKDTree2D	m_kdTreeW
	The KD tree (in the W view) More...

ClusterProximityMap	m_clusterProximityMapU
	The mapping of clusters to their neighbouring clusters (in the U view) More...

ClusterProximityMap	m_clusterProximityMapV
	The mapping of clusters to their neighbouring clusters (in the V view) More...

ClusterProximityMap	m_clusterProximityMapW
	The mapping of clusters to their neighbouring clusters (in the W view) More...

ClusterToPfoMap	m_clusterToPfoMapU
	The mapping of cosmic ray U clusters to the cosmic ray pfos to which they belong. More...

ClusterToPfoMap	m_clusterToPfoMapV
	The mapping of cosmic ray V clusters to the cosmic ray pfos to which they belong. More...

ClusterToPfoMap	m_clusterToPfoMapW
	The mapping of cosmic ray W clusters to the cosmic ray pfos to which they belong. More...

Detailed Description

DeltaRayMatchingContainers class.

Definition at line 21 of file DeltaRayMatchingContainers.h.

Member Typedef Documentation

typedef std::map<const pandora::Cluster *, pandora::ClusterList> lar_content::DeltaRayMatchingContainers::ClusterProximityMap

Definition at line 25 of file DeltaRayMatchingContainers.h.

typedef std::map<const pandora::Cluster *, const pandora::ParticleFlowObject *> lar_content::DeltaRayMatchingContainers::ClusterToPfoMap

Definition at line 24 of file DeltaRayMatchingContainers.h.

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

private

Definition at line 90 of file DeltaRayMatchingContainers.h.

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

private

Definition at line 91 of file DeltaRayMatchingContainers.h.

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

private

Definition at line 89 of file DeltaRayMatchingContainers.h.

typedef std::map<const pandora::CaloHit *, const pandora::Cluster *> lar_content::DeltaRayMatchingContainers::HitToClusterMap

private

Definition at line 88 of file DeltaRayMatchingContainers.h.

Constructor & Destructor Documentation

lar_content::DeltaRayMatchingContainers::DeltaRayMatchingContainers ( )

Default constructor.

Definition at line 23 of file DeltaRayMatchingContainers.cc.

                                                        : m_searchRegion1D(3.f)
 {
 }

Member Function Documentation

void lar_content::DeltaRayMatchingContainers::AddClustersToContainers	(	const pandora::ClusterVector &	newClusterVector,
		const pandora::PfoVector &	pfoVector
	)

Add a list of clusters to the hit to cluster and cluster proximity maps and, if appropriate, to the cluster to pfo map.

Parameters

newClusterVector	the ordered cluster vector
pfoVector	the matching ordered vector of pfos to which the clusters belong (nullptr if not applicable)

Definition at line 169 of file DeltaRayMatchingContainers.cc.

 {
     for (const Cluster *const pNewCluster : newClusterVector)
         this->AddToClusterMap(pNewCluster);
 
     for (unsigned int i = 0; i < newClusterVector.size(); i++)
     {
         const Cluster *const pNewCluster(newClusterVector.at(i));
         const ParticleFlowObject *const pMuonPfo(pfoVector.at(i));
 
         this->AddToClusterProximityMap(pNewCluster);
 
         if (pMuonPfo)
             this->AddClustersToPfoMaps(pMuonPfo);
     }
 }

void lar_content::DeltaRayMatchingContainers::AddClustersToPfoMaps ( const pandora::ParticleFlowObject *const pPfo )

Add the clusters of a cosmic ray/delta ray pfo to the cluster to pfo maps.

Parameters

the	address of the input cosmic ray/delta ray pfo

Definition at line 148 of file DeltaRayMatchingContainers.cc.

 {
     for (const HitType hitType : {TPC_VIEW_U, TPC_VIEW_V, TPC_VIEW_W})
     {
         ClusterList pfoClusters;
         LArPfoHelper::GetClusters(pPfo, hitType, pfoClusters);
 
         ClusterToPfoMap &clusterToPfoMap((hitType == TPC_VIEW_U) ? m_clusterToPfoMapU : (hitType == TPC_VIEW_V) ? m_clusterToPfoMapV : m_clusterToPfoMapW);
 
         for (const Cluster *const pCluster : pfoClusters)
         {
             if (clusterToPfoMap.find(pCluster) != clusterToPfoMap.end())
                 continue;
 
             clusterToPfoMap[pCluster] = pPfo;
         }
     }
 }

void lar_content::DeltaRayMatchingContainers::AddToClusterMap ( const pandora::Cluster *const pCluster )

private

Add the hits of a given cluster to the hit to cluster map.

Parameters

pCluster the address of the input cluster

Definition at line 53 of file DeltaRayMatchingContainers.cc.

 {
     const HitType hitType(LArClusterHelper::GetClusterHitType(pCluster));
     HitToClusterMap &hitToClusterMap((hitType == TPC_VIEW_U) ? m_hitToClusterMapU : (hitType == TPC_VIEW_V) ? m_hitToClusterMapV : m_hitToClusterMapW);
 
     CaloHitList caloHitList;
     pCluster->GetOrderedCaloHitList().FillCaloHitList(caloHitList);
 
     for (const CaloHit *const pCaloHit : caloHitList)
         hitToClusterMap[pCaloHit] = pCluster;
 }

void lar_content::DeltaRayMatchingContainers::AddToClusterProximityMap ( const pandora::Cluster *const pCluster )

private

Add a cluster to the cluster proximity map.

Parameters

pCluster the address of the input cluster

Definition at line 100 of file DeltaRayMatchingContainers.cc.

 {
     const HitType hitType(LArClusterHelper::GetClusterHitType(pCluster));
     const HitToClusterMap &hitToClusterMap((hitType == TPC_VIEW_U) ? m_hitToClusterMapU : (hitType == TPC_VIEW_V) ? m_hitToClusterMapV : m_hitToClusterMapW);
     HitKDTree2D &kdTree((hitType == TPC_VIEW_U) ? m_kdTreeU : (hitType == TPC_VIEW_V) ? m_kdTreeV : m_kdTreeW);
     ClusterProximityMap &clusterProximityMap(
         (hitType == TPC_VIEW_U) ? m_clusterProximityMapU : (hitType == TPC_VIEW_V) ? m_clusterProximityMapV : m_clusterProximityMapW);
 
     CaloHitList caloHitList;
     pCluster->GetOrderedCaloHitList().FillCaloHitList(caloHitList);
 
     for (const CaloHit *const pCaloHit : caloHitList)
     {
         HitKDNode2DList found;
         KDTreeBox searchRegionHits(build_2d_kd_search_region(pCaloHit, m_searchRegion1D, m_searchRegion1D));
 
         kdTree.search(searchRegionHits, found);
 
         for (const auto &hit : found)
         {
             const Cluster *const pNearbyCluster(hitToClusterMap.at(hit.data));
 
             if (pNearbyCluster == pCluster)
                 continue;
 
             ClusterList &nearbyClusterList(clusterProximityMap[pCluster]);
 
             if (std::find(nearbyClusterList.begin(), nearbyClusterList.end(), pNearbyCluster) == nearbyClusterList.end())
                 nearbyClusterList.push_back(pNearbyCluster);
 
             ClusterList &invertedNearbyClusterList(clusterProximityMap[pNearbyCluster]);
 
             if (std::find(invertedNearbyClusterList.begin(), invertedNearbyClusterList.end(), pCluster) == invertedNearbyClusterList.end())
                 invertedNearbyClusterList.push_back(pCluster);
         }
     }
 }

void lar_content::DeltaRayMatchingContainers::BuildKDTree ( const pandora::HitType hitType )

private

Build the KD tree.

Parameters

hitType the hit type of the KD tree to build

Definition at line 82 of file DeltaRayMatchingContainers.cc.

 {
     const HitToClusterMap &hitToClusterMap((hitType == TPC_VIEW_U) ? m_hitToClusterMapU : (hitType == TPC_VIEW_V) ? m_hitToClusterMapV : m_hitToClusterMapW);
     HitKDTree2D &kdTree((hitType == TPC_VIEW_U) ? m_kdTreeU : (hitType == TPC_VIEW_V) ? m_kdTreeV : m_kdTreeW);
 
     CaloHitList allCaloHits;
 
     for (auto &entry : hitToClusterMap)
         allCaloHits.push_back(entry.first);
 
     HitKDNode2DList hitKDNode2DList;
     KDTreeBox hitsBoundingRegion2D(fill_and_bound_2d_kd_tree(allCaloHits, hitKDNode2DList));
 
     kdTree.build(hitKDNode2DList, hitsBoundingRegion2D);
 }

void lar_content::DeltaRayMatchingContainers::ClearContainers ( )

Empty all algorithm containers.

Definition at line 239 of file DeltaRayMatchingContainers.cc.

 {
     m_hitToClusterMapU.clear();
     m_hitToClusterMapV.clear();
     m_hitToClusterMapW.clear();
 
     m_kdTreeU.clear();
     m_kdTreeV.clear();
     m_kdTreeW.clear();
 
     m_clusterProximityMapU.clear();
     m_clusterProximityMapV.clear();
     m_clusterProximityMapW.clear();
 
     m_clusterToPfoMapU.clear();
     m_clusterToPfoMapV.clear();
     m_clusterToPfoMapW.clear();
 }

void lar_content::DeltaRayMatchingContainers::FillClusterProximityMap ( const pandora::ClusterList & inputClusterList )

private

Populate the cluster proximity map from a list of clusters.

Parameters

inputClusterList the input list of clusters

Definition at line 67 of file DeltaRayMatchingContainers.cc.

 {
     if (inputClusterList.empty())
         return;
 
     const HitType hitType(LArClusterHelper::GetClusterHitType(inputClusterList.front()));
 
     this->BuildKDTree(hitType);
 
     for (const Cluster *const pCluster : inputClusterList)
         this->AddToClusterProximityMap(pCluster);
 }

void lar_content::DeltaRayMatchingContainers::FillClusterToPfoMaps ( const pandora::PfoList & pfoList )

private

Populate all cluster to pfo maps from a list of particle flow objects.

Parameters

pfoList the input list of pfos

Definition at line 140 of file DeltaRayMatchingContainers.cc.

 {
     for (const ParticleFlowObject *const pPfo : inputPfoList)
         this->AddClustersToPfoMaps(pPfo);
 }

void lar_content::DeltaRayMatchingContainers::FillContainers	(	const pandora::PfoList &	inputPfoList,
		const pandora::ClusterList &	inputClusterList1,
		const pandora::ClusterList &	inputClusterList2 = `pandora::ClusterList()`,
		const pandora::ClusterList &	inputClusterList3 = `pandora::ClusterList()`
	)

Fill the HitToClusterMap, the ClusterProximityMap and the ClusterToPfoMap in all input views.

Parameters

inputPfoList	the input list of pfos
inputClusterList1	the input list of clusters in view 1
inputClusterList2	the input list of clusters in view 2
inputClusterList3	the input list of clusters in view 3

Definition at line 29 of file DeltaRayMatchingContainers.cc.

 {
     this->FillHitToClusterMap(inputClusterList1);
     this->FillHitToClusterMap(inputClusterList2);
     this->FillHitToClusterMap(inputClusterList3);
 
     this->FillClusterProximityMap(inputClusterList1);
     this->FillClusterProximityMap(inputClusterList2);
     this->FillClusterProximityMap(inputClusterList3);
 
     this->FillClusterToPfoMaps(inputPfoList);
 }

void lar_content::DeltaRayMatchingContainers::FillHitToClusterMap ( const pandora::ClusterList & inputClusterList )

private

Populate the hit to cluster map from a list of clusters.

Parameters

inputClusterList the input list of clusters

Definition at line 45 of file DeltaRayMatchingContainers.cc.

 {
     for (const Cluster *const pCluster : inputClusterList)
         this->AddToClusterMap(pCluster);
 }

const DeltaRayMatchingContainers::ClusterProximityMap & lar_content::DeltaRayMatchingContainers::GetClusterProximityMap ( const pandora::HitType hitType ) const

inline

Get the mapping of clusters to to their neighbouring clusters.

Returns: the cluster to nearby cluster map

Definition at line 152 of file DeltaRayMatchingContainers.h.

 {
     return ((hitType == pandora::TPC_VIEW_U) ? m_clusterProximityMapU : (hitType == pandora::TPC_VIEW_V) ? m_clusterProximityMapV : m_clusterProximityMapW);
 }

const DeltaRayMatchingContainers::ClusterToPfoMap & lar_content::DeltaRayMatchingContainers::GetClusterToPfoMap ( const pandora::HitType hitType ) const

inline

Get the mapping of clusters to the pfos to which they belong.

Returns: the cluster to pfo map

Definition at line 159 of file DeltaRayMatchingContainers.h.

 {
     return ((hitType == pandora::TPC_VIEW_U) ? m_clusterToPfoMapU : (hitType == pandora::TPC_VIEW_V) ? m_clusterToPfoMapV : m_clusterToPfoMapW);
 }

void lar_content::DeltaRayMatchingContainers::RemoveClusterFromContainers ( const pandora::Cluster *const pDeletedCluster )

Remove an input cluster's hits from the hit to cluster and cluster proximity maps and, if appropriate, from the cluster to pfo map.

Parameters

pDeletedCluster the input cluster

Definition at line 188 of file DeltaRayMatchingContainers.cc.

 {
     const HitType hitType(LArClusterHelper::GetClusterHitType(pDeletedCluster));
     HitToClusterMap &hitToClusterMap((hitType == TPC_VIEW_U) ? m_hitToClusterMapU : (hitType == TPC_VIEW_V) ? m_hitToClusterMapV : m_hitToClusterMapW);
     ClusterProximityMap &clusterProximityMap(
         (hitType == TPC_VIEW_U) ? m_clusterProximityMapU : (hitType == TPC_VIEW_V) ? m_clusterProximityMapV : m_clusterProximityMapW);
     ClusterToPfoMap &clusterToPfoMap((hitType == TPC_VIEW_U) ? m_clusterToPfoMapU : (hitType == TPC_VIEW_V) ? m_clusterToPfoMapV : m_clusterToPfoMapW);
 
     CaloHitList caloHitList;
     pDeletedCluster->GetOrderedCaloHitList().FillCaloHitList(caloHitList);
 
     for (const CaloHit *const pCaloHit : caloHitList)
     {
         const HitToClusterMap::const_iterator iter(hitToClusterMap.find(pCaloHit));
 
         if (iter == hitToClusterMap.end())
             throw StatusCodeException(STATUS_CODE_FAILURE);
 
         hitToClusterMap.erase(iter);
     }
 
     const ClusterProximityMap::const_iterator clusterProximityIter(clusterProximityMap.find(pDeletedCluster));
 
     if (clusterProximityIter != clusterProximityMap.end())
     {
         const ClusterList &nearbyClusterList(clusterProximityIter->second);
 
         for (const Cluster *const pNearbyCluster : nearbyClusterList)
         {
             const ClusterProximityMap::iterator iter(clusterProximityMap.find(pNearbyCluster));
 
             if (iter == clusterProximityMap.end())
                 continue;
 
             ClusterList &invertedCloseClusters(iter->second);
 
             ClusterList::iterator invertedIter(std::find(invertedCloseClusters.begin(), invertedCloseClusters.end(), pDeletedCluster));
             invertedCloseClusters.erase(invertedIter);
         }
 
         clusterProximityMap.erase(clusterProximityIter);
     }
 
     const DeltaRayMatchingContainers::ClusterToPfoMap::const_iterator clusterToPfoIter(clusterToPfoMap.find(pDeletedCluster));
 
     if (clusterToPfoIter != clusterToPfoMap.end())
         clusterToPfoMap.erase(clusterToPfoIter);
 }