Geant4ParticleHandler user extension action to modify the particle reason mask. More...

Inheritance diagram for dd4hep::sim::Geant4ParticleMaskAction:

Public Member Functions
	Geant4ParticleMaskAction (Geant4Context *ctxt, const std::string &nam)
	Standard constructor. More...

void	mark_track (const G4Track track, Particle curr_track) override final
	User overload to handle particle settings when processing the track in the Geant4ParticleHandler. More...

Public Member Functions inherited from dd4hep::sim::Geant4UserParticleHandler
	Geant4UserParticleHandler (Geant4Context *context, const std::string &nam)
	Standard constructor. More...

virtual	~Geant4UserParticleHandler ()
	Default destructor. More...

virtual void	generate (G4Event event, Geant4ParticleHandler handler)
	Event generation action callback. More...

virtual void	begin (const G4Event *event)
	Pre-event action callback. More...

virtual void	end (const G4Event *event)
	Post-event action callback. More...

virtual void	step (const G4Step step, G4SteppingManager mgr, Particle &particle)
	User stepping callback. More...

virtual void	begin (const G4Track *track, Particle &particle)
	Pre-track action callback. More...

virtual void	end (const G4Track *track, Particle &particle)
	Post-track action callback. More...

virtual bool	keepParticle (Particle &particle)
	Callback to be answered if the particle MUST be kept during recombination step. More...

virtual void	combine (Particle &to_be_deleted, Particle &remaining_parent)
	Callback when parent should be combined. More...

Public Member Functions inherited from dd4hep::sim::Geant4Action
	Geant4Action (Geant4Context *context, const std::string &nam)
	Standard constructor. More...

long	addRef ()
	Increase reference count. More...

long	release ()
	Decrease reference count. Implicit destruction. More...

Geant4Context *	context () const
	Access the context. More...

virtual void	updateContext (Geant4Context *ctxt)
	Set or update client context. More...

virtual void	configureFiber (Geant4Context *thread_context)
	Set or update client for the use in a new thread fiber. More...

const std::string &	name () const
	Access name of the action. More...

const char *	c_name () const
	Access name of the action. More...

void	setName (const std::string &new_name)
	Set the object name. More...

PropertyManager &	properties ()
	Access to the properties of the object. More...

PrintLevel	outputLevel () const
	Access the output level. More...

PrintLevel	setOutputLevel (PrintLevel new_level)
	Set the output level; returns previous value. More...

Geant4UIMessenger *	control () const
	Access to the UI messenger. More...

virtual void	enableUI ()
	Enable and install UI messenger. More...

template<typename T >
Geant4Action &	declareProperty (const std::string &nam, T &val)
	Declare property. More...

template<typename T >
Geant4Action &	declareProperty (const char *nam, T &val)
	Declare property. More...

bool	hasProperty (const std::string &name) const
	Check property for existence. More...

Property &	property (const std::string &name)
	Access single property. More...

virtual void	installMessengers ()
	Install property control messenger if wanted. More...

virtual void	installCommandMessenger ()
	Install command control messenger if wanted. More...

virtual void	installPropertyMessenger ()
	Install property control messenger if wanted. More...

void	print (const char *fmt,...) const
	Support for messages with variable output level using output level. More...

void	printM1 (const char *fmt,...) const
	Support for messages with variable output level using output level-1. More...

void	printM2 (const char *fmt,...) const
	Support for messages with variable output level using output level-2. More...

void	printP1 (const char *fmt,...) const
	Support for messages with variable output level using output level+1. More...

void	printP2 (const char *fmt,...) const
	Support for messages with variable output level using output level+2. More...

void	always (const char *fmt,...) const
	Support of always printed messages. More...

void	debug (const char *fmt,...) const
	Support of debug messages. More...

void	info (const char *fmt,...) const
	Support of info messages. More...

void	warning (const char *fmt,...) const
	Support of warning messages. More...

void	error (const char *fmt,...) const
	Support of error messages. More...

bool	return_error (bool return_value, const char *fmt,...) const
	Action to support error messages. More...

void	fatal (const char *fmt,...) const
	Support of fatal messages. Throws exception. More...

void	except (const char *fmt,...) const
	Support of exceptions: Print fatal message and throw runtime_error. More...

void	abortRun (const std::string &exception, const char *fmt,...) const
	Abort Geant4 Run by throwing a G4Exception with type RunMustBeAborted. More...

Geant4RunActionSequence &	runAction () const
	Access to the main run action sequence from the kernel object. More...

Geant4EventActionSequence &	eventAction () const
	Access to the main event action sequence from the kernel object. More...

Geant4SteppingActionSequence &	steppingAction () const
	Access to the main stepping action sequence from the kernel object. More...

Geant4TrackingActionSequence &	trackingAction () const
	Access to the main tracking action sequence from the kernel object. More...

Geant4StackingActionSequence &	stackingAction () const
	Access to the main stacking action sequence from the kernel object. More...

Geant4GeneratorActionSequence &	generatorAction () const
	Access to the main generator action sequence from the kernel object. More...

Protected Attributes
std::map< std::string, int32_t >	m_nameMasks
	Map of Subdetector names to trigger setting of the mask : Bit mask to be set to particle. More...

std::map< std::string, int32_t >	m_typeMasks
	Map of Subdetector types to trigger setting of the mask : Bit mask to be set to particle. More...

Protected Attributes inherited from dd4hep::sim::Geant4UserParticleHandler
double	m_kinEnergyCut
	Property: Energy cut below which particles are not collected, but assigned to the parent. More...

Protected Attributes inherited from dd4hep::sim::Geant4Action
Geant4Context *	m_context { nullptr }
	Reference to the Geant4 context. More...

Geant4UIMessenger *	m_control { nullptr }
	Control directory of this action. More...

int	m_outputLevel { 3 }
	Default property: Output level. More...

bool	m_needsControl { false }
	Default property: Flag to create control instance. More...

std::string	m_name { }
	Action name. More...

PropertyManager	m_properties { }
	Property pool. More...

long	m_refCount { 1 }
	Reference count. Initial value: 1. More...

Additional Inherited Members
Public Types inherited from dd4hep::sim::Geant4UserParticleHandler
typedef Geant4Particle	Particle

Protected Member Functions inherited from dd4hep::sim::Geant4Action
	DDG4_DEFINE_ACTION_CONSTRUCTORS (Geant4Action)
	Define standard assignments and constructors. More...

virtual	~Geant4Action ()
	Default destructor. More...

Detailed Description

Geant4ParticleHandler user extension action to modify the particle reason mask.

This action marks the 'reason' bitmask of a Geant4Particle with a given bitmask if a sub-detector created a hit. Multiple subdetectors can be set to mask different values by the options <action>.Masks = {'det1': 4, 'det2': 1024, ... }

Please note:

This is a simple example of a user supplied Geant4UserParticleHandler Do not artificially complicate it. Enhanced functionality can also be achieved by chaining other sub-classes of Geant4UserParticleHandler instances.

Author: M.Frank

Version: 1.0

Definition at line 50 of file Geant4ParticleMaskAction.cpp.

Constructor & Destructor Documentation

◆ Geant4ParticleMaskAction()

dd4hep::sim::Geant4ParticleMaskAction::Geant4ParticleMaskAction	(	Geant4Context *	ctxt,
		const std::string &	nam
	)

inline

Standard constructor.

Definition at line 59 of file Geant4ParticleMaskAction.cpp.

Member Function Documentation

◆ mark_track()

void dd4hep::sim::Geant4ParticleMaskAction::mark_track	(	const G4Track *	track,
		Particle *	curr_track
	)

inlinefinaloverridevirtual

User overload to handle particle settings when processing the track in the Geant4ParticleHandler.

Reimplemented from dd4hep::sim::Geant4UserParticleHandler.

Definition at line 68 of file Geant4ParticleMaskAction.cpp.

Member Data Documentation

◆ m_nameMasks

std::map<std::string, int32_t> dd4hep::sim::Geant4ParticleMaskAction::m_nameMasks

protected

Map of Subdetector names to trigger setting of the mask : Bit mask to be set to particle.

Definition at line 53 of file Geant4ParticleMaskAction.cpp.

◆ m_typeMasks

std::map<std::string, int32_t> dd4hep::sim::Geant4ParticleMaskAction::m_typeMasks

protected

Map of Subdetector types to trigger setting of the mask : Bit mask to be set to particle.

Definition at line 55 of file Geant4ParticleMaskAction.cpp.

The documentation for this class was generated from the following file:

DDG4/plugins/Geant4ParticleMaskAction.cpp

Public Member Functions

Protected Attributes

Additional Inherited Members