DD4hep  1.30.0
Detector Description Toolkit for High Energy Physics
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
dd4hep::sim::Geant4InteractionVertexSmear Class Reference

Action class to smear the primary vertex (and all outgoing particles) of a single interaction. More...

#include <Geant4InteractionVertexSmear.h>

Inheritance diagram for dd4hep::sim::Geant4InteractionVertexSmear:
dd4hep::sim::Geant4GeneratorAction dd4hep::sim::Geant4Action

Public Types

typedef Geant4PrimaryInteraction Interaction
 Interaction definition. More...
 
- Public Types inherited from dd4hep::sim::Geant4GeneratorAction
typedef Geant4SharedGeneratorAction shared_type
 

Public Member Functions

 Geant4InteractionVertexSmear ()=delete
 Inhibit default constructor. More...
 
 Geant4InteractionVertexSmear (const Geant4InteractionVertexSmear &copy)=delete
 Inhibit copy constructor. More...
 
 Geant4InteractionVertexSmear (Geant4Context *context, const std::string &name)
 Standard constructor. More...
 
virtual ~Geant4InteractionVertexSmear ()
 Default destructor. More...
 
virtual void operator() (G4Event *event)
 Callback to generate primary particles. 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...
 
Geant4Contextcontext () 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...
 
PropertyManagerproperties ()
 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...
 
Geant4UIMessengercontrol () const
 Access to the UI messenger. More...
 
virtual void enableUI ()
 Enable and install UI messenger. More...
 
template<typename T >
Geant4ActiondeclareProperty (const std::string &nam, T &val)
 Declare property. More...
 
template<typename T >
Geant4ActiondeclareProperty (const char *nam, T &val)
 Declare property. More...
 
bool hasProperty (const std::string &name) const
 Check property for existence. More...
 
Propertyproperty (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...
 
Geant4RunActionSequencerunAction () const
 Access to the main run action sequence from the kernel object. More...
 
Geant4EventActionSequenceeventAction () const
 Access to the main event action sequence from the kernel object. More...
 
Geant4SteppingActionSequencesteppingAction () const
 Access to the main stepping action sequence from the kernel object. More...
 
Geant4TrackingActionSequencetrackingAction () const
 Access to the main tracking action sequence from the kernel object. More...
 
Geant4StackingActionSequencestackingAction () const
 Access to the main stacking action sequence from the kernel object. More...
 
Geant4GeneratorActionSequencegeneratorAction () const
 Access to the main generator action sequence from the kernel object. More...
 

Protected Member Functions

void smear (Interaction *interaction) const
 Action routine to smear one single interaction according to the properties. 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

ROOT::Math::PxPyPzEVector m_offset
 Property: The constant smearing offset. More...
 
ROOT::Math::PxPyPzEVector m_sigma
 Property: The gaussian sigmas to the offset. More...
 
int m_mask
 Property: Unique identifier of the interaction created. More...
 
- Protected Attributes inherited from dd4hep::sim::Geant4GeneratorAction
Callback m_calls
 
- Protected Attributes inherited from dd4hep::sim::Geant4Action
Geant4Contextm_context { nullptr }
 Reference to the Geant4 context. More...
 
Geant4UIMessengerm_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...
 

Detailed Description

Action class to smear the primary vertex (and all outgoing particles) of a single interaction.

The vertex smearing is steered by a 3D gaussian given by a constant offset and the corresponding errors. The interaction to be modified is identified by the interaction's unique mask.

Author
M.Frank
Version
1.0

Definition at line 52 of file Geant4InteractionVertexSmear.h.

Member Typedef Documentation

◆ Interaction

Interaction definition.

Definition at line 55 of file Geant4InteractionVertexSmear.h.

Constructor & Destructor Documentation

◆ Geant4InteractionVertexSmear() [1/3]

dd4hep::sim::Geant4InteractionVertexSmear::Geant4InteractionVertexSmear ( )
delete

Inhibit default constructor.

◆ Geant4InteractionVertexSmear() [2/3]

dd4hep::sim::Geant4InteractionVertexSmear::Geant4InteractionVertexSmear ( const Geant4InteractionVertexSmear copy)
delete

Inhibit copy constructor.

◆ Geant4InteractionVertexSmear() [3/3]

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

Standard constructor.

◆ ~Geant4InteractionVertexSmear()

virtual dd4hep::sim::Geant4InteractionVertexSmear::~Geant4InteractionVertexSmear ( )
virtual

Default destructor.

Member Function Documentation

◆ operator()()

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

Callback to generate primary particles.

Reimplemented from dd4hep::sim::Geant4GeneratorAction.

◆ smear()

void dd4hep::sim::Geant4InteractionVertexSmear::smear ( Interaction interaction) const
protected

Action routine to smear one single interaction according to the properties.

Member Data Documentation

◆ m_mask

int dd4hep::sim::Geant4InteractionVertexSmear::m_mask
protected

Property: Unique identifier of the interaction created.

Definition at line 63 of file Geant4InteractionVertexSmear.h.

◆ m_offset

ROOT::Math::PxPyPzEVector dd4hep::sim::Geant4InteractionVertexSmear::m_offset
protected

Property: The constant smearing offset.

Definition at line 59 of file Geant4InteractionVertexSmear.h.

◆ m_sigma

ROOT::Math::PxPyPzEVector dd4hep::sim::Geant4InteractionVertexSmear::m_sigma
protected

Property: The gaussian sigmas to the offset.

Definition at line 61 of file Geant4InteractionVertexSmear.h.


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