Pandora
Pandora source code navigator
Loading...
Searching...
No Matches
lar_content::ShowerOverlapResult Class Reference

ShowerOverlapResult class. More...

#include "LArShowerOverlapResult.h"

Collaboration diagram for lar_content::ShowerOverlapResult:

Public Member Functions

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

Protected Attributes

bool m_isInitialized
 Whether the track overlap result has been initialized.
 
unsigned int m_nMatchedSamplingPoints
 The number of matched sampling points.
 
unsigned int m_nSamplingPoints
 The number of sampling points.
 
float m_matchedFraction
 The fraction of sampling points resulting in a match.
 
XOverlap m_xOverlap
 The x overlap object.
 

Detailed Description

ShowerOverlapResult class.

Definition at line 25 of file LArShowerOverlapResult.h.

Constructor & Destructor Documentation

◆ ShowerOverlapResult() [1/3]

lar_content::ShowerOverlapResult::ShowerOverlapResult ( )

Default constructor.

Definition at line 20 of file LArShowerOverlapResult.cc.

◆ ShowerOverlapResult() [2/3]

lar_content::ShowerOverlapResult::ShowerOverlapResult ( const unsigned int  nMatchedSamplingPoints,
const unsigned int  nSamplingPoints,
const XOverlap xOverlap 
)

Constructor.

Parameters
nMatchedSamplingPoints
nSamplingPoints

Definition at line 31 of file LArShowerOverlapResult.cc.

◆ ShowerOverlapResult() [3/3]

lar_content::ShowerOverlapResult::ShowerOverlapResult ( const ShowerOverlapResult rhs)

Copy constructor.

Parameters
rhs

Definition at line 46 of file LArShowerOverlapResult.cc.

◆ ~ShowerOverlapResult()

lar_content::ShowerOverlapResult::~ShowerOverlapResult ( )

Destructor.

Definition at line 57 of file LArShowerOverlapResult.cc.

Member Function Documentation

◆ GetMatchedFraction()

float lar_content::ShowerOverlapResult::GetMatchedFraction ( ) const
inline

Get the fraction of sampling points resulting in a match.

Returns
the fraction of sampling points resulting in a match

Definition at line 146 of file LArShowerOverlapResult.h.

Here is the caller graph for this function:

◆ GetNMatchedSamplingPoints()

unsigned int lar_content::ShowerOverlapResult::GetNMatchedSamplingPoints ( ) const
inline

Get the number of matched sampling points.

Returns
the number of matched sampling points

Definition at line 126 of file LArShowerOverlapResult.h.

Here is the caller graph for this function:

◆ GetNSamplingPoints()

unsigned int lar_content::ShowerOverlapResult::GetNSamplingPoints ( ) const
inline

Get the number of sampling points.

Returns
the number of sampling points

Definition at line 136 of file LArShowerOverlapResult.h.

◆ GetXOverlap()

const XOverlap & lar_content::ShowerOverlapResult::GetXOverlap ( ) const
inline

Get the x overlap object.

Returns
the x overlap object

Definition at line 156 of file LArShowerOverlapResult.h.

Here is the caller graph for this function:

◆ IsInitialized()

bool lar_content::ShowerOverlapResult::IsInitialized ( ) const
inline

Whether the track overlap result has been initialized.

Returns
boolean

Definition at line 119 of file LArShowerOverlapResult.h.

Here is the caller graph for this function:

◆ operator<()

bool lar_content::ShowerOverlapResult::operator< ( const ShowerOverlapResult rhs) const

Track overlap result less than operator.

Parameters
rhsthe track overlap result for comparison

Definition at line 63 of file LArShowerOverlapResult.cc.

Here is the call graph for this function:

◆ operator=()

ShowerOverlapResult & lar_content::ShowerOverlapResult::operator= ( const ShowerOverlapResult rhs)

Track overlap result assigment operator.

Parameters
rhsthe track overlap result to assign

Definition at line 107 of file LArShowerOverlapResult.cc.

Here is the call graph for this function:

◆ operator>()

bool lar_content::ShowerOverlapResult::operator> ( const ShowerOverlapResult rhs) const

Track overlap result greater than operator.

Parameters
rhsthe track overlap result for comparison

Definition at line 97 of file LArShowerOverlapResult.cc.

Member Data Documentation

◆ m_isInitialized

bool lar_content::ShowerOverlapResult::m_isInitialized
protected

Whether the track overlap result has been initialized.

Definition at line 110 of file LArShowerOverlapResult.h.

◆ m_matchedFraction

float lar_content::ShowerOverlapResult::m_matchedFraction
protected

The fraction of sampling points resulting in a match.

Definition at line 113 of file LArShowerOverlapResult.h.

◆ m_nMatchedSamplingPoints

unsigned int lar_content::ShowerOverlapResult::m_nMatchedSamplingPoints
protected

The number of matched sampling points.

Definition at line 111 of file LArShowerOverlapResult.h.

◆ m_nSamplingPoints

unsigned int lar_content::ShowerOverlapResult::m_nSamplingPoints
protected

The number of sampling points.

Definition at line 112 of file LArShowerOverlapResult.h.

◆ m_xOverlap

XOverlap lar_content::ShowerOverlapResult::m_xOverlap
protected

The x overlap object.

Definition at line 114 of file LArShowerOverlapResult.h.


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