eicd::Vertex Class Reference

#include <Vertex.h>

Public Member Functions
	Vertex ()
	default constructor More...
	Vertex (std::int32_t primary, float chi2, float probability, edm4hep::Vector3f position, eicd::Cov3f positionError, std::int32_t algorithmType, float time)
	Vertex (VertexObj *obj)
	constructor from existing VertexObj More...
	Vertex (const Vertex &other)
	copy constructor More...
Vertex &	operator= (Vertex other)
	copy-assignment operator More...
MutableVertex	clone () const
	create a mutable deep-copy of the object with identical relations More...
	~Vertex ()
	destructor More...
const std::int32_t &	getPrimary () const
	Access the Boolean flag, if vertex is the primary vertex of the event. More...
const float &	getChi2 () const
	Access the Chi-squared of the vertex fit. More...
const float &	getProbability () const
	Access the Probability of the vertex fit. More...
const edm4hep::Vector3f &	getPosition () const
	Access the [mm] position of the vertex. More...
const eicd::Cov3f &	getPositionError () const
	Access the Covariance matrix of the position. More...
const std::int32_t &	getAlgorithmType () const
	Access the Type code for the algorithm that has been used to create the vertex - check/set the collection parameters AlgorithmName and AlgorithmType. More...
const float &	getTime () const
	Access the Vertex time. More...
const eicd::ReconstructedParticle	getAssociatedParticle () const
	Access the reconstructed particle associated to this vertex. More...
unsigned int	parameters_size () const
float	getParameters (unsigned int) const
std::vector< float >::const_iterator	parameters_begin () const
std::vector< float >::const_iterator	parameters_end () const
podio::RelationRange< float >	getParameters () const
bool	isAvailable () const
	check whether the object is actually available More...
void	unlink ()
	disconnect from VertexObj instance More...
bool	operator== (const Vertex &other) const
bool	operator== (const MutableVertex &other) const
bool	operator< (const Vertex &other) const
unsigned int	id () const
const podio::ObjectID	getObjectID () const

Friends
class	MutableVertex
class	VertexCollection
class	VertexCollectionIterator
void	swap (Vertex &a, Vertex &b)

Detailed Description

EIC vertex

Author

: W. Armstrong, S. Joosten, based off EDM4hep

Constructor & Destructor Documentation

Vertex() [1/4]

eicd::Vertex::Vertex

(

)

default constructor

Vertex() [2/4]

eicd::Vertex::Vertex	(	std::int32_t	primary,
		float	chi2,
		float	probability,
		edm4hep::Vector3f	position,
		eicd::Cov3f	positionError,
		std::int32_t	algorithmType,
		float	time
	)

Vertex() [3/4]

eicd::Vertex::Vertex

(

VertexObj *

obj

)

constructor from existing VertexObj

Vertex() [4/4]

eicd::Vertex::Vertex

(

const Vertex &

other

)

copy constructor

~Vertex()

eicd::Vertex::~Vertex

(

)

destructor

Member Function Documentation

clone()

MutableVertex eicd::Vertex::clone

(

)

const

create a mutable deep-copy of the object with identical relations

getAlgorithmType()

const std::int32_t & eicd::Vertex::getAlgorithmType

(

)

const

Access the Type code for the algorithm that has been used to create the vertex - check/set the collection parameters AlgorithmName and AlgorithmType.

getAssociatedParticle()

const eicd::ReconstructedParticle eicd::Vertex::getAssociatedParticle

(

)

const

Access the reconstructed particle associated to this vertex.

getChi2()

const float & eicd::Vertex::getChi2

(

)

const

Access the Chi-squared of the vertex fit.

getObjectID()

const podio::ObjectID eicd::Vertex::getObjectID

(

)

const

getParameters() [1/2]

podio::RelationRange< float > eicd::Vertex::getParameters

(

)

const

getParameters() [2/2]

float eicd::Vertex::getParameters

(

unsigned int

index

)

const

getPosition()

const edm4hep::Vector3f & eicd::Vertex::getPosition

(

)

const

Access the [mm] position of the vertex.

getPositionError()

const eicd::Cov3f & eicd::Vertex::getPositionError

(

)

const

Access the Covariance matrix of the position.

getPrimary()

const std::int32_t & eicd::Vertex::getPrimary

(

)

const

Access the Boolean flag, if vertex is the primary vertex of the event.

getProbability()

const float & eicd::Vertex::getProbability

(

)

const

Access the Probability of the vertex fit.

getTime()

const float & eicd::Vertex::getTime

(

)

const

Access the Vertex time.

id()

unsigned int eicd::Vertex::id ( ) const

inline

isAvailable()

bool eicd::Vertex::isAvailable

(

)

const

check whether the object is actually available

operator<()

bool eicd::Vertex::operator< ( const Vertex &  other ) const

inline

operator=()

Vertex & eicd::Vertex::operator=

(

Vertex

other

)

copy-assignment operator

operator==() [1/2]

bool eicd::Vertex::operator==

(

const MutableVertex &

other

)

const

operator==() [2/2]

bool eicd::Vertex::operator== ( const Vertex &  other ) const

inline

parameters_begin()

std::vector< float >::const_iterator eicd::Vertex::parameters_begin

(

)

const

parameters_end()

std::vector< float >::const_iterator eicd::Vertex::parameters_end

(

)

const

parameters_size()

unsigned int eicd::Vertex::parameters_size

(

)

const

unlink()

void eicd::Vertex::unlink ( )

inline

disconnect from VertexObj instance

Friends And Related Function Documentation

MutableVertex

friend class MutableVertex

friend

swap

void swap ( Vertex &  a, Vertex &  b  )

friend

VertexCollection

friend class VertexCollection

friend

VertexCollectionIterator

friend class VertexCollectionIterator

friend

---

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

• build/eicd/Vertex.h
• build/src/Vertex.cc