edm4eic::MutableSimPulse Class Reference

#include <MutableSimPulse.h>

Public Types
using	object_type = SimPulse
using	collection_type = SimPulseCollection

Public Member Functions
	MutableSimPulse ()
	default constructor
	MutableSimPulse (std::uint64_t cellID, float integral, edm4hep::Vector3f position, float time, float interval)
	Constructor initializing all members.
	MutableSimPulse (const MutableSimPulse &other)=default
	copy constructor
MutableSimPulse &	operator= (MutableSimPulse other)
	copy-assignment operator
MutableSimPulse	clone (bool cloneRelations=true) const
	~MutableSimPulse ()=default
	destructor
std::uint64_t	getCellID () const
	Access the ID of the readout cell for this pulse.
float	getIntegral () const
	Access the Total pulse integral in relevant units.
const edm4hep::Vector3f &	getPosition () const
	Access the Position the pulse is evaluated in world coordinates [mm].
float	getTime () const
	Access the Start time for the pulse in [ns].
float	getInterval () const
	Access the Time interval between amplitude values [ns].
void	setCellID (std::uint64_t value)
	Set the ID of the readout cell for this pulse.
std::uint64_t &	getCellID ()
	Get mutable reference to ID of the readout cell for this pulse.
std::uint64_t &	cellID ()
	Get reference to ID of the readout cell for this pulse.
void	setIntegral (float value)
	Set the Total pulse integral in relevant units.
float &	getIntegral ()
	Get mutable reference to Total pulse integral in relevant units.
float &	integral ()
	Get reference to Total pulse integral in relevant units.
void	setPosition (edm4hep::Vector3f value)
	Set the Position the pulse is evaluated in world coordinates [mm].
edm4hep::Vector3f &	getPosition ()
	Get mutable reference to Position the pulse is evaluated in world coordinates [mm].
edm4hep::Vector3f &	position ()
	Get reference to Position the pulse is evaluated in world coordinates [mm].
void	setTime (float value)
	Set the Start time for the pulse in [ns].
float &	getTime ()
	Get mutable reference to Start time for the pulse in [ns].
float &	time ()
	Get reference to Start time for the pulse in [ns].
void	setInterval (float value)
	Set the Time interval between amplitude values [ns].
float &	getInterval ()
	Get mutable reference to Time interval between amplitude values [ns].
float &	interval ()
	Get reference to Time interval between amplitude values [ns].
void	addToCalorimeterHits (const edm4hep::SimCalorimeterHit &)
std::size_t	calorimeterHits_size () const
edm4hep::SimCalorimeterHit	getCalorimeterHits (std::size_t) const
std::vector< edm4hep::SimCalorimeterHit >::const_iterator	calorimeterHits_begin () const
std::vector< edm4hep::SimCalorimeterHit >::const_iterator	calorimeterHits_end () const
podio::RelationRange< edm4hep::SimCalorimeterHit >	getCalorimeterHits () const
void	addToTrackerHits (const edm4hep::SimTrackerHit &)
std::size_t	trackerHits_size () const
edm4hep::SimTrackerHit	getTrackerHits (std::size_t) const
std::vector< edm4hep::SimTrackerHit >::const_iterator	trackerHits_begin () const
std::vector< edm4hep::SimTrackerHit >::const_iterator	trackerHits_end () const
podio::RelationRange< edm4hep::SimTrackerHit >	getTrackerHits () const
void	addToPulses (const edm4eic::SimPulse &)
std::size_t	pulses_size () const
edm4eic::SimPulse	getPulses (std::size_t) const
std::vector< edm4eic::SimPulse >::const_iterator	pulses_begin () const
std::vector< edm4eic::SimPulse >::const_iterator	pulses_end () const
podio::RelationRange< edm4eic::SimPulse >	getPulses () const
void	addToParticles (const edm4hep::MCParticle &)
std::size_t	particles_size () const
edm4hep::MCParticle	getParticles (std::size_t) const
std::vector< edm4hep::MCParticle >::const_iterator	particles_begin () const
std::vector< edm4hep::MCParticle >::const_iterator	particles_end () const
podio::RelationRange< edm4hep::MCParticle >	getParticles () const
void	addToAmplitude (const float &)
std::size_t	amplitude_size () const
float	getAmplitude (std::size_t) const
std::vector< float >::const_iterator	amplitude_begin () const
std::vector< float >::const_iterator	amplitude_end () const
podio::RelationRange< float >	getAmplitude () const
bool	isAvailable () const
	check whether the object is actually available
void	unlink ()
	disconnect from SimPulseObj instance
bool	operator== (const MutableSimPulse &other) const
bool	operator== (const SimPulse &other) const
bool	operator!= (const MutableSimPulse &other) const
bool	operator!= (const SimPulse &other) const
bool	operator< (const MutableSimPulse &other) const
podio::ObjectID	id () const
const podio::ObjectID	getObjectID () const

Friends
class	SimPulseCollection
class	SimPulseMutableCollectionIterator
class	SimPulse
void	swap (MutableSimPulse &a, MutableSimPulse &b)

Detailed Description

Simulated pulse prior to digitization.

Author

: D. Anderson, S. Gardner, S. Joosten., D. Kalinkin

Member Typedef Documentation

collection_type

using edm4eic::MutableSimPulse::collection_type = SimPulseCollection

object_type

using edm4eic::MutableSimPulse::object_type = SimPulse

Constructor & Destructor Documentation

MutableSimPulse() [1/3]

edm4eic::MutableSimPulse::MutableSimPulse

(

)

default constructor

MutableSimPulse() [2/3]

edm4eic::MutableSimPulse::MutableSimPulse	(	std::uint64_t	cellID,
		float	integral,
		edm4hep::Vector3f	position,
		float	time,
		float	interval )

Constructor initializing all members.

MutableSimPulse() [3/3]

edm4eic::MutableSimPulse::MutableSimPulse ( const MutableSimPulse & other )

default

copy constructor

~MutableSimPulse()

edm4eic::MutableSimPulse::~MutableSimPulse ( )

default

destructor

Member Function Documentation

addToAmplitude()

void edm4eic::MutableSimPulse::addToAmplitude

(

const float &

component

)

addToCalorimeterHits()

void edm4eic::MutableSimPulse::addToCalorimeterHits

(

const edm4hep::SimCalorimeterHit &

component

)

addToParticles()

void edm4eic::MutableSimPulse::addToParticles

(

const edm4hep::MCParticle &

component

)

addToPulses()

void edm4eic::MutableSimPulse::addToPulses

(

const edm4eic::SimPulse &

component

)

addToTrackerHits()

void edm4eic::MutableSimPulse::addToTrackerHits

(

const edm4hep::SimTrackerHit &

component

)

amplitude_begin()

std::vector< float >::const_iterator edm4eic::MutableSimPulse::amplitude_begin

(

)

const

amplitude_end()

std::vector< float >::const_iterator edm4eic::MutableSimPulse::amplitude_end

(

)

const

amplitude_size()

std::size_t edm4eic::MutableSimPulse::amplitude_size

(

)

const

calorimeterHits_begin()

std::vector< edm4hep::SimCalorimeterHit >::const_iterator edm4eic::MutableSimPulse::calorimeterHits_begin

(

)

const

calorimeterHits_end()

std::vector< edm4hep::SimCalorimeterHit >::const_iterator edm4eic::MutableSimPulse::calorimeterHits_end

(

)

const

calorimeterHits_size()

std::size_t edm4eic::MutableSimPulse::calorimeterHits_size

(

)

const

cellID()

std::uint64_t & edm4eic::MutableSimPulse::cellID

(

)

Get reference to ID of the readout cell for this pulse.

clone()

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

getAmplitude() [1/2]

podio::RelationRange< float > edm4eic::MutableSimPulse::getAmplitude

(

)

const

getAmplitude() [2/2]

float edm4eic::MutableSimPulse::getAmplitude

(

std::size_t

index

)

const

getCalorimeterHits() [1/2]

podio::RelationRange< edm4hep::SimCalorimeterHit > edm4eic::MutableSimPulse::getCalorimeterHits

(

)

const

getCalorimeterHits() [2/2]

edm4hep::SimCalorimeterHit edm4eic::MutableSimPulse::getCalorimeterHits

(

std::size_t

index

)

const

getCellID() [1/2]

std::uint64_t & edm4eic::MutableSimPulse::getCellID

(

)

Get mutable reference to ID of the readout cell for this pulse.

getCellID() [2/2]

std::uint64_t edm4eic::MutableSimPulse::getCellID

(

)

const

Access the ID of the readout cell for this pulse.

getIntegral() [1/2]

float & edm4eic::MutableSimPulse::getIntegral

(

)

Get mutable reference to Total pulse integral in relevant units.

getIntegral() [2/2]

float edm4eic::MutableSimPulse::getIntegral

(

)

const

Access the Total pulse integral in relevant units.

getInterval() [1/2]

float & edm4eic::MutableSimPulse::getInterval

(

)

Get mutable reference to Time interval between amplitude values [ns].

getInterval() [2/2]

float edm4eic::MutableSimPulse::getInterval

(

)

const

Access the Time interval between amplitude values [ns].

getObjectID()

const podio::ObjectID edm4eic::MutableSimPulse::getObjectID

(

)

const

getParticles() [1/2]

podio::RelationRange< edm4hep::MCParticle > edm4eic::MutableSimPulse::getParticles

(

)

const

getParticles() [2/2]

edm4hep::MCParticle edm4eic::MutableSimPulse::getParticles

(

std::size_t

index

)

const

getPosition() [1/2]

edm4hep::Vector3f & edm4eic::MutableSimPulse::getPosition

(

)

Get mutable reference to Position the pulse is evaluated in world coordinates [mm].

getPosition() [2/2]

const edm4hep::Vector3f & edm4eic::MutableSimPulse::getPosition

(

)

const

Access the Position the pulse is evaluated in world coordinates [mm].

getPulses() [1/2]

podio::RelationRange< edm4eic::SimPulse > edm4eic::MutableSimPulse::getPulses

(

)

const

getPulses() [2/2]

edm4eic::SimPulse edm4eic::MutableSimPulse::getPulses

(

std::size_t

index

)

const

getTime() [1/2]

float & edm4eic::MutableSimPulse::getTime

(

)

Get mutable reference to Start time for the pulse in [ns].

getTime() [2/2]

float edm4eic::MutableSimPulse::getTime

(

)

const

Access the Start time for the pulse in [ns].

getTrackerHits() [1/2]

podio::RelationRange< edm4hep::SimTrackerHit > edm4eic::MutableSimPulse::getTrackerHits

(

)

const

getTrackerHits() [2/2]

edm4hep::SimTrackerHit edm4eic::MutableSimPulse::getTrackerHits

(

std::size_t

index

)

const

id()

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

inline

integral()

float & edm4eic::MutableSimPulse::integral

(

)

Get reference to Total pulse integral in relevant units.

interval()

float & edm4eic::MutableSimPulse::interval

(

)

Get reference to Time interval between amplitude values [ns].

isAvailable()

bool edm4eic::MutableSimPulse::isAvailable

(

)

const

check whether the object is actually available

operator!=() [1/2]

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

inline

operator!=() [2/2]

bool edm4eic::MutableSimPulse::operator!= ( const SimPulse & other ) const

inline

operator<()

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

inline

operator=()

MutableSimPulse & edm4eic::MutableSimPulse::operator=

(

MutableSimPulse

other

)

copy-assignment operator

operator==() [1/2]

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

inline

operator==() [2/2]

bool edm4eic::MutableSimPulse::operator==

(

const SimPulse &

other

)

const

particles_begin()

std::vector< edm4hep::MCParticle >::const_iterator edm4eic::MutableSimPulse::particles_begin

(

)

const

particles_end()

std::vector< edm4hep::MCParticle >::const_iterator edm4eic::MutableSimPulse::particles_end

(

)

const

particles_size()

std::size_t edm4eic::MutableSimPulse::particles_size

(

)

const

position()

edm4hep::Vector3f & edm4eic::MutableSimPulse::position

(

)

Get reference to Position the pulse is evaluated in world coordinates [mm].

pulses_begin()

std::vector< edm4eic::SimPulse >::const_iterator edm4eic::MutableSimPulse::pulses_begin

(

)

const

pulses_end()

std::vector< edm4eic::SimPulse >::const_iterator edm4eic::MutableSimPulse::pulses_end

(

)

const

pulses_size()

std::size_t edm4eic::MutableSimPulse::pulses_size

(

)

const

setCellID()

void edm4eic::MutableSimPulse::setCellID

(

std::uint64_t

value

)

Set the ID of the readout cell for this pulse.

setIntegral()

void edm4eic::MutableSimPulse::setIntegral

(

float

value

)

Set the Total pulse integral in relevant units.

setInterval()

void edm4eic::MutableSimPulse::setInterval

(

float

value

)

Set the Time interval between amplitude values [ns].

setPosition()

void edm4eic::MutableSimPulse::setPosition

(

edm4hep::Vector3f

value

)

Set the Position the pulse is evaluated in world coordinates [mm].

setTime()

void edm4eic::MutableSimPulse::setTime

(

float

value

)

Set the Start time for the pulse in [ns].

time()

float & edm4eic::MutableSimPulse::time

(

)

Get reference to Start time for the pulse in [ns].

trackerHits_begin()

std::vector< edm4hep::SimTrackerHit >::const_iterator edm4eic::MutableSimPulse::trackerHits_begin

(

)

const

trackerHits_end()

std::vector< edm4hep::SimTrackerHit >::const_iterator edm4eic::MutableSimPulse::trackerHits_end

(

)

const

trackerHits_size()

std::size_t edm4eic::MutableSimPulse::trackerHits_size

(

)

const

unlink()

void edm4eic::MutableSimPulse::unlink ( )

inline

disconnect from SimPulseObj instance

Friends And Related Symbol Documentation

SimPulse

friend class SimPulse

friend

SimPulseCollection

friend class SimPulseCollection

friend

SimPulseMutableCollectionIterator

friend class SimPulseMutableCollectionIterator

friend

swap

void swap ( MutableSimPulse & a, MutableSimPulse & b )

friend

---

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

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