LArSoft  v09_90_00
Liquid Argon Software toolkit - https://larsoft.org/
ConeClusterMopUpAlgorithm.cc
Go to the documentation of this file.
1 
9 #include "Pandora/AlgorithmHeaders.h"
10 
13 
15 
17 
18 using namespace pandora;
19 
20 namespace lar_content
21 {
22 
23 ConeClusterMopUpAlgorithm::ConeClusterMopUpAlgorithm() :
24  m_slidingFitWindow(20),
25  m_showerEdgeMultiplier(1.5f),
26  m_coneAngleCentile(0.85f),
27  m_maxConeLengthMultiplier(1.5f),
28  m_minBoundedFraction(0.5f)
29 {
30 }
31 
32 //------------------------------------------------------------------------------------------------------------------------------------------
33 
34 void ConeClusterMopUpAlgorithm::ClusterMopUp(const ClusterList &pfoClusters, const ClusterList &remnantClusters) const
35 {
36  ClusterAssociationMap clusterAssociationMap;
37 
38  const VertexList *pVertexList(NULL);
39  PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::GetCurrentList(*this, pVertexList));
40 
41  if ((pVertexList->size() != 1) || (VERTEX_3D != (*(pVertexList->begin()))->GetVertexType()))
42  return;
43 
44  const Vertex *const pVertex(*(pVertexList->begin()));
45 
46  ClusterVector sortedPfoClusters(pfoClusters.begin(), pfoClusters.end());
47  std::sort(sortedPfoClusters.begin(), sortedPfoClusters.end(), LArClusterHelper::SortByNHits);
48 
49  ClusterVector sortedRemnantClusters(remnantClusters.begin(), remnantClusters.end());
50  std::sort(sortedRemnantClusters.begin(), sortedRemnantClusters.end(), LArClusterHelper::SortByNHits);
51 
52  for (const Cluster *const pPfoCluster : sortedPfoClusters)
53  {
54  try
55  {
56  const float slidingFitPitch(LArGeometryHelper::GetWirePitch(this->GetPandora(), LArClusterHelper::GetClusterHitType(pPfoCluster)));
57  const TwoDSlidingShowerFitResult showerFitResult(pPfoCluster, m_slidingFitWindow, slidingFitPitch, m_showerEdgeMultiplier);
58 
59  const LayerFitResultMap &layerFitResultMapS(showerFitResult.GetShowerFitResult().GetLayerFitResultMap());
60  const LayerFitResultMap &layerFitResultMapP(showerFitResult.GetPositiveEdgeFitResult().GetLayerFitResultMap());
61  const LayerFitResultMap &layerFitResultMapN(showerFitResult.GetNegativeEdgeFitResult().GetLayerFitResultMap());
62 
63  if (layerFitResultMapS.size() < 2)
64  continue;
65 
66  // Cone direction
67  CartesianVector minLayerPositionOnAxis(0.f, 0.f, 0.f), maxLayerPositionOnAxis(0.f, 0.f, 0.f);
68  showerFitResult.GetShowerFitResult().GetGlobalPosition(layerFitResultMapS.begin()->second.GetL(), 0.f, minLayerPositionOnAxis);
69  showerFitResult.GetShowerFitResult().GetGlobalPosition(layerFitResultMapS.rbegin()->second.GetL(), 0.f, maxLayerPositionOnAxis);
70 
71  const HitType hitType(LArClusterHelper::GetClusterHitType(pPfoCluster));
72  const CartesianVector vertexPosition2D(LArGeometryHelper::ProjectPosition(this->GetPandora(), pVertex->GetPosition(), hitType));
73  const bool vertexAtMinL((vertexPosition2D - minLayerPositionOnAxis).GetMagnitudeSquared() <
74  (vertexPosition2D - maxLayerPositionOnAxis).GetMagnitudeSquared());
75 
76  // Cone edges
77  CoordinateList coordinateListP, coordinateListN;
78 
79  for (LayerFitResultMap::const_iterator iterS = layerFitResultMapS.begin(); iterS != layerFitResultMapS.end(); ++iterS)
80  {
81  LayerFitResultMap::const_iterator iterP = layerFitResultMapP.find(iterS->first);
82  LayerFitResultMap::const_iterator iterN = layerFitResultMapN.find(iterS->first);
83 
84  if (layerFitResultMapP.end() != iterP)
85  coordinateListP.push_back(Coordinate(iterP->second.GetL(), iterP->second.GetFitT()));
86 
87  if (layerFitResultMapN.end() != iterN)
88  coordinateListN.push_back(Coordinate(iterN->second.GetL(), iterN->second.GetFitT()));
89  }
90 
91  if (coordinateListP.empty() || coordinateListN.empty())
92  continue;
93 
94  std::sort(coordinateListP.begin(), coordinateListP.end(), ConeClusterMopUpAlgorithm::SortCoordinates);
95  std::sort(coordinateListN.begin(), coordinateListN.end(), ConeClusterMopUpAlgorithm::SortCoordinates);
96 
97  const Coordinate maxP(coordinateListP.at(m_coneAngleCentile * coordinateListP.size()));
98  const Coordinate minP(vertexAtMinL
99  ? Coordinate(layerFitResultMapP.begin()->second.GetL(), layerFitResultMapP.begin()->second.GetFitT())
100  : Coordinate(layerFitResultMapP.rbegin()->second.GetL(), layerFitResultMapP.rbegin()->second.GetFitT()));
101 
102  const Coordinate maxN(coordinateListN.at((1.f - m_coneAngleCentile) * coordinateListN.size()));
103  const Coordinate minN(vertexAtMinL
104  ? Coordinate(layerFitResultMapN.begin()->second.GetL(), layerFitResultMapN.begin()->second.GetFitT())
105  : Coordinate(layerFitResultMapN.rbegin()->second.GetL(), layerFitResultMapN.rbegin()->second.GetFitT()));
106 
107  const float minL(layerFitResultMapS.begin()->second.GetL());
108  const float maxL(minL + m_maxConeLengthMultiplier * std::fabs(layerFitResultMapS.rbegin()->second.GetL() - minL));
109 
110  if ((std::fabs(maxP.first - minP.first) < std::numeric_limits<float>::epsilon()) ||
111  (std::fabs(maxN.first - minN.first) < std::numeric_limits<float>::epsilon()) ||
112  (std::fabs(maxL - minL) < std::numeric_limits<float>::epsilon()))
113  {
114  continue;
115  }
116 
117  // Bounded fraction calculation
118  for (const Cluster *const pRemnantCluster : sortedRemnantClusters)
119  {
120  const unsigned int nHits(pRemnantCluster->GetNCaloHits());
121 
122  unsigned int nMatchedHits(0);
123  const OrderedCaloHitList &orderedCaloHitList(pRemnantCluster->GetOrderedCaloHitList());
124 
125  for (OrderedCaloHitList::const_iterator iter = orderedCaloHitList.begin(), iterEnd = orderedCaloHitList.end(); iter != iterEnd; ++iter)
126  {
127  for (CaloHitList::const_iterator hIter = iter->second->begin(), hIterEnd = iter->second->end(); hIter != hIterEnd; ++hIter)
128  {
129  float rL(0.f), rT(0.f);
130  showerFitResult.GetShowerFitResult().GetLocalPosition((*hIter)->GetPositionVector(), rL, rT);
131 
132  if ((rL < minL) || (rL > maxL))
133  continue;
134 
135  const float rTP(minP.second + (rL - minP.first) * ((maxP.second - minP.second) / (maxP.first - minP.first)));
136  const float rTN(minN.second + (rL - minN.first) * ((maxN.second - minN.second) / (maxN.first - minN.first)));
137 
138  if ((rT > rTP) || (rT < rTN))
139  continue;
140 
141  ++nMatchedHits;
142  }
143  }
144 
145  const float boundedFraction((nHits > 0) ? static_cast<float>(nMatchedHits) / static_cast<float>(nHits) : 0.f);
146 
147  if (boundedFraction < m_minBoundedFraction)
148  continue;
149 
150  AssociationDetails &associationDetails(clusterAssociationMap[pRemnantCluster]);
151 
152  if (!associationDetails.insert(AssociationDetails::value_type(pPfoCluster, boundedFraction)).second)
153  throw StatusCodeException(STATUS_CODE_FAILURE);
154  }
155  }
156  catch (StatusCodeException &statusCodeException)
157  {
158  if (STATUS_CODE_FAILURE == statusCodeException.GetStatusCode())
159  throw statusCodeException;
160  }
161  }
162 
163  this->MakeClusterMerges(clusterAssociationMap);
164 }
165 
166 //------------------------------------------------------------------------------------------------------------------------------------------
167 
169 {
170  return (lhs.second < rhs.second);
171 }
172 
173 //------------------------------------------------------------------------------------------------------------------------------------------
174 
175 StatusCode ConeClusterMopUpAlgorithm::ReadSettings(const TiXmlHandle xmlHandle)
176 {
177  PANDORA_RETURN_RESULT_IF_AND_IF(
178  STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "SlidingFitWindow", m_slidingFitWindow));
179 
180  PANDORA_RETURN_RESULT_IF_AND_IF(
181  STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "ShowerEdgeMultiplier", m_showerEdgeMultiplier));
182 
183  PANDORA_RETURN_RESULT_IF_AND_IF(
184  STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "ConeAngleCentile", m_coneAngleCentile));
185 
186  PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=,
187  XmlHelper::ReadValue(xmlHandle, "MaxConeLengthMultiplier", m_maxConeLengthMultiplier));
188 
189  PANDORA_RETURN_RESULT_IF_AND_IF(
190  STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "MinBoundedFraction", m_minBoundedFraction));
191 
192  return ClusterMopUpBaseAlgorithm::ReadSettings(xmlHandle);
193 }
194 
195 } // namespace lar_content
Header file for the lar two dimensional sliding shower fit result class.
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 ...
pandora::StatusCode ReadSettings(const pandora::TiXmlHandle xmlHandle)
static bool SortCoordinates(const Coordinate &lhs, const Coordinate &rhs)
Sort coordinates by increasing transverse displacement.
const TwoDSlidingFitResult & GetShowerFitResult() const
Get the sliding fit result for the full shower cluster.
static pandora::CartesianVector ProjectPosition(const pandora::Pandora &pandora, const pandora::CartesianVector &position3D, const pandora::HitType view)
Project 3D position into a given 2D view.
intermediate_table::const_iterator const_iterator
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
float m_maxConeLengthMultiplier
Consider hits as bound if inside cone, with projected distance less than N times cone length...
float m_minBoundedFraction
The minimum cluster bounded fraction for merging.
TFile f
Definition: plotHisto.C:6
Header file for the geometry helper class.
Header file for the cone cluster mop up algorithm class.
virtual pandora::StatusCode ReadSettings(const pandora::TiXmlHandle xmlHandle)
Header file for the cluster helper class.
float m_showerEdgeMultiplier
Artificially tune width of shower envelope so as to make it more/less inclusive.
std::map< int, LayerFitResult > LayerFitResultMap
static float GetWirePitch(const pandora::Pandora &pandora, const pandora::HitType view, const float maxWirePitchDiscrepancy=0.01)
Return the wire pitch.
std::unordered_map< const pandora::Cluster *, float > AssociationDetails
const TwoDSlidingFitResult & GetPositiveEdgeFitResult() const
Get the sliding fit result for the positive shower edge.
const LayerFitResultMap & GetLayerFitResultMap() const
Get the layer fit result map.
const TwoDSlidingFitResult & GetNegativeEdgeFitResult() const
Get the sliding fit result for the negative shower edge.
HitType
Definition: HitType.h:12
void GetGlobalPosition(const float rL, const float rT, pandora::CartesianVector &position) const
Get global coordinates for given sliding linear fit coordinates.
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_coneAngleCentile
Cluster cone angle is defined using specified centile of distribution of hit half angles...
boost::graph_traits< ModuleGraph >::vertex_descriptor Vertex
Definition: ModuleGraph.h:25
std::vector< art::Ptr< recob::Cluster > > ClusterVector
unsigned int m_slidingFitWindow
The layer window for the sliding linear fits.
void GetLocalPosition(const pandora::CartesianVector &position, float &rL, float &rT) const
Get local sliding fit coordinates for a given global position.
std::list< Vertex > VertexList
Definition: DCEL.h:169