EDM4eic
EIC data model
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Friends | List of all members
edm4eic::MutableVertex Class Reference

#include <MutableVertex.h>

Public Types

using object_type = Vertex
 
using collection_type = VertexCollection
 

Public Member Functions

 MutableVertex ()
 default constructor
 
 MutableVertex (std::int32_t type, float chi2, int ndf, edm4hep::Vector4f position, edm4eic::Cov4f positionError)
 Constructor initializing all members.
 
 MutableVertex (const MutableVertex &other)=default
 copy constructor
 
MutableVertex & operator= (MutableVertex other)
 copy-assignment operator
 
MutableVertex clone () const
 create a mutable deep-copy of the object with identical relations
 
 ~MutableVertex ()=default
 destructor
 
 operator Vertex () const
 conversion to const object
 
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 (std::int32_t value)
 Set the Type flag, to identify what type of vertex it is (e.g. primary, secondary, generated, etc.)
 
void setChi2 (float value)
 Set the Chi-squared of the vertex fit.
 
void setNdf (int value)
 Set the NDF of the vertex fit.
 
void setPosition (edm4hep::Vector4f value)
 Set the 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 (edm4eic::Cov4f value)
 Set the 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 (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
 
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 ( std::int32_t type,
float chi2,
int ndf,
edm4hep::Vector4f position,
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 ( 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

◆ clone()

MutableVertex edm4eic::MutableVertex::clone ( ) const

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

◆ 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()

float edm4eic::MutableVertex::getChi2 ( ) const

Access the Chi-squared of the vertex fit.

◆ getNdf()

int edm4eic::MutableVertex::getNdf ( ) const

Access the NDF of the vertex fit.

◆ getObjectID()

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

◆ getPosition()

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

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

◆ getPositionError()

const edm4eic::Cov4f & edm4eic::MutableVertex::getPositionError ( ) const

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

◆ getType()

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

◆ operator Vertex()

edm4eic::MutableVertex::operator Vertex ( ) const

conversion to const object

◆ operator<()

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

◆ operator=()

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

copy-assignment operator

◆ 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 ( float value)

Set the Chi-squared of the vertex fit.

◆ setNdf()

void edm4eic::MutableVertex::setNdf ( int value)

Set the NDF of the vertex fit.

◆ setPosition()

void edm4eic::MutableVertex::setPosition ( edm4hep::Vector4f value)

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

◆ setPositionError()

void edm4eic::MutableVertex::setPositionError ( edm4eic::Cov4f value)

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

◆ setType()

void edm4eic::MutableVertex::setType ( std::int32_t value)

Set the 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: