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

TwoViewDeltaRayOverlapResult class. More...

#include "LArTrackTwoViewOverlapResult.h"

Public Member Functions

 TwoViewDeltaRayOverlapResult ()
 Default constructor. More...
 
 TwoViewDeltaRayOverlapResult (const TwoViewXOverlap &xOverlap, const pandora::PfoList &commonMuonPfoList, const pandora::Cluster *const pBestMatchedCluster, const pandora::ClusterList &matchedClusterList, const float reducedChiSquared)
 Constructor. More...
 
 TwoViewDeltaRayOverlapResult (const TwoViewDeltaRayOverlapResult &rhs)
 Copy constructor. More...
 
virtual ~TwoViewDeltaRayOverlapResult ()
 Destructor. More...
 
bool IsInitialized () const
 Whether the track overlap result has been initialized. More...
 
const TwoViewXOverlapGetXOverlap () const
 Get the x overlap object. More...
 
const pandora::Cluster * GetBestMatchedCluster () const
 Get the best matched cluster. More...
 
const pandora::PfoList & GetCommonMuonPfoList () const
 Get the common muon pfo list. More...
 
const pandora::ClusterList & GetMatchedClusterList () const
 Get the matched cluster list. More...
 
float GetReducedChiSquared () const
 Get the reduced chi squared value. More...
 
const pandora::Cluster * GetBestMatchedAvailableCluster () const
 Get the best matched available cluster. More...
 
TwoViewDeltaRayOverlapResultoperator= (const TwoViewDeltaRayOverlapResult &rhs)
 Track overlap result assigment operator. More...
 
bool operator< (const TwoViewDeltaRayOverlapResult &rhs) const
 Track two view overlap result less than operator. More...
 

Private Attributes

bool m_isInitialized
 Whether the two view delta ray overlap result has been initialized. More...
 
TwoViewXOverlap m_xOverlap
 The x overlap object. More...
 
pandora::PfoList m_commonMuonPfoList
 The list of muon pfos whose clusters lie close to delta ray clusters in all views. More...
 
const pandora::Cluster * m_pBestMatchedCluster
 The largest cluster that lies on the projected hits. More...
 
pandora::ClusterList m_matchedClusterList
 The list of clusters that lie on the projected hits. More...
 
float m_reducedChiSquared
 The reduced chi squared of the best matched cluster. More...
 

Detailed Description

Constructor & Destructor Documentation

lar_content::TwoViewDeltaRayOverlapResult::TwoViewDeltaRayOverlapResult ( )

Default constructor.

Definition at line 17 of file LArTrackTwoViewOverlapResult.cc.

References m_commonMuonPfoList, m_isInitialized, m_matchedClusterList, m_pBestMatchedCluster, m_reducedChiSquared, and m_xOverlap.

17  :
18  m_isInitialized(false),
19  m_xOverlap(TwoViewXOverlap(0.f, 0.f, 0.f, 0.f)),
21  m_pBestMatchedCluster(nullptr),
23  m_reducedChiSquared(std::numeric_limits<float>::max())
24 {
25 }
pandora::ClusterList m_matchedClusterList
The list of clusters that lie on the projected hits.
float m_reducedChiSquared
The reduced chi squared of the best matched cluster.
pandora::PfoList m_commonMuonPfoList
The list of muon pfos whose clusters lie close to delta ray clusters in all views.
TFile f
Definition: plotHisto.C:6
TwoViewXOverlap m_xOverlap
The x overlap object.
const pandora::Cluster * m_pBestMatchedCluster
The largest cluster that lies on the projected hits.
bool m_isInitialized
Whether the two view delta ray overlap result has been initialized.
lar_content::TwoViewDeltaRayOverlapResult::TwoViewDeltaRayOverlapResult ( const TwoViewXOverlap xOverlap,
const pandora::PfoList &  commonMuonPfoList,
const pandora::Cluster *const  pBestMatchedCluster,
const pandora::ClusterList &  matchedClusterList,
const float  reducedChiSquared 
)

Constructor.

Parameters
xOverlapthe xOverlap of the two clusters
commonMuonPfoListthe list of muon pfos whose clusters lie close to delta ray clusters in all views
pBestMatchedClusterthe largest cluster that lies on the projected hits
matchedClusterListthe list of clusters that lie on the projected hits
reducedChiSquaredthe reduced chi squared
lar_content::TwoViewDeltaRayOverlapResult::TwoViewDeltaRayOverlapResult ( const TwoViewDeltaRayOverlapResult rhs)

Copy constructor.

Parameters
rhs

Definition at line 42 of file LArTrackTwoViewOverlapResult.cc.

42  :
43  m_isInitialized(rhs.m_isInitialized),
44  m_xOverlap(rhs.GetXOverlap()),
45  m_commonMuonPfoList(rhs.GetCommonMuonPfoList()),
46  m_pBestMatchedCluster(rhs.GetBestMatchedCluster()),
47  m_matchedClusterList(rhs.GetMatchedClusterList()),
48  m_reducedChiSquared(rhs.GetReducedChiSquared())
49 {
50 }
pandora::ClusterList m_matchedClusterList
The list of clusters that lie on the projected hits.
float m_reducedChiSquared
The reduced chi squared of the best matched cluster.
pandora::PfoList m_commonMuonPfoList
The list of muon pfos whose clusters lie close to delta ray clusters in all views.
TwoViewXOverlap m_xOverlap
The x overlap object.
const pandora::Cluster * m_pBestMatchedCluster
The largest cluster that lies on the projected hits.
bool m_isInitialized
Whether the two view delta ray overlap result has been initialized.
lar_content::TwoViewDeltaRayOverlapResult::~TwoViewDeltaRayOverlapResult ( )
virtual

Destructor.

Definition at line 54 of file LArTrackTwoViewOverlapResult.cc.

55 {
56 }

Member Function Documentation

const Cluster * lar_content::TwoViewDeltaRayOverlapResult::GetBestMatchedAvailableCluster ( ) const

Get the best matched available cluster.

Returns
the best matched available cluster

Definition at line 60 of file LArTrackTwoViewOverlapResult.cc.

References m_matchedClusterList.

61 {
62  unsigned int highestNHits(0);
63  const Cluster *pBestMatchedCluster(nullptr);
64 
65  for (const Cluster *const pMatchedCluster : m_matchedClusterList)
66  {
67  if (!pMatchedCluster->IsAvailable())
68  continue;
69 
70  if (pMatchedCluster->GetNCaloHits() > highestNHits)
71  {
72  highestNHits = pMatchedCluster->GetNCaloHits();
73  pBestMatchedCluster = pMatchedCluster;
74  }
75  }
76 
77  return pBestMatchedCluster;
78 }
pandora::ClusterList m_matchedClusterList
The list of clusters that lie on the projected hits.
const pandora::Cluster * lar_content::TwoViewDeltaRayOverlapResult::GetBestMatchedCluster ( ) const
inline

Get the best matched cluster.

Returns
the best matched cluster

Definition at line 327 of file LArTrackTwoViewOverlapResult.h.

References m_pBestMatchedCluster.

Referenced by operator=().

328 {
329  return m_pBestMatchedCluster;
330 }
const pandora::Cluster * m_pBestMatchedCluster
The largest cluster that lies on the projected hits.
const pandora::PfoList & lar_content::TwoViewDeltaRayOverlapResult::GetCommonMuonPfoList ( ) const
inline

Get the common muon pfo list.

Returns
the common muon pfo list

Definition at line 334 of file LArTrackTwoViewOverlapResult.h.

References m_commonMuonPfoList.

Referenced by operator=(), and lar_content::TwoViewDeltaRayMatchingAlgorithm::UpdateForThirdViewClusterModification().

335 {
336  return m_commonMuonPfoList;
337 }
pandora::PfoList m_commonMuonPfoList
The list of muon pfos whose clusters lie close to delta ray clusters in all views.
const pandora::ClusterList & lar_content::TwoViewDeltaRayOverlapResult::GetMatchedClusterList ( ) const
inline

Get the matched cluster list.

Returns
the matched cluster list

Definition at line 341 of file LArTrackTwoViewOverlapResult.h.

References m_matchedClusterList.

Referenced by operator=(), and lar_content::TwoViewDeltaRayMatchingAlgorithm::UpdateForThirdViewClusterModification().

342 {
343  return m_matchedClusterList;
344 }
pandora::ClusterList m_matchedClusterList
The list of clusters that lie on the projected hits.
float lar_content::TwoViewDeltaRayOverlapResult::GetReducedChiSquared ( ) const
inline

Get the reduced chi squared value.

Returns
the reduced chi squared value

Definition at line 348 of file LArTrackTwoViewOverlapResult.h.

References m_reducedChiSquared.

Referenced by operator=().

349 {
350  return m_reducedChiSquared;
351 }
float m_reducedChiSquared
The reduced chi squared of the best matched cluster.
const TwoViewXOverlap & lar_content::TwoViewDeltaRayOverlapResult::GetXOverlap ( ) const
inline

Get the x overlap object.

Returns
the x overlap object

Definition at line 320 of file LArTrackTwoViewOverlapResult.h.

References m_xOverlap.

Referenced by operator=(), and lar_content::TwoViewDeltaRayMatchingAlgorithm::UpdateForThirdViewClusterModification().

321 {
322  return m_xOverlap;
323 }
TwoViewXOverlap m_xOverlap
The x overlap object.
bool lar_content::TwoViewDeltaRayOverlapResult::IsInitialized ( ) const
inline

Whether the track overlap result has been initialized.

Returns
boolean

Definition at line 313 of file LArTrackTwoViewOverlapResult.h.

References m_isInitialized.

Referenced by lar_content::TwoViewDeltaRayMatchingAlgorithm::DoesClusterPassTensorThreshold().

314 {
315  return m_isInitialized;
316 }
bool m_isInitialized
Whether the two view delta ray overlap result has been initialized.
bool lar_content::TwoViewDeltaRayOverlapResult::operator< ( const TwoViewDeltaRayOverlapResult rhs) const

Track two view overlap result less than operator.

Parameters
rhsthe track two view overlap result for comparison

Definition at line 96 of file LArTrackTwoViewOverlapResult.cc.

References lar_content::TwoViewXOverlap::GetTwoViewXOverlapSpan(), m_isInitialized, and m_xOverlap.

97 {
98  if (this == &rhs)
99  return false;
100 
101  if (!m_isInitialized && !rhs.m_isInitialized)
102  throw StatusCodeException(STATUS_CODE_NOT_INITIALIZED);
103 
104  if (!m_isInitialized)
105  return true;
106 
107  if (!rhs.m_isInitialized)
108  return false;
109 
110  return (m_xOverlap.GetTwoViewXOverlapSpan() < rhs.m_xOverlap.GetTwoViewXOverlapSpan());
111 }
TwoViewXOverlap m_xOverlap
The x overlap object.
float GetTwoViewXOverlapSpan() const
Get the x overlap span.
bool m_isInitialized
Whether the two view delta ray overlap result has been initialized.
TwoViewDeltaRayOverlapResult & lar_content::TwoViewDeltaRayOverlapResult::operator= ( const TwoViewDeltaRayOverlapResult rhs)

Track overlap result assigment operator.

Parameters
rhsthe track overlap result to assign

Definition at line 82 of file LArTrackTwoViewOverlapResult.cc.

References GetBestMatchedCluster(), GetCommonMuonPfoList(), GetMatchedClusterList(), GetReducedChiSquared(), GetXOverlap(), m_commonMuonPfoList, m_isInitialized, m_matchedClusterList, m_pBestMatchedCluster, m_reducedChiSquared, and m_xOverlap.

83 {
84  m_isInitialized = rhs.m_isInitialized;
85  m_xOverlap = rhs.GetXOverlap();
86  m_commonMuonPfoList = rhs.GetCommonMuonPfoList();
87  m_pBestMatchedCluster = rhs.GetBestMatchedCluster();
88  m_matchedClusterList = rhs.GetMatchedClusterList();
89  m_reducedChiSquared = rhs.GetReducedChiSquared();
90 
91  return *this;
92 }
pandora::ClusterList m_matchedClusterList
The list of clusters that lie on the projected hits.
float m_reducedChiSquared
The reduced chi squared of the best matched cluster.
pandora::PfoList m_commonMuonPfoList
The list of muon pfos whose clusters lie close to delta ray clusters in all views.
TwoViewXOverlap m_xOverlap
The x overlap object.
const pandora::Cluster * m_pBestMatchedCluster
The largest cluster that lies on the projected hits.
bool m_isInitialized
Whether the two view delta ray overlap result has been initialized.

Member Data Documentation

pandora::PfoList lar_content::TwoViewDeltaRayOverlapResult::m_commonMuonPfoList
private

The list of muon pfos whose clusters lie close to delta ray clusters in all views.

Definition at line 121 of file LArTrackTwoViewOverlapResult.h.

Referenced by GetCommonMuonPfoList(), operator=(), and TwoViewDeltaRayOverlapResult().

pandora::ClusterList lar_content::TwoViewDeltaRayOverlapResult::m_matchedClusterList
private

The list of clusters that lie on the projected hits.

Definition at line 123 of file LArTrackTwoViewOverlapResult.h.

Referenced by GetBestMatchedAvailableCluster(), GetMatchedClusterList(), operator=(), and TwoViewDeltaRayOverlapResult().

const pandora::Cluster* lar_content::TwoViewDeltaRayOverlapResult::m_pBestMatchedCluster
private

The largest cluster that lies on the projected hits.

Definition at line 122 of file LArTrackTwoViewOverlapResult.h.

Referenced by GetBestMatchedCluster(), operator=(), and TwoViewDeltaRayOverlapResult().

float lar_content::TwoViewDeltaRayOverlapResult::m_reducedChiSquared
private

The reduced chi squared of the best matched cluster.

Definition at line 124 of file LArTrackTwoViewOverlapResult.h.

Referenced by GetReducedChiSquared(), operator=(), and TwoViewDeltaRayOverlapResult().

TwoViewXOverlap lar_content::TwoViewDeltaRayOverlapResult::m_xOverlap
private

The x overlap object.

Definition at line 120 of file LArTrackTwoViewOverlapResult.h.

Referenced by GetXOverlap(), operator<(), operator=(), and TwoViewDeltaRayOverlapResult().


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