allpix::PixelHit

Module: Objects

Pixel triggered in an event after digitization.

#include <PixelHit.hpp>

Inherits from allpix::Object, TObject

Public Functions

	Name
	PixelHit(Pixel pixel, double local_time, double global_time, double signal, const PixelCharge * pixel_charge =nullptr, const PixelPulse * pixel_pulse =nullptr) Construct a digitized pixel hit.
const Pixel &	getPixel() const Get the pixel hit.
Pixel::Index	getIndex() const Shortcut to retrieve the pixel indices.
double	getGlobalTime() const Get the timing data of the hit in the global reference frame.
double	getLocalTime() const Get the timing data of the hit in the local reference frame.
double	getSignal() const Get the signal data for the hit.
const PixelCharge *	getPixelCharge() const Get related pixel charge.
const PixelPulse *	getPixelPulse() const Get related pixel pulse.
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.
virtual void	print(std::ostream & out) const override Print an ASCII representation of PixelHit to the given stream.
	ClassDefOverride(PixelHit , 7 ) ROOT class definition.
	PixelHit() =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 Documentation

function PixelHit

PixelHit(
    Pixel pixel,
    double local_time,
    double global_time,
    double signal,
    const PixelCharge * pixel_charge =nullptr,
    const PixelPulse * pixel_pulse =nullptr
)

Construct a digitized pixel hit.

Parameters:

pixel Object holding the information of the pixel
local_time Timing of the occurrence of the hit in local reference frame
global_time Timing of the occurrence of the hit in global reference frame
signal Signal data produced by the digitizer
pixel_charge Optional pointer to the related pixel charge
pixel_pulse Optional pointer to the related pixel pulse this his might have been derived from

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 getGlobalTime

inline double getGlobalTime() const

Get the timing data of the hit in the global reference frame.

Return: Timestamp from event start

function getLocalTime

inline double getLocalTime() const

Get the timing data of the hit in the local reference frame.

Return: Timestamp from primary particle arrival

function getSignal

inline double getSignal() const

Get the signal data for the hit.

Return: Digitized signal

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 getPixelPulse

const PixelPulse * getPixelPulse() const

Get related pixel pulse.

Exceptions:

MissingReferenceException If the pointed object is not in scope

Return: Possible related pixel pulse

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 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(
    PixelHit ,
    7 
)

ROOT class definition.

function PixelHit

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