allpix::VisualizationGeant4Module

Module: Modules

Module that shows visualization of constructed Geant4 geometry. More…

#include <VisualizationGeant4Module.hpp>

Public Functions

	Name
	VisualizationGeant4Module(Configuration & config, Messenger * messenger, GeometryManager * geo_manager) Constructor for this unique module.
	~VisualizationGeant4Module() override Destructor applies a workaround for some visualization drivers to prevent display during exception handling.
virtual void	initialize() override Initializes visualization and apply configuration parameters.
virtual void	run(Event * ) override Show visualization updates if not accumulating data.
virtual void	finalize() override Possibly start GUI or terminal and display the visualization.

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

Module that shows visualization of constructed Geant4 geometry.

Displays the geometry constructed in GeometryBuilderGeant4Module. Allows passing a variety of options to configure both the visualization viewer as well as the display of the various detector components and the beam.

Public Functions Documentation

function VisualizationGeant4Module

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

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

function ~VisualizationGeant4Module

~VisualizationGeant4Module() override

Destructor applies a workaround for some visualization drivers to prevent display during exception handling.

Without applying this workaround the visualization (sometimes without content) is also shown when an exception occurred in any other module.

function initialize

virtual void initialize() override

Initializes visualization and apply configuration parameters.

Reimplements: allpix::Module::initialize

function run

virtual void run(
    Event * 
) override

Show visualization updates if not accumulating data.

Reimplements: allpix::Module::run

function finalize

virtual void finalize() override

Possibly start GUI or terminal and display the visualization.

Reimplements: allpix::Module::finalize

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