HierarchyPfo class. More...

#include "LArHierarchyPfo.h"

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

	HierarchyPfo (const pandora::ParticleFlowObject *pPfo, const ThreeDSlidingFitResult &threeDSlidingFitResult, const ExtremalPoint &upstreamPoint, const ExtremalPoint &downstreamPoint)
	Constructor. More...

const pandora::ParticleFlowObject *	GetPfo () const
	Get the pfo. More...

void	SetPfo (const pandora::ParticleFlowObject *pPfo)
	Set the pfo. More...

const ThreeDSlidingFitResult &	GetSlidingFitResult () const
	Get the pfo's 3D sliding fit result. More...

const pandora::ParticleFlowObject *	GetPredictedParentPfo () const
	Get the best matched parent pfo. More...

void	SetPredictedParentPfo (const pandora::ParticleFlowObject *pPredictedParentPfo)
	Set the best matched parent pfo. More...

const pandora::ParticleFlowObject *	GetParentPfo () const
	Get the parent pfo. More...

void	SetParentPfo (const pandora::ParticleFlowObject *pParentPfo)
	Set the parent pfo. More...

const pandora::PfoVector &	GetChildPfoVector () const
	Get the vector of child pfos. More...

void	AddChildPfo (const pandora::ParticleFlowObject *const pChildPfo)
	Add a child pfo to the child pfo vector. More...

const ExtremalPoint &	GetUpstreamPoint () const
	Get the upstream extremal point. More...

void	SetUpstreamPoint (const ExtremalPoint &upstreamPoint)
	Set the upstream extremal point. More...

const ExtremalPoint &	GetDownstreamPoint () const
	Get the downstream extremal point. More...

void	SetDownstreamPoint (const ExtremalPoint &downstreamPoint)
	Set the downstream extremal point. More...

float	GetPrimaryScore () const
	Get the primary network score. More...

void	SetPrimaryScore (const float primaryScore)
	Set the primary network score. More...

float	GetLaterTierScore () const
	Get the later tier network score. More...

void	SetLaterTierScore (const float laterTierScore)
	Set the later tier network score. More...

bool	GetIsInHierarchy () const
	Get whether the pfo has been assigned to a particle hierarchy. More...

void	SetIsInHierarchy (const bool isInHierarchy)
	Set whether the pfo has been assigned to a particle hierarchy. More...

bool	operator== (const HierarchyPfo &rhs) const
	HierarchyPfo == operator. More...

bool	operator== (const pandora::ParticleFlowObject *const rhs) const
	HierarchyPfo == operator. More...

Private Attributes
const pandora::ParticleFlowObject *	m_pPfo
	a pointer to the corresponding pfo More...

ThreeDSlidingFitResult	m_slidingFitResult
	the 3D sliding fit result of the pfo More...

const pandora::ParticleFlowObject *	m_pPredictedParentPfo
	a pointer to the best matched parent pfo More...

const pandora::ParticleFlowObject *	m_pParentPfo
	a pointer to the assigned parent pfo More...

pandora::PfoVector	m_childPfoVector
	the vector of pointers to the assigned child pfos More...

ExtremalPoint	m_upstreamPoint
	The extremal point that lies closest to the neutrino vertex. More...

ExtremalPoint	m_downstreamPoint
	The extremal point that lies furthest from the neutrino vertex. More...

float	m_primaryScore
	the primary network score More...

float	m_laterTierScore
	the later tier network score More...

bool	m_isInHierarchy
	whether the pfo has been assigned to a particle hierarchy More...

Detailed Description

HierarchyPfo class.

Definition at line 82 of file LArHierarchyPfo.h.

Constructor & Destructor Documentation

lar_dl_content::HierarchyPfo::HierarchyPfo ( )

Default constructor.

lar_dl_content::HierarchyPfo::HierarchyPfo	(	const pandora::ParticleFlowObject *	pPfo,
		const ThreeDSlidingFitResult &	threeDSlidingFitResult,
		const ExtremalPoint &	upstreamPoint,
		const ExtremalPoint &	downstreamPoint
	)

inline

Constructor.

Parameters

pPfo	pointer to the input pfo
threeDSlidingFitResult	3D sliding fit of the input pfo
upstreamPoint	the extremal point closest to the neutrino vertex
downstreamPoint	the extremal point furthest from the neutrino vertex

Definition at line 324 of file LArHierarchyPfo.h.

                                                                               :
     m_pPfo(pPfo),
     m_slidingFitResult(slidingFitResult),
     m_pPredictedParentPfo(nullptr),
     m_pParentPfo(nullptr),
     m_childPfoVector(pandora::PfoVector()),
     m_upstreamPoint(upstreamPoint),
     m_downstreamPoint(downstreamPoint),
     m_primaryScore(-std::numeric_limits<float>::max()),
     m_laterTierScore(-std::numeric_limits<float>::max()),
     m_isInHierarchy(false)
 {
 }

Member Function Documentation

void lar_dl_content::HierarchyPfo::AddChildPfo ( const pandora::ParticleFlowObject *const pChildPfo )

inline

Add a child pfo to the child pfo vector.

Parameters

pChildPfo the pointer to the child pfo to add

Definition at line 397 of file LArHierarchyPfo.h.

References m_childPfoVector.

 {
     m_childPfoVector.emplace_back(pChildPfo);
 }

const pandora::PfoVector & lar_dl_content::HierarchyPfo::GetChildPfoVector ( ) const

inline

Get the vector of child pfos.

Returns: the vector of pointers to child pfos

Definition at line 390 of file LArHierarchyPfo.h.

References m_childPfoVector.

Referenced by lar_dl_content::DLNeutrinoHierarchyAlgorithm::BuildPandoraHierarchy().

 {
     return m_childPfoVector;
 }

const ExtremalPoint & lar_dl_content::HierarchyPfo::GetDownstreamPoint ( ) const

inline

Get the downstream extremal point.

Returns: the downstream extremal point

Definition at line 418 of file LArHierarchyPfo.h.

References m_downstreamPoint.

Referenced by lar_dl_content::DLNeutrinoHierarchyAlgorithm::BuildPandoraHierarchy(), lar_dl_content::DLPrimaryHierarchyTool::CalculateNetworkVariables(), lar_dl_content::DLLaterTierHierarchyTool::CalculateNetworkVariables(), lar_dl_content::DLLaterTierHierarchyTool::IsShowerVertexUpstream(), and lar_dl_content::DLCheatHierarchyTool::Run().

 {
     return m_downstreamPoint;
 }

bool lar_dl_content::HierarchyPfo::GetIsInHierarchy ( ) const

inline

Get whether the pfo has been assigned to a particle hierarchy.

Returns: whether the pfo has been assigned to a particle hierarchy

Definition at line 460 of file LArHierarchyPfo.h.

References m_isInHierarchy.

Referenced by lar_dl_content::DLNeutrinoHierarchyAlgorithm::BuildPandoraHierarchy().

 {
     return m_isInHierarchy;
 }

float lar_dl_content::HierarchyPfo::GetLaterTierScore ( ) const

inline

Get the later tier network score.

Returns: the later tier network score

Definition at line 446 of file LArHierarchyPfo.h.

References m_laterTierScore.

 {
     return m_laterTierScore;
 }

const pandora::ParticleFlowObject * lar_dl_content::HierarchyPfo::GetParentPfo ( ) const

inline

Get the parent pfo.

Returns: a pointer to the parent pfo

Definition at line 376 of file LArHierarchyPfo.h.

References m_pParentPfo.

Referenced by lar_dl_content::DLNeutrinoHierarchyAlgorithm::BuildPandoraHierarchy().

 {
     return m_pParentPfo;
 }

const pandora::ParticleFlowObject * lar_dl_content::HierarchyPfo::GetPfo ( ) const

inline

Get the pfo.

Returns: a pointer to the pfo

Definition at line 341 of file LArHierarchyPfo.h.

References m_pPfo.

Referenced by lar_dl_content::DLPrimaryHierarchyTool::CalculateNetworkVariables(), lar_dl_content::DLLaterTierHierarchyTool::CalculateNetworkVariables(), lar_dl_content::DLLaterTierHierarchyTool::IsShowerVertexUpstream(), operator==(), lar_dl_content::DLCheatHierarchyTool::Run(), lar_dl_content::DLLaterTierHierarchyTool::Run(), lar_dl_content::DLPrimaryHierarchyTool::Run(), and lar_dl_content::DLLaterTierHierarchyTool::SetParentConnectionPointVars().

 {
     return m_pPfo;
 }

const pandora::ParticleFlowObject * lar_dl_content::HierarchyPfo::GetPredictedParentPfo ( ) const

inline

Get the best matched parent pfo.

Returns: a pointer to the best matched parent pfo

Definition at line 362 of file LArHierarchyPfo.h.

References m_pPredictedParentPfo.

 {
     return m_pPredictedParentPfo;
 }

float lar_dl_content::HierarchyPfo::GetPrimaryScore ( ) const

inline

Get the primary network score.

Returns: the primary network score

Definition at line 432 of file LArHierarchyPfo.h.

References m_primaryScore.

 {
     return m_primaryScore;
 }

const ThreeDSlidingFitResult & lar_dl_content::HierarchyPfo::GetSlidingFitResult ( ) const

inline

Get the pfo's 3D sliding fit result.

Returns: the 3D sliding fit result

Definition at line 355 of file LArHierarchyPfo.h.

References m_slidingFitResult.

Referenced by lar_dl_content::DLLaterTierHierarchyTool::SetConnectionParams().

 {
     return m_slidingFitResult;
 }

const ExtremalPoint & lar_dl_content::HierarchyPfo::GetUpstreamPoint ( ) const

inline

Get the upstream extremal point.

Returns: the upstream extremal point

Definition at line 404 of file LArHierarchyPfo.h.

References m_upstreamPoint.

Referenced by lar_dl_content::DLNeutrinoHierarchyAlgorithm::BuildPandoraHierarchy(), lar_dl_content::DLPrimaryHierarchyTool::CalculateNetworkVariables(), lar_dl_content::DLLaterTierHierarchyTool::CalculateNetworkVariables(), lar_dl_content::DLLaterTierHierarchyTool::IsShowerVertexUpstream(), and lar_dl_content::DLCheatHierarchyTool::Run().

 {
     return m_upstreamPoint;
 }

bool lar_dl_content::HierarchyPfo::operator== ( const HierarchyPfo & rhs ) const

inline

HierarchyPfo == operator.

Parameters

rhs	the HierarchyPfo to compare

Definition at line 474 of file LArHierarchyPfo.h.

References GetPfo().

 {
     return this->GetPfo() == rhs.GetPfo();
 }

bool lar_dl_content::HierarchyPfo::operator== ( const pandora::ParticleFlowObject *const rhs ) const

inline

HierarchyPfo == operator.

Parameters

rhs	the pfo to compare

Definition at line 481 of file LArHierarchyPfo.h.

References GetPfo().

 {
     return this->GetPfo() == rhs;
 }

void lar_dl_content::HierarchyPfo::SetDownstreamPoint ( const ExtremalPoint & downstreamPoint )

inline

Set the downstream extremal point.

Parameters

downstreamPoint the downstream extremal point

Definition at line 425 of file LArHierarchyPfo.h.

References m_downstreamPoint.

 {
     m_downstreamPoint = downstreamPoint;
 }

void lar_dl_content::HierarchyPfo::SetIsInHierarchy ( const bool isInHierarchy )

inline

Set whether the pfo has been assigned to a particle hierarchy.

Parameters

isInHierarchy whether the pfo has been assigned to a particle hierarchy

Definition at line 467 of file LArHierarchyPfo.h.

References m_isInHierarchy.

 {
     m_isInHierarchy = isInHierarchy;
 }

void lar_dl_content::HierarchyPfo::SetLaterTierScore ( const float laterTierScore )

inline

Set the later tier network score.

Parameters

the	later tier network score

Definition at line 453 of file LArHierarchyPfo.h.

References m_laterTierScore.

 {
     m_laterTierScore = laterTierScore;
 }

void lar_dl_content::HierarchyPfo::SetParentPfo ( const pandora::ParticleFlowObject * pParentPfo )

inline

Set the parent pfo.

Parameters

pParentPfo a pointer to the parent pfo

Definition at line 383 of file LArHierarchyPfo.h.

References m_pParentPfo.

 {
     m_pParentPfo = pParentPfo;
 }

void lar_dl_content::HierarchyPfo::SetPfo ( const pandora::ParticleFlowObject * pPfo )

inline

Set the pfo.

Parameters

pPfo	a pointer to the pfo

Definition at line 348 of file LArHierarchyPfo.h.

References m_pPfo.

 {
     m_pPfo = pPfo;
 }

void lar_dl_content::HierarchyPfo::SetPredictedParentPfo ( const pandora::ParticleFlowObject * pPredictedParentPfo )

inline

Set the best matched parent pfo.

Parameters

pPredictedParentPfo a pointer to the best matched parent pfo

Definition at line 369 of file LArHierarchyPfo.h.

References m_pPredictedParentPfo.

 {
     m_pPredictedParentPfo = pPredictedParentPfo;
 }

void lar_dl_content::HierarchyPfo::SetPrimaryScore ( const float primaryScore )

inline

Set the primary network score.

Parameters

the	primary network score

Definition at line 439 of file LArHierarchyPfo.h.

References m_primaryScore.

 {
     m_primaryScore = primaryScore;
 }

void lar_dl_content::HierarchyPfo::SetUpstreamPoint ( const ExtremalPoint & upstreamPoint )

inline

Set the upstream extremal point.

Parameters

upstreamPoint the upstream extremal point

Definition at line 411 of file LArHierarchyPfo.h.

References m_upstreamPoint.

 {
     m_upstreamPoint = upstreamPoint;
 }

Member Data Documentation

pandora::PfoVector lar_dl_content::HierarchyPfo::m_childPfoVector

private

the vector of pointers to the assigned child pfos

Definition at line 253 of file LArHierarchyPfo.h.

Referenced by AddChildPfo(), and GetChildPfoVector().

ExtremalPoint lar_dl_content::HierarchyPfo::m_downstreamPoint

private

The extremal point that lies furthest from the neutrino vertex.

Definition at line 255 of file LArHierarchyPfo.h.

Referenced by GetDownstreamPoint(), and SetDownstreamPoint().

bool lar_dl_content::HierarchyPfo::m_isInHierarchy

private

whether the pfo has been assigned to a particle hierarchy

Definition at line 258 of file LArHierarchyPfo.h.

Referenced by GetIsInHierarchy(), and SetIsInHierarchy().

float lar_dl_content::HierarchyPfo::m_laterTierScore

private

the later tier network score

Definition at line 257 of file LArHierarchyPfo.h.

Referenced by GetLaterTierScore(), and SetLaterTierScore().

const pandora::ParticleFlowObject* lar_dl_content::HierarchyPfo::m_pParentPfo

private

a pointer to the assigned parent pfo

Definition at line 252 of file LArHierarchyPfo.h.

Referenced by GetParentPfo(), and SetParentPfo().

const pandora::ParticleFlowObject* lar_dl_content::HierarchyPfo::m_pPfo

private

a pointer to the corresponding pfo

Definition at line 249 of file LArHierarchyPfo.h.

Referenced by GetPfo(), and SetPfo().

const pandora::ParticleFlowObject* lar_dl_content::HierarchyPfo::m_pPredictedParentPfo

private

a pointer to the best matched parent pfo

Definition at line 251 of file LArHierarchyPfo.h.

Referenced by GetPredictedParentPfo(), and SetPredictedParentPfo().

float lar_dl_content::HierarchyPfo::m_primaryScore

private

the primary network score

Definition at line 256 of file LArHierarchyPfo.h.

Referenced by GetPrimaryScore(), and SetPrimaryScore().

ThreeDSlidingFitResult lar_dl_content::HierarchyPfo::m_slidingFitResult

private

the 3D sliding fit result of the pfo

Definition at line 250 of file LArHierarchyPfo.h.

Referenced by GetSlidingFitResult().

ExtremalPoint lar_dl_content::HierarchyPfo::m_upstreamPoint

private

The extremal point that lies closest to the neutrino vertex.

Definition at line 254 of file LArHierarchyPfo.h.

Referenced by GetUpstreamPoint(), and SetUpstreamPoint().

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

larpandoracontent/v04_15_01/source/larpandoradlcontent/LArThreeDReco/LArEventBuilding/LArHierarchyPfo.h

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation