Implementation of a particle gun using Geant4Particles. More...

#include <Geant4ParticleGun.h>

Inheritance diagram for dd4hep::sim::Geant4ParticleGun:

Public Member Functions
	Geant4ParticleGun (Geant4Context *context, const std::string &name)
	Standard constructor. More...

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

virtual void	operator() (G4Event *event)
	Callback to generate primary particles. More...

Public Member Functions inherited from dd4hep::sim::Geant4IsotropeGenerator
	Geant4IsotropeGenerator ()=delete
	Inhibit default constructor. More...

	Geant4IsotropeGenerator (const Geant4IsotropeGenerator &copy)=delete
	Inhibit copy constructor. More...

	Geant4IsotropeGenerator (Geant4Context *context, const std::string &name)
	Standard constructor. More...

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

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

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

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

virtual	~Geant4GeneratorAction ()
	Default destructor. 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 Member Functions
virtual void	getParticleDirection (int, ROOT::Math::XYZVector &direction, double &momentum) const
	Particle modification. Caller presets defaults to: ( direction = m_direction, momentum = [m_momentumMin, m_momentumMax]) More...

Protected Member Functions inherited from dd4hep::sim::Geant4IsotropeGenerator
void	getParticleDirectionFFbar (int num, ROOT::Math::XYZVector &direction, double &momentum) const
	e+e- --> ffbar particle distribution ~ 1 + cos^2(theta) More...

void	getParticleDirectionEta (int num, ROOT::Math::XYZVector &direction, double &momentum) const
	e+e- --> ffbar particle distribution ~ 1 + cos^2(theta) More...

void	getParticleDirectionCosTheta (int num, ROOT::Math::XYZVector &direction, double &momentum) const
	Particle distribution ~ cos(theta) More...

void	getParticleDirectionUniform (int num, ROOT::Math::XYZVector &direction, double &momentum) const
	Uniform particle distribution. More...

Protected Member Functions inherited from dd4hep::sim::Geant4ParticleGenerator
virtual void	getParticleMultiplicity (int &multiplicity) const
	Particle modification. Caller presets defaults to: (multiplicity=m_multiplicity) More...

virtual void	getVertexPosition (ROOT::Math::XYZVector &position) const
	Particle's vertex modification. Caller presets defaults to: (multiplicity=m_multiplicity) More...

void	getParticleMomentumUniform (double &momentum) const
	Uniform particle momentum. More...

virtual void	printInteraction (int mask) const
	Print single particle interaction identified by its mask. More...

virtual void	printInteraction (Geant4PrimaryInteraction *inter) const
	Print single particle interaction identified by its reference. More...

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

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

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

Protected Attributes
bool	m_isotrop
	Property: Isotrope particles? More...

bool	m_standalone
	Property: Standalone mode: includes interaction merging and primary generation. More...

bool	m_print
	Property: Enable printout. More...

int	m_shotNo
	Shot number in sequence. More...

Protected Attributes inherited from dd4hep::sim::Geant4IsotropeGenerator
std::string	m_distribution
	Property: Distribution name. Default: "uniform". Allowed: "uniform", "cos(theta)", "ffbar", "eta". More...

double	m_phiMin
	Property: Minimal phi angular value. More...

double	m_phiMax
	Property: Maximal phi angular value. More...

double	m_thetaMin
	Property: Minimal theta angular value. More...

double	m_thetaMax
	Property: Maximal theta angular value. More...

Protected Attributes inherited from dd4hep::sim::Geant4ParticleGenerator
ROOT::Math::XYZVector	m_direction
	Property: Shooting direction of the gun. More...

ROOT::Math::XYZVector	m_position
	Property: Position of the gun in space. More...

std::string	m_particleName
	Property: Particle name. More...

G4ParticleDefinition *	m_particle
	Pointer to geant4 particle definition. More...

double	m_energy
	Property: Fixed momentum value, overwrites momentumMin and momentumMax if set. More...

double	m_momentumMin
	Property: Minimal momentum value. More...

double	m_momentumMax
	Property: Maximal momentum value. More...

int	m_multiplicity
	Property: Desired multiplicity of the particles to be shot. More...

int	m_mask
	Property: User mask passed to all particles in the generated interaction. More...

Protected Attributes inherited from dd4hep::sim::Geant4GeneratorAction
Callback	m_calls

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::Geant4GeneratorAction
typedef Geant4SharedGeneratorAction	shared_type

Detailed Description

Implementation of a particle gun using Geant4Particles.

The {\tt{Geant4ParticleGun}} is a tool to shoot a number of particles with identical properties into a given region of the detector to be simulated.

The particle gun is a input source like any other and participates in the general input stage merging process like any other input e.g. from file. Hence, there may be several particle guns present each generating its own primary vertex. Use the mask property to ensure each gun generates its own, well identified primary vertex.

There is one 'user lazyness' support though: If there is only one particle gun in use, the property 'Standalone', which by default is set to true invokes the interaction merging and he Geant4 primary generation directly.

Author: M.Frank

Version: 1.0

Definition at line 56 of file Geant4ParticleGun.h.

Constructor & Destructor Documentation

◆ Geant4ParticleGun()

dd4hep::sim::Geant4ParticleGun::Geant4ParticleGun	(	Geant4Context *	context,
		const std::string &	name
	)

Standard constructor.

◆ ~Geant4ParticleGun()

virtual dd4hep::sim::Geant4ParticleGun::~Geant4ParticleGun ( )

virtual

Default destructor.

Member Function Documentation

◆ getParticleDirection()

virtual void dd4hep::sim::Geant4ParticleGun::getParticleDirection	(	int	,
		ROOT::Math::XYZVector &	direction,
		double &	momentum
	)		const

protectedvirtual

Particle modification. Caller presets defaults to: ( direction = m_direction, momentum = [m_momentumMin, m_momentumMax])

Reimplemented from dd4hep::sim::Geant4IsotropeGenerator.

◆ operator()()

virtual void dd4hep::sim::Geant4ParticleGun::operator() ( G4Event * event )

virtual

Callback to generate primary particles.

Reimplemented from dd4hep::sim::Geant4ParticleGenerator.

Member Data Documentation

◆ m_isotrop

bool dd4hep::sim::Geant4ParticleGun::m_isotrop

protected

Property: Isotrope particles?

Definition at line 59 of file Geant4ParticleGun.h.

◆ m_print

bool dd4hep::sim::Geant4ParticleGun::m_print

protected

Property: Enable printout.

Definition at line 63 of file Geant4ParticleGun.h.

◆ m_shotNo

int dd4hep::sim::Geant4ParticleGun::m_shotNo

protected

Shot number in sequence.

Definition at line 65 of file Geant4ParticleGun.h.

◆ m_standalone

bool dd4hep::sim::Geant4ParticleGun::m_standalone

protected

Property: Standalone mode: includes interaction merging and primary generation.

Definition at line 61 of file Geant4ParticleGun.h.

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

DDG4/include/DDG4/Geant4ParticleGun.h

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Geant4ParticleGun()

◆ ~Geant4ParticleGun()

Member Function Documentation

◆ getParticleDirection()

◆ operator()()

Member Data Documentation

◆ m_isotrop

◆ m_print

◆ m_shotNo

◆ m_standalone