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

Geant4 sensitive detector filter base class for particle filters. More...

Inheritance diagram for dd4hep::sim::ParticleFilter:
dd4hep::sim::Geant4Filter dd4hep::sim::Geant4Action dd4hep::sim::GeantinoRejectFilter dd4hep::sim::ParticleRejectFilter dd4hep::sim::ParticleSelectFilter

Public Member Functions

 ParticleFilter (Geant4Context *context, const std::string &name)
 Constructor. More...
 
virtual ~ParticleFilter ()
 Standard destructor. More...
 
const G4ParticleDefinition * definition () const
 Safe access to the definition. More...
 
bool isSameType (const G4Track *track) const
 Check if a track is of the same type. More...
 
bool isGeantino (const G4Track *track) const
 Check if the particle is a geantino. More...
 
const G4Track * getTrack (const G4Step *step) const
 Access to the track from step. More...
 
const G4Track * getTrack (const Geant4FastSimSpot *spot) const
 Access to the track from step. More...
 
const G4Track * getTrack (const G4FastTrack *fast) const
 Access originator track from G4 fast track. More...
 
- Public Member Functions inherited from dd4hep::sim::Geant4Filter
 Geant4Filter (Geant4Context *context, const std::string &name)
 Standard constructor. More...
 
virtual ~Geant4Filter ()
 Standard destructor. More...
 
virtual bool operator() (const G4Step *step) const
 Filter action. Return true if hits should be processed. Default returns true. More...
 
virtual bool operator() (const Geant4FastSimSpot *spot) const
 GFLASH/FastSim interface: Filter action. Return true if hits should be processed. 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 Attributes

std::string m_particle
 name of the particle to be filtered More...
 
G4ParticleDefinition * m_definition
 Corresponding geant4 particle definiton. More...
 
- 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...
 

Additional Inherited Members

- Protected Member Functions inherited from dd4hep::sim::Geant4Filter
 DDG4_DEFINE_ACTION_CONSTRUCTORS (Geant4Filter)
 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...
 

Detailed Description

Geant4 sensitive detector filter base class for particle filters.

Author
M.Frank
Version
1.0

Definition at line 35 of file Geant4SensDetFilters.cpp.

Constructor & Destructor Documentation

◆ ParticleFilter()

ParticleFilter::ParticleFilter ( Geant4Context context,
const std::string &  name 
)

Constructor.

Definition at line 175 of file Geant4SensDetFilters.cpp.

◆ ~ParticleFilter()

ParticleFilter::~ParticleFilter ( )
virtual

Standard destructor.

Definition at line 183 of file Geant4SensDetFilters.cpp.

Member Function Documentation

◆ definition()

const G4ParticleDefinition * ParticleFilter::definition ( ) const

Safe access to the definition.

Definition at line 188 of file Geant4SensDetFilters.cpp.

◆ getTrack() [1/3]

const G4Track* dd4hep::sim::ParticleFilter::getTrack ( const G4FastTrack *  fast) const
inline

Access originator track from G4 fast track.

Definition at line 61 of file Geant4SensDetFilters.cpp.

◆ getTrack() [2/3]

const G4Track* dd4hep::sim::ParticleFilter::getTrack ( const G4Step *  step) const
inline

Access to the track from step.

Definition at line 53 of file Geant4SensDetFilters.cpp.

◆ getTrack() [3/3]

const G4Track* dd4hep::sim::ParticleFilter::getTrack ( const Geant4FastSimSpot spot) const
inline

Access to the track from step.

Definition at line 57 of file Geant4SensDetFilters.cpp.

◆ isGeantino()

bool ParticleFilter::isGeantino ( const G4Track *  track) const

Check if the particle is a geantino.

Definition at line 204 of file Geant4SensDetFilters.cpp.

◆ isSameType()

bool ParticleFilter::isSameType ( const G4Track *  track) const

Check if a track is of the same type.

Definition at line 198 of file Geant4SensDetFilters.cpp.

Member Data Documentation

◆ m_definition

G4ParticleDefinition* dd4hep::sim::ParticleFilter::m_definition
mutableprotected

Corresponding geant4 particle definiton.

Definition at line 40 of file Geant4SensDetFilters.cpp.

◆ m_particle

std::string dd4hep::sim::ParticleFilter::m_particle
protected

name of the particle to be filtered

Definition at line 38 of file Geant4SensDetFilters.cpp.


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