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

TransverseOverlapResult class. More...

#include "LArTrackOverlapResult.h"

Inheritance diagram for lar_content::TransverseOverlapResult:
lar_content::TrackOverlapResult lar_content::DeltaRayOverlapResult

Public Member Functions

 TransverseOverlapResult ()
 Default constructor. More...
 
 TransverseOverlapResult (const unsigned int nMatchedSamplingPoints, const unsigned int nSamplingPoints, const float chi2, const XOverlap &xOverlap)
 Constructor. More...
 
 TransverseOverlapResult (const TransverseOverlapResult &rhs)
 Copy constructor. More...
 
 ~TransverseOverlapResult ()
 Destructor. More...
 
const XOverlapGetXOverlap () const
 Get the x overlap object. More...
 
TransverseOverlapResultoperator= (const TransverseOverlapResult &rhs)
 Track overlap result assigment operator. More...
 
bool IsInitialized () const
 Whether the track overlap result has been initialized. More...
 
unsigned int GetNMatchedSamplingPoints () const
 Get the number of matched sampling points. More...
 
unsigned int GetNSamplingPoints () const
 Get the number of sampling points. More...
 
float GetMatchedFraction () const
 Get the fraction of sampling points resulting in a match. More...
 
float GetChi2 () const
 Get the absolute chi2 value. More...
 
float GetReducedChi2 () const
 Get the chi2 per samping point value. More...
 
bool operator< (const TrackOverlapResult &rhs) const
 Track overlap result less than operator. More...
 
bool operator> (const TrackOverlapResult &rhs) const
 Track overlap result greater than operator. More...
 

Protected Attributes

bool m_isInitialized
 Whether the track overlap result has been initialized. More...
 
unsigned int m_nMatchedSamplingPoints
 The number of matched sampling points. More...
 
unsigned int m_nSamplingPoints
 The number of sampling points. More...
 
float m_matchedFraction
 The fraction of sampling points resulting in a match. More...
 
float m_chi2
 The absolute chi2 value. More...
 
float m_reducedChi2
 The chi2 per samping point value. More...
 

Private Attributes

XOverlap m_xOverlap
 The x overlap object. More...
 

Detailed Description

TransverseOverlapResult class.

Definition at line 131 of file LArTrackOverlapResult.h.

Constructor & Destructor Documentation

lar_content::TransverseOverlapResult::TransverseOverlapResult ( )

Default constructor.

Definition at line 120 of file LArTrackOverlapResult.cc.

Referenced by lar_content::DeltaRayOverlapResult::DeltaRayOverlapResult(), and lar_content::operator+().

120  :
122  m_xOverlap(XOverlap(0.f, 0.f, 0.f, 0.f, 0.f, 0.f, 0.f))
123 {
124 }
TrackOverlapResult()
Default constructor.
TFile f
Definition: plotHisto.C:6
XOverlap m_xOverlap
The x overlap object.
lar_content::TransverseOverlapResult::TransverseOverlapResult ( const unsigned int  nMatchedSamplingPoints,
const unsigned int  nSamplingPoints,
const float  chi2,
const XOverlap xOverlap 
)

Constructor.

Parameters
nMatchedSamplingPoints
nSamplingPoints
chi2
xOverlap

Definition at line 128 of file LArTrackOverlapResult.cc.

129  :
130  TrackOverlapResult(nMatchedSamplingPoints, nSamplingPoints, chi2),
131  m_xOverlap(xOverlap)
132 {
133 }
TrackOverlapResult()
Default constructor.
XOverlap m_xOverlap
The x overlap object.
lar_content::TransverseOverlapResult::TransverseOverlapResult ( const TransverseOverlapResult rhs)

Copy constructor.

Parameters
rhs

Definition at line 137 of file LArTrackOverlapResult.cc.

137  :
138  TrackOverlapResult(rhs),
139  m_xOverlap(rhs.IsInitialized() ? rhs.GetXOverlap() : XOverlap(0.f, 0.f, 0.f, 0.f, 0.f, 0.f, 0.f))
140 {
141 }
TrackOverlapResult()
Default constructor.
TFile f
Definition: plotHisto.C:6
XOverlap m_xOverlap
The x overlap object.
lar_content::TransverseOverlapResult::~TransverseOverlapResult ( )

Destructor.

Definition at line 145 of file LArTrackOverlapResult.cc.

146 {
147 }

Member Function Documentation

float lar_content::TrackOverlapResult::GetChi2 ( ) const
inlineinherited

Get the absolute chi2 value.

Returns
the absolute chi2 value

Definition at line 441 of file LArTrackOverlapResult.h.

References lar_content::TrackOverlapResult::m_chi2, and lar_content::TrackOverlapResult::m_isInitialized.

Referenced by lar_content::operator+().

442 {
443  if (m_isInitialized)
444  return m_chi2;
445 
446  throw pandora::StatusCodeException(pandora::STATUS_CODE_NOT_INITIALIZED);
447 }
float m_chi2
The absolute chi2 value.
bool m_isInitialized
Whether the track overlap result has been initialized.
float lar_content::TrackOverlapResult::GetMatchedFraction ( ) const
inlineinherited

Get the fraction of sampling points resulting in a match.

Returns
the fraction of sampling points resulting in a match

Definition at line 431 of file LArTrackOverlapResult.h.

References lar_content::TrackOverlapResult::m_isInitialized, and lar_content::TrackOverlapResult::m_matchedFraction.

Referenced by lar_content::ClearTrackFragmentsTool::CheckOverlapResult(), lar_content::ThreeViewTrackFragmentsAlgorithm::CheckOverlapResult(), and lar_content::ThreeViewTransverseTracksAlgorithm::ThreeViewTransverseTracksAlgorithm().

432 {
433  if (m_isInitialized)
434  return m_matchedFraction;
435 
436  throw pandora::StatusCodeException(pandora::STATUS_CODE_NOT_INITIALIZED);
437 }
bool m_isInitialized
Whether the track overlap result has been initialized.
float m_matchedFraction
The fraction of sampling points resulting in a match.
unsigned int lar_content::TrackOverlapResult::GetNMatchedSamplingPoints ( ) const
inlineinherited

Get the number of matched sampling points.

Returns
the number of matched sampling points

Definition at line 411 of file LArTrackOverlapResult.h.

References lar_content::TrackOverlapResult::m_isInitialized, and lar_content::TrackOverlapResult::m_nMatchedSamplingPoints.

Referenced by lar_content::operator+(), lar_content::ThreeViewLongitudinalTracksAlgorithm::ThreeViewLongitudinalTracksAlgorithm(), and lar_content::ThreeViewTransverseTracksAlgorithm::ThreeViewTransverseTracksAlgorithm().

412 {
413  if (m_isInitialized)
415 
416  throw pandora::StatusCodeException(pandora::STATUS_CODE_NOT_INITIALIZED);
417 }
unsigned int m_nMatchedSamplingPoints
The number of matched sampling points.
bool m_isInitialized
Whether the track overlap result has been initialized.
unsigned int lar_content::TrackOverlapResult::GetNSamplingPoints ( ) const
inlineinherited

Get the number of sampling points.

Returns
the number of sampling points

Definition at line 421 of file LArTrackOverlapResult.h.

References lar_content::TrackOverlapResult::m_isInitialized, and lar_content::TrackOverlapResult::m_nSamplingPoints.

Referenced by lar_content::operator+(), and lar_content::ThreeViewTransverseTracksAlgorithm::ThreeViewTransverseTracksAlgorithm().

422 {
423  if (m_isInitialized)
424  return m_nSamplingPoints;
425 
426  throw pandora::StatusCodeException(pandora::STATUS_CODE_NOT_INITIALIZED);
427 }
bool m_isInitialized
Whether the track overlap result has been initialized.
unsigned int m_nSamplingPoints
The number of sampling points.
float lar_content::TrackOverlapResult::GetReducedChi2 ( ) const
inlineinherited

Get the chi2 per samping point value.

Returns
the chi2 per samping point value

Definition at line 451 of file LArTrackOverlapResult.h.

References lar_content::TrackOverlapResult::m_isInitialized, and lar_content::TrackOverlapResult::m_reducedChi2.

452 {
453  if (m_isInitialized)
454  return m_reducedChi2;
455 
456  throw pandora::StatusCodeException(pandora::STATUS_CODE_NOT_INITIALIZED);
457 }
bool m_isInitialized
Whether the track overlap result has been initialized.
float m_reducedChi2
The chi2 per samping point value.
const XOverlap & lar_content::TransverseOverlapResult::GetXOverlap ( ) const
inline

Get the x overlap object.

Returns
the x overlap object

Definition at line 462 of file LArTrackOverlapResult.h.

References lar_content::TrackOverlapResult::m_isInitialized.

Referenced by lar_content::operator+(), and operator=().

463 {
464  if (m_isInitialized)
465  return m_xOverlap;
466 
467  throw pandora::StatusCodeException(pandora::STATUS_CODE_NOT_INITIALIZED);
468 }
bool m_isInitialized
Whether the track overlap result has been initialized.
XOverlap m_xOverlap
The x overlap object.
bool lar_content::TrackOverlapResult::operator< ( const TrackOverlapResult rhs) const
inherited

Track overlap result less than operator.

Parameters
rhsthe track overlap result for comparison

Definition at line 67 of file LArTrackOverlapResult.cc.

References lar_content::TrackOverlapResult::IsInitialized(), lar_content::TrackOverlapResult::m_isInitialized, lar_content::TrackOverlapResult::m_matchedFraction, lar_content::TrackOverlapResult::m_nMatchedSamplingPoints, and lar_content::TrackOverlapResult::m_reducedChi2.

68 {
69  if (this == &rhs)
70  return false;
71 
72  if (!m_isInitialized && !rhs.IsInitialized())
73  throw StatusCodeException(STATUS_CODE_NOT_INITIALIZED);
74 
75  if (!m_isInitialized)
76  return true;
77 
78  if (!rhs.IsInitialized())
79  return false;
80 
81  if (m_nMatchedSamplingPoints != rhs.m_nMatchedSamplingPoints)
82  return (m_nMatchedSamplingPoints < rhs.m_nMatchedSamplingPoints);
83 
84  if (std::fabs(m_reducedChi2 - rhs.m_reducedChi2) > std::numeric_limits<float>::epsilon())
85  return (m_reducedChi2 > rhs.m_reducedChi2);
86 
87  return (m_matchedFraction < rhs.m_matchedFraction);
88 }
unsigned int m_nMatchedSamplingPoints
The number of matched sampling points.
bool m_isInitialized
Whether the track overlap result has been initialized.
float m_reducedChi2
The chi2 per samping point value.
float m_matchedFraction
The fraction of sampling points resulting in a match.
TransverseOverlapResult & lar_content::TransverseOverlapResult::operator= ( const TransverseOverlapResult rhs)

Track overlap result assigment operator.

Parameters
rhsthe track overlap result to assign

Definition at line 151 of file LArTrackOverlapResult.cc.

References f, GetXOverlap(), lar_content::TrackOverlapResult::IsInitialized(), m_xOverlap, and lar_content::TrackOverlapResult::operator=().

Referenced by lar_content::DeltaRayOverlapResult::operator=().

152 {
154 
155  if (rhs.IsInitialized())
156  {
157  m_xOverlap = rhs.GetXOverlap();
158  }
159  else
160  {
161  m_xOverlap = XOverlap(0.f, 0.f, 0.f, 0.f, 0.f, 0.f, 0.f);
162  }
163 
164  return *this;
165 }
TFile f
Definition: plotHisto.C:6
TrackOverlapResult & operator=(const TrackOverlapResult &rhs)
Track overlap result assigment operator.
XOverlap m_xOverlap
The x overlap object.
bool lar_content::TrackOverlapResult::operator> ( const TrackOverlapResult rhs) const
inherited

Track overlap result greater than operator.

Parameters
rhsthe track overlap result for comparison

Definition at line 92 of file LArTrackOverlapResult.cc.

93 {
94  if (this == &rhs)
95  return false;
96 
97  return !(*this < rhs);
98 }

Member Data Documentation

float lar_content::TrackOverlapResult::m_chi2
protectedinherited
float lar_content::TrackOverlapResult::m_matchedFraction
protectedinherited
unsigned int lar_content::TrackOverlapResult::m_nMatchedSamplingPoints
protectedinherited
unsigned int lar_content::TrackOverlapResult::m_nSamplingPoints
protectedinherited
float lar_content::TrackOverlapResult::m_reducedChi2
protectedinherited
XOverlap lar_content::TransverseOverlapResult::m_xOverlap
private

The x overlap object.

Definition at line 176 of file LArTrackOverlapResult.h.

Referenced by operator=().


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