allpix::Pulse

Module: Objects

Pulse holding induced charges as a function of time. More…

#include <Pulse.hpp>

Inherits from std::vector< double >

Inherited by allpix::PixelPulse

Public Functions

Detailed Description

class allpix::Pulse;

Pulse holding induced charges as a function of time.

Warning: This object is special and is not meant to be written directly to a tree (not inheriting from Object)

Public Functions Documentation

function Pulse

explicit Pulse(
    double time_bin
)

Construct a new pulse.

Parameters:

• time_bin Length in time of a single bin of the pulse

function Pulse

Pulse(
    double time_bin,
    double total_time
)

Parameters:

• time_bin Length in time of a single bin of the pulse
• total_time Expected total length of the pulse used to pre-allocate memory

Exceptions:

• PulseBadAllocException if memory allocation failed

function Pulse

Pulse() =default

Construct default pulse, uninitialized.

function addCharge

void addCharge(
    double charge,
    double time
)

adding induced charge to the pulse

Parameters:

• charge induced charge
• time time when it has been induced

function getCharge

int getCharge() const

Function to retrieve the integral (net) charge from the full pulse.

Return: Integrated charge

function getBinning

double getBinning() const

Function to retrieve time binning of pulse.

Return: Width of one pulse bin in nanoseconds

function isInitialized

bool isInitialized() const

Method to check if this is an initialized or empty pulse.

Return: Initialization status of the pulse object

function operator+=

Pulse & operator+=(
    const Pulse & rhs
)

compound assignment operator to sum different pulses

Exceptions:

• IncompatibleDatatypesException If the binning of the pulses does not match

function ClassDef

ClassDef(
    Pulse ,
    3 
)

Default constructor for ROOT I/O.

Updated on 2024-12-13 at 08:31:37 +0000