allpix::DepositionGeneratorModule

Module: Modules

Module to read primary particles from MC generators. More…

#include <DepositionGeneratorModule.hpp>

Inherits from allpix::DepositionGeant4Module, allpix::SequentialModule, allpix::Module

Public Functions

	Name
	DepositionGeneratorModule(Configuration & config, Messenger * messenger, GeometryManager * geo_manager) Constructor for the DepositionGenerator module.
virtual void	initialize() override Initializes the file reader according to the configuration and then calls DepositionGeant4Module::initialize() to initialize physics lists etc.
virtual void	run(Event * event) override Passes the currently processed event number to the primary particle reader module and calls DepositionGeant4Module::run.

Additional inherited members

Public Functions inherited from allpix::DepositionGeant4Module

	Name
	DepositionGeant4Module(Configuration & config, Messenger * messenger, GeometryManager * geo_manager) Constructor for this unique module.
virtual void	initializeThread() override Prepare thread-local instances of worker run managers.
virtual void	finalizeThread() override Cleanup RunManager for each thread.
virtual void	finalize() override Display statistical summary.

Protected Attributes inherited from allpix::DepositionGeant4Module

	Name
Messenger *	messenger_
GeometryManager *	geo_manager_
G4RunManager *	run_manager_g4_

Friends inherited from allpix::DepositionGeant4Module

	Name
class	SDAndFieldConstruction
class	SetTrackInfoUserHookG4

Public Functions inherited from allpix::SequentialModule

	Name
	SequentialModule(Configuration & config)
	SequentialModule(Configuration & config, std::shared_ptr< Detector > detector)

Protected Functions inherited from allpix::SequentialModule

	Name
void	waive_sequence_requirement(bool waive =true) Release strict sequence processing requirement.

Friends inherited from allpix::SequentialModule

	Name
class	Event
class	ModuleManager
class	Messenger

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.
virtual void	finalize() Finalize the module after the event sequence.

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::DepositionGeneratorModule;

Module to read primary particles from MC generators.

This module reads primary particles produced by Monte Carlo generators from a data file and dispatches them using a Geant4 ParticleGun. The DepositionGeant4Module then performs the tracking of the particles through the setup and deposits electron/hole pairs.

Public Functions Documentation

function DepositionGeneratorModule

DepositionGeneratorModule(
    Configuration & config,
    Messenger * messenger,
    GeometryManager * geo_manager
)

Constructor for the DepositionGenerator 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
geo_manager Pointer to the geometry manager, containing the detectors

function initialize

virtual void initialize() override

Initializes the file reader according to the configuration and then calls DepositionGeant4Module::initialize() to initialize physics lists etc.

Reimplements: allpix::DepositionGeant4Module::initialize

function run

virtual void run(
    Event * event
) override

Passes the currently processed event number to the primary particle reader module and calls DepositionGeant4Module::run.

Parameters:

event Pointer to the currently processed event

Reimplements: allpix::DepositionGeant4Module::run

Updated on 2025-05-10 at 19:40:39 +0000