pandora::Vertex Class Reference

Vertex class. More...

#include "Vertex.h"

Collaboration diagram for pandora::Vertex:

Public Member Functions
const CartesianVector &	GetPosition () const
	Get the vertex position.
float	GetX0 () const
	For LArTPC usage, the x-coordinate shift associated with a drift time t0 shift, units mm.
VertexLabel	GetVertexLabel () const
	Get the vertex label.
VertexType	GetVertexType () const
	Get the vertex type.
bool	IsAvailable () const
	Whether the vertex is available to be added to a particle flow object.

Protected Member Functions
	Vertex (const object_creation::Vertex::Parameters &parameters)
	Constructor.
virtual	~Vertex ()
	Destructor.
StatusCode	AlterMetadata (const object_creation::Vertex::Metadata &metadata)
	Alter the metadata information stored in a vertex.
void	SetAvailability (bool isAvailable)
	Set availability of vertex to be added to a particle flow object.

Protected Attributes
CartesianVector	m_position
	The vertex position.
float	m_x0
	For LArTPC usage, the x-coordinate shift associated with a drift time t0 shift, units mm.
VertexLabel	m_vertexLabel
	The vertex label (interaction, start, end, etc.)
VertexType	m_vertexType
	The vertex type (3d, view u, v, w, etc.)
bool	m_isAvailable
	Whether the track is available to be added to a particle flow object.

Friends
class	VertexManager
class	AlgorithmObjectManager< Vertex >
class	PandoraObjectFactory< object_creation::Vertex::Parameters, object_creation::Vertex::Object >

Detailed Description

Vertex class.

Definition at line 25 of file Vertex.h.

Constructor & Destructor Documentation

Vertex()

pandora::Vertex::Vertex ( const object_creation::Vertex::Parameters &  parameters )

protected

Constructor.

Parameters

parameters

the vertex parameters

Definition at line 14 of file Vertex.cc.

~Vertex()

pandora::Vertex::~Vertex ( )

protectedvirtual

Destructor.

Definition at line 25 of file Vertex.cc.

Member Function Documentation

AlterMetadata()

StatusCode pandora::Vertex::AlterMetadata ( const object_creation::Vertex::Metadata &  metadata )

protected

Alter the metadata information stored in a vertex.

Parameters

metaData

the metadata (only populated metadata fields will be propagated to the object)

Definition at line 31 of file Vertex.cc.

Here is the caller graph for this function:

GetPosition()

const CartesianVector & pandora::Vertex::GetPosition ( ) const

inline

Get the vertex position.

Returns

the vertex position

Definition at line 103 of file Vertex.h.

GetVertexLabel()

VertexLabel pandora::Vertex::GetVertexLabel ( ) const

inline

Get the vertex label.

Returns

the vertex label

Definition at line 117 of file Vertex.h.

Here is the caller graph for this function:

GetVertexType()

VertexType pandora::Vertex::GetVertexType ( ) const

inline

Get the vertex type.

Returns

the vertex type

Definition at line 124 of file Vertex.h.

Here is the caller graph for this function:

GetX0()

float pandora::Vertex::GetX0 ( ) const

inline

For LArTPC usage, the x-coordinate shift associated with a drift time t0 shift, units mm.

Returns

the x-coordinate shift

Definition at line 110 of file Vertex.h.

Here is the caller graph for this function:

IsAvailable()

bool pandora::Vertex::IsAvailable ( ) const

inline

Whether the vertex is available to be added to a particle flow object.

Returns

boolean

Definition at line 131 of file Vertex.h.

Here is the caller graph for this function:

SetAvailability()

void pandora::Vertex::SetAvailability ( bool  isAvailable )

inlineprotected

Set availability of vertex to be added to a particle flow object.

Parameters

isAvailable

the vertex availability

Definition at line 138 of file Vertex.h.

Friends And Related Symbol Documentation

AlgorithmObjectManager< Vertex >

friend class AlgorithmObjectManager< Vertex >

friend

Definition at line 96 of file Vertex.h.

PandoraObjectFactory< object_creation::Vertex::Parameters, object_creation::Vertex::Object >

friend class PandoraObjectFactory< object_creation::Vertex::Parameters, object_creation::Vertex::Object >

friend

Definition at line 96 of file Vertex.h.

VertexManager

friend class VertexManager

friend

Definition at line 96 of file Vertex.h.

Member Data Documentation

m_isAvailable

bool pandora::Vertex::m_isAvailable

protected

Whether the track is available to be added to a particle flow object.

Definition at line 94 of file Vertex.h.

m_position

CartesianVector pandora::Vertex::m_position

protected

The vertex position.

Definition at line 90 of file Vertex.h.

m_vertexLabel

VertexLabel pandora::Vertex::m_vertexLabel

protected

The vertex label (interaction, start, end, etc.)

Definition at line 92 of file Vertex.h.

m_vertexType

VertexType pandora::Vertex::m_vertexType

protected

The vertex type (3d, view u, v, w, etc.)

Definition at line 93 of file Vertex.h.

m_x0

float pandora::Vertex::m_x0

protected

For LArTPC usage, the x-coordinate shift associated with a drift time t0 shift, units mm.

Definition at line 91 of file Vertex.h.

---

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

• PandoraSDK/include/Objects/Vertex.h
• PandoraSDK/src/Objects/Vertex.cc