LArSoft  v09_90_00
Liquid Argon Software toolkit - https://larsoft.org/
lar_content::SplitShowersTool Class Reference

SplitShowersTool class. More...

#include "SplitShowersTool.h"

Inheritance diagram for lar_content::SplitShowersTool:
lar_content::ShowerTensorTool

Public Types

typedef ThreeViewShowersAlgorithm::MatchingType::TensorType TensorType
 
typedef std::vector< TensorType::ElementList::const_iteratorIteratorList
 

Public Member Functions

 SplitShowersTool ()
 Default constructor. More...
 
bool Run (ThreeViewShowersAlgorithm *const pAlgorithm, TensorType &overlapTensor)
 Run the algorithm tool. More...
 

Private Member Functions

void FindSplitShowers (ThreeViewShowersAlgorithm *const pAlgorithm, const TensorType &overlapTensor, ClusterMergeMap &clusterMergeMap) const
 Find split showers, using information from the overlap tensor. More...
 
bool PassesElementCuts (TensorType::ElementList::const_iterator eIter, const pandora::ClusterSet &usedClusters) const
 Whether a provided (iterator to a) tensor element passes the selection cuts for undershoots identification. More...
 
void SelectTensorElements (TensorType::ElementList::const_iterator eIter, const TensorType::ElementList &elementList, const pandora::ClusterSet &usedClusters, IteratorList &iteratorList) const
 Select elements representing possible components of interest due to undershoots in clustering. More...
 
void FindShowerMerges (ThreeViewShowersAlgorithm *const pAlgorithm, const IteratorList &iteratorList, pandora::ClusterSet &usedClusters, ClusterMergeMap &clusterMergeMap) const
 Get cluster merges specific elements of the tensor. More...
 
bool CheckClusterProximities (ThreeViewShowersAlgorithm *const pAlgorithm, const pandora::ClusterList &clusterList) const
 Check the clusters in a provided cluster list are in suitable proximity for merging. More...
 
bool CheckClusterVertexRelations (ThreeViewShowersAlgorithm *const pAlgorithm, const pandora::ClusterList &clusterList) const
 Check the consistency of the clusters in a provided cluster list with the event vertex, if available. More...
 
bool CheckClusterSplitPositions (ThreeViewShowersAlgorithm *const pAlgorithm, const pandora::ClusterList &clusterListU, const pandora::ClusterList &clusterListV, const pandora::ClusterList &clusterListW) const
 Check the consistency of the split positions in the provided u, v and w cluster lists. More...
 
void GetSplitXDetails (ThreeViewShowersAlgorithm *const pAlgorithm, const pandora::Cluster *const pClusterA, const pandora::Cluster *const pClusterB, float &splitXPosition, float &overlapX) const
 Get the x coordinate representing the midpoint between two clusters (hypothesis: clusters represent a split shower) More...
 
void SpecifyClusterMerges (ThreeViewShowersAlgorithm *const pAlgorithm, const pandora::ClusterList &clusterList, ClusterMergeMap &clusterMergeMap) const
 Populate the cluster merge map, based on the information contained in the provided cluster list. More...
 
bool ApplyChanges (ThreeViewShowersAlgorithm *const pAlgorithm, const ClusterMergeMap &clusterMergeMap) const
 Apply the changes cached in a cluster merge map and update the tensor accordingly. More...
 
pandora::StatusCode ReadSettings (const pandora::TiXmlHandle xmlHandle)
 

Private Attributes

unsigned int m_nCommonClusters
 The number of common clusters. More...
 
float m_minMatchedFraction
 The min matched sampling point fraction for use as a key tensor element. More...
 
unsigned int m_minMatchedSamplingPoints
 The min number of matched sampling points for use as a key tensor element. More...
 
bool m_checkClusterProximities
 Whether to check the proximities of the candidate split shower clusters. More...
 
float m_maxClusterSeparation
 The maximum separation for clusters to be merged. More...
 
bool m_checkClusterVertexRelations
 Whether to check the consistency of the clusters with the event vertex. More...
 
float m_minVertexLongitudinalDistance
 Vertex association check: min longitudinal distance cut. More...
 
float m_maxVertexLongitudinalDistance
 Vertex association check: max longitudinal distance cut. More...
 
float m_maxVertexTransverseDistance
 Vertex association check: max transverse distance cut. More...
 
float m_vertexAngularAllowance
 Vertex association check: pointing angular allowance in degrees. More...
 
unsigned int m_maxVertexAssociations
 The maximum number of vertex associations for clusters to be merged. More...
 
bool m_checkClusterSplitPositions
 Whether to check the cluster split positions, if there are splits in multiple views. More...
 
float m_vetoMergeXDifference
 The x distance between split positions in two views below which may refuse a merge. More...
 
float m_vetoMergeXOverlap
 The x overlap between candidate cluster sliding fits below which may refuse a merge. More...
 

Detailed Description

SplitShowersTool class.

Definition at line 19 of file SplitShowersTool.h.

Member Typedef Documentation

Constructor & Destructor Documentation

lar_content::SplitShowersTool::SplitShowersTool ( )

Default constructor.

Definition at line 24 of file SplitShowersTool.cc.

24  :
39 {
40 }
float m_maxVertexLongitudinalDistance
Vertex association check: max longitudinal distance cut.
float m_maxVertexTransverseDistance
Vertex association check: max transverse distance cut.
unsigned int m_nCommonClusters
The number of common clusters.
TFile f
Definition: plotHisto.C:6
bool m_checkClusterProximities
Whether to check the proximities of the candidate split shower clusters.
float m_vetoMergeXOverlap
The x overlap between candidate cluster sliding fits below which may refuse a merge.
unsigned int m_minMatchedSamplingPoints
The min number of matched sampling points for use as a key tensor element.
float m_maxClusterSeparation
The maximum separation for clusters to be merged.
bool m_checkClusterSplitPositions
Whether to check the cluster split positions, if there are splits in multiple views.
float m_vetoMergeXDifference
The x distance between split positions in two views below which may refuse a merge.
float m_minMatchedFraction
The min matched sampling point fraction for use as a key tensor element.
float m_vertexAngularAllowance
Vertex association check: pointing angular allowance in degrees.
float m_minVertexLongitudinalDistance
Vertex association check: min longitudinal distance cut.
bool m_checkClusterVertexRelations
Whether to check the consistency of the clusters with the event vertex.
unsigned int m_maxVertexAssociations
The maximum number of vertex associations for clusters to be merged.

Member Function Documentation

bool lar_content::SplitShowersTool::ApplyChanges ( ThreeViewShowersAlgorithm *const  pAlgorithm,
const ClusterMergeMap clusterMergeMap 
) const
private

Apply the changes cached in a cluster merge map and update the tensor accordingly.

Parameters
pAlgorithmaddress of the calling algorithm
clusterMergeMapthe cluster merge map
Returns
whether changes to the tensor have been made

Definition at line 366 of file SplitShowersTool.cc.

References lar_content::MatchingBaseAlgorithm::MakeClusterMerges(), and lar_content::LArClusterHelper::SortByNHits().

Referenced by Run().

367 {
368  ClusterMergeMap consolidatedMergeMap;
369 
370  ClusterList clusterList;
371  for (const auto &mapEntry : clusterMergeMap)
372  clusterList.push_back(mapEntry.first);
373  clusterList.sort(LArClusterHelper::SortByNHits);
374 
375  for (const Cluster *const pParentCluster : clusterList)
376  {
377  const ClusterList &daughterClusters(clusterMergeMap.at(pParentCluster));
378 
379  for (const Cluster *const pDaughterCluster : daughterClusters)
380  {
381  if (consolidatedMergeMap.count(pDaughterCluster))
382  throw StatusCodeException(STATUS_CODE_FAILURE);
383  }
384 
385  ClusterList &targetClusterList(consolidatedMergeMap[pParentCluster]);
386  targetClusterList.insert(targetClusterList.end(), daughterClusters.begin(), daughterClusters.end());
387  }
388 
389  return pAlgorithm->MakeClusterMerges(consolidatedMergeMap);
390 }
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.
std::unordered_map< const pandora::Cluster *, pandora::ClusterList > ClusterMergeMap
bool lar_content::SplitShowersTool::CheckClusterProximities ( ThreeViewShowersAlgorithm *const  pAlgorithm,
const pandora::ClusterList &  clusterList 
) const
private

Check the clusters in a provided cluster list are in suitable proximity for merging.

Parameters
pAlgorithmaddress of the calling algorithm
clusterListthe cluster list

Definition at line 221 of file SplitShowersTool.cc.

References lar_content::LArClusterHelper::GetClosestDistance(), and m_maxClusterSeparation.

Referenced by FindShowerMerges().

222 {
223  if (1 == clusterList.size())
224  return true;
225 
226  if (2 != clusterList.size())
227  throw StatusCodeException(STATUS_CODE_FAILURE);
228 
229  const Cluster *const pCluster1(*(clusterList.begin()));
230  const Cluster *const pCluster2(*(++(clusterList.begin())));
231 
232  const float outer12(LArClusterHelper::GetClosestDistance(pCluster1->GetCentroid(pCluster1->GetOuterPseudoLayer()), pCluster2));
233  const float outer21(LArClusterHelper::GetClosestDistance(pCluster2->GetCentroid(pCluster2->GetOuterPseudoLayer()), pCluster1));
234  const float inner12(LArClusterHelper::GetClosestDistance(pCluster1->GetCentroid(pCluster1->GetInnerPseudoLayer()), pCluster2));
235  const float inner21(LArClusterHelper::GetClosestDistance(pCluster2->GetCentroid(pCluster2->GetInnerPseudoLayer()), pCluster1));
236 
237  if ((outer12 > m_maxClusterSeparation) && (outer21 > m_maxClusterSeparation) && (inner12 > m_maxClusterSeparation) && (inner21 > m_maxClusterSeparation))
238  return false;
239 
240  return true;
241 }
float m_maxClusterSeparation
The maximum separation for clusters to be merged.
static float GetClosestDistance(const pandora::ClusterList &clusterList1, const pandora::ClusterList &clusterList2)
Get closest distance between clusters in a pair of cluster lists.
bool lar_content::SplitShowersTool::CheckClusterSplitPositions ( ThreeViewShowersAlgorithm *const  pAlgorithm,
const pandora::ClusterList &  clusterListU,
const pandora::ClusterList &  clusterListV,
const pandora::ClusterList &  clusterListW 
) const
private

Check the consistency of the split positions in the provided u, v and w cluster lists.

Parameters
pAlgorithmaddress of the calling algorithm
clusterListUthe u cluster list
clusterListVthe v cluster list
clusterListWthe w cluster list

Definition at line 288 of file SplitShowersTool.cc.

References f, GetSplitXDetails(), m_vetoMergeXDifference, and m_vetoMergeXOverlap.

Referenced by FindShowerMerges().

290 {
291  const unsigned int nClustersU(clusterListU.size()), nClustersV(clusterListV.size()), nClustersW(clusterListW.size());
292  const unsigned int nClustersProduct(nClustersU * nClustersV * nClustersW);
293 
294  if (2 == nClustersProduct)
295  return true;
296 
297  const ClusterList &clusterList1((1 == nClustersU) ? clusterListV : clusterListU);
298  const ClusterList &clusterList2((1 == nClustersU) ? clusterListW : (1 == nClustersV) ? clusterListW : clusterListV);
299 
300  if ((2 != clusterList1.size()) || (2 != clusterList2.size()))
301  throw StatusCodeException(STATUS_CODE_FAILURE);
302 
303  float splitXPosition1(0.f), overlapX1(0.f);
304  this->GetSplitXDetails(pAlgorithm, *(clusterList1.begin()), *(++(clusterList1.begin())), splitXPosition1, overlapX1);
305 
306  float splitXPosition2(0.f), overlapX2(0.f);
307  this->GetSplitXDetails(pAlgorithm, *(clusterList2.begin()), *(++(clusterList2.begin())), splitXPosition2, overlapX2);
308 
309  if ((std::fabs(splitXPosition1 - splitXPosition2) < m_vetoMergeXDifference) && (overlapX1 < m_vetoMergeXOverlap) && (overlapX2 < m_vetoMergeXOverlap))
310  return false;
311 
312  return true;
313 }
void GetSplitXDetails(ThreeViewShowersAlgorithm *const pAlgorithm, const pandora::Cluster *const pClusterA, const pandora::Cluster *const pClusterB, float &splitXPosition, float &overlapX) const
Get the x coordinate representing the midpoint between two clusters (hypothesis: clusters represent a...
TFile f
Definition: plotHisto.C:6
float m_vetoMergeXOverlap
The x overlap between candidate cluster sliding fits below which may refuse a merge.
float m_vetoMergeXDifference
The x distance between split positions in two views below which may refuse a merge.
bool lar_content::SplitShowersTool::CheckClusterVertexRelations ( ThreeViewShowersAlgorithm *const  pAlgorithm,
const pandora::ClusterList &  clusterList 
) const
private

Check the consistency of the clusters in a provided cluster list with the event vertex, if available.

Parameters
pAlgorithmaddress of the calling algorithm
clusterListthe cluster list

Definition at line 245 of file SplitShowersTool.cc.

References lar_content::ThreeViewShowersAlgorithm::GetCachedSlidingFitResult(), lar_content::LArClusterHelper::GetClusterHitType(), lar_content::TwoDSlidingShowerFitResult::GetShowerFitResult(), lar_content::LArPointingClusterHelper::IsEmission(), lar_content::LArPointingClusterHelper::IsNode(), m_maxVertexAssociations, m_maxVertexLongitudinalDistance, m_maxVertexTransverseDistance, m_minVertexLongitudinalDistance, m_vertexAngularAllowance, and lar_content::LArGeometryHelper::ProjectPosition().

Referenced by FindShowerMerges().

246 {
247  const VertexList *pVertexList(NULL);
248  PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::GetCurrentList(*pAlgorithm, pVertexList));
249  const Vertex *const pVertex(
250  ((pVertexList->size() == 1) && (VERTEX_3D == (*(pVertexList->begin()))->GetVertexType())) ? *(pVertexList->begin()) : NULL);
251 
252  if (NULL == pVertex)
253  return true;
254 
255  unsigned int nVertexAssociations(0);
256 
257  for (ClusterList::const_iterator iter = clusterList.begin(), iterEnd = clusterList.end(); iter != iterEnd; ++iter)
258  {
259  try
260  {
261  const HitType hitType(LArClusterHelper::GetClusterHitType(*iter));
262  const CartesianVector vertex2D(LArGeometryHelper::ProjectPosition(this->GetPandora(), pVertex->GetPosition(), hitType));
263  const LArPointingCluster pointingCluster(pAlgorithm->GetCachedSlidingFitResult(*iter).GetShowerFitResult());
264 
265  if (LArPointingClusterHelper::IsNode(vertex2D, pointingCluster.GetInnerVertex(), m_minVertexLongitudinalDistance, m_maxVertexTransverseDistance) ||
267  LArPointingClusterHelper::IsEmission(vertex2D, pointingCluster.GetInnerVertex(), m_minVertexLongitudinalDistance,
269  LArPointingClusterHelper::IsEmission(vertex2D, pointingCluster.GetOuterVertex(), m_minVertexLongitudinalDistance,
271  {
272  ++nVertexAssociations;
273  }
274  }
275  catch (StatusCodeException &)
276  {
277  }
278  }
279 
280  if (nVertexAssociations > m_maxVertexAssociations)
281  return false;
282 
283  return true;
284 }
float m_maxVertexLongitudinalDistance
Vertex association check: max longitudinal distance cut.
static bool IsEmission(const pandora::CartesianVector &parentVertex, const LArPointingCluster::Vertex &daughterVertex, const float minLongitudinalDistance, const float maxLongitudinalDistance, const float maxTransverseDistance, const float angularAllowance)
Whether pointing vertex is emitted from a given position.
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.
float m_maxVertexTransverseDistance
Vertex association check: max transverse distance cut.
HitType
Definition: HitType.h:12
float m_vertexAngularAllowance
Vertex association check: pointing angular allowance in degrees.
float m_minVertexLongitudinalDistance
Vertex association check: min longitudinal distance cut.
boost::graph_traits< ModuleGraph >::vertex_descriptor Vertex
Definition: ModuleGraph.h:25
std::list< Vertex > VertexList
Definition: DCEL.h:169
static bool IsNode(const pandora::CartesianVector &parentVertex, const LArPointingCluster::Vertex &daughterVertex, const float minLongitudinalDistance, const float maxTransverseDistance)
Whether pointing vertex is adjacent to a given position.
unsigned int m_maxVertexAssociations
The maximum number of vertex associations for clusters to be merged.
void lar_content::SplitShowersTool::FindShowerMerges ( ThreeViewShowersAlgorithm *const  pAlgorithm,
const IteratorList iteratorList,
pandora::ClusterSet &  usedClusters,
ClusterMergeMap clusterMergeMap 
) const
private

Get cluster merges specific elements of the tensor.

Parameters
pAlgorithmaddress of the calling algorithm
iteratorListlist of iterators to relevant tensor elements
usedClustersthe list of used clusters
clusterMergeMapto be populated with cluster merges

Definition at line 149 of file SplitShowersTool.cc.

References CheckClusterProximities(), CheckClusterSplitPositions(), CheckClusterVertexRelations(), m_checkClusterProximities, m_checkClusterSplitPositions, m_checkClusterVertexRelations, m_nCommonClusters, and SpecifyClusterMerges().

Referenced by FindSplitShowers().

151 {
152  for (IteratorList::const_iterator iIter1 = iteratorList.begin(), iIter1End = iteratorList.end(); iIter1 != iIter1End; ++iIter1)
153  {
154  for (IteratorList::const_iterator iIter2 = iIter1; iIter2 != iIter1End; ++iIter2)
155  {
156  try
157  {
158  if (iIter1 == iIter2)
159  continue;
160 
161  const TensorType::Element &element1(*(*iIter1));
162  const TensorType::Element &element2(*(*iIter2));
163 
164  ClusterList clusterListU(1, element1.GetClusterU());
165  if (element1.GetClusterU() != element2.GetClusterU())
166  clusterListU.push_back(element2.GetClusterU());
167 
168  ClusterList clusterListV(1, element1.GetClusterV());
169  if (element1.GetClusterV() != element2.GetClusterV())
170  clusterListV.push_back(element2.GetClusterV());
171 
172  ClusterList clusterListW(1, element1.GetClusterW());
173  if (element1.GetClusterW() != element2.GetClusterW())
174  clusterListW.push_back(element2.GetClusterW());
175 
176  const unsigned int nClustersU(clusterListU.size()), nClustersV(clusterListV.size()), nClustersW(clusterListW.size());
177  const unsigned int nClustersProduct(nClustersU * nClustersV * nClustersW);
178 
179  if (((1 == m_nCommonClusters) && (4 != nClustersProduct)) || ((2 == m_nCommonClusters) && (2 != nClustersProduct)))
180  throw StatusCodeException(STATUS_CODE_FAILURE);
181 
182  if ((1 == m_nCommonClusters) && !((2 == nClustersU) || (2 == nClustersV) || (2 == nClustersW)))
183  throw StatusCodeException(STATUS_CODE_FAILURE);
184 
186  (!this->CheckClusterProximities(pAlgorithm, clusterListU) || !this->CheckClusterProximities(pAlgorithm, clusterListV) ||
187  !this->CheckClusterProximities(pAlgorithm, clusterListW)))
188  {
189  continue;
190  }
191 
193  (!this->CheckClusterVertexRelations(pAlgorithm, clusterListU) || !this->CheckClusterVertexRelations(pAlgorithm, clusterListV) ||
194  !this->CheckClusterVertexRelations(pAlgorithm, clusterListW)))
195  {
196  continue;
197  }
198 
199  if (m_checkClusterSplitPositions && !this->CheckClusterSplitPositions(pAlgorithm, clusterListU, clusterListV, clusterListW))
200  {
201  continue;
202  }
203 
204  this->SpecifyClusterMerges(pAlgorithm, clusterListU, clusterMergeMap);
205  this->SpecifyClusterMerges(pAlgorithm, clusterListV, clusterMergeMap);
206  this->SpecifyClusterMerges(pAlgorithm, clusterListW, clusterMergeMap);
207 
208  usedClusters.insert(clusterListU.begin(), clusterListU.end());
209  usedClusters.insert(clusterListV.begin(), clusterListV.end());
210  usedClusters.insert(clusterListW.begin(), clusterListW.end());
211  }
212  catch (StatusCodeException &)
213  {
214  }
215  }
216  }
217 }
bool CheckClusterVertexRelations(ThreeViewShowersAlgorithm *const pAlgorithm, const pandora::ClusterList &clusterList) const
Check the consistency of the clusters in a provided cluster list with the event vertex, if available.
intermediate_table::const_iterator const_iterator
bool CheckClusterProximities(ThreeViewShowersAlgorithm *const pAlgorithm, const pandora::ClusterList &clusterList) const
Check the clusters in a provided cluster list are in suitable proximity for merging.
unsigned int m_nCommonClusters
The number of common clusters.
bool m_checkClusterProximities
Whether to check the proximities of the candidate split shower clusters.
bool CheckClusterSplitPositions(ThreeViewShowersAlgorithm *const pAlgorithm, const pandora::ClusterList &clusterListU, const pandora::ClusterList &clusterListV, const pandora::ClusterList &clusterListW) const
Check the consistency of the split positions in the provided u, v and w cluster lists.
void SpecifyClusterMerges(ThreeViewShowersAlgorithm *const pAlgorithm, const pandora::ClusterList &clusterList, ClusterMergeMap &clusterMergeMap) const
Populate the cluster merge map, based on the information contained in the provided cluster list...
bool m_checkClusterSplitPositions
Whether to check the cluster split positions, if there are splits in multiple views.
bool m_checkClusterVertexRelations
Whether to check the consistency of the clusters with the event vertex.
void lar_content::SplitShowersTool::FindSplitShowers ( ThreeViewShowersAlgorithm *const  pAlgorithm,
const TensorType overlapTensor,
ClusterMergeMap clusterMergeMap 
) const
private

Find split showers, using information from the overlap tensor.

Parameters
pAlgorithmaddress of the calling algorithm
overlapTensorthe overlap tensor
clusterMergeMapto receive the list of cluster merges

Definition at line 57 of file SplitShowersTool.cc.

References FindShowerMerges(), lar_content::OverlapTensor< T >::GetConnectedElements(), lar_content::OverlapTensor< T >::GetSortedKeyClusters(), PassesElementCuts(), and SelectTensorElements().

Referenced by Run().

58 {
59  ClusterSet usedClusters;
60  ClusterVector sortedKeyClusters;
61  overlapTensor.GetSortedKeyClusters(sortedKeyClusters);
62 
63  for (const Cluster *const pKeyCluster : sortedKeyClusters)
64  {
65  if (!pKeyCluster->IsAvailable())
66  continue;
67 
68  unsigned int nU(0), nV(0), nW(0);
69  TensorType::ElementList elementList;
70  overlapTensor.GetConnectedElements(pKeyCluster, true, elementList, nU, nV, nW);
71 
72  if (nU * nV * nW < 2)
73  continue;
74 
75  for (TensorType::ElementList::const_iterator eIter = elementList.begin(); eIter != elementList.end(); ++eIter)
76  {
77  if (!this->PassesElementCuts(eIter, usedClusters))
78  continue;
79 
80  IteratorList iteratorList;
81  this->SelectTensorElements(eIter, elementList, usedClusters, iteratorList);
82 
83  if (iteratorList.size() < 2)
84  continue;
85 
86  this->FindShowerMerges(pAlgorithm, iteratorList, usedClusters, clusterMergeMap);
87  }
88  }
89 }
intermediate_table::const_iterator const_iterator
std::vector< TensorType::ElementList::const_iterator > IteratorList
void FindShowerMerges(ThreeViewShowersAlgorithm *const pAlgorithm, const IteratorList &iteratorList, pandora::ClusterSet &usedClusters, ClusterMergeMap &clusterMergeMap) const
Get cluster merges specific elements of the tensor.
bool PassesElementCuts(TensorType::ElementList::const_iterator eIter, const pandora::ClusterSet &usedClusters) const
Whether a provided (iterator to a) tensor element passes the selection cuts for undershoots identific...
std::vector< art::Ptr< recob::Cluster > > ClusterVector
void SelectTensorElements(TensorType::ElementList::const_iterator eIter, const TensorType::ElementList &elementList, const pandora::ClusterSet &usedClusters, IteratorList &iteratorList) const
Select elements representing possible components of interest due to undershoots in clustering...
void lar_content::SplitShowersTool::GetSplitXDetails ( ThreeViewShowersAlgorithm *const  pAlgorithm,
const pandora::Cluster *const  pClusterA,
const pandora::Cluster *const  pClusterB,
float &  splitXPosition,
float &  overlapX 
) const
private

Get the x coordinate representing the midpoint between two clusters (hypothesis: clusters represent a split shower)

Parameters
pAlgorithmaddress of the calling algorithm
pClusterAthe address of cluster A
pClusterBthe address of cluster B
splitXPositionto receive the split position estimate
overlapXto receive the overlap estimate

Definition at line 317 of file SplitShowersTool.cc.

References f, lar_content::ThreeViewShowersAlgorithm::GetCachedSlidingFitResult(), and lar_content::TwoDSlidingShowerFitResult::GetShowerFitResult().

Referenced by CheckClusterSplitPositions().

319 {
320  const TwoDSlidingFitResult &fitResultA(pAlgorithm->GetCachedSlidingFitResult(pClusterA).GetShowerFitResult());
321  const TwoDSlidingFitResult &fitResultB(pAlgorithm->GetCachedSlidingFitResult(pClusterB).GetShowerFitResult());
322 
323  const float minXA(std::min(fitResultA.GetGlobalMinLayerPosition().GetX(), fitResultA.GetGlobalMaxLayerPosition().GetX()));
324  const float maxXA(std::max(fitResultA.GetGlobalMinLayerPosition().GetX(), fitResultA.GetGlobalMaxLayerPosition().GetX()));
325  const float minXB(std::min(fitResultB.GetGlobalMinLayerPosition().GetX(), fitResultB.GetGlobalMaxLayerPosition().GetX()));
326  const float maxXB(std::max(fitResultB.GetGlobalMinLayerPosition().GetX(), fitResultB.GetGlobalMaxLayerPosition().GetX()));
327 
328  FloatVector floatVector;
329  floatVector.push_back(minXA);
330  floatVector.push_back(maxXA);
331  floatVector.push_back(minXB);
332  floatVector.push_back(maxXB);
333  std::sort(floatVector.begin(), floatVector.end());
334 
335  if (4 != floatVector.size())
336  throw StatusCodeException(STATUS_CODE_FAILURE);
337 
338  splitXPosition = 0.5f * (floatVector.at(1) + floatVector.at(2));
339  overlapX = std::max(0.f, std::min(maxXA, maxXB) - std::max(minXA, minXB));
340 }
TFile f
Definition: plotHisto.C:6
bool lar_content::SplitShowersTool::PassesElementCuts ( TensorType::ElementList::const_iterator  eIter,
const pandora::ClusterSet &  usedClusters 
) const
private

Whether a provided (iterator to a) tensor element passes the selection cuts for undershoots identification.

Parameters
eIterthe iterator to the tensor element
usedClustersthe list of used clusters

Definition at line 93 of file SplitShowersTool.cc.

References m_minMatchedFraction, and m_minMatchedSamplingPoints.

Referenced by FindSplitShowers(), and SelectTensorElements().

94 {
95  if (usedClusters.count(eIter->GetClusterU()) || usedClusters.count(eIter->GetClusterV()) || usedClusters.count(eIter->GetClusterW()))
96  return false;
97 
98  if (eIter->GetOverlapResult().GetMatchedFraction() < m_minMatchedFraction)
99  return false;
100 
101  if (eIter->GetOverlapResult().GetNMatchedSamplingPoints() < m_minMatchedSamplingPoints)
102  return false;
103 
104  return true;
105 }
unsigned int m_minMatchedSamplingPoints
The min number of matched sampling points for use as a key tensor element.
float m_minMatchedFraction
The min matched sampling point fraction for use as a key tensor element.
StatusCode lar_content::SplitShowersTool::ReadSettings ( const pandora::TiXmlHandle  xmlHandle)
private

Definition at line 394 of file SplitShowersTool.cc.

References m_checkClusterProximities, m_checkClusterSplitPositions, m_checkClusterVertexRelations, m_maxClusterSeparation, m_maxVertexAssociations, m_maxVertexLongitudinalDistance, m_maxVertexTransverseDistance, m_minMatchedFraction, m_minMatchedSamplingPoints, m_minVertexLongitudinalDistance, m_nCommonClusters, m_vertexAngularAllowance, m_vetoMergeXDifference, and m_vetoMergeXOverlap.

395 {
396  PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "NCommonClusters", m_nCommonClusters));
397 
398  if ((1 != m_nCommonClusters) && (2 != m_nCommonClusters))
399  {
400  std::cout << "SplitShowersTool: NCommonClusters must be set to either 1 or 2 (provided: " << m_nCommonClusters << ") " << std::endl;
401  return STATUS_CODE_INVALID_PARAMETER;
402  }
403 
404  PANDORA_RETURN_RESULT_IF_AND_IF(
405  STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "MinMatchedFraction", m_minMatchedFraction));
406 
407  PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=,
408  XmlHelper::ReadValue(xmlHandle, "MinMatchedSamplingPoints", m_minMatchedSamplingPoints));
409 
410  PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=,
411  XmlHelper::ReadValue(xmlHandle, "CheckClusterProximities", m_checkClusterProximities));
412 
413  PANDORA_RETURN_RESULT_IF_AND_IF(
414  STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "MaxClusterSeparation", m_maxClusterSeparation));
415 
416  PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=,
417  XmlHelper::ReadValue(xmlHandle, "CheckClusterVertexRelations", m_checkClusterVertexRelations));
418 
419  PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=,
420  XmlHelper::ReadValue(xmlHandle, "MinVertexLongitudinalDistance", m_minVertexLongitudinalDistance));
421 
422  PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=,
423  XmlHelper::ReadValue(xmlHandle, "MaxVertexLongitudinalDistance", m_maxVertexLongitudinalDistance));
424 
425  PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=,
426  XmlHelper::ReadValue(xmlHandle, "MaxVertexTransverseDistance", m_maxVertexTransverseDistance));
427 
428  PANDORA_RETURN_RESULT_IF_AND_IF(
429  STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "VertexAngularAllowance", m_vertexAngularAllowance));
430 
431  PANDORA_RETURN_RESULT_IF_AND_IF(
432  STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "MaxVertexAssociations", m_maxVertexAssociations));
433 
434  PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=,
435  XmlHelper::ReadValue(xmlHandle, "CheckClusterSplitPositions", m_checkClusterSplitPositions));
436 
437  PANDORA_RETURN_RESULT_IF_AND_IF(
438  STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "VetoMergeXDifference", m_vetoMergeXDifference));
439 
440  PANDORA_RETURN_RESULT_IF_AND_IF(
441  STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "VetoMergeXOverlap", m_vetoMergeXOverlap));
442 
443  return STATUS_CODE_SUCCESS;
444 }
float m_maxVertexLongitudinalDistance
Vertex association check: max longitudinal distance cut.
float m_maxVertexTransverseDistance
Vertex association check: max transverse distance cut.
unsigned int m_nCommonClusters
The number of common clusters.
bool m_checkClusterProximities
Whether to check the proximities of the candidate split shower clusters.
float m_vetoMergeXOverlap
The x overlap between candidate cluster sliding fits below which may refuse a merge.
unsigned int m_minMatchedSamplingPoints
The min number of matched sampling points for use as a key tensor element.
float m_maxClusterSeparation
The maximum separation for clusters to be merged.
bool m_checkClusterSplitPositions
Whether to check the cluster split positions, if there are splits in multiple views.
float m_vetoMergeXDifference
The x distance between split positions in two views below which may refuse a merge.
float m_minMatchedFraction
The min matched sampling point fraction for use as a key tensor element.
float m_vertexAngularAllowance
Vertex association check: pointing angular allowance in degrees.
float m_minVertexLongitudinalDistance
Vertex association check: min longitudinal distance cut.
bool m_checkClusterVertexRelations
Whether to check the consistency of the clusters with the event vertex.
unsigned int m_maxVertexAssociations
The maximum number of vertex associations for clusters to be merged.
bool lar_content::SplitShowersTool::Run ( ThreeViewShowersAlgorithm *const  pAlgorithm,
TensorType overlapTensor 
)
virtual

Run the algorithm tool.

Parameters
pAlgorithmaddress of the calling algorithm
overlapTensorthe overlap tensor
Returns
whether changes have been made by the tool

Implements lar_content::ShowerTensorTool.

Definition at line 44 of file SplitShowersTool.cc.

References ApplyChanges(), and FindSplitShowers().

45 {
46  if (PandoraContentApi::GetSettings(*pAlgorithm)->ShouldDisplayAlgorithmInfo())
47  std::cout << "----> Running Algorithm Tool: " << this->GetInstanceName() << ", " << this->GetType() << std::endl;
48 
49  ClusterMergeMap clusterMergeMap;
50  this->FindSplitShowers(pAlgorithm, overlapTensor, clusterMergeMap);
51 
52  return this->ApplyChanges(pAlgorithm, clusterMergeMap);
53 }
void FindSplitShowers(ThreeViewShowersAlgorithm *const pAlgorithm, const TensorType &overlapTensor, ClusterMergeMap &clusterMergeMap) const
Find split showers, using information from the overlap tensor.
bool ApplyChanges(ThreeViewShowersAlgorithm *const pAlgorithm, const ClusterMergeMap &clusterMergeMap) const
Apply the changes cached in a cluster merge map and update the tensor accordingly.
std::unordered_map< const pandora::Cluster *, pandora::ClusterList > ClusterMergeMap
void lar_content::SplitShowersTool::SelectTensorElements ( TensorType::ElementList::const_iterator  eIter,
const TensorType::ElementList elementList,
const pandora::ClusterSet &  usedClusters,
IteratorList iteratorList 
) const
private

Select elements representing possible components of interest due to undershoots in clustering.

Parameters
eIteriterator to a candidate element
elementListthe provided element list
usedClustersthe list of used clusters
iteratorListto receive a list of iterators to relevant elements

Definition at line 109 of file SplitShowersTool.cc.

References m_nCommonClusters, and PassesElementCuts().

Referenced by FindSplitShowers().

111 {
112  iteratorList.push_back(eIter);
113 
114  for (TensorType::ElementList::const_iterator eIter2 = elementList.begin(); eIter2 != elementList.end(); ++eIter2)
115  {
116  if (eIter == eIter2)
117  continue;
118 
119  if (!this->PassesElementCuts(eIter2, usedClusters))
120  continue;
121 
122  for (IteratorList::const_iterator iIter = iteratorList.begin(); iIter != iteratorList.end(); ++iIter)
123  {
124  if ((*iIter) == eIter2)
125  continue;
126 
127  unsigned int nMatchedClusters(0);
128 
129  if ((*iIter)->GetClusterU() == eIter2->GetClusterU())
130  ++nMatchedClusters;
131 
132  if ((*iIter)->GetClusterV() == eIter2->GetClusterV())
133  ++nMatchedClusters;
134 
135  if ((*iIter)->GetClusterW() == eIter2->GetClusterW())
136  ++nMatchedClusters;
137 
138  if (m_nCommonClusters == nMatchedClusters)
139  {
140  iteratorList.push_back(eIter2);
141  return;
142  }
143  }
144  }
145 }
intermediate_table::const_iterator const_iterator
unsigned int m_nCommonClusters
The number of common clusters.
bool PassesElementCuts(TensorType::ElementList::const_iterator eIter, const pandora::ClusterSet &usedClusters) const
Whether a provided (iterator to a) tensor element passes the selection cuts for undershoots identific...
void lar_content::SplitShowersTool::SpecifyClusterMerges ( ThreeViewShowersAlgorithm *const  pAlgorithm,
const pandora::ClusterList &  clusterList,
ClusterMergeMap clusterMergeMap 
) const
private

Populate the cluster merge map, based on the information contained in the provided cluster list.

Parameters
pAlgorithmaddress of the calling algorithm
clusterListthe cluster list
clusterMergeMapto receive the populated cluster merge map

Definition at line 344 of file SplitShowersTool.cc.

References lar_content::ThreeViewShowersAlgorithm::GetCachedSlidingFitResult(), and lar_content::TwoDSlidingShowerFitResult::GetShowerFitResult().

Referenced by FindShowerMerges().

345 {
346  if (1 == clusterList.size())
347  return;
348 
349  if (2 != clusterList.size())
350  throw StatusCodeException(STATUS_CODE_FAILURE);
351 
352  const Cluster *const pClusterA(*(clusterList.begin())), *const pClusterB(*(++(clusterList.begin())));
353  const TwoDSlidingFitResult &fitResultA(pAlgorithm->GetCachedSlidingFitResult(pClusterA).GetShowerFitResult());
354  const TwoDSlidingFitResult &fitResultB(pAlgorithm->GetCachedSlidingFitResult(pClusterB).GetShowerFitResult());
355 
356  const float minXA(std::min(fitResultA.GetGlobalMinLayerPosition().GetX(), fitResultA.GetGlobalMaxLayerPosition().GetX()));
357  const float minXB(std::min(fitResultB.GetGlobalMinLayerPosition().GetX(), fitResultB.GetGlobalMaxLayerPosition().GetX()));
358 
359  const Cluster *const pLowXCluster((minXA < minXB) ? pClusterA : pClusterB);
360  const Cluster *const pHighXCluster((minXA < minXB) ? pClusterB : pClusterA);
361  clusterMergeMap[pLowXCluster].push_back(pHighXCluster);
362 }

Member Data Documentation

bool lar_content::SplitShowersTool::m_checkClusterProximities
private

Whether to check the proximities of the candidate split shower clusters.

Definition at line 133 of file SplitShowersTool.h.

Referenced by FindShowerMerges(), and ReadSettings().

bool lar_content::SplitShowersTool::m_checkClusterSplitPositions
private

Whether to check the cluster split positions, if there are splits in multiple views.

Definition at line 143 of file SplitShowersTool.h.

Referenced by FindShowerMerges(), and ReadSettings().

bool lar_content::SplitShowersTool::m_checkClusterVertexRelations
private

Whether to check the consistency of the clusters with the event vertex.

Definition at line 136 of file SplitShowersTool.h.

Referenced by FindShowerMerges(), and ReadSettings().

float lar_content::SplitShowersTool::m_maxClusterSeparation
private

The maximum separation for clusters to be merged.

Definition at line 134 of file SplitShowersTool.h.

Referenced by CheckClusterProximities(), and ReadSettings().

unsigned int lar_content::SplitShowersTool::m_maxVertexAssociations
private

The maximum number of vertex associations for clusters to be merged.

Definition at line 141 of file SplitShowersTool.h.

Referenced by CheckClusterVertexRelations(), and ReadSettings().

float lar_content::SplitShowersTool::m_maxVertexLongitudinalDistance
private

Vertex association check: max longitudinal distance cut.

Definition at line 138 of file SplitShowersTool.h.

Referenced by CheckClusterVertexRelations(), and ReadSettings().

float lar_content::SplitShowersTool::m_maxVertexTransverseDistance
private

Vertex association check: max transverse distance cut.

Definition at line 139 of file SplitShowersTool.h.

Referenced by CheckClusterVertexRelations(), and ReadSettings().

float lar_content::SplitShowersTool::m_minMatchedFraction
private

The min matched sampling point fraction for use as a key tensor element.

Definition at line 130 of file SplitShowersTool.h.

Referenced by PassesElementCuts(), and ReadSettings().

unsigned int lar_content::SplitShowersTool::m_minMatchedSamplingPoints
private

The min number of matched sampling points for use as a key tensor element.

Definition at line 131 of file SplitShowersTool.h.

Referenced by PassesElementCuts(), and ReadSettings().

float lar_content::SplitShowersTool::m_minVertexLongitudinalDistance
private

Vertex association check: min longitudinal distance cut.

Definition at line 137 of file SplitShowersTool.h.

Referenced by CheckClusterVertexRelations(), and ReadSettings().

unsigned int lar_content::SplitShowersTool::m_nCommonClusters
private

The number of common clusters.

Definition at line 129 of file SplitShowersTool.h.

Referenced by FindShowerMerges(), ReadSettings(), and SelectTensorElements().

float lar_content::SplitShowersTool::m_vertexAngularAllowance
private

Vertex association check: pointing angular allowance in degrees.

Definition at line 140 of file SplitShowersTool.h.

Referenced by CheckClusterVertexRelations(), and ReadSettings().

float lar_content::SplitShowersTool::m_vetoMergeXDifference
private

The x distance between split positions in two views below which may refuse a merge.

Definition at line 144 of file SplitShowersTool.h.

Referenced by CheckClusterSplitPositions(), and ReadSettings().

float lar_content::SplitShowersTool::m_vetoMergeXOverlap
private

The x overlap between candidate cluster sliding fits below which may refuse a merge.

Definition at line 145 of file SplitShowersTool.h.

Referenced by CheckClusterSplitPositions(), and ReadSettings().


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