TwoViewDeltaRayOverlapResult class. More...

#include "LArTrackTwoViewOverlapResult.h"

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

	TwoViewDeltaRayOverlapResult (const TwoViewXOverlap &xOverlap, const pandora::PfoList &commonMuonPfoList, const pandora::Cluster *const pBestMatchedCluster, const pandora::ClusterList &matchedClusterList, const float reducedChiSquared)
	Constructor. More...

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

virtual	~TwoViewDeltaRayOverlapResult ()
	Destructor. More...

bool	IsInitialized () const
	Whether the track overlap result has been initialized. More...

const TwoViewXOverlap &	GetXOverlap () const
	Get the x overlap object. More...

const pandora::Cluster *	GetBestMatchedCluster () const
	Get the best matched cluster. More...

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

const pandora::ClusterList &	GetMatchedClusterList () const
	Get the matched cluster list. More...

float	GetReducedChiSquared () const
	Get the reduced chi squared value. More...

const pandora::Cluster *	GetBestMatchedAvailableCluster () const
	Get the best matched available cluster. More...

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

bool	operator< (const TwoViewDeltaRayOverlapResult &rhs) const
	Track two view overlap result less than operator. More...

Private Attributes
bool	m_isInitialized
	Whether the two view delta ray overlap result has been initialized. More...

TwoViewXOverlap	m_xOverlap
	The x overlap object. More...

pandora::PfoList	m_commonMuonPfoList
	The list of muon pfos whose clusters lie close to delta ray clusters in all views. More...

const pandora::Cluster *	m_pBestMatchedCluster
	The largest cluster that lies on the projected hits. More...

pandora::ClusterList	m_matchedClusterList
	The list of clusters that lie on the projected hits. More...

float	m_reducedChiSquared
	The reduced chi squared of the best matched cluster. More...

Detailed Description

TwoViewDeltaRayOverlapResult class.

Definition at line 23 of file LArTrackTwoViewOverlapResult.h.

Constructor & Destructor Documentation

lar_content::TwoViewDeltaRayOverlapResult::TwoViewDeltaRayOverlapResult ( )

Default constructor.

Definition at line 17 of file LArTrackTwoViewOverlapResult.cc.

References m_commonMuonPfoList, m_isInitialized, m_matchedClusterList, m_pBestMatchedCluster, m_reducedChiSquared, and m_xOverlap.

                                                            :
     m_isInitialized(false),
     m_xOverlap(TwoViewXOverlap(0.f, 0.f, 0.f, 0.f)),
     m_commonMuonPfoList(),
     m_pBestMatchedCluster(nullptr),
     m_matchedClusterList(),
     m_reducedChiSquared(std::numeric_limits<float>::max())
 {
 }

lar_content::TwoViewDeltaRayOverlapResult::TwoViewDeltaRayOverlapResult	(	const TwoViewXOverlap &	xOverlap,
		const pandora::PfoList &	commonMuonPfoList,
		const pandora::Cluster *const	pBestMatchedCluster,
		const pandora::ClusterList &	matchedClusterList,
		const float	reducedChiSquared
	)

Constructor.

Parameters

xOverlap	the xOverlap of the two clusters
commonMuonPfoList	the list of muon pfos whose clusters lie close to delta ray clusters in all views
pBestMatchedCluster	the largest cluster that lies on the projected hits
matchedClusterList	the list of clusters that lie on the projected hits
reducedChiSquared	the reduced chi squared

lar_content::TwoViewDeltaRayOverlapResult::TwoViewDeltaRayOverlapResult ( const TwoViewDeltaRayOverlapResult & rhs )

Copy constructor.

Parameters

rhs

Definition at line 42 of file LArTrackTwoViewOverlapResult.cc.

                                                                                                   :
     m_isInitialized(rhs.m_isInitialized),
     m_xOverlap(rhs.GetXOverlap()),
     m_commonMuonPfoList(rhs.GetCommonMuonPfoList()),
     m_pBestMatchedCluster(rhs.GetBestMatchedCluster()),
     m_matchedClusterList(rhs.GetMatchedClusterList()),
     m_reducedChiSquared(rhs.GetReducedChiSquared())
 {
 }

lar_content::TwoViewDeltaRayOverlapResult::~TwoViewDeltaRayOverlapResult ( )

virtual

Destructor.

Definition at line 54 of file LArTrackTwoViewOverlapResult.cc.

55 {

56 }

Member Function Documentation

const Cluster * lar_content::TwoViewDeltaRayOverlapResult::GetBestMatchedAvailableCluster ( ) const

Get the best matched available cluster.

Returns: the best matched available cluster

Definition at line 60 of file LArTrackTwoViewOverlapResult.cc.

References m_matchedClusterList.

 {
     unsigned int highestNHits(0);
     const Cluster *pBestMatchedCluster(nullptr);
 
     for (const Cluster *const pMatchedCluster : m_matchedClusterList)
     {
         if (!pMatchedCluster->IsAvailable())
             continue;
 
         if (pMatchedCluster->GetNCaloHits() > highestNHits)
         {
             highestNHits = pMatchedCluster->GetNCaloHits();
             pBestMatchedCluster = pMatchedCluster;
         }
     }
 
     return pBestMatchedCluster;
 }

const pandora::Cluster * lar_content::TwoViewDeltaRayOverlapResult::GetBestMatchedCluster ( ) const

inline

Get the best matched cluster.

Returns: the best matched cluster

Definition at line 327 of file LArTrackTwoViewOverlapResult.h.

References m_pBestMatchedCluster.

Referenced by operator=().

 {
     return m_pBestMatchedCluster;
 }

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

inline

Get the common muon pfo list.

Returns: the common muon pfo list

Definition at line 334 of file LArTrackTwoViewOverlapResult.h.

References m_commonMuonPfoList.

Referenced by operator=(), and lar_content::TwoViewDeltaRayMatchingAlgorithm::UpdateForThirdViewClusterModification().

 {
     return m_commonMuonPfoList;
 }

const pandora::ClusterList & lar_content::TwoViewDeltaRayOverlapResult::GetMatchedClusterList ( ) const

inline

Get the matched cluster list.

Returns: the matched cluster list

Definition at line 341 of file LArTrackTwoViewOverlapResult.h.

References m_matchedClusterList.

Referenced by operator=(), and lar_content::TwoViewDeltaRayMatchingAlgorithm::UpdateForThirdViewClusterModification().

 {
     return m_matchedClusterList;
 }

float lar_content::TwoViewDeltaRayOverlapResult::GetReducedChiSquared ( ) const

inline

Get the reduced chi squared value.

Returns: the reduced chi squared value

Definition at line 348 of file LArTrackTwoViewOverlapResult.h.

References m_reducedChiSquared.

Referenced by operator=().

 {
     return m_reducedChiSquared;
 }

const TwoViewXOverlap & lar_content::TwoViewDeltaRayOverlapResult::GetXOverlap ( ) const

inline

Get the x overlap object.

Returns: the x overlap object

Definition at line 320 of file LArTrackTwoViewOverlapResult.h.

References m_xOverlap.

Referenced by operator=(), and lar_content::TwoViewDeltaRayMatchingAlgorithm::UpdateForThirdViewClusterModification().

 {
     return m_xOverlap;
 }

bool lar_content::TwoViewDeltaRayOverlapResult::IsInitialized ( ) const

inline

Whether the track overlap result has been initialized.

Returns: boolean

Definition at line 313 of file LArTrackTwoViewOverlapResult.h.

References m_isInitialized.

Referenced by lar_content::TwoViewDeltaRayMatchingAlgorithm::DoesClusterPassTensorThreshold().

 {
     return m_isInitialized;
 }

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

Track two view overlap result less than operator.

Parameters

rhs	the track two view overlap result for comparison

Definition at line 96 of file LArTrackTwoViewOverlapResult.cc.

References lar_content::TwoViewXOverlap::GetTwoViewXOverlapSpan(), m_isInitialized, and m_xOverlap.

 {
     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_xOverlap.GetTwoViewXOverlapSpan() < rhs.m_xOverlap.GetTwoViewXOverlapSpan());
 }

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

Track overlap result assigment operator.

Parameters

rhs	the track overlap result to assign

Definition at line 82 of file LArTrackTwoViewOverlapResult.cc.

References GetBestMatchedCluster(), GetCommonMuonPfoList(), GetMatchedClusterList(), GetReducedChiSquared(), GetXOverlap(), m_commonMuonPfoList, m_isInitialized, m_matchedClusterList, m_pBestMatchedCluster, m_reducedChiSquared, and m_xOverlap.

 {
     m_isInitialized = rhs.m_isInitialized;
     m_xOverlap = rhs.GetXOverlap();
     m_commonMuonPfoList = rhs.GetCommonMuonPfoList();
     m_pBestMatchedCluster = rhs.GetBestMatchedCluster();
     m_matchedClusterList = rhs.GetMatchedClusterList();
     m_reducedChiSquared = rhs.GetReducedChiSquared();
 
     return *this;
 }

Member Data Documentation

pandora::PfoList lar_content::TwoViewDeltaRayOverlapResult::m_commonMuonPfoList

private

The list of muon pfos whose clusters lie close to delta ray clusters in all views.

Definition at line 121 of file LArTrackTwoViewOverlapResult.h.

Referenced by GetCommonMuonPfoList(), operator=(), and TwoViewDeltaRayOverlapResult().

bool lar_content::TwoViewDeltaRayOverlapResult::m_isInitialized

private

Whether the two view delta ray overlap result has been initialized.

Definition at line 119 of file LArTrackTwoViewOverlapResult.h.

Referenced by lar_content::TwoViewTransverseOverlapResult::GetCorrelationCoefficient(), lar_content::TwoViewTransverseOverlapResult::GetLocallyMatchedFraction(), lar_content::TrackTwoViewOverlapResult::GetMatchingScore(), lar_content::TwoViewTransverseOverlapResult::GetNMatchedReUpsampledSamplingPoints(), lar_content::TwoViewTransverseOverlapResult::GetNMatchedSamplingPoints(), lar_content::TwoViewTransverseOverlapResult::GetNReUpsampledSamplingPoints(), lar_content::TwoViewTransverseOverlapResult::GetNSamplingPoints(), lar_content::TwoViewTransverseOverlapResult::GetTwoViewXOverlap(), IsInitialized(), lar_content::TrackTwoViewOverlapResult::IsInitialized(), operator<(), operator=(), and TwoViewDeltaRayOverlapResult().

pandora::ClusterList lar_content::TwoViewDeltaRayOverlapResult::m_matchedClusterList

private

The list of clusters that lie on the projected hits.

Definition at line 123 of file LArTrackTwoViewOverlapResult.h.

Referenced by GetBestMatchedAvailableCluster(), GetMatchedClusterList(), operator=(), and TwoViewDeltaRayOverlapResult().

const pandora::Cluster* lar_content::TwoViewDeltaRayOverlapResult::m_pBestMatchedCluster

private

The largest cluster that lies on the projected hits.

Definition at line 122 of file LArTrackTwoViewOverlapResult.h.

Referenced by GetBestMatchedCluster(), operator=(), and TwoViewDeltaRayOverlapResult().

float lar_content::TwoViewDeltaRayOverlapResult::m_reducedChiSquared

private

The reduced chi squared of the best matched cluster.

Definition at line 124 of file LArTrackTwoViewOverlapResult.h.

Referenced by GetReducedChiSquared(), operator=(), and TwoViewDeltaRayOverlapResult().

TwoViewXOverlap lar_content::TwoViewDeltaRayOverlapResult::m_xOverlap

private

The x overlap object.

Definition at line 120 of file LArTrackTwoViewOverlapResult.h.

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

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

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation