lar_content::ShowerOverlapResult Class Reference

ShowerOverlapResult class. More...

#include "LArShowerOverlapResult.h"

Public Member Functions
	ShowerOverlapResult ()
	Default constructor. More...
	ShowerOverlapResult (const unsigned int nMatchedSamplingPoints, const unsigned int nSamplingPoints, const XOverlap &xOverlap)
	Constructor. More...
	ShowerOverlapResult (const ShowerOverlapResult &rhs)
	Copy constructor. More...
	~ShowerOverlapResult ()
	Destructor. 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...
const XOverlap &	GetXOverlap () const
	Get the x overlap object. More...
bool	operator< (const ShowerOverlapResult &rhs) const
	Track overlap result less than operator. More...
bool	operator> (const ShowerOverlapResult &rhs) const
	Track overlap result greater than operator. More...
ShowerOverlapResult &	operator= (const ShowerOverlapResult &rhs)
	Track overlap result assigment 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...
XOverlap	m_xOverlap
	The x overlap object. More...

Detailed Description

ShowerOverlapResult class.

Definition at line 25 of file LArShowerOverlapResult.h.

Constructor & Destructor Documentation

lar_content::ShowerOverlapResult::ShowerOverlapResult

(

)

Default constructor.

Definition at line 20 of file LArShowerOverlapResult.cc.

                                         :
    m_isInitialized(false),
    m_nMatchedSamplingPoints(0),
    m_nSamplingPoints(0),
    m_matchedFraction(0.f),
    m_xOverlap(XOverlap(0.f, 0.f, 0.f, 0.f, 0.f, 0.f, 0.f))
{
}

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.

References m_matchedFraction, m_nMatchedSamplingPoints, and m_nSamplingPoints.

                                                                                                                                                :
    m_isInitialized(true),
    m_nMatchedSamplingPoints(nMatchedSamplingPoints),
    m_nSamplingPoints(nSamplingPoints),
    m_matchedFraction(0.f),
    m_xOverlap(xOverlap)
{
    if ((0 == m_nSamplingPoints) || (m_nMatchedSamplingPoints > m_nSamplingPoints))
        throw StatusCodeException(STATUS_CODE_INVALID_PARAMETER);

    m_matchedFraction = static_cast<float>(m_nMatchedSamplingPoints) / static_cast<float>(m_nSamplingPoints);
}

lar_content::ShowerOverlapResult::ShowerOverlapResult

(

const ShowerOverlapResult &

rhs

)

Copy constructor.

Parameters

rhs

Definition at line 46 of file LArShowerOverlapResult.cc.

                                                                       :
    m_isInitialized(rhs.m_isInitialized),
    m_nMatchedSamplingPoints(rhs.m_nMatchedSamplingPoints),
    m_nSamplingPoints(rhs.m_nSamplingPoints),
    m_matchedFraction(rhs.m_matchedFraction),
    m_xOverlap(rhs.IsInitialized() ? rhs.GetXOverlap() : XOverlap(0.f, 0.f, 0.f, 0.f, 0.f, 0.f, 0.f))
{
}

lar_content::ShowerOverlapResult::~ShowerOverlapResult

(

)

Destructor.

Definition at line 57 of file LArShowerOverlapResult.cc.

{
}

Member Function Documentation

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.

References m_isInitialized, and m_matchedFraction.

Referenced by lar_content::ThreeDShowersAlgorithm::RemoveFromSlidingFitCache().

{
    if (m_isInitialized)
        return m_matchedFraction;

    throw pandora::StatusCodeException(pandora::STATUS_CODE_NOT_INITIALIZED);
}

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.

References m_isInitialized, and m_nMatchedSamplingPoints.

Referenced by lar_content::ThreeDShowersAlgorithm::RemoveFromSlidingFitCache().

{
    if (m_isInitialized)
        return m_nMatchedSamplingPoints;

    throw pandora::StatusCodeException(pandora::STATUS_CODE_NOT_INITIALIZED);
}

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.

References m_isInitialized, and m_nSamplingPoints.

{
    if (m_isInitialized)
        return m_nSamplingPoints;

    throw pandora::StatusCodeException(pandora::STATUS_CODE_NOT_INITIALIZED);
}

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.

References m_isInitialized, and m_xOverlap.

Referenced by operator=().

{
    if (m_isInitialized)
        return m_xOverlap;

    throw pandora::StatusCodeException(pandora::STATUS_CODE_NOT_INITIALIZED);
}

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.

References m_isInitialized.

Referenced by operator<(), operator=(), and lar_content::ThreeDShowersAlgorithm::RemoveFromSlidingFitCache().

{
    return m_isInitialized;
}

bool lar_content::ShowerOverlapResult::operator<

(

const ShowerOverlapResult &

rhs

)

const

Track overlap result less than operator.

Parameters

rhs	the track overlap result for comparison

Definition at line 63 of file LArShowerOverlapResult.cc.

References lar_content::XOverlap::GetXOverlapSpan(), IsInitialized(), m_isInitialized, m_matchedFraction, m_nMatchedSamplingPoints, and m_xOverlap.

{
    if (this == &rhs)
        return false;

    if (!m_isInitialized && !rhs.IsInitialized())
        throw StatusCodeException(STATUS_CODE_NOT_INITIALIZED);

    if (!m_isInitialized)
        return true;

    if (!rhs.IsInitialized())
        return false;

    if (m_nMatchedSamplingPoints != rhs.m_nMatchedSamplingPoints)
        return (m_nMatchedSamplingPoints < rhs.m_nMatchedSamplingPoints);

    if (std::fabs(m_xOverlap.GetXOverlapSpan() - rhs.m_xOverlap.GetXOverlapSpan()) > std::numeric_limits<float>::epsilon())
        return (m_xOverlap.GetXOverlapSpan() < rhs.m_xOverlap.GetXOverlapSpan());

    return (m_matchedFraction < rhs.m_matchedFraction);
}

ShowerOverlapResult & lar_content::ShowerOverlapResult::operator=

(

const ShowerOverlapResult &

rhs

)

Track overlap result assigment operator.

Parameters

rhs	the track overlap result to assign

Definition at line 98 of file LArShowerOverlapResult.cc.

References f, GetXOverlap(), IsInitialized(), m_isInitialized, m_matchedFraction, m_nMatchedSamplingPoints, m_nSamplingPoints, and m_xOverlap.

{
    if (this == &rhs)
        throw StatusCodeException(STATUS_CODE_INVALID_PARAMETER);

    m_isInitialized = rhs.m_isInitialized;
    m_nMatchedSamplingPoints = rhs.m_nMatchedSamplingPoints;
    m_nSamplingPoints = rhs.m_nSamplingPoints;
    m_matchedFraction = rhs.m_matchedFraction;

    if (rhs.IsInitialized())
    {
        m_xOverlap = rhs.GetXOverlap();
    }
    else
    {
        m_xOverlap = XOverlap(0.f, 0.f, 0.f, 0.f, 0.f, 0.f, 0.f);
    }

    return *this;
}

bool lar_content::ShowerOverlapResult::operator>

(

const ShowerOverlapResult &

rhs

)

const

Track overlap result greater than operator.

Parameters

rhs	the track overlap result for comparison

Definition at line 88 of file LArShowerOverlapResult.cc.

{
    if (this == &rhs)
        return false;

    return !(*this < rhs);
}

Member Data Documentation

bool lar_content::ShowerOverlapResult::m_isInitialized

protected

Whether the track overlap result has been initialized.

Definition at line 110 of file LArShowerOverlapResult.h.

Referenced by GetMatchedFraction(), GetNMatchedSamplingPoints(), GetNSamplingPoints(), GetXOverlap(), IsInitialized(), operator<(), and operator=().

float lar_content::ShowerOverlapResult::m_matchedFraction

protected

The fraction of sampling points resulting in a match.

Definition at line 113 of file LArShowerOverlapResult.h.

Referenced by GetMatchedFraction(), operator<(), operator=(), and ShowerOverlapResult().

unsigned int lar_content::ShowerOverlapResult::m_nMatchedSamplingPoints

protected

The number of matched sampling points.

Definition at line 111 of file LArShowerOverlapResult.h.

Referenced by GetNMatchedSamplingPoints(), operator<(), operator=(), and ShowerOverlapResult().

unsigned int lar_content::ShowerOverlapResult::m_nSamplingPoints

protected

The number of sampling points.

Definition at line 112 of file LArShowerOverlapResult.h.

Referenced by GetNSamplingPoints(), operator=(), and ShowerOverlapResult().

XOverlap lar_content::ShowerOverlapResult::m_xOverlap

protected

The x overlap object.

Definition at line 114 of file LArShowerOverlapResult.h.

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

---

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

• /cvmfs/larsoft.opensciencegrid.org/products/larpandoracontent/v03_14_03/source/larpandoracontent/LArObjects/LArShowerOverlapResult.h
• /cvmfs/larsoft.opensciencegrid.org/products/larpandoracontent/v03_14_03/source/larpandoracontent/LArObjects/LArShowerOverlapResult.cc