edm4eic::MutableReconstructedParticle Class Reference

#include <MutableReconstructedParticle.h>

Public Types
using	object_type = ReconstructedParticle
using	collection_type = ReconstructedParticleCollection

Public Member Functions
	MutableReconstructedParticle ()
	default constructor
	MutableReconstructedParticle (std::int32_t type, float energy, edm4hep::Vector3f momentum, edm4hep::Vector3f referencePoint, float charge, float mass, float goodnessOfPID, edm4eic::Cov4f covMatrix, std::int32_t PDG)
	Constructor initializing all members.
	MutableReconstructedParticle (const MutableReconstructedParticle &other)=default
	copy constructor
MutableReconstructedParticle &	operator= (MutableReconstructedParticle other)
	copy-assignment operator
MutableReconstructedParticle	clone () const
	create a mutable deep-copy of the object with identical relations
	~MutableReconstructedParticle ()=default
	destructor
	operator ReconstructedParticle () const
	conversion to const object
std::int32_t	getType () const
	Access the type of reconstructed particle. Check/set collection parameters ReconstructedParticleTypeNames and ReconstructedParticleTypeValues.
float	getEnergy () const
	Access the [GeV] energy of the reconstructed particle. Four momentum state is not kept consistent internally.
const edm4hep::Vector3f &	getMomentum () const
	Access the [GeV] particle momentum. Four momentum state is not kept consistent internally.
const edm4hep::Vector3f &	getReferencePoint () const
	Access the [mm] reference, i.e. where the particle has been measured.
float	getCharge () const
	Access the charge of the reconstructed particle.
float	getMass () const
	Access the [GeV] mass of the reconstructed particle, set independently from four vector. Four momentum state is not kept consistent internally.
float	getGoodnessOfPID () const
	Access the overall goodness of the PID on a scale of [0;1].
const edm4eic::Cov4f &	getCovMatrix () const
	Access the covariance matrix of the reconstructed particle 4vector (10 parameters).
std::int32_t	getPDG () const
	Access the PDG code for this particle.
const edm4eic::Vertex	getStartVertex () const
	Access the Start vertex associated to this particle.
const edm4hep::ParticleID	getParticleIDUsed () const
	Access the particle ID used for the kinematics of this particle.
void	setType (std::int32_t value)
	Set the type of reconstructed particle. Check/set collection parameters ReconstructedParticleTypeNames and ReconstructedParticleTypeValues.
void	setEnergy (float value)
	Set the [GeV] energy of the reconstructed particle. Four momentum state is not kept consistent internally.
void	setMomentum (edm4hep::Vector3f value)
	Set the [GeV] particle momentum. Four momentum state is not kept consistent internally.
edm4hep::Vector3f &	momentum ()
	Get reference to [GeV] particle momentum. Four momentum state is not kept consistent internally.
void	setReferencePoint (edm4hep::Vector3f value)
	Set the [mm] reference, i.e. where the particle has been measured.
edm4hep::Vector3f &	referencePoint ()
	Get reference to [mm] reference, i.e. where the particle has been measured.
void	setCharge (float value)
	Set the charge of the reconstructed particle.
void	setMass (float value)
	Set the [GeV] mass of the reconstructed particle, set independently from four vector. Four momentum state is not kept consistent internally.
void	setGoodnessOfPID (float value)
	Set the overall goodness of the PID on a scale of [0;1].
void	setCovMatrix (edm4eic::Cov4f value)
	Set the covariance matrix of the reconstructed particle 4vector (10 parameters).
edm4eic::Cov4f &	covMatrix ()
	Get reference to covariance matrix of the reconstructed particle 4vector (10 parameters).
void	setPDG (std::int32_t value)
	Set the PDG code for this particle.
void	setStartVertex (edm4eic::Vertex value)
	Set the Start vertex associated to this particle.
void	setParticleIDUsed (edm4hep::ParticleID value)
	Set the particle ID used for the kinematics of this particle.
void	addToClusters (edm4eic::Cluster)
std::size_t	clusters_size () const
edm4eic::Cluster	getClusters (std::size_t) const
std::vector< edm4eic::Cluster >::const_iterator	clusters_begin () const
std::vector< edm4eic::Cluster >::const_iterator	clusters_end () const
podio::RelationRange< edm4eic::Cluster >	getClusters () const
void	addToTracks (edm4eic::Track)
std::size_t	tracks_size () const
edm4eic::Track	getTracks (std::size_t) const
std::vector< edm4eic::Track >::const_iterator	tracks_begin () const
std::vector< edm4eic::Track >::const_iterator	tracks_end () const
podio::RelationRange< edm4eic::Track >	getTracks () const
void	addToParticles (edm4eic::ReconstructedParticle)
std::size_t	particles_size () const
edm4eic::ReconstructedParticle	getParticles (std::size_t) const
std::vector< edm4eic::ReconstructedParticle >::const_iterator	particles_begin () const
std::vector< edm4eic::ReconstructedParticle >::const_iterator	particles_end () const
podio::RelationRange< edm4eic::ReconstructedParticle >	getParticles () const
void	addToParticleIDs (edm4hep::ParticleID)
std::size_t	particleIDs_size () const
edm4hep::ParticleID	getParticleIDs (std::size_t) const
std::vector< edm4hep::ParticleID >::const_iterator	particleIDs_begin () const
std::vector< edm4hep::ParticleID >::const_iterator	particleIDs_end () const
podio::RelationRange< edm4hep::ParticleID >	getParticleIDs () const
bool	isCompound () const
bool	isAvailable () const
	check whether the object is actually available
void	unlink ()
	disconnect from ReconstructedParticleObj instance
bool	operator== (const MutableReconstructedParticle &other) const
bool	operator== (const ReconstructedParticle &other) const
bool	operator< (const MutableReconstructedParticle &other) const
podio::ObjectID	id () const
const podio::ObjectID	getObjectID () const

Friends
class	ReconstructedParticleCollection
class	ReconstructedParticleMutableCollectionIterator
class	ReconstructedParticle
void	swap (MutableReconstructedParticle &a, MutableReconstructedParticle &b)

Detailed Description

EIC Reconstructed Particle

Author

: W. Armstrong, S. Joosten, F. Gaede

Member Typedef Documentation

collection_type

using edm4eic::MutableReconstructedParticle::collection_type = ReconstructedParticleCollection

object_type

using edm4eic::MutableReconstructedParticle::object_type = ReconstructedParticle

Constructor & Destructor Documentation

MutableReconstructedParticle() [1/3]

edm4eic::MutableReconstructedParticle::MutableReconstructedParticle

(

)

default constructor

MutableReconstructedParticle() [2/3]

edm4eic::MutableReconstructedParticle::MutableReconstructedParticle	(	std::int32_t	type,
		float	energy,
		edm4hep::Vector3f	momentum,
		edm4hep::Vector3f	referencePoint,
		float	charge,
		float	mass,
		float	goodnessOfPID,
		edm4eic::Cov4f	covMatrix,
		std::int32_t	PDG )

Constructor initializing all members.

MutableReconstructedParticle() [3/3]

edm4eic::MutableReconstructedParticle::MutableReconstructedParticle ( const MutableReconstructedParticle & other )

default

copy constructor

~MutableReconstructedParticle()

edm4eic::MutableReconstructedParticle::~MutableReconstructedParticle ( )

default

destructor

Member Function Documentation

addToClusters()

void edm4eic::MutableReconstructedParticle::addToClusters

(

edm4eic::Cluster

component

)

addToParticleIDs()

void edm4eic::MutableReconstructedParticle::addToParticleIDs

(

edm4hep::ParticleID

component

)

addToParticles()

void edm4eic::MutableReconstructedParticle::addToParticles

(

edm4eic::ReconstructedParticle

component

)

addToTracks()

void edm4eic::MutableReconstructedParticle::addToTracks

(

edm4eic::Track

component

)

clone()

MutableReconstructedParticle edm4eic::MutableReconstructedParticle::clone

(

)

const

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

clusters_begin()

std::vector< edm4eic::Cluster >::const_iterator edm4eic::MutableReconstructedParticle::clusters_begin

(

)

const

clusters_end()

std::vector< edm4eic::Cluster >::const_iterator edm4eic::MutableReconstructedParticle::clusters_end

(

)

const

clusters_size()

std::size_t edm4eic::MutableReconstructedParticle::clusters_size

(

)

const

covMatrix()

edm4eic::Cov4f & edm4eic::MutableReconstructedParticle::covMatrix

(

)

Get reference to covariance matrix of the reconstructed particle 4vector (10 parameters).

getCharge()

float edm4eic::MutableReconstructedParticle::getCharge

(

)

const

Access the charge of the reconstructed particle.

getClusters() [1/2]

podio::RelationRange< edm4eic::Cluster > edm4eic::MutableReconstructedParticle::getClusters

(

)

const

getClusters() [2/2]

edm4eic::Cluster edm4eic::MutableReconstructedParticle::getClusters

(

std::size_t

index

)

const

getCovMatrix()

const edm4eic::Cov4f & edm4eic::MutableReconstructedParticle::getCovMatrix

(

)

const

Access the covariance matrix of the reconstructed particle 4vector (10 parameters).

getEnergy()

float edm4eic::MutableReconstructedParticle::getEnergy

(

)

const

Access the [GeV] energy of the reconstructed particle. Four momentum state is not kept consistent internally.

getGoodnessOfPID()

float edm4eic::MutableReconstructedParticle::getGoodnessOfPID

(

)

const

Access the overall goodness of the PID on a scale of [0;1].

getMass()

float edm4eic::MutableReconstructedParticle::getMass

(

)

const

Access the [GeV] mass of the reconstructed particle, set independently from four vector. Four momentum state is not kept consistent internally.

getMomentum()

const edm4hep::Vector3f & edm4eic::MutableReconstructedParticle::getMomentum

(

)

const

Access the [GeV] particle momentum. Four momentum state is not kept consistent internally.

getObjectID()

const podio::ObjectID edm4eic::MutableReconstructedParticle::getObjectID

(

)

const

getParticleIDs() [1/2]

podio::RelationRange< edm4hep::ParticleID > edm4eic::MutableReconstructedParticle::getParticleIDs

(

)

const

getParticleIDs() [2/2]

edm4hep::ParticleID edm4eic::MutableReconstructedParticle::getParticleIDs

(

std::size_t

index

)

const

getParticleIDUsed()

const edm4hep::ParticleID edm4eic::MutableReconstructedParticle::getParticleIDUsed

(

)

const

Access the particle ID used for the kinematics of this particle.

getParticles() [1/2]

podio::RelationRange< edm4eic::ReconstructedParticle > edm4eic::MutableReconstructedParticle::getParticles

(

)

const

getParticles() [2/2]

edm4eic::ReconstructedParticle edm4eic::MutableReconstructedParticle::getParticles

(

std::size_t

index

)

const

getPDG()

std::int32_t edm4eic::MutableReconstructedParticle::getPDG

(

)

const

Access the PDG code for this particle.

getReferencePoint()

const edm4hep::Vector3f & edm4eic::MutableReconstructedParticle::getReferencePoint

(

)

const

Access the [mm] reference, i.e. where the particle has been measured.

getStartVertex()

const edm4eic::Vertex edm4eic::MutableReconstructedParticle::getStartVertex

(

)

const

Access the Start vertex associated to this particle.

getTracks() [1/2]

podio::RelationRange< edm4eic::Track > edm4eic::MutableReconstructedParticle::getTracks

(

)

const

getTracks() [2/2]

edm4eic::Track edm4eic::MutableReconstructedParticle::getTracks

(

std::size_t

index

)

const

getType()

std::int32_t edm4eic::MutableReconstructedParticle::getType

(

)

const

Access the type of reconstructed particle. Check/set collection parameters ReconstructedParticleTypeNames and ReconstructedParticleTypeValues.

id()

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

inline

isAvailable()

bool edm4eic::MutableReconstructedParticle::isAvailable

(

)

const

check whether the object is actually available

isCompound()

bool edm4eic::MutableReconstructedParticle::isCompound ( ) const

inline

momentum()

edm4hep::Vector3f & edm4eic::MutableReconstructedParticle::momentum

(

)

Get reference to [GeV] particle momentum. Four momentum state is not kept consistent internally.

operator ReconstructedParticle()

edm4eic::MutableReconstructedParticle::operator ReconstructedParticle

(

)

const

conversion to const object

operator<()

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

inline

operator=()

MutableReconstructedParticle & edm4eic::MutableReconstructedParticle::operator=

(

MutableReconstructedParticle

other

)

copy-assignment operator

operator==() [1/2]

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

inline

operator==() [2/2]

bool edm4eic::MutableReconstructedParticle::operator==

(

const ReconstructedParticle &

other

)

const

particleIDs_begin()

std::vector< edm4hep::ParticleID >::const_iterator edm4eic::MutableReconstructedParticle::particleIDs_begin

(

)

const

particleIDs_end()

std::vector< edm4hep::ParticleID >::const_iterator edm4eic::MutableReconstructedParticle::particleIDs_end

(

)

const

particleIDs_size()

std::size_t edm4eic::MutableReconstructedParticle::particleIDs_size

(

)

const

particles_begin()

std::vector< edm4eic::ReconstructedParticle >::const_iterator edm4eic::MutableReconstructedParticle::particles_begin

(

)

const

particles_end()

std::vector< edm4eic::ReconstructedParticle >::const_iterator edm4eic::MutableReconstructedParticle::particles_end

(

)

const

particles_size()

std::size_t edm4eic::MutableReconstructedParticle::particles_size

(

)

const

referencePoint()

edm4hep::Vector3f & edm4eic::MutableReconstructedParticle::referencePoint

(

)

Get reference to [mm] reference, i.e. where the particle has been measured.

setCharge()

void edm4eic::MutableReconstructedParticle::setCharge

(

float

value

)

Set the charge of the reconstructed particle.

setCovMatrix()

void edm4eic::MutableReconstructedParticle::setCovMatrix

(

edm4eic::Cov4f

value

)

Set the covariance matrix of the reconstructed particle 4vector (10 parameters).

setEnergy()

void edm4eic::MutableReconstructedParticle::setEnergy

(

float

value

)

Set the [GeV] energy of the reconstructed particle. Four momentum state is not kept consistent internally.

setGoodnessOfPID()

void edm4eic::MutableReconstructedParticle::setGoodnessOfPID

(

float

value

)

Set the overall goodness of the PID on a scale of [0;1].

setMass()

void edm4eic::MutableReconstructedParticle::setMass

(

float

value

)

Set the [GeV] mass of the reconstructed particle, set independently from four vector. Four momentum state is not kept consistent internally.

setMomentum()

void edm4eic::MutableReconstructedParticle::setMomentum

(

edm4hep::Vector3f

value

)

Set the [GeV] particle momentum. Four momentum state is not kept consistent internally.

setParticleIDUsed()

void edm4eic::MutableReconstructedParticle::setParticleIDUsed

(

edm4hep::ParticleID

value

)

Set the particle ID used for the kinematics of this particle.

setPDG()

void edm4eic::MutableReconstructedParticle::setPDG

(

std::int32_t

value

)

Set the PDG code for this particle.

setReferencePoint()

void edm4eic::MutableReconstructedParticle::setReferencePoint

(

edm4hep::Vector3f

value

)

Set the [mm] reference, i.e. where the particle has been measured.

setStartVertex()

void edm4eic::MutableReconstructedParticle::setStartVertex

(

edm4eic::Vertex

value

)

Set the Start vertex associated to this particle.

setType()

void edm4eic::MutableReconstructedParticle::setType

(

std::int32_t

value

)

Set the type of reconstructed particle. Check/set collection parameters ReconstructedParticleTypeNames and ReconstructedParticleTypeValues.

tracks_begin()

std::vector< edm4eic::Track >::const_iterator edm4eic::MutableReconstructedParticle::tracks_begin

(

)

const

tracks_end()

std::vector< edm4eic::Track >::const_iterator edm4eic::MutableReconstructedParticle::tracks_end

(

)

const

tracks_size()

std::size_t edm4eic::MutableReconstructedParticle::tracks_size

(

)

const

unlink()

void edm4eic::MutableReconstructedParticle::unlink ( )

inline

disconnect from ReconstructedParticleObj instance

Friends And Related Symbol Documentation

ReconstructedParticle

friend class ReconstructedParticle

friend

ReconstructedParticleCollection

friend class ReconstructedParticleCollection

friend

ReconstructedParticleMutableCollectionIterator

friend class ReconstructedParticleMutableCollectionIterator

friend

swap

void swap ( MutableReconstructedParticle & a, MutableReconstructedParticle & b )

friend

---

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

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