#include "LArTrackOverlapResult.h"

Inheritance diagram for lar_content::DeltaRayOverlapResult:

Public Member Functions
	DeltaRayOverlapResult ()
	Default constructor. More...

	DeltaRayOverlapResult (const unsigned int nMatchedSamplingPoints, const unsigned int nSamplingPoints, const float chi2, const XOverlap &xOverlap, const pandora::PfoList &commonMuonPfoList)
	Constructor. More...

	DeltaRayOverlapResult (const DeltaRayOverlapResult &rhs)
	Copy constructor. More...

virtual	~DeltaRayOverlapResult ()
	Destructor. More...

const pandora::PfoList &	GetCommonMuonPfoList () const
	Get the common muon pfo list. More...

DeltaRayOverlapResult &	operator= (const DeltaRayOverlapResult &rhs)
	Track overlap result assigment operator. More...

const XOverlap &	GetXOverlap () const
	Get the x overlap object. 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
pandora::PfoList	m_commonMuonPfoList
	The list of cosmic ray pfos that, in each view, lie close to the clusters of the tensor element. More...

Detailed Description

DeltaRayOverlapResult class.

Definition at line 349 of file LArTrackOverlapResult.h.

Constructor & Destructor Documentation

lar_content::DeltaRayOverlapResult::DeltaRayOverlapResult ( )

Default constructor.

Definition at line 307 of file LArTrackOverlapResult.cc.

References m_commonMuonPfoList, and lar_content::TransverseOverlapResult::TransverseOverlapResult().

                                              :
     TransverseOverlapResult(),
     m_commonMuonPfoList(PfoList())
 {
 }

lar_content::DeltaRayOverlapResult::DeltaRayOverlapResult	(	const unsigned int	nMatchedSamplingPoints,
		const unsigned int	nSamplingPoints,
		const float	chi2,
		const XOverlap &	xOverlap,
		const pandora::PfoList &	commonMuonPfoList
	)

Constructor.

Parameters

nMatchedSamplingPoints
nSamplingPoints
chi2
xOverlap
commonMuonPfoList	the list of cosmic ray pfos that, in each view, lie close to the clusters of the tensor element

lar_content::DeltaRayOverlapResult::DeltaRayOverlapResult ( const DeltaRayOverlapResult & rhs )

Copy constructor.

Parameters

rhs

Definition at line 324 of file LArTrackOverlapResult.cc.

                                                                              :
     TransverseOverlapResult(rhs),
     m_commonMuonPfoList(rhs.GetCommonMuonPfoList())
 {
 }

lar_content::DeltaRayOverlapResult::~DeltaRayOverlapResult ( )

virtual

Destructor.

Definition at line 332 of file LArTrackOverlapResult.cc.

333 {

334 }

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+().

 {
     if (m_isInitialized)
         return m_chi2;
 
     throw pandora::StatusCodeException(pandora::STATUS_CODE_NOT_INITIALIZED);
 }

const pandora::PfoList & lar_content::DeltaRayOverlapResult::GetCommonMuonPfoList ( ) const

inline

Get the common muon pfo list.

Returns: the common muon pfo list

Definition at line 503 of file LArTrackOverlapResult.h.

Referenced by operator=().

 {
     return m_commonMuonPfoList;
 }

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().

 {
     if (m_isInitialized)
         return m_matchedFraction;
 
     throw pandora::StatusCodeException(pandora::STATUS_CODE_NOT_INITIALIZED);
 }

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().

 {
     if (m_isInitialized)
         return m_nMatchedSamplingPoints;
 
     throw pandora::StatusCodeException(pandora::STATUS_CODE_NOT_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().

 {
     if (m_isInitialized)
         return m_nSamplingPoints;
 
     throw pandora::StatusCodeException(pandora::STATUS_CODE_NOT_INITIALIZED);
 }

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.

 {
     if (m_isInitialized)
         return m_reducedChi2;
 
     throw pandora::StatusCodeException(pandora::STATUS_CODE_NOT_INITIALIZED);
 }

const XOverlap & lar_content::TransverseOverlapResult::GetXOverlap ( ) const

inlineinherited

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 lar_content::TransverseOverlapResult::operator=().

 {
     if (m_isInitialized)
         return m_xOverlap;
 
     throw pandora::StatusCodeException(pandora::STATUS_CODE_NOT_INITIALIZED);
 }

bool lar_content::TrackOverlapResult::IsInitialized ( ) const

inlineinherited

Whether the track overlap result has been initialized.

Returns: boolean

Definition at line 404 of file LArTrackOverlapResult.h.

References lar_content::TrackOverlapResult::m_isInitialized.

Referenced by lar_content::ThreeViewDeltaRayMatchingAlgorithm::DoesClusterPassTensorThreshold(), lar_content::ThreeViewTransverseTracksAlgorithm::GetBestOverlapResult(), lar_content::ThreeViewTransverseTracksAlgorithm::GetPreviousOverlapResults(), lar_content::operator+(), lar_content::TrackOverlapResult::operator<(), lar_content::TransverseOverlapResult::operator=(), lar_content::ThreeViewTrackFragmentsAlgorithm::PerformMainLoop(), lar_content::ThreeViewLongitudinalTracksAlgorithm::ThreeViewLongitudinalTracksAlgorithm(), and lar_content::ThreeViewTransverseTracksAlgorithm::ThreeViewTransverseTracksAlgorithm().

 {
     return m_isInitialized;
 }

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

inherited

Track overlap result less than operator.

Parameters

rhs	the 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.

 {
     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);
 }

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

Track overlap result assigment operator.

Parameters

rhs	the track overlap result to assign

Definition at line 338 of file LArTrackOverlapResult.cc.

References GetCommonMuonPfoList(), m_commonMuonPfoList, and lar_content::TransverseOverlapResult::operator=().

 {
     this->TransverseOverlapResult::operator=(rhs);
 
     m_commonMuonPfoList = rhs.GetCommonMuonPfoList();
 
     return *this;
 }

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

inherited

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

protectedinherited

The absolute chi2 value.

Definition at line 122 of file LArTrackOverlapResult.h.

Referenced by lar_content::TrackOverlapResult::GetChi2(), lar_content::TrackOverlapResult::operator=(), and lar_content::TrackOverlapResult::TrackOverlapResult().

pandora::PfoList lar_content::DeltaRayOverlapResult::m_commonMuonPfoList

private

The list of cosmic ray pfos that, in each view, lie close to the clusters of the tensor element.

Definition at line 396 of file LArTrackOverlapResult.h.

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

bool lar_content::TrackOverlapResult::m_isInitialized

protectedinherited

Whether the track overlap result has been initialized.

Definition at line 118 of file LArTrackOverlapResult.h.

Referenced by lar_content::TrackOverlapResult::GetChi2(), lar_content::TrackOverlapResult::GetMatchedFraction(), lar_content::TrackOverlapResult::GetNMatchedSamplingPoints(), lar_content::TrackOverlapResult::GetNSamplingPoints(), lar_content::TrackOverlapResult::GetReducedChi2(), lar_content::TransverseOverlapResult::GetXOverlap(), lar_content::TrackOverlapResult::IsInitialized(), lar_content::TrackOverlapResult::operator<(), and lar_content::TrackOverlapResult::operator=().

float lar_content::TrackOverlapResult::m_matchedFraction

protectedinherited

The fraction of sampling points resulting in a match.

Definition at line 121 of file LArTrackOverlapResult.h.

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

unsigned int lar_content::TrackOverlapResult::m_nMatchedSamplingPoints

protectedinherited

The number of matched sampling points.

Definition at line 119 of file LArTrackOverlapResult.h.

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

unsigned int lar_content::TrackOverlapResult::m_nSamplingPoints

protectedinherited

The number of sampling points.

Definition at line 120 of file LArTrackOverlapResult.h.

Referenced by lar_content::TrackOverlapResult::GetNSamplingPoints(), lar_content::TrackOverlapResult::operator=(), and lar_content::TrackOverlapResult::TrackOverlapResult().

float lar_content::TrackOverlapResult::m_reducedChi2

protectedinherited

The chi2 per samping point value.

Definition at line 123 of file LArTrackOverlapResult.h.

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

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

larpandoracontent/v04_08_01/source/larpandoracontent/LArObjects/LArTrackOverlapResult.h
larpandoracontent/v04_08_01/source/larpandoracontent/LArObjects/LArTrackOverlapResult.cc

Public Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation