LArSoft  v09_90_00
Liquid Argon Software toolkit - https://larsoft.org/
NearbyClusterMopUpAlgorithm.cc
Go to the documentation of this file.
1 
9 #include "Pandora/AlgorithmHeaders.h"
10 
13 
15 
16 using namespace pandora;
17 
18 namespace lar_content
19 {
20 
21 NearbyClusterMopUpAlgorithm::NearbyClusterMopUpAlgorithm() :
22  m_minHitsInCluster(5),
23  m_vertexProximity(5.f),
24  m_minClusterSeparation(2.5f),
25  m_touchingDistance(0.001f)
26 {
27 }
28 
29 //------------------------------------------------------------------------------------------------------------------------------------------
30 
31 void NearbyClusterMopUpAlgorithm::ClusterMopUp(const ClusterList &pfoClusters, const ClusterList &remnantClusters) const
32 {
33  ClusterAssociationMap clusterAssociationMap;
34 
35  const VertexList *pVertexList(NULL);
36  PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::GetCurrentList(*this, pVertexList));
37  const Vertex *const pVertex(
38  ((pVertexList->size() == 1) && (VERTEX_3D == (*(pVertexList->begin()))->GetVertexType())) ? *(pVertexList->begin()) : NULL);
39 
40  ClusterVector sortedPfoClusters(pfoClusters.begin(), pfoClusters.end());
41  std::sort(sortedPfoClusters.begin(), sortedPfoClusters.end(), LArClusterHelper::SortByNHits);
42 
43  ClusterVector sortedRemnantClusters(remnantClusters.begin(), remnantClusters.end());
44  std::sort(sortedRemnantClusters.begin(), sortedRemnantClusters.end(), LArClusterHelper::SortByNHits);
45 
46  for (const Cluster *const pClusterP : sortedPfoClusters)
47  {
48  const HitType hitType(LArClusterHelper::GetClusterHitType(pClusterP));
49  const CartesianVector vertexPosition2D(
50  !pVertex ? CartesianVector(0.f, 0.f, 0.f) : LArGeometryHelper::ProjectPosition(this->GetPandora(), pVertex->GetPosition(), hitType));
51 
52  const float innerPV((vertexPosition2D - pClusterP->GetCentroid(pClusterP->GetInnerPseudoLayer())).GetMagnitude());
53  const float outerPV((vertexPosition2D - pClusterP->GetCentroid(pClusterP->GetOuterPseudoLayer())).GetMagnitude());
54 
55  for (const Cluster *const pClusterR : sortedRemnantClusters)
56  {
57  if (pClusterR->GetNCaloHits() < m_minHitsInCluster)
58  continue;
59 
60  const float innerRV((vertexPosition2D - pClusterR->GetCentroid(pClusterR->GetInnerPseudoLayer())).GetMagnitude());
61  const float outerRV((vertexPosition2D - pClusterR->GetCentroid(pClusterR->GetOuterPseudoLayer())).GetMagnitude());
62 
63  // ATTN Could use pointing clusters here, for consistency with other vertex association mechanics
64  if (pVertex && (((innerPV < m_vertexProximity) || (outerPV < m_vertexProximity)) && ((innerRV < m_vertexProximity) || (outerRV < m_vertexProximity))))
65  continue;
66 
67  const float innerRP(LArClusterHelper::GetClosestDistance(pClusterR->GetCentroid(pClusterR->GetInnerPseudoLayer()), pClusterP));
68  const float outerRP(LArClusterHelper::GetClosestDistance(pClusterR->GetCentroid(pClusterR->GetOuterPseudoLayer()), pClusterP));
69 
70  const float minSeparation(std::min(innerRP, outerRP));
71 
72  if (minSeparation > m_minClusterSeparation)
73  continue;
74 
75  // ATTN Use of ClusterMopUp base algorithm assumes bigger figure of merit means better association
76  if (m_touchingDistance < std::numeric_limits<float>::epsilon())
77  throw StatusCodeException(STATUS_CODE_INVALID_PARAMETER);
78 
79  AssociationDetails &associationDetails(clusterAssociationMap[pClusterR]);
80  const float figureOfMerit((minSeparation < m_touchingDistance) ? 1.f / m_touchingDistance : 1.f / minSeparation);
81 
82  if (!associationDetails.insert(AssociationDetails::value_type(pClusterP, figureOfMerit)).second)
83  throw StatusCodeException(STATUS_CODE_ALREADY_PRESENT);
84  }
85  }
86 
87  this->MakeClusterMerges(clusterAssociationMap);
88 }
89 
90 //------------------------------------------------------------------------------------------------------------------------------------------
91 
92 StatusCode NearbyClusterMopUpAlgorithm::ReadSettings(const TiXmlHandle xmlHandle)
93 {
94  PANDORA_RETURN_RESULT_IF_AND_IF(
95  STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "MinHitsInCluster", m_minHitsInCluster));
96 
97  PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "VertexProximity", m_vertexProximity));
98 
99  PANDORA_RETURN_RESULT_IF_AND_IF(
100  STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "MinClusterSeparation", m_minClusterSeparation));
101 
102  PANDORA_RETURN_RESULT_IF_AND_IF(
103  STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "TouchingDistance", m_touchingDistance));
104 
105  return ClusterMopUpBaseAlgorithm::ReadSettings(xmlHandle);
106 }
107 
108 } // namespace lar_content
static bool SortByNHits(const pandora::Cluster *const pLhs, const pandora::Cluster *const pRhs)
Sort clusters by number of hits, then layer span, then inner layer, then position, then pulse-height.
virtual void MakeClusterMerges(const ClusterAssociationMap &clusterAssociationMap) const
Make the cluster merges specified in the cluster association map, using list name information in the ...
float m_vertexProximity
Distance between cluster inner/outer centroid and vtx to declare cluster vtx associated.
static pandora::CartesianVector ProjectPosition(const pandora::Pandora &pandora, const pandora::CartesianVector &position3D, const pandora::HitType view)
Project 3D position into a given 2D view.
static pandora::HitType GetClusterHitType(const pandora::Cluster *const pCluster)
Get the hit type associated with a two dimensional cluster.
std::unordered_map< const pandora::Cluster *, AssociationDetails > ClusterAssociationMap
TFile f
Definition: plotHisto.C:6
Header file for the geometry helper class.
virtual pandora::StatusCode ReadSettings(const pandora::TiXmlHandle xmlHandle)
unsigned int m_minHitsInCluster
Minimum number of hits in order to consider a cluster.
float m_touchingDistance
Threshold (small) distance below which parent and daughter clusters are declated touching.
Header file for the cluster helper class.
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 cluste...
float m_minClusterSeparation
Minimum distance between parent and daughter clusters to declare clusters associated.
std::unordered_map< const pandora::Cluster *, float > AssociationDetails
pandora::StatusCode ReadSettings(const pandora::TiXmlHandle xmlHandle)
HitType
Definition: HitType.h:12
boost::graph_traits< ModuleGraph >::vertex_descriptor Vertex
Definition: ModuleGraph.h:25
Header file for the nearby cluster mop up algorithm class.
std::vector< art::Ptr< recob::Cluster > > ClusterVector
std::list< Vertex > VertexList
Definition: DCEL.h:169
static float GetClosestDistance(const pandora::ClusterList &clusterList1, const pandora::ClusterList &clusterList2)
Get closest distance between clusters in a pair of cluster lists.