EICd
EIC data model
eicd::MutableVertex Class Reference

#include <MutableVertex.h>

Public Member Functions

 MutableVertex ()
 default constructor More...
 
 MutableVertex (std::int32_t primary, float chi2, float probability, edm4hep::Vector3f position, eicd::Cov3f positionError, std::int32_t algorithmType, float time)
 
 MutableVertex (VertexObj *obj)
 constructor from existing VertexObj More...
 
 MutableVertex (const MutableVertex &other)
 copy constructor More...
 
MutableVertexoperator= (MutableVertex other)
 copy-assignment operator More...
 
MutableVertex clone () const
 create a mutable deep-copy of the object with identical relations More...
 
 ~MutableVertex ()
 destructor More...
 
 operator Vertex () const
 conversion to const object 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::Cov3fgetPositionError () 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...
 
void setPrimary (std::int32_t value)
 Set the Boolean flag, if vertex is the primary vertex of the event. More...
 
void setChi2 (float value)
 Set the Chi-squared of the vertex fit. More...
 
void setProbability (float value)
 Set the Probability of the vertex fit. More...
 
void setPosition (edm4hep::Vector3f value)
 Set the [mm] position of the vertex. More...
 
edm4hep::Vector3f & position ()
 Get reference to [mm] position of the vertex. More...
 
void setPositionError (eicd::Cov3f value)
 Set the Covariance matrix of the position. More...
 
eicd::Cov3fpositionError ()
 Get reference to Covariance matrix of the position. More...
 
void setAlgorithmType (std::int32_t value)
 Set the Type code for the algorithm that has been used to create the vertex - check/set the collection parameters AlgorithmName and AlgorithmType. More...
 
void setTime (float value)
 Set the Vertex time. More...
 
void setAssociatedParticle (eicd::ReconstructedParticle value)
 Set the reconstructed particle associated to this vertex. More...
 
void addToParameters (float)
 
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 MutableVertex &other) const
 
bool operator== (const Vertex &other) const
 
bool operator< (const MutableVertex &other) const
 
unsigned int 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
: W. Armstrong, S. Joosten, based off EDM4hep

Constructor & Destructor Documentation

◆ MutableVertex() [1/4]

eicd::MutableVertex::MutableVertex ( )

default constructor

◆ MutableVertex() [2/4]

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

◆ MutableVertex() [3/4]

eicd::MutableVertex::MutableVertex ( VertexObj obj)

constructor from existing VertexObj

◆ MutableVertex() [4/4]

eicd::MutableVertex::MutableVertex ( const MutableVertex other)

copy constructor

◆ ~MutableVertex()

eicd::MutableVertex::~MutableVertex ( )

destructor

Member Function Documentation

◆ addToParameters()

void eicd::MutableVertex::addToParameters ( float  component)

◆ clone()

MutableVertex eicd::MutableVertex::clone ( ) const

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

◆ getAlgorithmType()

const std::int32_t & eicd::MutableVertex::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::MutableVertex::getAssociatedParticle ( ) const

Access the reconstructed particle associated to this vertex.

◆ getChi2()

const float & eicd::MutableVertex::getChi2 ( ) const

Access the Chi-squared of the vertex fit.

◆ getObjectID()

const podio::ObjectID eicd::MutableVertex::getObjectID ( ) const

◆ getParameters() [1/2]

podio::RelationRange< float > eicd::MutableVertex::getParameters ( ) const

◆ getParameters() [2/2]

float eicd::MutableVertex::getParameters ( unsigned int  index) const

◆ getPosition()

const edm4hep::Vector3f & eicd::MutableVertex::getPosition ( ) const

Access the [mm] position of the vertex.

◆ getPositionError()

const eicd::Cov3f & eicd::MutableVertex::getPositionError ( ) const

Access the Covariance matrix of the position.

◆ getPrimary()

const std::int32_t & eicd::MutableVertex::getPrimary ( ) const

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

◆ getProbability()

const float & eicd::MutableVertex::getProbability ( ) const

Access the Probability of the vertex fit.

◆ getTime()

const float & eicd::MutableVertex::getTime ( ) const

Access the Vertex time.

◆ id()

unsigned int eicd::MutableVertex::id ( ) const
inline

◆ isAvailable()

bool eicd::MutableVertex::isAvailable ( ) const

check whether the object is actually available

◆ operator Vertex()

eicd::MutableVertex::operator Vertex ( ) const

conversion to const object

◆ operator<()

bool eicd::MutableVertex::operator< ( const MutableVertex other) const
inline

◆ operator=()

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

copy-assignment operator

◆ operator==() [1/2]

bool eicd::MutableVertex::operator== ( const MutableVertex other) const
inline

◆ operator==() [2/2]

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

◆ parameters_begin()

std::vector< float >::const_iterator eicd::MutableVertex::parameters_begin ( ) const

◆ parameters_end()

std::vector< float >::const_iterator eicd::MutableVertex::parameters_end ( ) const

◆ parameters_size()

unsigned int eicd::MutableVertex::parameters_size ( ) const

◆ position()

edm4hep::Vector3f & eicd::MutableVertex::position ( )

Get reference to [mm] position of the vertex.

◆ positionError()

eicd::Cov3f & eicd::MutableVertex::positionError ( )

Get reference to Covariance matrix of the position.

◆ setAlgorithmType()

void eicd::MutableVertex::setAlgorithmType ( std::int32_t  value)

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

◆ setAssociatedParticle()

void eicd::MutableVertex::setAssociatedParticle ( eicd::ReconstructedParticle  value)

Set the reconstructed particle associated to this vertex.

◆ setChi2()

void eicd::MutableVertex::setChi2 ( float  value)

Set the Chi-squared of the vertex fit.

◆ setPosition()

void eicd::MutableVertex::setPosition ( edm4hep::Vector3f  value)

Set the [mm] position of the vertex.

◆ setPositionError()

void eicd::MutableVertex::setPositionError ( eicd::Cov3f  value)

Set the Covariance matrix of the position.

◆ setPrimary()

void eicd::MutableVertex::setPrimary ( std::int32_t  value)

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

◆ setProbability()

void eicd::MutableVertex::setProbability ( float  value)

Set the Probability of the vertex fit.

◆ setTime()

void eicd::MutableVertex::setTime ( float  value)

Set the Vertex time.

◆ unlink()

void eicd::MutableVertex::unlink ( )
inline

disconnect from VertexObj instance

Friends And Related Function 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: