#include "LArTrackOverlapResult.h"

Inheritance diagram for lar_content::FragmentOverlapResult:

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

	FragmentOverlapResult (const TrackOverlapResult trackOverlapResult, const pandora::CaloHitList &caloHitList, const pandora::ClusterList &clusterList)
	Constructor. More...

	FragmentOverlapResult (const unsigned int nMatchedSamplingPoints, const unsigned int nSamplingPoints, const float chi2, const pandora::CaloHitList &caloHitList, const pandora::ClusterList &clusterList)
	Constructor. More...

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

	~FragmentOverlapResult ()
	Destructor. More...

const pandora::CaloHitList &	GetFragmentCaloHitList () const
	Get the list of fragment-associated hits. More...

const pandora::ClusterList &	GetFragmentClusterList () const
	Get the list of fragment-associated clusters. More...

pandora::HitType	GetFragmentHitType () const
	Get the fragment hit type. More...

FragmentOverlapResult &	operator= (const FragmentOverlapResult &rhs)
	Fragments overlap result assigment operator. 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::CaloHitList	m_caloHitList
	The list of fragment-associated hits. More...

pandora::ClusterList	m_clusterList
	The list of fragment-associated clusters. More...

Detailed Description

FragmentOverlapResult class.

Definition at line 269 of file LArTrackOverlapResult.h.

Constructor & Destructor Documentation

lar_content::FragmentOverlapResult::FragmentOverlapResult ( )

Default constructor.

Definition at line 243 of file LArTrackOverlapResult.cc.

                                              :
     TrackOverlapResult(),
     m_caloHitList(),
     m_clusterList()
 {
 }

lar_content::FragmentOverlapResult::FragmentOverlapResult	(	const TrackOverlapResult	trackOverlapResult,
		const pandora::CaloHitList &	caloHitList,
		const pandora::ClusterList &	clusterList
	)

Constructor.

Parameters

trackOverlapResult
caloHitList
clusterList

Definition at line 251 of file LArTrackOverlapResult.cc.

                                                :
     TrackOverlapResult(trackOverlapResult),
     m_caloHitList(caloHitList),
     m_clusterList(clusterList)
 {
 
 }

lar_content::FragmentOverlapResult::FragmentOverlapResult	(	const unsigned int	nMatchedSamplingPoints,
		const unsigned int	nSamplingPoints,
		const float	chi2,
		const pandora::CaloHitList &	caloHitList,
		const pandora::ClusterList &	clusterList
	)

Constructor.

Parameters

nMatchedSamplingPoints
nSamplingPoints
chi2
caloHitList
clusterList

Definition at line 262 of file LArTrackOverlapResult.cc.

                                                                                                         :
     TrackOverlapResult(nMatchedSamplingPoints, nSamplingPoints, chi2),
     m_caloHitList(caloHitList),
     m_clusterList(clusterList)
 {
 }

lar_content::FragmentOverlapResult::FragmentOverlapResult ( const FragmentOverlapResult & rhs )

Copy constructor.

Parameters

rhs

Definition at line 272 of file LArTrackOverlapResult.cc.

                                                                              :
     TrackOverlapResult(rhs),
     m_caloHitList(rhs.IsInitialized() ? rhs.GetFragmentCaloHitList() : CaloHitList()),
     m_clusterList(rhs.IsInitialized() ? rhs.GetFragmentClusterList() : ClusterList())
 {
 }

lar_content::FragmentOverlapResult::~FragmentOverlapResult ( )

Destructor.

Definition at line 281 of file LArTrackOverlapResult.cc.

282 {

283 }

Member Function Documentation

float lar_content::TrackOverlapResult::GetChi2 ( ) const

inlineinherited

Get the absolute chi2 value.

Returns: the absolute chi2 value

Definition at line 386 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::CaloHitList & lar_content::FragmentOverlapResult::GetFragmentCaloHitList ( ) const

inline

Get the list of fragment-associated hits.

Returns: the list of fragment-associated hits

Definition at line 433 of file LArTrackOverlapResult.h.

Referenced by lar_content::ClearTrackFragmentsTool::CheckOverlapResult(), lar_content::ThreeDTrackFragmentsAlgorithm::CheckOverlapResult(), operator=(), lar_content::ThreeDTrackFragmentsAlgorithm::PerformMainLoop(), and lar_content::ClearTrackFragmentsTool::ProcessTensorElement().

 {
     return m_caloHitList;
 }

const pandora::ClusterList & lar_content::FragmentOverlapResult::GetFragmentClusterList ( ) const

inline

Get the list of fragment-associated clusters.

Returns: the list of fragment-associated clusters

Definition at line 440 of file LArTrackOverlapResult.h.

Referenced by lar_content::ClearTrackFragmentsTool::GetAffectedKeyClusters(), operator=(), and lar_content::ClearTrackFragmentsTool::ProcessTensorElement().

 {
     return m_clusterList;
 }

pandora::HitType lar_content::FragmentOverlapResult::GetFragmentHitType ( ) const

Get the fragment hit type.

Returns: the fragment hit type

Definition at line 298 of file LArTrackOverlapResult.cc.

References m_caloHitList.

Referenced by lar_content::ClearTrackFragmentsTool::GetAffectedKeyClusters(), and lar_content::ClearTrackFragmentsTool::ProcessTensorElement().

 {
     if (m_caloHitList.empty())
         throw StatusCodeException(STATUS_CODE_INVALID_PARAMETER);
 
     return (*(m_caloHitList.begin()))->GetHitType();
 }

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 376 of file LArTrackOverlapResult.h.

References lar_content::TrackOverlapResult::m_isInitialized, and lar_content::TrackOverlapResult::m_matchedFraction.

Referenced by lar_content::ClearTrackFragmentsTool::CheckOverlapResult(), lar_content::ThreeDTrackFragmentsAlgorithm::CheckOverlapResult(), and lar_content::ThreeDTransverseTracksAlgorithm::ThreeDTransverseTracksAlgorithm().

 {
     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 356 of file LArTrackOverlapResult.h.

References lar_content::TrackOverlapResult::m_isInitialized, and lar_content::TrackOverlapResult::m_nMatchedSamplingPoints.

Referenced by lar_content::operator+(), lar_content::ThreeDLongitudinalTracksAlgorithm::ThreeDLongitudinalTracksAlgorithm(), and lar_content::ThreeDTransverseTracksAlgorithm::ThreeDTransverseTracksAlgorithm().

 {
     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 366 of file LArTrackOverlapResult.h.

References lar_content::TrackOverlapResult::m_isInitialized, and lar_content::TrackOverlapResult::m_nSamplingPoints.

Referenced by lar_content::operator+(), and lar_content::ThreeDTransverseTracksAlgorithm::ThreeDTransverseTracksAlgorithm().

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

bool lar_content::TrackOverlapResult::IsInitialized ( ) const

inlineinherited

Whether the track overlap result has been initialized.

Returns: boolean

Definition at line 349 of file LArTrackOverlapResult.h.

References lar_content::TrackOverlapResult::m_isInitialized.

Referenced by lar_content::ThreeDTransverseTracksAlgorithm::GetBestOverlapResult(), lar_content::ThreeDTransverseTracksAlgorithm::GetPreviousOverlapResults(), lar_content::operator+(), lar_content::TrackOverlapResult::operator<(), lar_content::TransverseOverlapResult::operator=(), lar_content::ThreeDTrackFragmentsAlgorithm::PerformMainLoop(), lar_content::ThreeDLongitudinalTracksAlgorithm::ThreeDLongitudinalTracksAlgorithm(), and lar_content::ThreeDTransverseTracksAlgorithm::ThreeDTransverseTracksAlgorithm().

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

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

Fragments overlap result assigment operator.

Parameters

rhs	the track overlap result to assign

Definition at line 287 of file LArTrackOverlapResult.cc.

References GetFragmentCaloHitList(), GetFragmentClusterList(), m_caloHitList, m_clusterList, and lar_content::TrackOverlapResult::operator=().

 {
     this->TrackOverlapResult::operator=(rhs);
     m_caloHitList = rhs.GetFragmentCaloHitList();
     m_clusterList = rhs.GetFragmentClusterList();
 
     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

pandora::CaloHitList lar_content::FragmentOverlapResult::m_caloHitList

private

The list of fragment-associated hits.

Definition at line 340 of file LArTrackOverlapResult.h.

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

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::ClusterList lar_content::FragmentOverlapResult::m_clusterList

private

The list of fragment-associated clusters.

Definition at line 341 of file LArTrackOverlapResult.h.

Referenced by 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:

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

Public Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation