allpix::PropagatedCharge

Module: Objects

Set of charges propagated through the sensor.

#include <PropagatedCharge.hpp>

Inherits from allpix::SensorCharge, allpix::Object, TObject

Public Functions

	Name
	PropagatedCharge(ROOT::Math::XYZPoint local_position, ROOT::Math::XYZPoint global_position, CarrierType type, unsigned int charge, double local_time, double global_time, CarrierState state =CarrierState::UNKNOWN, const DepositedCharge * deposited_charge =nullptr) Construct a set of propagated charges.
	PropagatedCharge(ROOT::Math::XYZPoint local_position, ROOT::Math::XYZPoint global_position, CarrierType type, std::map< Pixel::Index, Pulse > pulses, double local_time, double global_time, CarrierState state =CarrierState::UNKNOWN, const DepositedCharge * deposited_charge =nullptr) Construct a set of propagated charges.
const DepositedCharge *	getDepositedCharge() const Get related deposited charge.
const MCParticle *	getMCParticle() const Get related Monte-Carlo particle.
std::map< Pixel::Index, Pulse >	getPulses() const Get related induced pulses.
CarrierState	getState() const Get state of the charge carrier.
virtual void	print(std::ostream & out) const override Print an ASCII representation of PropagatedCharge to the given stream.
	ClassDefOverride(PropagatedCharge , 7 ) ROOT class definition.
	PropagatedCharge() =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	PixelCharge

Additional inherited members

Public Functions inherited from allpix::SensorCharge

	Name
	SensorCharge(ROOT::Math::XYZPoint local_position, ROOT::Math::XYZPoint global_position, CarrierType type, unsigned int charge, double local_time, double global_time) Construct a set of charges in a sensor.
ROOT::Math::XYZPoint	getLocalPosition() const Get local position of the set of charges in the sensor.
ROOT::Math::XYZPoint	getGlobalPosition() const Get the global position of the set of charges in the sensor.
CarrierType	getType() const Get the type of charge carrier.
unsigned int	getCharge() const Get total amount of charges stored.
long	getSign() const Get the sign of the charge for set of charge carriers.
double	getGlobalTime() const Get time after start of event in global reference frame.
double	getLocalTime() const Get local time in the sensor.
	SensorCharge() =default Default constructor for ROOT I/O.

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 PropagatedCharge

PropagatedCharge(
    ROOT::Math::XYZPoint local_position,
    ROOT::Math::XYZPoint global_position,
    CarrierType type,
    unsigned int charge,
    double local_time,
    double global_time,
    CarrierState state =CarrierState::UNKNOWN,
    const DepositedCharge * deposited_charge =nullptr
)

Construct a set of propagated charges.

Parameters:

local_position Local position of the propagated set of charges in the sensor
global_position Global position of the propagated set of charges in the sensor
type Type of the carrier to propagate
charge Total charge propagated
local_time Time of propagation arrival after energy deposition, local reference frame
global_time Total time of propagation arrival after event start, global reference frame
state State of the charge carrier when reaching its position
deposited_charge Optional pointer to related deposited charge

function PropagatedCharge

PropagatedCharge(
    ROOT::Math::XYZPoint local_position,
    ROOT::Math::XYZPoint global_position,
    CarrierType type,
    std::map< Pixel::Index, Pulse > pulses,
    double local_time,
    double global_time,
    CarrierState state =CarrierState::UNKNOWN,
    const DepositedCharge * deposited_charge =nullptr
)

Construct a set of propagated charges.

Parameters:

local_position Local position of the propagated set of charges in the sensor
global_position Global position of the propagated set of charges in the sensor
type Type of the carrier to propagate
pulses Map of pulses induced at electrodes identified by their index
local_time Time of propagation arrival after energy deposition, local reference frame
global_time Total time of propagation arrival after event start, global reference frame
state State of the charge carrier when reaching its position
deposited_charge Optional pointer to related deposited charge

function getDepositedCharge

const DepositedCharge * getDepositedCharge() const

Get related deposited charge.

Exceptions:

MissingReferenceException If the pointed object is not in scope

Return: Pointer to possible deposited charge

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

function getMCParticle

const MCParticle * getMCParticle() const

Get related Monte-Carlo particle.

Exceptions:

MissingReferenceException If the pointed object is not in scope

Return: Pointer to Monte-Carlo particle

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

function getPulses

std::map< Pixel::Index, Pulse > getPulses() const

Get related induced pulses.

Return: Map with induced pulses if available

function getState

CarrierState getState() const

Get state of the charge carrier.

Return: Charge carrier state

function print

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

Print an ASCII representation of PropagatedCharge to the given stream.

Parameters:

out Stream to print to

Reimplements: allpix::Object::print

function ClassDefOverride

ClassDefOverride(
    PropagatedCharge ,
    7 
)

ROOT class definition.

function PropagatedCharge

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

friend class PixelCharge(
    PixelCharge 
);

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