allpix::ProjectionPropagationModule

Module: Modules

Module to project created electrons onto the sensor surface including diffusion. More…

#include <ProjectionPropagationModule.hpp>

Public Functions

	Name
	ProjectionPropagationModule(Configuration & config, Messenger * messenger, std::shared_ptr< Detector > detector) Constructor for this detector-specific module.
virtual void	initialize() override Initialize - create plots if needed.
virtual void	run(Event * event) override Projection of the electrons to the surface.
virtual void	finalize() override Write plots if needed.

Additional inherited members

Public Functions inherited from allpix::Module

	Name
	Module(const Module & ) =delete Copying a module is not allowed.
Module &	operator=(const Module & ) =delete Copying a module is not allowed.
	Module(Module && ) =delete Disallow move behaviour (not possible with references)
Module &	operator=(Module && ) =delete Disallow move behaviour (not possible with references)
	Module(Configuration & config) Base constructor for unique modules.
	Module(Configuration & config, std::shared_ptr< Detector > detector) Base constructor for detector modules.
virtual	~Module() Essential virtual destructor.
std::shared_ptr< Detector >	getDetector() const Get the detector linked to this module.
std::string	getUniqueName() const Get the unique name of this module.
std::string	createOutputFile(const std::string & pathname, const std::string & extension ="", bool global =false, bool delete_file =false) Create and return an absolute path to be used for output from a relative path.
TDirectory *	getROOTDirectory() const Get ROOT directory which should be used to output histograms et cetera.
ConfigManager *	getConfigManager() const Get the config manager object to allow to read the global and other module configurations.
bool	multithreadingEnabled() const Returns if multithreading of this module is enabled.
virtual void	initializeThread() Initialize the module for each thread after the global initialization.
virtual void	finalizeThread() Finalize the module after the event sequence for each thread.

Protected Functions inherited from allpix::Module

	Name
void	allow_multithreading() Enable multithreading for this module.
Configuration &	get_configuration() Get the module configuration for internal use.

Protected Attributes inherited from allpix::Module

	Name
Configuration &	config_

Friends inherited from allpix::Module

	Name
class	Event
class	ModuleManager
class	Messenger
class	LocalMessenger

Detailed Description

class allpix::ProjectionPropagationModule;

Module to project created electrons onto the sensor surface including diffusion.

The electrons from the deposition message are projected onto the sensor surface as a simple propagation method. Diffusion is added by approximating the drift time and drawing a random number from a 2D gaussian distribution of the calculated width.

Public Functions Documentation

function ProjectionPropagationModule

ProjectionPropagationModule(
    Configuration & config,
    Messenger * messenger,
    std::shared_ptr< Detector > detector
)

Constructor for this detector-specific module.

Parameters:

config Configuration object for this module as retrieved from the steering file
messenger Pointer to the messenger object to allow binding to messages on the bus
detector Pointer to the detector for this module instance

function initialize

virtual void initialize() override

Initialize - create plots if needed.

Reimplements: allpix::Module::initialize

function run

virtual void run(
    Event * event
) override

Projection of the electrons to the surface.

Reimplements: allpix::Module::run

function finalize

virtual void finalize() override

Write plots if needed.

Reimplements: allpix::Module::finalize

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