lar_content::TwoViewTransverseOverlapResult Class Reference

TwoViewTransverseOverlapResult class. More...

#include "LArTrackTwoViewOverlapResult.h"

Inheritance diagram for lar_content::TwoViewTransverseOverlapResult:

Public Member Functions
	TwoViewTransverseOverlapResult ()
	Default constructor. More...
	TwoViewTransverseOverlapResult (const float matchingScore, const float downsamplingFactor, const unsigned int nSamplingPoints, const unsigned int nMatchedSamplingPoints, const float correlationCoefficient, const TwoViewXOverlap &twoViewXOverlap)
	Constructor. More...
	TwoViewTransverseOverlapResult (const TwoViewTransverseOverlapResult &rhs)
	Copy constructor. More...
	~TwoViewTransverseOverlapResult ()
	Destructor. More...
unsigned int	GetNSamplingPoints () const
	Get the number of sampling points. More...
unsigned int	GetNMatchedSamplingPoints () const
	Get the number of matched sampling points. More...
unsigned int	GetNReUpsampledSamplingPoints () const
	Get the number of re-upsampled sampling points. More...
unsigned int	GetNMatchedReUpsampledSamplingPoints () const
	Get the number of matched re-upsampled sampling points. More...
float	GetCorrelationCoefficient () const
	Get the correlation coefficient. More...
float	GetLocallyMatchedFraction () const
	Get the locally matched fraction. More...
const TwoViewXOverlap &	GetTwoViewXOverlap () const
	Get the two view x overlap object. More...
bool	operator< (const TwoViewTransverseOverlapResult &rhs) const
	Track two view overlap result less than operator. More...
TwoViewTransverseOverlapResult &	operator= (const TwoViewTransverseOverlapResult &rhs)
	Track overlap result assigment operator. More...
bool	IsInitialized () const
	Whether the track overlap result has been initialized. More...
float	GetMatchingScore () const
	Get the matching score of the overlap result. More...
bool	operator< (const TrackTwoViewOverlapResult &rhs) const
	Track two view overlap result less than operator. More...
bool	operator> (const TrackTwoViewOverlapResult &rhs) const
	Track two view overlap result greater than operator. More...

Protected Attributes
bool	m_isInitialized
	Whether the track overlap result has been initialized. More...
float	m_matchingScore
	The compatability score for the two objects associated with the overlap result. More...

Private Attributes
float	m_downsamplingFactor
	The downsampling factor. More...
unsigned int	m_nSamplingPoints
	The number of sampling points. More...
unsigned int	m_nMatchedSamplingPoints
	The number of matched sampling points. More...
float	m_correlationCoefficient
	The correlation coefficient. More...
TwoViewXOverlap	m_twoViewXOverlap
	The two view x overlap object. More...

Detailed Description

TwoViewTransverseOverlapResult class.

Definition at line 204 of file LArTrackTwoViewOverlapResult.h.

Constructor & Destructor Documentation

lar_content::TwoViewTransverseOverlapResult::TwoViewTransverseOverlapResult

(

)

Default constructor.

Definition at line 189 of file LArTrackTwoViewOverlapResult.cc.

                                                               :
    TrackTwoViewOverlapResult(),
    m_downsamplingFactor(0.f),
    m_nSamplingPoints(0),
    m_nMatchedSamplingPoints(0),
    m_correlationCoefficient(0.f),
    m_twoViewXOverlap(TwoViewXOverlap(0.f, 0.f, 0.f, 0.f))
{
}

lar_content::TwoViewTransverseOverlapResult::TwoViewTransverseOverlapResult	(	const float	matchingScore,
		const float	downsamplingFactor,
		const unsigned int	nSamplingPoints,
		const unsigned int	nMatchedSamplingPoints,
		const float	correlationCoefficient,
		const TwoViewXOverlap &	twoViewXOverlap
	)

Constructor.

Parameters

matchingScore	the matching candidate matching score
downsamplingFactor	the downsampling factor
nSamplingPoints	the number of sampling points used in the matching
nMatchedSamplingPoints	the number of matched sampling points
correlationCoefficient	the corerlation coefficient for the matching candidate
twoViewXOverlap	the description of the geometrical overlap for the matching candidate

Definition at line 201 of file LArTrackTwoViewOverlapResult.cc.

                                                                                                                           :
    TrackTwoViewOverlapResult(matchingScore),
    m_downsamplingFactor(downsamplingFactor),
    m_nSamplingPoints(nSamplingPoints),
    m_nMatchedSamplingPoints(nMatchedSamplingPoints),
    m_correlationCoefficient(correlationCoefficient),
    m_twoViewXOverlap(twoViewXOverlap)
{
}

lar_content::TwoViewTransverseOverlapResult::TwoViewTransverseOverlapResult

(

const TwoViewTransverseOverlapResult &

rhs

)

Copy constructor.

Parameters

rhs

the rhs

Definition at line 214 of file LArTrackTwoViewOverlapResult.cc.

                                                                                                        :
    TrackTwoViewOverlapResult(rhs),
    m_downsamplingFactor(rhs.m_downsamplingFactor),
    m_nSamplingPoints(rhs.m_nSamplingPoints),
    m_nMatchedSamplingPoints(rhs.m_nMatchedSamplingPoints),
    m_correlationCoefficient(rhs.m_correlationCoefficient),
    m_twoViewXOverlap(rhs.m_isInitialized ? rhs.m_twoViewXOverlap : TwoViewXOverlap(0.f, 0.f, 0.f, 0.f))
{
}

lar_content::TwoViewTransverseOverlapResult::~TwoViewTransverseOverlapResult

(

)

Destructor.

Definition at line 226 of file LArTrackTwoViewOverlapResult.cc.

{
}

Member Function Documentation

float lar_content::TwoViewTransverseOverlapResult::GetCorrelationCoefficient ( ) const

inline

Get the correlation coefficient.

Returns

the correlation coefficient

Definition at line 414 of file LArTrackTwoViewOverlapResult.h.

References lar_content::TwoViewDeltaRayOverlapResult::m_isInitialized.

{
    if (m_isInitialized)
        return m_correlationCoefficient;

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

float lar_content::TwoViewTransverseOverlapResult::GetLocallyMatchedFraction ( ) const

inline

Get the locally matched fraction.

Returns

the locally matched fraction

Definition at line 424 of file LArTrackTwoViewOverlapResult.h.

References f, and lar_content::TwoViewDeltaRayOverlapResult::m_isInitialized.

Referenced by operator<().

{
    if (m_isInitialized)
        return (m_nSamplingPoints > 0 ? static_cast<float>(m_nMatchedSamplingPoints) / static_cast<float>(m_nSamplingPoints) : 0.f);

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

float lar_content::TrackTwoViewOverlapResult::GetMatchingScore ( ) const

inlineinherited

Get the matching score of the overlap result.

Returns

matching score

Definition at line 363 of file LArTrackTwoViewOverlapResult.h.

References lar_content::TwoViewDeltaRayOverlapResult::m_isInitialized.

{
    if (m_isInitialized)
        return m_matchingScore;

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

unsigned int lar_content::TwoViewTransverseOverlapResult::GetNMatchedReUpsampledSamplingPoints ( ) const

inline

Get the number of matched re-upsampled sampling points.

Returns

the number of matched re-upsampled sampling points

Definition at line 404 of file LArTrackTwoViewOverlapResult.h.

References lar_content::TwoViewDeltaRayOverlapResult::m_isInitialized.

{
    if (m_isInitialized)
        return static_cast<unsigned int>(m_downsamplingFactor * static_cast<float>(m_nMatchedSamplingPoints));

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

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

inline

Get the number of matched sampling points.

Returns

the number of matched sampling points

Definition at line 384 of file LArTrackTwoViewOverlapResult.h.

References lar_content::TwoViewDeltaRayOverlapResult::m_isInitialized.

{
    if (m_isInitialized)
        return m_nMatchedSamplingPoints;

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

unsigned int lar_content::TwoViewTransverseOverlapResult::GetNReUpsampledSamplingPoints ( ) const

inline

Get the number of re-upsampled sampling points.

Returns

the number of re-upsampled sampling points

Definition at line 394 of file LArTrackTwoViewOverlapResult.h.

References lar_content::TwoViewDeltaRayOverlapResult::m_isInitialized.

{
    if (m_isInitialized)
        return static_cast<unsigned int>(m_downsamplingFactor * static_cast<float>(m_nSamplingPoints));

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

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

inline

Get the number of sampling points.

Returns

the number of sampling points

Definition at line 374 of file LArTrackTwoViewOverlapResult.h.

References lar_content::TwoViewDeltaRayOverlapResult::m_isInitialized.

{
    if (m_isInitialized)
        return m_nSamplingPoints;

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

const TwoViewXOverlap & lar_content::TwoViewTransverseOverlapResult::GetTwoViewXOverlap ( ) const

inline

Get the two view x overlap object.

Returns

the two view x overlap object

Definition at line 434 of file LArTrackTwoViewOverlapResult.h.

References lar_content::TwoViewDeltaRayOverlapResult::m_isInitialized.

{
    if (m_isInitialized)
        return m_twoViewXOverlap;

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

bool lar_content::TrackTwoViewOverlapResult::IsInitialized ( ) const

inlineinherited

Whether the track overlap result has been initialized.

Returns

boolean

Definition at line 356 of file LArTrackTwoViewOverlapResult.h.

References lar_content::TwoViewDeltaRayOverlapResult::m_isInitialized.

Referenced by lar_content::TwoViewTransverseTracksAlgorithm::TwoViewTransverseTracksAlgorithm().

{
    return m_isInitialized;
}

bool lar_content::TrackTwoViewOverlapResult::operator< ( const TrackTwoViewOverlapResult &  rhs ) const

inherited

Track two view overlap result less than operator.

Parameters

rhs	the track two view overlap result for comparison

Definition at line 146 of file LArTrackTwoViewOverlapResult.cc.

References lar_content::TrackTwoViewOverlapResult::m_isInitialized, and lar_content::TrackTwoViewOverlapResult::m_matchingScore.

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

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

    if (!m_isInitialized)
        return true;

    if (!rhs.m_isInitialized)
        return false;

    return (m_matchingScore < rhs.m_matchingScore);
}

bool lar_content::TwoViewTransverseOverlapResult::operator<

(

const TwoViewTransverseOverlapResult &

rhs

)

const

Track two view overlap result less than operator.

Parameters

rhs	the track two view overlap result for comparison

Definition at line 232 of file LArTrackTwoViewOverlapResult.cc.

References GetLocallyMatchedFraction(), lar_content::TwoViewXOverlap::GetTwoViewXOverlapSpan(), lar_content::TwoViewXOverlap::GetXSpan0(), lar_content::TwoViewXOverlap::GetXSpan1(), m_correlationCoefficient, lar_content::TrackTwoViewOverlapResult::m_isInitialized, lar_content::TrackTwoViewOverlapResult::m_matchingScore, m_nMatchedSamplingPoints, m_nSamplingPoints, and m_twoViewXOverlap.

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

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

    if (!m_isInitialized)
        return true;

    if (!rhs.m_isInitialized)
        return false;

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

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

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

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

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

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

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

    return (m_twoViewXOverlap.GetXSpan1() < rhs.m_twoViewXOverlap.GetXSpan1());
}

TwoViewTransverseOverlapResult & lar_content::TwoViewTransverseOverlapResult::operator=

(

const TwoViewTransverseOverlapResult &

rhs

)

Track overlap result assigment operator.

Parameters

rhs	the track overlap result to assign

Definition at line 272 of file LArTrackTwoViewOverlapResult.cc.

References f, m_correlationCoefficient, m_downsamplingFactor, lar_content::TrackTwoViewOverlapResult::m_isInitialized, lar_content::TrackTwoViewOverlapResult::m_matchingScore, m_nMatchedSamplingPoints, m_nSamplingPoints, m_twoViewXOverlap, and lar_content::TrackTwoViewOverlapResult::operator=().

{
    this->TrackTwoViewOverlapResult::operator=(rhs);

    if (rhs.m_isInitialized)
    {
        m_isInitialized = rhs.m_isInitialized;
        m_matchingScore = rhs.m_matchingScore;
        m_downsamplingFactor = rhs.m_downsamplingFactor;
        m_nSamplingPoints = rhs.m_nSamplingPoints;
        m_nMatchedSamplingPoints = rhs.m_nMatchedSamplingPoints;
        m_correlationCoefficient = rhs.m_correlationCoefficient;
        m_twoViewXOverlap = rhs.m_twoViewXOverlap;
    }
    else
    {
        m_isInitialized = false;
        m_matchingScore = 0.f;
        m_downsamplingFactor = 0.f;
        m_nSamplingPoints = 0;
        m_nMatchedSamplingPoints = 0;
        m_correlationCoefficient = 0.f;
        m_twoViewXOverlap = TwoViewXOverlap(0.f, 0.f, 0.f, 0.f);
    }

    return *this;
}

bool lar_content::TrackTwoViewOverlapResult::operator> ( const TrackTwoViewOverlapResult &  rhs ) const

inherited

Track two view overlap result greater than operator.

Parameters

rhs	the track two view overlap result for comparison

Definition at line 165 of file LArTrackTwoViewOverlapResult.cc.

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

    return !(*this < rhs);
}

Member Data Documentation

float lar_content::TwoViewTransverseOverlapResult::m_correlationCoefficient

private

The correlation coefficient.

Definition at line 304 of file LArTrackTwoViewOverlapResult.h.

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

float lar_content::TwoViewTransverseOverlapResult::m_downsamplingFactor

private

The downsampling factor.

Definition at line 301 of file LArTrackTwoViewOverlapResult.h.

Referenced by operator=().

bool lar_content::TrackTwoViewOverlapResult::m_isInitialized

protectedinherited

Whether the track overlap result has been initialized.

Definition at line 195 of file LArTrackTwoViewOverlapResult.h.

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

float lar_content::TrackTwoViewOverlapResult::m_matchingScore

protectedinherited

The compatability score for the two objects associated with the overlap result.

Definition at line 196 of file LArTrackTwoViewOverlapResult.h.

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

unsigned int lar_content::TwoViewTransverseOverlapResult::m_nMatchedSamplingPoints

private

The number of matched sampling points.

Definition at line 303 of file LArTrackTwoViewOverlapResult.h.

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

unsigned int lar_content::TwoViewTransverseOverlapResult::m_nSamplingPoints

private

The number of sampling points.

Definition at line 302 of file LArTrackTwoViewOverlapResult.h.

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

TwoViewXOverlap lar_content::TwoViewTransverseOverlapResult::m_twoViewXOverlap

private

The two view x overlap object.

Definition at line 305 of file LArTrackTwoViewOverlapResult.h.

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

---

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

• larpandoracontent/v04_08_01/source/larpandoracontent/LArObjects/LArTrackTwoViewOverlapResult.h
• larpandoracontent/v04_08_01/source/larpandoracontent/LArObjects/LArTrackTwoViewOverlapResult.cc