edm4eic::MutableVertex Class Reference

#include <MutableVertex.h>

Public Types
using	object_type = Vertex
using	collection_type = VertexCollection

Public Member Functions
	MutableVertex ()
	default constructor
	MutableVertex (const std::int32_t type, const float chi2, const int ndf, const edm4hep::Vector4f &position, const edm4eic::Cov4f &positionError)
	Constructor initializing all members.
	MutableVertex (const MutableVertex &other)=default
	copy constructor
MutableVertex &	operator= (MutableVertex other) &
	copy-assignment operator
MutableVertex &	operator= (MutableVertex other) &&=delete
MutableVertex	clone (bool cloneRelations=true) const
	~MutableVertex ()=default
	destructor
std::int32_t	getType () const
	Access the Type flag, to identify what type of vertex it is (e.g. primary, secondary, generated, etc.)
float	getChi2 () const
	Access the Chi-squared of the vertex fit.
int	getNdf () const
	Access the NDF of the vertex fit.
const edm4hep::Vector4f &	getPosition () const
	Access the position [mm] + time t0 [ns] of the vertex. Time is 4th component in vector.
const edm4eic::Cov4f &	getPositionError () const
	Access the Covariance matrix of the position+time. Time is 4th component, similarly to 4vector.
void	setType (const std::int32_t type)
	Set the Type flag, to identify what type of vertex it is (e.g. primary, secondary, generated, etc.)
std::int32_t &	getType ()
	Get mutable reference to Type flag, to identify what type of vertex it is (e.g. primary, secondary, generated, etc.)
std::int32_t &	type ()
	Get reference to Type flag, to identify what type of vertex it is (e.g. primary, secondary, generated, etc.)
void	setChi2 (const float chi2)
	Set the Chi-squared of the vertex fit.
float &	getChi2 ()
	Get mutable reference to Chi-squared of the vertex fit.
float &	chi2 ()
	Get reference to Chi-squared of the vertex fit.
void	setNdf (const int ndf)
	Set the NDF of the vertex fit.
int &	getNdf ()
	Get mutable reference to NDF of the vertex fit.
int &	ndf ()
	Get reference to NDF of the vertex fit.
void	setPosition (const edm4hep::Vector4f &position)
	Set the position [mm] + time t0 [ns] of the vertex. Time is 4th component in vector.
edm4hep::Vector4f &	getPosition ()
	Get mutable reference to position [mm] + time t0 [ns] of the vertex. Time is 4th component in vector.
edm4hep::Vector4f &	position ()
	Get reference to position [mm] + time t0 [ns] of the vertex. Time is 4th component in vector.
void	setPositionError (const edm4eic::Cov4f &positionError)
	Set the Covariance matrix of the position+time. Time is 4th component, similarly to 4vector.
edm4eic::Cov4f &	getPositionError ()
	Get mutable reference to Covariance matrix of the position+time. Time is 4th component, similarly to 4vector.
edm4eic::Cov4f &	positionError ()
	Get reference to Covariance matrix of the position+time. Time is 4th component, similarly to 4vector.
void	addToAssociatedParticles (const edm4eic::ReconstructedParticle &)
std::size_t	associatedParticles_size () const
edm4eic::ReconstructedParticle	getAssociatedParticles (std::size_t) const
std::vector< edm4eic::ReconstructedParticle >::const_iterator	associatedParticles_begin () const
std::vector< edm4eic::ReconstructedParticle >::const_iterator	associatedParticles_end () const
podio::RelationRange< edm4eic::ReconstructedParticle >	getAssociatedParticles () const
bool	isAvailable () const
	check whether the object is actually available
void	unlink ()
	disconnect from VertexObj instance
bool	operator== (const MutableVertex &other) const
bool	operator== (const Vertex &other) const
bool	operator!= (const MutableVertex &other) const
bool	operator!= (const Vertex &other) const
bool	operator< (const MutableVertex &other) const
podio::ObjectID	id () const
const podio::ObjectID	getObjectID () const

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

Detailed Description

EIC vertex

Author

: J. Osborn

Member Typedef Documentation

collection_type

using edm4eic::MutableVertex::collection_type = VertexCollection

object_type

using edm4eic::MutableVertex::object_type = Vertex

Constructor & Destructor Documentation

MutableVertex() [1/3]

edm4eic::MutableVertex::MutableVertex

(

)

default constructor

MutableVertex() [2/3]

edm4eic::MutableVertex::MutableVertex	(	const std::int32_t	type,
		const float	chi2,
		const int	ndf,
		const edm4hep::Vector4f &	position,
		const edm4eic::Cov4f &	positionError )

Constructor initializing all members.

MutableVertex() [3/3]

edm4eic::MutableVertex::MutableVertex ( const MutableVertex & other )

default

copy constructor

~MutableVertex()

edm4eic::MutableVertex::~MutableVertex ( )

default

destructor

Member Function Documentation

addToAssociatedParticles()

void edm4eic::MutableVertex::addToAssociatedParticles

(

const edm4eic::ReconstructedParticle &

component

)

associatedParticles_begin()

std::vector< edm4eic::ReconstructedParticle >::const_iterator edm4eic::MutableVertex::associatedParticles_begin

(

)

const

associatedParticles_end()

std::vector< edm4eic::ReconstructedParticle >::const_iterator edm4eic::MutableVertex::associatedParticles_end

(

)

const

associatedParticles_size()

std::size_t edm4eic::MutableVertex::associatedParticles_size

(

)

const

chi2()

float & edm4eic::MutableVertex::chi2

(

)

Get reference to Chi-squared of the vertex fit.

clone()

MutableVertex edm4eic::MutableVertex::clone

(

bool

cloneRelations = true

)

const

create a mutable deep-copy of the object with identical relations if cloneRelations=false, the relations are not cloned and will be empty

getAssociatedParticles() [1/2]

podio::RelationRange< edm4eic::ReconstructedParticle > edm4eic::MutableVertex::getAssociatedParticles

(

)

const

getAssociatedParticles() [2/2]

edm4eic::ReconstructedParticle edm4eic::MutableVertex::getAssociatedParticles

(

std::size_t

index

)

const

getChi2() [1/2]

float & edm4eic::MutableVertex::getChi2

(

)

Get mutable reference to Chi-squared of the vertex fit.

getChi2() [2/2]

float edm4eic::MutableVertex::getChi2

(

)

const

Access the Chi-squared of the vertex fit.

getNdf() [1/2]

int & edm4eic::MutableVertex::getNdf

(

)

Get mutable reference to NDF of the vertex fit.

getNdf() [2/2]

int edm4eic::MutableVertex::getNdf

(

)

const

Access the NDF of the vertex fit.

getObjectID()

const podio::ObjectID edm4eic::MutableVertex::getObjectID

(

)

const

getPosition() [1/2]

edm4hep::Vector4f & edm4eic::MutableVertex::getPosition

(

)

Get mutable reference to position [mm] + time t0 [ns] of the vertex. Time is 4th component in vector.

getPosition() [2/2]

const edm4hep::Vector4f & edm4eic::MutableVertex::getPosition

(

)

const

Access the position [mm] + time t0 [ns] of the vertex. Time is 4th component in vector.

getPositionError() [1/2]

edm4eic::Cov4f & edm4eic::MutableVertex::getPositionError

(

)

Get mutable reference to Covariance matrix of the position+time. Time is 4th component, similarly to 4vector.

getPositionError() [2/2]

const edm4eic::Cov4f & edm4eic::MutableVertex::getPositionError

(

)

const

Access the Covariance matrix of the position+time. Time is 4th component, similarly to 4vector.

getType() [1/2]

std::int32_t & edm4eic::MutableVertex::getType

(

)

Get mutable reference to Type flag, to identify what type of vertex it is (e.g. primary, secondary, generated, etc.)

getType() [2/2]

std::int32_t edm4eic::MutableVertex::getType

(

)

const

Access the Type flag, to identify what type of vertex it is (e.g. primary, secondary, generated, etc.)

id()

podio::ObjectID edm4eic::MutableVertex::id ( ) const

inline

isAvailable()

bool edm4eic::MutableVertex::isAvailable

(

)

const

check whether the object is actually available

ndf()

int & edm4eic::MutableVertex::ndf

(

)

Get reference to NDF of the vertex fit.

operator!=() [1/2]

bool edm4eic::MutableVertex::operator!= ( const MutableVertex & other ) const

inline

operator!=() [2/2]

bool edm4eic::MutableVertex::operator!= ( const Vertex & other ) const

inline

operator<()

bool edm4eic::MutableVertex::operator< ( const MutableVertex & other ) const

inline

operator=() [1/2]

MutableVertex & edm4eic::MutableVertex::operator=

(

MutableVertex

other

)

&

copy-assignment operator

operator=() [2/2]

MutableVertex & edm4eic::MutableVertex::operator= ( MutableVertex other ) &&

delete

operator==() [1/2]

bool edm4eic::MutableVertex::operator== ( const MutableVertex & other ) const

inline

operator==() [2/2]

bool edm4eic::MutableVertex::operator==

(

const Vertex &

other

)

const

position()

edm4hep::Vector4f & edm4eic::MutableVertex::position

(

)

Get reference to position [mm] + time t0 [ns] of the vertex. Time is 4th component in vector.

positionError()

edm4eic::Cov4f & edm4eic::MutableVertex::positionError

(

)

Get reference to Covariance matrix of the position+time. Time is 4th component, similarly to 4vector.

setChi2()

void edm4eic::MutableVertex::setChi2

(

const float

chi2

)

Set the Chi-squared of the vertex fit.

setNdf()

void edm4eic::MutableVertex::setNdf

(

const int

ndf

)

Set the NDF of the vertex fit.

setPosition()

void edm4eic::MutableVertex::setPosition

(

const edm4hep::Vector4f &

position

)

Set the position [mm] + time t0 [ns] of the vertex. Time is 4th component in vector.

setPositionError()

void edm4eic::MutableVertex::setPositionError

(

const edm4eic::Cov4f &

positionError

)

Set the Covariance matrix of the position+time. Time is 4th component, similarly to 4vector.

setType()

void edm4eic::MutableVertex::setType

(

const std::int32_t

type

)

Set the Type flag, to identify what type of vertex it is (e.g. primary, secondary, generated, etc.)

type()

std::int32_t & edm4eic::MutableVertex::type

(

)

Get reference to Type flag, to identify what type of vertex it is (e.g. primary, secondary, generated, etc.)

unlink()

void edm4eic::MutableVertex::unlink ( )

inline

disconnect from VertexObj instance

Friends And Related Symbol Documentation

swap

void swap ( MutableVertex & a, MutableVertex & b )

friend

Vertex

friend class Vertex

friend

VertexCollection

friend class VertexCollection

friend

VertexMutableCollectionIterator

friend class VertexMutableCollectionIterator

friend

---

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

• build/edm4eic/MutableVertex.h
• build/src/MutableVertex.cc