allpix::MagneticFieldReaderModule

Module: Modules

Module to define magnetic fields. More…

#include <MagneticFieldReaderModule.hpp>

Public Functions

	Name
	MagneticFieldReaderModule(Configuration & config, Messenger * messenger, GeometryManager * geoManager) Constructor for this unique module.
virtual void	initialize() override Read magnetic field, feed it back to the geometry manager and apply it to the bound detectors.

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	run(Event * event) Execute the function of the module for every event.
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::MagneticFieldReaderModule;

Module to define magnetic fields.

Read the model of the magnetic field from the config during initialization and apply a constant field throughout the whole volume

Public Functions Documentation

function MagneticFieldReaderModule

MagneticFieldReaderModule(
    Configuration & config,
    Messenger * messenger,
    GeometryManager * geoManager
)

Constructor for this unique 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
geoManager Pointer to the global GeometryManager

function initialize

virtual void initialize() override

Read magnetic field, feed it back to the geometry manager and apply it to the bound detectors.

Reimplements: allpix::Module::initialize

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