All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Classes | Public Member Functions | Private Types | Private Member Functions | Private Attributes | List of all members
lar_content::SlidingConePfoMopUpAlgorithm Class Reference

SlidingConePfoMopUpAlgorithm class. More...

#include <SlidingConePfoMopUpAlgorithm.h>

Inheritance diagram for lar_content::SlidingConePfoMopUpAlgorithm:
lar_content::PfoMopUpBaseAlgorithm lar_content::MopUpBaseAlgorithm

Classes

class  ClusterMerge
 ClusterMerge class. More...
 

Public Member Functions

 SlidingConePfoMopUpAlgorithm ()
 Default constructor. More...
 
- Public Member Functions inherited from lar_content::PfoMopUpBaseAlgorithm
virtual void MergeAndDeletePfos (const pandora::ParticleFlowObject *const pPfoToEnlarge, const pandora::ParticleFlowObject *const pPfoToDelete) const
 Merge and delete a pair of pfos, with a specific set of conventions for cluster merging, vertex use, etc. 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::vector< ClusterMergeClusterMergeList
 
typedef std::unordered_map
< const pandora::Cluster
*, const
pandora::ParticleFlowObject * > 
ClusterToPfoMap
 
typedef std::unordered_map
< const pandora::Cluster
*, ClusterMergeList
ClusterMergeMap
 
typedef std::unordered_map
< const pandora::Cluster
*, bool > 
VertexAssociationMap
 
typedef std::unordered_map
< const pandora::Cluster
*, const pandora::Cluster * > 
ClusterReplacementMap
 

Private Member Functions

pandora::StatusCode Run ()
 
void GetInteractionVertex (const pandora::Vertex *&pVertex) const
 Get the neutrino interaction vertex if it is available and if the algorithm is configured to do so. More...
 
void GetThreeDClusters (pandora::ClusterVector &clusters3D, ClusterToPfoMap &clusterToPfoMap) const
 Get all 3d clusters contained in the input pfo lists and a mapping from clusters to pfos. More...
 
void GetClusterMergeMap (const pandora::Vertex *const pVertex, const pandora::ClusterVector &clusters3D, const ClusterToPfoMap &clusterToPfoMap, ClusterMergeMap &clusterMergeMap) const
 Get the cluster merge map describing all potential 3d cluster merges. More...
 
bool IsVertexAssociated (const pandora::Cluster *const pCluster, const pandora::Vertex *const pVertex, VertexAssociationMap &vertexAssociationMap, const ThreeDSlidingFitResult *const pSlidingFitResult=nullptr) const
 Whether a 3D cluster is nodally associated with a provided vertex. More...
 
bool IsVertexAssociated (const pandora::Cluster *const pCluster, const pandora::CartesianVector &vertexPosition, const ThreeDSlidingFitResult *const pSlidingFitResult=nullptr) const
 Whether a 3D cluster is nodally associated with a provided vertex. More...
 
bool MakePfoMerges (const ClusterToPfoMap &clusterToPfoMap, const ClusterMergeMap &clusterMergeMap) const
 Make pfo merges based on the provided cluster merge map. More...
 
pandora::StatusCode ReadSettings (const pandora::TiXmlHandle xmlHandle)
 

Private Attributes

pandora::StringVector m_inputPfoListNames
 The input pfo list names. More...
 
bool m_useVertex
 Whether to use the interaction vertex to select useful cone directions. More...
 
unsigned int m_maxIterations
 The maximum allowed number of algorithm iterations. More...
 
unsigned int m_maxHitsToConsider3DTrack
 The maximum number of hits in a 3d track cluster to warrant inclusion in algorithm. More...
 
unsigned int m_minHitsToConsider3DShower
 The minimum number of hits in a 3d shower cluster to attempt cone fits. More...
 
unsigned int m_halfWindowLayers
 The number of layers to use for half-window of sliding fit. More...
 
unsigned int m_nConeFitLayers
 The number of layers over which to sum fitted direction to obtain cone fit. More...
 
unsigned int m_nConeFits
 The number of cone fits to perform, spread roughly uniformly along the shower length. More...
 
float m_coneLengthMultiplier
 The cone length multiplier to use when calculating bounded cluster fractions. More...
 
float m_maxConeLength
 The maximum allowed cone length to use when calculating bounded cluster fractions. More...
 
float m_coneTanHalfAngle1
 The cone tan half angle to use when calculating bounded cluster fractions 1. More...
 
float m_coneBoundedFraction1
 The minimum cluster bounded fraction for association 1. More...
 
float m_coneTanHalfAngle2
 The cone tan half angle to use when calculating bounded cluster fractions 2. More...
 
float m_coneBoundedFraction2
 The minimum cluster bounded fraction for association 2. More...
 
float m_minVertexLongitudinalDistance
 Vertex association check: min longitudinal distance cut. More...
 
float m_maxVertexTransverseDistance
 Vertex association check: max transverse distance cut. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from lar_content::PfoMopUpBaseAlgorithm
static const pandora::Cluster * GetParentCluster (const pandora::ClusterList &clusterList, const pandora::HitType hitType)
 Select the parent cluster (same hit type and most hits) using a provided cluster list and hit type. More...
 
- Protected Attributes inherited from lar_content::MopUpBaseAlgorithm
pandora::StringVector m_daughterListNames
 The list of potential daughter object list names. More...
 

Detailed Description

SlidingConePfoMopUpAlgorithm class.

Definition at line 21 of file SlidingConePfoMopUpAlgorithm.h.

Member Typedef Documentation

Definition at line 81 of file SlidingConePfoMopUpAlgorithm.h.

typedef std::unordered_map<const pandora::Cluster *, ClusterMergeList> lar_content::SlidingConePfoMopUpAlgorithm::ClusterMergeMap
private

Definition at line 102 of file SlidingConePfoMopUpAlgorithm.h.

typedef std::unordered_map<const pandora::Cluster *, const pandora::Cluster *> lar_content::SlidingConePfoMopUpAlgorithm::ClusterReplacementMap
private

Definition at line 154 of file SlidingConePfoMopUpAlgorithm.h.

typedef std::unordered_map<const pandora::Cluster *, const pandora::ParticleFlowObject *> lar_content::SlidingConePfoMopUpAlgorithm::ClusterToPfoMap
private

Definition at line 92 of file SlidingConePfoMopUpAlgorithm.h.

typedef std::unordered_map<const pandora::Cluster *, bool> lar_content::SlidingConePfoMopUpAlgorithm::VertexAssociationMap
private

Definition at line 115 of file SlidingConePfoMopUpAlgorithm.h.

Constructor & Destructor Documentation

lar_content::SlidingConePfoMopUpAlgorithm::SlidingConePfoMopUpAlgorithm ( )

Default constructor.

Definition at line 25 of file SlidingConePfoMopUpAlgorithm.cc.

25  :
26  m_useVertex(true),
27  m_maxIterations(1000),
31  m_nConeFitLayers(20),
32  m_nConeFits(5),
34  m_maxConeLength(126.f),
35  m_coneTanHalfAngle1(0.5f),
37  m_coneTanHalfAngle2(0.75f),
41 {
42 }
float m_coneBoundedFraction2
The minimum cluster bounded fraction for association 2.
float m_maxConeLength
The maximum allowed cone length to use when calculating bounded cluster fractions.
float m_maxVertexTransverseDistance
Vertex association check: max transverse distance cut.
float m_coneLengthMultiplier
The cone length multiplier to use when calculating bounded cluster fractions.
bool m_useVertex
Whether to use the interaction vertex to select useful cone directions.
float m_minVertexLongitudinalDistance
Vertex association check: min longitudinal distance cut.
unsigned int m_nConeFitLayers
The number of layers over which to sum fitted direction to obtain cone fit.
unsigned int m_maxHitsToConsider3DTrack
The maximum number of hits in a 3d track cluster to warrant inclusion in algorithm.
float m_coneTanHalfAngle1
The cone tan half angle to use when calculating bounded cluster fractions 1.
float m_coneBoundedFraction1
The minimum cluster bounded fraction for association 1.
unsigned int m_maxIterations
The maximum allowed number of algorithm iterations.
unsigned int m_minHitsToConsider3DShower
The minimum number of hits in a 3d shower cluster to attempt cone fits.
unsigned int m_nConeFits
The number of cone fits to perform, spread roughly uniformly along the shower length.
float m_coneTanHalfAngle2
The cone tan half angle to use when calculating bounded cluster fractions 2.
unsigned int m_halfWindowLayers
The number of layers to use for half-window of sliding fit.

Member Function Documentation

void lar_content::SlidingConePfoMopUpAlgorithm::GetClusterMergeMap ( const pandora::Vertex *const  pVertex,
const pandora::ClusterVector &  clusters3D,
const ClusterToPfoMap clusterToPfoMap,
ClusterMergeMap clusterMergeMap 
) const
private

Get the cluster merge map describing all potential 3d cluster merges.

Parameters
pVertexthe neutrino interaction vertex, if available
clusters3Dthe sorted list of 3d clusters
clusterToPfoMapthe mapping from 3d cluster to pfo
clusterMergeMapto receive the populated cluster merge map

Definition at line 124 of file SlidingConePfoMopUpAlgorithm.cc.

126 {
127  VertexAssociationMap vertexAssociationMap;
128  const float layerPitch(LArGeometryHelper::GetWireZPitch(this->GetPandora()));
129 
130  for (const Cluster *const pShowerCluster : clusters3D)
131  {
132  if ((pShowerCluster->GetNCaloHits() < m_minHitsToConsider3DShower) || !LArPfoHelper::IsShower(clusterToPfoMap.at(pShowerCluster)))
133  continue;
134 
135  float coneLength(0.f);
136  SimpleConeList simpleConeList;
137  bool isShowerVertexAssociated(false);
138 
139  try
140  {
141  const ThreeDSlidingConeFitResult slidingConeFitResult3D(pShowerCluster, m_halfWindowLayers, layerPitch);
142 
143  const CartesianVector &minLayerPosition(slidingConeFitResult3D.GetSlidingFitResult().GetGlobalMinLayerPosition());
144  const CartesianVector &maxLayerPosition(slidingConeFitResult3D.GetSlidingFitResult().GetGlobalMaxLayerPosition());
145  coneLength = std::min(m_coneLengthMultiplier * (maxLayerPosition - minLayerPosition).GetMagnitude(), m_maxConeLength);
146 
147  const float vertexToMinLayer(!pVertex ? 0.f : (pVertex->GetPosition() - minLayerPosition).GetMagnitude());
148  const float vertexToMaxLayer(!pVertex ? 0.f : (pVertex->GetPosition() - maxLayerPosition).GetMagnitude());
149  const ConeSelection coneSelection(
150  !pVertex ? CONE_BOTH_DIRECTIONS : (vertexToMaxLayer > vertexToMinLayer) ? CONE_FORWARD_ONLY : CONE_BACKWARD_ONLY);
151 
152  slidingConeFitResult3D.GetSimpleConeList(m_nConeFitLayers, m_nConeFits, coneSelection, simpleConeList);
153  isShowerVertexAssociated =
154  this->IsVertexAssociated(pShowerCluster, pVertex, vertexAssociationMap, &(slidingConeFitResult3D.GetSlidingFitResult()));
155  }
156  catch (const StatusCodeException &)
157  {
158  continue;
159  }
160 
161  for (const Cluster *const pNearbyCluster : clusters3D)
162  {
163  if (pNearbyCluster == pShowerCluster)
164  continue;
165 
166  ClusterMerge bestClusterMerge(nullptr, 0.f, 0.f);
167 
168  for (const SimpleCone &simpleCone : simpleConeList)
169  {
170  const float boundedFraction1(simpleCone.GetBoundedHitFraction(pNearbyCluster, coneLength, m_coneTanHalfAngle1));
171  const float boundedFraction2(simpleCone.GetBoundedHitFraction(pNearbyCluster, coneLength, m_coneTanHalfAngle2));
172  const ClusterMerge clusterMerge(pShowerCluster, boundedFraction1, boundedFraction2);
173 
174  if (clusterMerge < bestClusterMerge)
175  bestClusterMerge = clusterMerge;
176  }
177 
178  if (isShowerVertexAssociated && this->IsVertexAssociated(pNearbyCluster, pVertex, vertexAssociationMap))
179  continue;
180 
181  if (bestClusterMerge.GetParentCluster() && (bestClusterMerge.GetBoundedFraction1() > m_coneBoundedFraction1) &&
182  (bestClusterMerge.GetBoundedFraction2() > m_coneBoundedFraction2))
183  clusterMergeMap[pNearbyCluster].push_back(bestClusterMerge);
184  }
185  }
186 
187  for (ClusterMergeMap::value_type &mapEntry : clusterMergeMap)
188  std::sort(mapEntry.second.begin(), mapEntry.second.end());
189 }
float m_coneBoundedFraction2
The minimum cluster bounded fraction for association 2.
float m_maxConeLength
The maximum allowed cone length to use when calculating bounded cluster fractions.
float m_coneLengthMultiplier
The cone length multiplier to use when calculating bounded cluster fractions.
std::vector< SimpleCone > SimpleConeList
static float GetWireZPitch(const pandora::Pandora &pandora, const float maxWirePitchDiscrepancy=0.01)
Return the wire pitch.
bool IsVertexAssociated(const pandora::Cluster *const pCluster, const pandora::Vertex *const pVertex, VertexAssociationMap &vertexAssociationMap, const ThreeDSlidingFitResult *const pSlidingFitResult=nullptr) const
Whether a 3D cluster is nodally associated with a provided vertex.
static bool IsShower(const pandora::ParticleFlowObject *const pPfo)
Return shower flag based on Pfo Particle ID.
unsigned int m_nConeFitLayers
The number of layers over which to sum fitted direction to obtain cone fit.
float m_coneTanHalfAngle1
The cone tan half angle to use when calculating bounded cluster fractions 1.
float m_coneBoundedFraction1
The minimum cluster bounded fraction for association 1.
std::unordered_map< const pandora::Cluster *, bool > VertexAssociationMap
ConeSelection
ConeSelection enum.
unsigned int m_minHitsToConsider3DShower
The minimum number of hits in a 3d shower cluster to attempt cone fits.
unsigned int m_nConeFits
The number of cone fits to perform, spread roughly uniformly along the shower length.
float m_coneTanHalfAngle2
The cone tan half angle to use when calculating bounded cluster fractions 2.
unsigned int m_halfWindowLayers
The number of layers to use for half-window of sliding fit.
void lar_content::SlidingConePfoMopUpAlgorithm::GetInteractionVertex ( const pandora::Vertex *&  pVertex) const
private

Get the neutrino interaction vertex if it is available and if the algorithm is configured to do so.

Parameters
pVertexto receive the neutrino interaction vertex

Definition at line 78 of file SlidingConePfoMopUpAlgorithm.cc.

79 {
80  if (!m_useVertex)
81  return;
82 
83  const VertexList *pVertexList = nullptr;
84  PANDORA_THROW_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_INITIALIZED, !=, PandoraContentApi::GetCurrentList(*this, pVertexList));
85 
86  pVertex =
87  ((pVertexList && (pVertexList->size() == 1) && (VERTEX_3D == (*(pVertexList->begin()))->GetVertexType())) ? *(pVertexList->begin()) : nullptr);
88 }
bool m_useVertex
Whether to use the interaction vertex to select useful cone directions.
std::list< Vertex > VertexList
Definition: DCEL.h:182
void lar_content::SlidingConePfoMopUpAlgorithm::GetThreeDClusters ( pandora::ClusterVector &  clusters3D,
ClusterToPfoMap clusterToPfoMap 
) const
private

Get all 3d clusters contained in the input pfo lists and a mapping from clusters to pfos.

Parameters
clusters3Dto receive the sorted list of 3d clusters
clusterToPfoMapto receive the mapping from 3d cluster to pfo

Definition at line 92 of file SlidingConePfoMopUpAlgorithm.cc.

93 {
94  for (const std::string &pfoListName : m_inputPfoListNames)
95  {
96  const PfoList *pPfoList(nullptr);
97 
98  if (STATUS_CODE_SUCCESS != PandoraContentApi::GetList(*this, pfoListName, pPfoList))
99  continue;
100 
101  for (const Pfo *const pPfo : *pPfoList)
102  {
103  ClusterList pfoClusters3D;
104  LArPfoHelper::GetThreeDClusterList(pPfo, pfoClusters3D);
105 
106  for (const Cluster *const pCluster3D : pfoClusters3D)
107  {
108  if (LArPfoHelper::IsTrack(pPfo) && (pCluster3D->GetNCaloHits() > m_maxHitsToConsider3DTrack))
109  continue;
110 
111  if (!clusterToPfoMap.insert(ClusterToPfoMap::value_type(pCluster3D, pPfo)).second)
112  throw StatusCodeException(STATUS_CODE_ALREADY_PRESENT);
113 
114  clusters3D.push_back(pCluster3D);
115  }
116  }
117  }
118 
119  std::sort(clusters3D.begin(), clusters3D.end(), LArClusterHelper::SortByNHits);
120 }
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.
static bool IsTrack(const pandora::ParticleFlowObject *const pPfo)
Return track flag based on Pfo Particle ID.
unsigned int m_maxHitsToConsider3DTrack
The maximum number of hits in a 3d track cluster to warrant inclusion in algorithm.
pandora::StringVector m_inputPfoListNames
The input pfo list names.
static void GetThreeDClusterList(const pandora::ParticleFlowObject *const pPfo, pandora::ClusterList &clusterList)
Get the list of 3D clusters from an input pfo.
bool lar_content::SlidingConePfoMopUpAlgorithm::IsVertexAssociated ( const pandora::Cluster *const  pCluster,
const pandora::Vertex *const  pVertex,
VertexAssociationMap vertexAssociationMap,
const ThreeDSlidingFitResult *const  pSlidingFitResult = nullptr 
) const
private

Whether a 3D cluster is nodally associated with a provided vertex.

Parameters
pClusterthe address of the cluster
pVertexthe address of the vertex
vertexAssociationMapthe vertex association map, which caches the results for efficiency
pSlidingFitResultthe address of a 3D sliding linear fit, if available, which aids pointing cluster construction efficiency
Returns
boolean
bool lar_content::SlidingConePfoMopUpAlgorithm::IsVertexAssociated ( const pandora::Cluster *const  pCluster,
const pandora::CartesianVector &  vertexPosition,
const ThreeDSlidingFitResult *const  pSlidingFitResult = nullptr 
) const
private

Whether a 3D cluster is nodally associated with a provided vertex.

Parameters
pClusterthe address of the cluster
vertexPositionthe vertex position
pSlidingFitResultthe address of a 3D sliding linear fit, if available, which aids pointing cluster construction efficiency
Returns
boolean
bool lar_content::SlidingConePfoMopUpAlgorithm::MakePfoMerges ( const ClusterToPfoMap clusterToPfoMap,
const ClusterMergeMap clusterMergeMap 
) const
private

Make pfo merges based on the provided cluster merge map.

Parameters
clusterToPfoMapthe mapping from 3d cluster to pfo
clusterMergeMapthe populated cluster merge map
Returns
whether a pfo merge has been made

Definition at line 236 of file SlidingConePfoMopUpAlgorithm.cc.

237 {
238  ClusterVector daughterClusters;
239  for (const ClusterMergeMap::value_type &mapEntry : clusterMergeMap)
240  daughterClusters.push_back(mapEntry.first);
241  std::sort(daughterClusters.begin(), daughterClusters.end(), LArClusterHelper::SortByNHits);
242 
243  bool pfosMerged(false);
244  ClusterReplacementMap clusterReplacementMap;
245 
246  for (ClusterVector::const_reverse_iterator rIter = daughterClusters.rbegin(), rIterEnd = daughterClusters.rend(); rIter != rIterEnd; ++rIter)
247  {
248  const Cluster *const pDaughterCluster(*rIter);
249 
250  if (clusterReplacementMap.count(pDaughterCluster))
251  throw StatusCodeException(STATUS_CODE_FAILURE);
252 
253  const Cluster *pParentCluster(clusterMergeMap.at(pDaughterCluster).at(0).GetParentCluster());
254 
255  if (clusterReplacementMap.count(pParentCluster))
256  pParentCluster = clusterReplacementMap.at(pParentCluster);
257 
258  // ATTN Sign there was a reciprocal relationship in the cluster merge map (already actioned once)
259  if (pDaughterCluster == pParentCluster)
260  continue;
261 
262  // Key book-keeping on clusters and use cluster->pfo lookup
263  const Pfo *const pDaughterPfo(clusterToPfoMap.at(pDaughterCluster));
264  const Pfo *const pParentPfo(clusterToPfoMap.at(pParentCluster));
265  this->MergeAndDeletePfos(pParentPfo, pDaughterPfo);
266  pfosMerged = true;
267 
268  // Simple/placeholder book-keeping for reciprocal relationships and progressive merges
269  clusterReplacementMap[pDaughterCluster] = pParentCluster;
270 
271  for (ClusterReplacementMap::value_type &mapEntry : clusterReplacementMap)
272  {
273  if (pDaughterCluster == mapEntry.second)
274  mapEntry.second = pParentCluster;
275  }
276  }
277 
278  return pfosMerged;
279 }
std::unordered_map< const pandora::Cluster *, const pandora::Cluster * > ClusterReplacementMap
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 MergeAndDeletePfos(const pandora::ParticleFlowObject *const pPfoToEnlarge, const pandora::ParticleFlowObject *const pPfoToDelete) const
Merge and delete a pair of pfos, with a specific set of conventions for cluster merging, vertex use, etc.
std::vector< art::Ptr< recob::Cluster > > ClusterVector
StatusCode lar_content::SlidingConePfoMopUpAlgorithm::ReadSettings ( const pandora::TiXmlHandle  xmlHandle)
privatevirtual

Reimplemented from lar_content::PfoMopUpBaseAlgorithm.

Definition at line 307 of file SlidingConePfoMopUpAlgorithm.cc.

308 {
309  PANDORA_RETURN_RESULT_IF_AND_IF(
310  STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadVectorOfValues(xmlHandle, "InputPfoListNames", m_inputPfoListNames));
311 
312  PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "UseVertex", m_useVertex));
313 
314  PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "MaxIterations", m_maxIterations));
315 
316  PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=,
317  XmlHelper::ReadValue(xmlHandle, "MaxHitsToConsider3DTrack", m_maxHitsToConsider3DTrack));
318 
319  PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=,
320  XmlHelper::ReadValue(xmlHandle, "MinHitsToConsider3DShower", m_minHitsToConsider3DShower));
321 
322  PANDORA_RETURN_RESULT_IF_AND_IF(
323  STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "SlidingFitHalfWindow", m_halfWindowLayers));
324 
325  PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "NConeFitLayers", m_nConeFitLayers));
326 
327  PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "NConeFits", m_nConeFits));
328 
329  PANDORA_RETURN_RESULT_IF_AND_IF(
330  STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "ConeLengthMultiplier", m_coneLengthMultiplier));
331 
332  PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "MaxConeLength", m_maxConeLength));
333 
334  PANDORA_RETURN_RESULT_IF_AND_IF(
335  STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "ConeTanHalfAngle1", m_coneTanHalfAngle1));
336 
337  PANDORA_RETURN_RESULT_IF_AND_IF(
338  STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "ConeBoundedFraction1", m_coneBoundedFraction1));
339 
340  PANDORA_RETURN_RESULT_IF_AND_IF(
341  STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "ConeTanHalfAngle2", m_coneTanHalfAngle2));
342 
343  PANDORA_RETURN_RESULT_IF_AND_IF(
344  STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "ConeBoundedFraction2", m_coneBoundedFraction2));
345 
346  PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=,
347  XmlHelper::ReadValue(xmlHandle, "MinVertexLongitudinalDistance", m_minVertexLongitudinalDistance));
348 
349  PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=,
350  XmlHelper::ReadValue(xmlHandle, "MaxVertexTransverseDistance", m_maxVertexTransverseDistance));
351 
353 
354  return PfoMopUpBaseAlgorithm::ReadSettings(xmlHandle);
355 }
float m_coneBoundedFraction2
The minimum cluster bounded fraction for association 2.
float m_maxConeLength
The maximum allowed cone length to use when calculating bounded cluster fractions.
float m_maxVertexTransverseDistance
Vertex association check: max transverse distance cut.
float m_coneLengthMultiplier
The cone length multiplier to use when calculating bounded cluster fractions.
pandora::StringVector m_daughterListNames
The list of potential daughter object list names.
bool m_useVertex
Whether to use the interaction vertex to select useful cone directions.
float m_minVertexLongitudinalDistance
Vertex association check: min longitudinal distance cut.
unsigned int m_nConeFitLayers
The number of layers over which to sum fitted direction to obtain cone fit.
unsigned int m_maxHitsToConsider3DTrack
The maximum number of hits in a 3d track cluster to warrant inclusion in algorithm.
float m_coneTanHalfAngle1
The cone tan half angle to use when calculating bounded cluster fractions 1.
pandora::StringVector m_inputPfoListNames
The input pfo list names.
float m_coneBoundedFraction1
The minimum cluster bounded fraction for association 1.
virtual pandora::StatusCode ReadSettings(const pandora::TiXmlHandle xmlHandle)
unsigned int m_maxIterations
The maximum allowed number of algorithm iterations.
unsigned int m_minHitsToConsider3DShower
The minimum number of hits in a 3d shower cluster to attempt cone fits.
unsigned int m_nConeFits
The number of cone fits to perform, spread roughly uniformly along the shower length.
float m_coneTanHalfAngle2
The cone tan half angle to use when calculating bounded cluster fractions 2.
unsigned int m_halfWindowLayers
The number of layers to use for half-window of sliding fit.
StatusCode lar_content::SlidingConePfoMopUpAlgorithm::Run ( )
private

Definition at line 46 of file SlidingConePfoMopUpAlgorithm.cc.

47 {
48  const Vertex *pVertex(nullptr);
49  this->GetInteractionVertex(pVertex);
50 
51  if (m_useVertex && !pVertex)
52  {
53  if (PandoraContentApi::GetSettings(*this)->ShouldDisplayAlgorithmInfo())
54  std::cout << "SlidingConePfoMopUpAlgorithm - interaction vertex not available for use." << std::endl;
55  return STATUS_CODE_SUCCESS;
56  }
57 
58  unsigned int nIterations(0);
59 
60  while (nIterations++ < m_maxIterations)
61  {
62  ClusterVector clusters3D;
63  ClusterToPfoMap clusterToPfoMap;
64  this->GetThreeDClusters(clusters3D, clusterToPfoMap);
65 
66  ClusterMergeMap clusterMergeMap;
67  this->GetClusterMergeMap(pVertex, clusters3D, clusterToPfoMap, clusterMergeMap);
68 
69  if (!this->MakePfoMerges(clusterToPfoMap, clusterMergeMap))
70  break;
71  }
72 
73  return STATUS_CODE_SUCCESS;
74 }
void GetClusterMergeMap(const pandora::Vertex *const pVertex, const pandora::ClusterVector &clusters3D, const ClusterToPfoMap &clusterToPfoMap, ClusterMergeMap &clusterMergeMap) const
Get the cluster merge map describing all potential 3d cluster merges.
void GetInteractionVertex(const pandora::Vertex *&pVertex) const
Get the neutrino interaction vertex if it is available and if the algorithm is configured to do so...
std::unordered_map< const pandora::Cluster *, const pandora::ParticleFlowObject * > ClusterToPfoMap
bool MakePfoMerges(const ClusterToPfoMap &clusterToPfoMap, const ClusterMergeMap &clusterMergeMap) const
Make pfo merges based on the provided cluster merge map.
void GetThreeDClusters(pandora::ClusterVector &clusters3D, ClusterToPfoMap &clusterToPfoMap) const
Get all 3d clusters contained in the input pfo lists and a mapping from clusters to pfos...
bool m_useVertex
Whether to use the interaction vertex to select useful cone directions.
unsigned int m_maxIterations
The maximum allowed number of algorithm iterations.
std::vector< art::Ptr< recob::Cluster > > ClusterVector
std::unordered_map< const pandora::Cluster *, ClusterMergeList > ClusterMergeMap
BEGIN_PROLOG could also be cout

Member Data Documentation

float lar_content::SlidingConePfoMopUpAlgorithm::m_coneBoundedFraction1
private

The minimum cluster bounded fraction for association 1.

Definition at line 167 of file SlidingConePfoMopUpAlgorithm.h.

float lar_content::SlidingConePfoMopUpAlgorithm::m_coneBoundedFraction2
private

The minimum cluster bounded fraction for association 2.

Definition at line 169 of file SlidingConePfoMopUpAlgorithm.h.

float lar_content::SlidingConePfoMopUpAlgorithm::m_coneLengthMultiplier
private

The cone length multiplier to use when calculating bounded cluster fractions.

Definition at line 164 of file SlidingConePfoMopUpAlgorithm.h.

float lar_content::SlidingConePfoMopUpAlgorithm::m_coneTanHalfAngle1
private

The cone tan half angle to use when calculating bounded cluster fractions 1.

Definition at line 166 of file SlidingConePfoMopUpAlgorithm.h.

float lar_content::SlidingConePfoMopUpAlgorithm::m_coneTanHalfAngle2
private

The cone tan half angle to use when calculating bounded cluster fractions 2.

Definition at line 168 of file SlidingConePfoMopUpAlgorithm.h.

unsigned int lar_content::SlidingConePfoMopUpAlgorithm::m_halfWindowLayers
private

The number of layers to use for half-window of sliding fit.

Definition at line 161 of file SlidingConePfoMopUpAlgorithm.h.

pandora::StringVector lar_content::SlidingConePfoMopUpAlgorithm::m_inputPfoListNames
private

The input pfo list names.

Definition at line 156 of file SlidingConePfoMopUpAlgorithm.h.

float lar_content::SlidingConePfoMopUpAlgorithm::m_maxConeLength
private

The maximum allowed cone length to use when calculating bounded cluster fractions.

Definition at line 165 of file SlidingConePfoMopUpAlgorithm.h.

unsigned int lar_content::SlidingConePfoMopUpAlgorithm::m_maxHitsToConsider3DTrack
private

The maximum number of hits in a 3d track cluster to warrant inclusion in algorithm.

Definition at line 159 of file SlidingConePfoMopUpAlgorithm.h.

unsigned int lar_content::SlidingConePfoMopUpAlgorithm::m_maxIterations
private

The maximum allowed number of algorithm iterations.

Definition at line 158 of file SlidingConePfoMopUpAlgorithm.h.

float lar_content::SlidingConePfoMopUpAlgorithm::m_maxVertexTransverseDistance
private

Vertex association check: max transverse distance cut.

Definition at line 171 of file SlidingConePfoMopUpAlgorithm.h.

unsigned int lar_content::SlidingConePfoMopUpAlgorithm::m_minHitsToConsider3DShower
private

The minimum number of hits in a 3d shower cluster to attempt cone fits.

Definition at line 160 of file SlidingConePfoMopUpAlgorithm.h.

float lar_content::SlidingConePfoMopUpAlgorithm::m_minVertexLongitudinalDistance
private

Vertex association check: min longitudinal distance cut.

Definition at line 170 of file SlidingConePfoMopUpAlgorithm.h.

unsigned int lar_content::SlidingConePfoMopUpAlgorithm::m_nConeFitLayers
private

The number of layers over which to sum fitted direction to obtain cone fit.

Definition at line 162 of file SlidingConePfoMopUpAlgorithm.h.

unsigned int lar_content::SlidingConePfoMopUpAlgorithm::m_nConeFits
private

The number of cone fits to perform, spread roughly uniformly along the shower length.

Definition at line 163 of file SlidingConePfoMopUpAlgorithm.h.

bool lar_content::SlidingConePfoMopUpAlgorithm::m_useVertex
private

Whether to use the interaction vertex to select useful cone directions.

Definition at line 157 of file SlidingConePfoMopUpAlgorithm.h.


The documentation for this class was generated from the following files: