allpix::PixelCharge

Module: Objects

Set of charges at a pixel.

#include <PixelCharge.hpp>

Inherits from allpix::Object, TObject

Public Functions

	Name
	PixelCharge(Pixel pixel, long charge, const std::vector< const PropagatedCharge * > & propagated_charges =std::vector< const PropagatedCharge * >()) Construct a set of charges at a pixel.
	PixelCharge(Pixel pixel, Pulse pulse, const std::vector< const PropagatedCharge * > & propagated_charges =std::vector< const PropagatedCharge * >()) Construct a set of charges at a pixel.
const Pixel &	getPixel() const Get the pixel containing the charges.
Pixel::Index	getIndex() const Shortcut to retrieve the pixel indices.
long	getCharge() const Get the charge at the pixel.
unsigned long	getAbsoluteCharge() const Get the absolute charge value at the pixel.
std::vector< const PropagatedCharge * >	getPropagatedCharges() const Get related propagated charges.
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 contributing to this pixel charge. A particle is considered primary if it has no parent particle set.
const Pulse &	getPulse() const Get recoded charge pulse.
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 PixelCharge to the given stream.
	ClassDefOverride(PixelCharge , 9 ) ROOT class definition.
	PixelCharge() =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.

Friends

	Name
class	PixelHit
class	PixelPulse

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 Documentation

function PixelCharge

PixelCharge(
    Pixel pixel,
    long charge,
    const std::vector< const PropagatedCharge * > & propagated_charges =std::vector< const PropagatedCharge * >()
)

Construct a set of charges at a pixel.

Parameters:

pixel Object holding the information of the pixel
charge Amount of charge stored at this pixel
propagated_charges Optional pointer to the related propagated charges

function PixelCharge

PixelCharge(
    Pixel pixel,
    Pulse pulse,
    const std::vector< const PropagatedCharge * > & propagated_charges =std::vector< const PropagatedCharge * >()
)

Construct a set of charges at a pixel.

Parameters:

pixel Object holding the information of the pixel
pulse Pulse of induced or collected charges
propagated_charges Optional pointer to the related propagated charges

function getPixel

const Pixel & getPixel() const

Get the pixel containing the charges.

Return: Pixel indices in the grid

function getIndex

Pixel::Index getIndex() const

Shortcut to retrieve the pixel indices.

Return: Index of the pixel

function getCharge

long getCharge() const

Get the charge at the pixel.

Return: Total charge stored

function getAbsoluteCharge

unsigned long getAbsoluteCharge() const

Get the absolute charge value at the pixel.

Return: Absolute total charge stored

function getPropagatedCharges

std::vector< const PropagatedCharge * > getPropagatedCharges() const

Get related propagated charges.

Exceptions:

MissingReferenceException If the pointed object is not in scope

Return: Possible set of pointers to propagated charges

Objects are stored as vector of TRef and can only be accessed if pointed objects are 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 contributing to this pixel charge. 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 getPulse

const Pulse & getPulse() const

Get recoded charge pulse.

Return: Constant reference to the full charge pulse

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 PixelCharge to the given stream.

Parameters:

out Stream to print to

Reimplements: allpix::Object::print

function ClassDefOverride

ClassDefOverride(
    PixelCharge ,
    9 
)

ROOT class definition.

function PixelCharge

PixelCharge() =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

Friends

friend PixelHit

friend class PixelHit(
    PixelHit 
);

friend PixelPulse

friend class PixelPulse(
    PixelPulse 
);

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