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

#include <SimPulse.h>

Public Types

using mutable_type = MutableSimPulse
 
using collection_type = SimPulseCollection
 

Public Member Functions

 SimPulse ()
 default constructor
 
 SimPulse (const std::uint64_t cellID, const float integral, const edm4hep::Vector3f &position, const float time, const float interval)
 Constructor initializing all members.
 
 SimPulse (const SimPulse &other)=default
 copy constructor
 
SimPulse & operator= (SimPulse other) &
 copy-assignment operator
 
SimPulse & operator= (SimPulse other) &&=delete
 
MutableSimPulse clone (bool cloneRelations=true) const
 
 ~SimPulse ()=default
 destructor
 
 SimPulse (const MutableSimPulse &other)
 converting constructor from mutable object
 
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].
 
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
 
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
 
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
 
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
 
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 SimPulse &other) const
 
bool operator== (const MutableSimPulse &other) const
 
bool operator!= (const SimPulse &other) const
 
bool operator!= (const MutableSimPulse &other) const
 
bool operator< (const SimPulse &other) const
 
podio::ObjectID id () const
 
const podio::ObjectID getObjectID () const
 

Static Public Member Functions

static SimPulse makeEmpty ()
 

Static Public Attributes

static constexpr std::string_view typeName = "edm4eic::SimPulse"
 

Friends

class MutableSimPulse
 
class SimPulseCollection
 
class edm4eic::SimPulseCollectionData
 
class SimPulseCollectionIterator
 
podio::detail::OrderKey podio::detail::getOrderKey (const SimPulse &obj)
 
void swap (SimPulse &a, SimPulse &b)
 

Detailed Description

Simulated pulse prior to digitization.

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

Member Typedef Documentation

◆ collection_type

using edm4eic::SimPulse::collection_type = SimPulseCollection

◆ mutable_type

using edm4eic::SimPulse::mutable_type = MutableSimPulse

Constructor & Destructor Documentation

◆ SimPulse() [1/4]

edm4eic::SimPulse::SimPulse ( )

default constructor

◆ SimPulse() [2/4]

edm4eic::SimPulse::SimPulse ( const std::uint64_t cellID,
const float integral,
const edm4hep::Vector3f & position,
const float time,
const float interval )

Constructor initializing all members.

◆ SimPulse() [3/4]

edm4eic::SimPulse::SimPulse ( const SimPulse & other)
default

copy constructor

◆ ~SimPulse()

edm4eic::SimPulse::~SimPulse ( )
default

destructor

◆ SimPulse() [4/4]

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

converting constructor from mutable object

Member Function Documentation

◆ amplitude_begin()

std::vector< float >::const_iterator edm4eic::SimPulse::amplitude_begin ( ) const

◆ amplitude_end()

std::vector< float >::const_iterator edm4eic::SimPulse::amplitude_end ( ) const

◆ amplitude_size()

std::size_t edm4eic::SimPulse::amplitude_size ( ) const

◆ calorimeterHits_begin()

std::vector< edm4hep::SimCalorimeterHit >::const_iterator edm4eic::SimPulse::calorimeterHits_begin ( ) const

◆ calorimeterHits_end()

std::vector< edm4hep::SimCalorimeterHit >::const_iterator edm4eic::SimPulse::calorimeterHits_end ( ) const

◆ calorimeterHits_size()

std::size_t edm4eic::SimPulse::calorimeterHits_size ( ) const

◆ clone()

MutableSimPulse edm4eic::SimPulse::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::SimPulse::getAmplitude ( ) const

◆ getAmplitude() [2/2]

float edm4eic::SimPulse::getAmplitude ( std::size_t index) const

◆ getCalorimeterHits() [1/2]

podio::RelationRange< edm4hep::SimCalorimeterHit > edm4eic::SimPulse::getCalorimeterHits ( ) const

◆ getCalorimeterHits() [2/2]

edm4hep::SimCalorimeterHit edm4eic::SimPulse::getCalorimeterHits ( std::size_t index) const

◆ getCellID()

std::uint64_t edm4eic::SimPulse::getCellID ( ) const

Access the ID of the readout cell for this pulse.

◆ getIntegral()

float edm4eic::SimPulse::getIntegral ( ) const

Access the Total pulse integral in relevant units.

◆ getInterval()

float edm4eic::SimPulse::getInterval ( ) const

Access the Time interval between amplitude values [ns].

◆ getObjectID()

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

◆ getParticles() [1/2]

podio::RelationRange< edm4hep::MCParticle > edm4eic::SimPulse::getParticles ( ) const

◆ getParticles() [2/2]

edm4hep::MCParticle edm4eic::SimPulse::getParticles ( std::size_t index) const

◆ getPosition()

const edm4hep::Vector3f & edm4eic::SimPulse::getPosition ( ) const

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

◆ getPulses() [1/2]

podio::RelationRange< edm4eic::SimPulse > edm4eic::SimPulse::getPulses ( ) const

◆ getPulses() [2/2]

edm4eic::SimPulse edm4eic::SimPulse::getPulses ( std::size_t index) const

◆ getTime()

float edm4eic::SimPulse::getTime ( ) const

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

◆ getTrackerHits() [1/2]

podio::RelationRange< edm4hep::SimTrackerHit > edm4eic::SimPulse::getTrackerHits ( ) const

◆ getTrackerHits() [2/2]

edm4hep::SimTrackerHit edm4eic::SimPulse::getTrackerHits ( std::size_t index) const

◆ id()

podio::ObjectID edm4eic::SimPulse::id ( ) const
inline

◆ isAvailable()

bool edm4eic::SimPulse::isAvailable ( ) const

check whether the object is actually available

◆ makeEmpty()

SimPulse edm4eic::SimPulse::makeEmpty ( )
static

◆ operator!=() [1/2]

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

◆ operator!=() [2/2]

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

◆ operator<()

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

◆ operator=() [1/2]

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

copy-assignment operator

◆ operator=() [2/2]

SimPulse & edm4eic::SimPulse::operator= ( SimPulse other) &&
delete

◆ operator==() [1/2]

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

◆ operator==() [2/2]

bool edm4eic::SimPulse::operator== ( const SimPulse & other) const
inline

◆ particles_begin()

std::vector< edm4hep::MCParticle >::const_iterator edm4eic::SimPulse::particles_begin ( ) const

◆ particles_end()

std::vector< edm4hep::MCParticle >::const_iterator edm4eic::SimPulse::particles_end ( ) const

◆ particles_size()

std::size_t edm4eic::SimPulse::particles_size ( ) const

◆ pulses_begin()

std::vector< edm4eic::SimPulse >::const_iterator edm4eic::SimPulse::pulses_begin ( ) const

◆ pulses_end()

std::vector< edm4eic::SimPulse >::const_iterator edm4eic::SimPulse::pulses_end ( ) const

◆ pulses_size()

std::size_t edm4eic::SimPulse::pulses_size ( ) const

◆ trackerHits_begin()

std::vector< edm4hep::SimTrackerHit >::const_iterator edm4eic::SimPulse::trackerHits_begin ( ) const

◆ trackerHits_end()

std::vector< edm4hep::SimTrackerHit >::const_iterator edm4eic::SimPulse::trackerHits_end ( ) const

◆ trackerHits_size()

std::size_t edm4eic::SimPulse::trackerHits_size ( ) const

◆ unlink()

void edm4eic::SimPulse::unlink ( )
inline

disconnect from SimPulseObj instance

Friends And Related Symbol Documentation

◆ edm4eic::SimPulseCollectionData

friend class edm4eic::SimPulseCollectionData
friend

◆ MutableSimPulse

friend class MutableSimPulse
friend

◆ podio::detail::getOrderKey

podio::detail::OrderKey podio::detail::getOrderKey ( const SimPulse & obj)
friend

◆ SimPulseCollection

friend class SimPulseCollection
friend

◆ SimPulseCollectionIterator

friend class SimPulseCollectionIterator
friend

◆ swap

void swap ( SimPulse & a,
SimPulse & b )
friend

Member Data Documentation

◆ typeName

std::string_view edm4eic::SimPulse::typeName = "edm4eic::SimPulse"
staticconstexpr
The documentation for this class was generated from the following files: