edm4eic::MutableReconstructedParticle Class Reference

#include <MutableReconstructedParticle.h>

Public Types
using	object_type = ReconstructedParticle
using	collection_type = ReconstructedParticleCollection

Public Member Functions
	MutableReconstructedParticle ()
	default constructor
	MutableReconstructedParticle (const std::int32_t type, const float energy, const edm4hep::Vector3f &momentum, const edm4hep::Vector3f &referencePoint, const float charge, const float mass, const float goodnessOfPID, const edm4eic::Cov4f &covMatrix, const std::int32_t PDG)
	Constructor initializing all members.
	MutableReconstructedParticle (const MutableReconstructedParticle &other)=default
	copy constructor
MutableReconstructedParticle &	operator= (MutableReconstructedParticle other) &
	copy-assignment operator
MutableReconstructedParticle &	operator= (MutableReconstructedParticle other) &&=delete
MutableReconstructedParticle	clone (bool cloneRelations=true) const
	~MutableReconstructedParticle ()=default
	destructor
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 (const std::int32_t type)
	Set the type of reconstructed particle. Check/set collection parameters ReconstructedParticleTypeNames and ReconstructedParticleTypeValues.
std::int32_t &	getType ()
	Get mutable reference to type of reconstructed particle. Check/set collection parameters ReconstructedParticleTypeNames and ReconstructedParticleTypeValues.
std::int32_t &	type ()
	Get reference to type of reconstructed particle. Check/set collection parameters ReconstructedParticleTypeNames and ReconstructedParticleTypeValues.
void	setEnergy (const float energy)
	Set the [GeV] energy of the reconstructed particle. Four momentum state is not kept consistent internally.
float &	getEnergy ()
	Get mutable reference to [GeV] energy of the reconstructed particle. Four momentum state is not kept consistent internally.
float &	energy ()
	Get reference to [GeV] energy of the reconstructed particle. Four momentum state is not kept consistent internally.
void	setMomentum (const edm4hep::Vector3f &momentum)
	Set the [GeV] particle momentum. Four momentum state is not kept consistent internally.
edm4hep::Vector3f &	getMomentum ()
	Get mutable reference to [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 (const edm4hep::Vector3f &referencePoint)
	Set the [mm] reference, i.e. where the particle has been measured.
edm4hep::Vector3f &	getReferencePoint ()
	Get mutable reference to [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 (const float charge)
	Set the charge of the reconstructed particle.
float &	getCharge ()
	Get mutable reference to charge of the reconstructed particle.
float &	charge ()
	Get reference to charge of the reconstructed particle.
void	setMass (const float mass)
	Set the [GeV] mass of the reconstructed particle, set independently from four vector. Four momentum state is not kept consistent internally.
float &	getMass ()
	Get mutable reference to [GeV] mass of the reconstructed particle, set independently from four vector. Four momentum state is not kept consistent internally.
float &	mass ()
	Get reference to [GeV] mass of the reconstructed particle, set independently from four vector. Four momentum state is not kept consistent internally.
void	setGoodnessOfPID (const float goodnessOfPID)
	Set the overall goodness of the PID on a scale of [0;1].
float &	getGoodnessOfPID ()
	Get mutable reference to overall goodness of the PID on a scale of [0;1].
float &	goodnessOfPID ()
	Get reference to overall goodness of the PID on a scale of [0;1].
void	setCovMatrix (const edm4eic::Cov4f &covMatrix)
	Set the covariance matrix of the reconstructed particle 4vector (10 parameters).
edm4eic::Cov4f &	getCovMatrix ()
	Get mutable reference to 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 (const std::int32_t PDG)
	Set the PDG code for this particle.
std::int32_t &	getPDG ()
	Get mutable reference to PDG code for this particle.
std::int32_t &	PDG ()
	Get reference to PDG code for this particle.
void	setStartVertex (const edm4eic::Vertex &value)
	Set the Start vertex associated to this particle.
void	setParticleIDUsed (const edm4hep::ParticleID &value)
	Set the particle ID used for the kinematics of this particle.
void	addToClusters (const 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 (const 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 (const 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 (const 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
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	(	const std::int32_t	type,
		const float	energy,
		const edm4hep::Vector3f &	momentum,
		const edm4hep::Vector3f &	referencePoint,
		const float	charge,
		const float	mass,
		const float	goodnessOfPID,
		const edm4eic::Cov4f &	covMatrix,
		const 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

(

const edm4eic::Cluster &

component

)

addToParticleIDs()

void edm4eic::MutableReconstructedParticle::addToParticleIDs

(

const edm4hep::ParticleID &

component

)

addToParticles()

void edm4eic::MutableReconstructedParticle::addToParticles

(

const edm4eic::ReconstructedParticle &

component

)

addToTracks()

void edm4eic::MutableReconstructedParticle::addToTracks

(

const edm4eic::Track &

component

)

charge()

float & edm4eic::MutableReconstructedParticle::charge

(

)

Get reference to charge of the reconstructed particle.

clone()

MutableReconstructedParticle edm4eic::MutableReconstructedParticle::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

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).

energy()

float & edm4eic::MutableReconstructedParticle::energy

(

)

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

getCharge() [1/2]

float & edm4eic::MutableReconstructedParticle::getCharge

(

)

Get mutable reference to charge of the reconstructed particle.

getCharge() [2/2]

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() [1/2]

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

(

)

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

getCovMatrix() [2/2]

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

(

)

const

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

getEnergy() [1/2]

float & edm4eic::MutableReconstructedParticle::getEnergy

(

)

Get mutable reference to [GeV] energy of the reconstructed particle. Four momentum state is not kept consistent internally.

getEnergy() [2/2]

float edm4eic::MutableReconstructedParticle::getEnergy

(

)

const

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

getGoodnessOfPID() [1/2]

float & edm4eic::MutableReconstructedParticle::getGoodnessOfPID

(

)

Get mutable reference to overall goodness of the PID on a scale of [0;1].

getGoodnessOfPID() [2/2]

float edm4eic::MutableReconstructedParticle::getGoodnessOfPID

(

)

const

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

getMass() [1/2]

float & edm4eic::MutableReconstructedParticle::getMass

(

)

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

getMass() [2/2]

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() [1/2]

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

(

)

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

getMomentum() [2/2]

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() [1/2]

std::int32_t & edm4eic::MutableReconstructedParticle::getPDG

(

)

Get mutable reference to PDG code for this particle.

getPDG() [2/2]

std::int32_t edm4eic::MutableReconstructedParticle::getPDG

(

)

const

Access the PDG code for this particle.

getReferencePoint() [1/2]

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

(

)

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

getReferencePoint() [2/2]

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() [1/2]

std::int32_t & edm4eic::MutableReconstructedParticle::getType

(

)

Get mutable reference to type of reconstructed particle. Check/set collection parameters ReconstructedParticleTypeNames and ReconstructedParticleTypeValues.

getType() [2/2]

std::int32_t edm4eic::MutableReconstructedParticle::getType

(

)

const

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

goodnessOfPID()

float & edm4eic::MutableReconstructedParticle::goodnessOfPID

(

)

Get reference to overall goodness of the PID on a scale of [0;1].

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

mass()

float & edm4eic::MutableReconstructedParticle::mass

(

)

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

momentum()

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

(

)

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

operator!=() [1/2]

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

inline

operator!=() [2/2]

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

inline

operator<()

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

inline

operator=() [1/2]

MutableReconstructedParticle & edm4eic::MutableReconstructedParticle::operator=

(

MutableReconstructedParticle

other

)

&

copy-assignment operator

operator=() [2/2]

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

delete

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

PDG()

std::int32_t & edm4eic::MutableReconstructedParticle::PDG

(

)

Get reference to PDG code for this particle.

referencePoint()

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

(

)

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

setCharge()

void edm4eic::MutableReconstructedParticle::setCharge

(

const float

charge

)

Set the charge of the reconstructed particle.

setCovMatrix()

void edm4eic::MutableReconstructedParticle::setCovMatrix

(

const edm4eic::Cov4f &

covMatrix

)

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

setEnergy()

void edm4eic::MutableReconstructedParticle::setEnergy

(

const float

energy

)

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

setGoodnessOfPID()

void edm4eic::MutableReconstructedParticle::setGoodnessOfPID

(

const float

goodnessOfPID

)

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

setMass()

void edm4eic::MutableReconstructedParticle::setMass

(

const float

mass

)

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

(

const edm4hep::Vector3f &

momentum

)

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

setParticleIDUsed()

void edm4eic::MutableReconstructedParticle::setParticleIDUsed

(

const edm4hep::ParticleID &

value

)

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

setPDG()

void edm4eic::MutableReconstructedParticle::setPDG

(

const std::int32_t

PDG

)

Set the PDG code for this particle.

setReferencePoint()

void edm4eic::MutableReconstructedParticle::setReferencePoint

(

const edm4hep::Vector3f &

referencePoint

)

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

setStartVertex()

void edm4eic::MutableReconstructedParticle::setStartVertex

(

const edm4eic::Vertex &

value

)

Set the Start vertex associated to this particle.

setType()

void edm4eic::MutableReconstructedParticle::setType

(

const std::int32_t

type

)

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

type()

std::int32_t & edm4eic::MutableReconstructedParticle::type

(

)

Get reference to type of reconstructed particle. Check/set collection parameters ReconstructedParticleTypeNames and ReconstructedParticleTypeValues.

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