lar_content::TrackOverlapResult Class Reference

TrackOverlapResult class. More...

#include <LArTrackOverlapResult.h>

Inheritance diagram for lar_content::TrackOverlapResult:

Public Member Functions
	TrackOverlapResult ()
	Default constructor. More...
	TrackOverlapResult (const unsigned int nMatchedSamplingPoints, const unsigned int nSamplingPoints, const float chi2)
	Constructor. More...
	TrackOverlapResult (const TrackOverlapResult &rhs)
	Copy constructor. More...
virtual	~TrackOverlapResult ()
	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...
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...
TrackOverlapResult &	operator= (const TrackOverlapResult &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...
float	m_chi2
	The absolute chi2 value. More...
float	m_reducedChi2
	The chi2 per samping point value. More...

Detailed Description

TrackOverlapResult class.

Definition at line 25 of file LArTrackOverlapResult.h.

Constructor & Destructor Documentation

lar_content::TrackOverlapResult::TrackOverlapResult

(

)

Default constructor.

Definition at line 20 of file LArTrackOverlapResult.cc.

                                       :
    m_isInitialized(false),
    m_nMatchedSamplingPoints(0),
    m_nSamplingPoints(0),
    m_matchedFraction(0.f),
    m_chi2(0.f),
    m_reducedChi2(0.f)
{
}

lar_content::TrackOverlapResult::TrackOverlapResult	(	const unsigned int	nMatchedSamplingPoints,
		const unsigned int	nSamplingPoints,
		const float	chi2
	)

Constructor.

Parameters

nMatchedSamplingPoints
nSamplingPoints
chi2

Definition at line 32 of file LArTrackOverlapResult.cc.

                                                                                                                                      :
    m_isInitialized(true),
    m_nMatchedSamplingPoints(nMatchedSamplingPoints),
    m_nSamplingPoints(nSamplingPoints),
    m_matchedFraction(0.f),
    m_chi2(chi2),
    m_reducedChi2(0.f)
{
    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);
    m_reducedChi2 = m_chi2 / static_cast<float>(m_nSamplingPoints);
}

lar_content::TrackOverlapResult::TrackOverlapResult

(

const TrackOverlapResult &

rhs

)

Copy constructor.

Parameters

rhs

Definition at line 49 of file LArTrackOverlapResult.cc.

                                                                    :
    m_isInitialized(rhs.m_isInitialized),
    m_nMatchedSamplingPoints(rhs.m_nMatchedSamplingPoints),
    m_nSamplingPoints(rhs.m_nSamplingPoints),
    m_matchedFraction(rhs.m_matchedFraction),
    m_chi2(rhs.m_chi2),
    m_reducedChi2(rhs.m_reducedChi2)
{
}

lar_content::TrackOverlapResult::~TrackOverlapResult ( )

virtual

Destructor.

Definition at line 61 of file LArTrackOverlapResult.cc.

{
}

Member Function Documentation

float lar_content::TrackOverlapResult::GetChi2 ( ) const

inline

Get the absolute chi2 value.

Returns

the absolute chi2 value

Definition at line 441 of file LArTrackOverlapResult.h.

{
    if (m_isInitialized)
        return m_chi2;

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

float lar_content::TrackOverlapResult::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 431 of file LArTrackOverlapResult.h.

{
    if (m_isInitialized)
        return m_matchedFraction;

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

unsigned int lar_content::TrackOverlapResult::GetNMatchedSamplingPoints ( ) const

inline

Get the number of matched sampling points.

Returns

the number of matched sampling points

Definition at line 411 of file LArTrackOverlapResult.h.

{
    if (m_isInitialized)
        return m_nMatchedSamplingPoints;

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

unsigned int lar_content::TrackOverlapResult::GetNSamplingPoints ( ) const

inline

Get the number of sampling points.

Returns

the number of sampling points

Definition at line 421 of file LArTrackOverlapResult.h.

{
    if (m_isInitialized)
        return m_nSamplingPoints;

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

float lar_content::TrackOverlapResult::GetReducedChi2 ( ) const

inline

Get the chi2 per samping point value.

Returns

the chi2 per samping point value

Definition at line 451 of file LArTrackOverlapResult.h.

{
    if (m_isInitialized)
        return m_reducedChi2;

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

bool lar_content::TrackOverlapResult::IsInitialized ( ) const

inline

Whether the track overlap result has been initialized.

Returns

boolean

Definition at line 404 of file LArTrackOverlapResult.h.

{
    return m_isInitialized;
}

bool lar_content::TrackOverlapResult::operator<

(

const TrackOverlapResult &

rhs

)

const

Track overlap result less than operator.

Parameters

rhs	the track overlap result for comparison

Definition at line 67 of file LArTrackOverlapResult.cc.

{
    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_reducedChi2 - rhs.m_reducedChi2) > std::numeric_limits<float>::epsilon())
        return (m_reducedChi2 > rhs.m_reducedChi2);

    return (m_matchedFraction < rhs.m_matchedFraction);
}

TrackOverlapResult & lar_content::TrackOverlapResult::operator=

(

const TrackOverlapResult &

rhs

)

Track overlap result assigment operator.

Parameters

rhs	the track overlap result to assign

Definition at line 102 of file LArTrackOverlapResult.cc.

{
    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;
    m_chi2 = rhs.m_chi2;
    m_reducedChi2 = rhs.m_reducedChi2;

    return *this;
}

bool lar_content::TrackOverlapResult::operator>

(

const TrackOverlapResult &

rhs

)

const

Track overlap result greater than operator.

Parameters

rhs	the track overlap result for comparison

Definition at line 92 of file LArTrackOverlapResult.cc.

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

    return !(*this < rhs);
}

Member Data Documentation

float lar_content::TrackOverlapResult::m_chi2

protected

The absolute chi2 value.

Definition at line 122 of file LArTrackOverlapResult.h.

bool lar_content::TrackOverlapResult::m_isInitialized

protected

Whether the track overlap result has been initialized.

Definition at line 118 of file LArTrackOverlapResult.h.

float lar_content::TrackOverlapResult::m_matchedFraction

protected

The fraction of sampling points resulting in a match.

Definition at line 121 of file LArTrackOverlapResult.h.

unsigned int lar_content::TrackOverlapResult::m_nMatchedSamplingPoints

protected

The number of matched sampling points.

Definition at line 119 of file LArTrackOverlapResult.h.

unsigned int lar_content::TrackOverlapResult::m_nSamplingPoints

protected

The number of sampling points.

Definition at line 120 of file LArTrackOverlapResult.h.

float lar_content::TrackOverlapResult::m_reducedChi2

protected

The chi2 per samping point value.

Definition at line 123 of file LArTrackOverlapResult.h.

---

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

• larpandoracontent/larpandoracontent/LArObjects/LArTrackOverlapResult.h
• larpandoracontent/larpandoracontent/LArObjects/LArTrackOverlapResult.cc