allpix::PixelPulse

Module: Objects

Pixel triggered in an event after digitization.

#include <PixelPulse.hpp>

Inherits from allpix::Object, allpix::Pulse, TObject

Public Functions

	Name
	PixelPulse(Pixel pixel, const Pulse & pulse, const PixelCharge * pixel_charge =nullptr) Construct a digitized pixel front-end pulse.
const Pixel &	getPixel() const Get the pixel hit.
Pixel::Index	getIndex() const Shortcut to retrieve the pixel indices.
const PixelCharge *	getPixelCharge() const Get related pixel charge.
std::vector< const MCParticle * >	getMCParticles() const Get the Monte-Carlo particles resulting in this pixel hit.
std::vector< const MCParticle * >	getPrimaryMCParticles() const Get all primary Monte-Carlo particles resulting in this pixel hit. A particle is considered primary if it has no parent particle set.
double	getGlobalTime() const Get time after start of event in global reference frame.
double	getLocalTime() const Get local time in the sensor.
virtual void	print(std::ostream & out) const override Print an ASCII representation of PixelHit to the given stream.
	ClassDefOverride(PixelPulse , 1 ) ROOT class definition.
	PixelPulse() =default Default constructor for ROOT I/O.
virtual void	loadHistory() override Resolve all the history to standard pointers.
virtual void	petrifyHistory() override Petrify all the pointers to prepare for persistent storage.

Additional inherited members

Public Classes inherited from allpix::Object

	Name
class	BaseWrapper
class	PointerWrapper

Public Functions inherited from allpix::Object

	Name
	Object(const Object & ) =default Use default copy behaviour.
Object &	operator=(const Object & ) =default Use default copy behaviour.
	Object(Object && ) =default Use default move behaviour.
Object &	operator=(Object && ) =default Use default move behaviour.
	Object() =default Required default constructor.
	~Object() override =default Required virtual destructor.
void	markForStorage()

Protected Functions inherited from allpix::Object

	Name
void	Print(Option_t * ) const override Override function to implement ROOT Print()

Friends inherited from allpix::Object

	Name
std::ostream &	operator«(std::ostream & out, const allpix::Object & obj) Overloaded ostream operator for printing of object data.

Public Functions inherited from allpix::Pulse

	Name
	Pulse(double time_bin) Construct a new pulse.
	Pulse(double time_bin, double total_time)
	Pulse() =default Construct default pulse, uninitialized.
void	addCharge(double charge, double time) adding induced charge to the pulse
int	getCharge() const Function to retrieve the integral (net) charge from the full pulse.
double	getBinning() const Function to retrieve time binning of pulse.
bool	isInitialized() const Method to check if this is an initialized or empty pulse.
Pulse &	operator+=(const Pulse & rhs) compound assignment operator to sum different pulses
	ClassDef(Pulse , 3 ) Default constructor for ROOT I/O.

Public Functions Documentation

function PixelPulse

PixelPulse(
    Pixel pixel,
    const Pulse & pulse,
    const PixelCharge * pixel_charge =nullptr
)

Construct a digitized pixel front-end pulse.

Parameters:

pixel Object holding the information of the pixel
pulse Output pulse produced by the digitizer
pixel_charge Optional pointer to the related pixel charge

function getPixel

const Pixel & getPixel() const

Get the pixel hit.

Return: Pixel indices in the grid

function getIndex

Pixel::Index getIndex() const

Shortcut to retrieve the pixel indices.

Return: Index of the pixel

function getPixelCharge

const PixelCharge * getPixelCharge() const

Get related pixel charge.

Exceptions:

MissingReferenceException If the pointed object is not in scope

Return: Possible related pixel charge

Object is stored as TRef and can only be accessed if pointed object is in scope

function getMCParticles

std::vector< const MCParticle * > getMCParticles() const

Get the Monte-Carlo particles resulting in this pixel hit.

Exceptions:

MissingReferenceException If the pointed object is not in scope

Return: List of all related Monte-Carlo particles

MCParticles can only be fetched if the full history of objects are in scope and stored

function getPrimaryMCParticles

std::vector< const MCParticle * > getPrimaryMCParticles() const

Get all primary Monte-Carlo particles resulting in this pixel hit. A particle is considered primary if it has no parent particle set.

Exceptions:

MissingReferenceException If the pointed object is not in scope

Return: List of all related primary Monte-Carlo particles

MCParticles can only be fetched if the full history of objects are in scope and stored

function getGlobalTime

double getGlobalTime() const

Get time after start of event in global reference frame.

Return: Time from start event

function getLocalTime

double getLocalTime() const

Get local time in the sensor.

Return: Time with respect to local sensor

function print

virtual void print(
    std::ostream & out
) const override

Print an ASCII representation of PixelHit to the given stream.

Parameters:

out Stream to print to

Reimplements: allpix::Object::print

function ClassDefOverride

ClassDefOverride(
    PixelPulse ,
    1 
)

ROOT class definition.

function PixelPulse

PixelPulse() =default

Default constructor for ROOT I/O.

function loadHistory

virtual void loadHistory() override

Resolve all the history to standard pointers.

Reimplements: allpix::Object::loadHistory

function petrifyHistory

virtual void petrifyHistory() override

Petrify all the pointers to prepare for persistent storage.

Reimplements: allpix::Object::petrifyHistory

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