Base class to output Geant4 event data to EDM4hep. More...

Inheritance diagram for dd4hep::sim::Geant4Output2EDM4hep:

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

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

virtual void	beginRun (const G4Run *run)
	Callback to store the Geant4 run information. More...

virtual void	endRun (const G4Run *run)
	Callback to store the Geant4 run information. More...

virtual void	saveRun (const G4Run *run)
	Callback to store the Geant4 run information. More...

virtual void	saveEvent (OutputContext< G4Event > &ctxt)
	Callback to store the Geant4 event. More...

virtual void	saveCollection (OutputContext< G4Event > &ctxt, G4VHitsCollection *collection)
	Callback to store each Geant4 hit collection. More...

virtual void	commit (OutputContext< G4Event > &ctxt)
	Commit data at end of filling procedure. More...

virtual void	begin (const G4Event *event)
	begin-of-event callback - creates EDM4hep event and adds it to the event context More...

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

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

	Geant4OutputAction (Geant4Context *c, const std::string &nam)
	Standard constructor. More...

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

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

virtual void	end (const G4Event *event) override
	End-of-event callback. More...

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

virtual	~Geant4EventAction ()
	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...

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 Types
using	writer_t = podio::ROOTWriter

using	stringmap_t = std::map< std::string, std::string >

using	trackermap_t = std::map< std::string, edm4hep::SimTrackerHitCollection >

using	calorimeterpair_t = std::pair< edm4hep::SimCalorimeterHitCollection, edm4hep::CaloHitContributionCollection >

using	calorimetermap_t = std::map< std::string, calorimeterpair_t >

Protected Member Functions
void	saveParticles (Geant4ParticleMap *particles)
	Data conversion interface for MC particles to EDM4hep format. More...

void	saveFileMetaData ()
	Store the metadata frame with e.g. the cellID encoding strings. More...

template<typename T >
void	saveEventParameters (const std::map< std::string, std::string > &parameters)
	Fill event parameters in EDM4hep event. More...

Protected Member Functions inherited from dd4hep::sim::Geant4EventAction
	DDG4_DEFINE_ACTION_CONSTRUCTORS (Geant4EventAction)
	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
std::unique_ptr< writer_t >	m_file { }

podio::Frame	m_frame { }

edm4hep::MCParticleCollection	m_particles { }

trackermap_t	m_trackerHits

calorimetermap_t	m_calorimeterHits

stringmap_t	m_runHeader

stringmap_t	m_eventParametersInt

stringmap_t	m_eventParametersFloat

stringmap_t	m_eventParametersString

stringmap_t	m_cellIDEncodingStrings {}

std::string	m_section_name { "events" }

int	m_runNo { 0 }

int	m_runNumberOffset { 0 }

int	m_eventNo { 0 }

int	m_eventNumberOffset { 0 }

bool	m_filesByRun { false }

Protected Attributes inherited from dd4hep::sim::Geant4OutputAction
std::string	m_output { }
	Property: "Output" output destination. More...

bool	m_errorFatal { true }
	Property: "HandleErrorsAsFatal" Handle errors as fatal and rethrow eventual exceptions. More...

Geant4ParticleMap *	m_truth { nullptr }
	Reference to MC truth object. 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::Geant4EventAction
typedef Geant4SharedEventAction	shared_type

Detailed Description

Base class to output Geant4 event data to EDM4hep.

Author: F.Gaede

Version: 1.0

Definition at line 59 of file Geant4Output2EDM4hep.cpp.

Member Typedef Documentation

◆ calorimetermap_t

using dd4hep::sim::Geant4Output2EDM4hep::calorimetermap_t = std::map< std::string, calorimeterpair_t >

protected

Definition at line 65 of file Geant4Output2EDM4hep.cpp.

◆ calorimeterpair_t

using dd4hep::sim::Geant4Output2EDM4hep::calorimeterpair_t = std::pair< edm4hep::SimCalorimeterHitCollection, edm4hep::CaloHitContributionCollection >

protected

Definition at line 64 of file Geant4Output2EDM4hep.cpp.

◆ stringmap_t

using dd4hep::sim::Geant4Output2EDM4hep::stringmap_t = std::map< std::string, std::string >

protected

Definition at line 62 of file Geant4Output2EDM4hep.cpp.

◆ trackermap_t

using dd4hep::sim::Geant4Output2EDM4hep::trackermap_t = std::map< std::string, edm4hep::SimTrackerHitCollection >

protected

Definition at line 63 of file Geant4Output2EDM4hep.cpp.

◆ writer_t

using dd4hep::sim::Geant4Output2EDM4hep::writer_t = podio::ROOTWriter

protected

Definition at line 61 of file Geant4Output2EDM4hep.cpp.

Constructor & Destructor Documentation

◆ Geant4Output2EDM4hep()

Geant4Output2EDM4hep::Geant4Output2EDM4hep	(	Geant4Context *	ctxt,
		const std::string &	nam
	)

Standard constructor.

Definition at line 217 of file Geant4Output2EDM4hep.cpp.

◆ ~Geant4Output2EDM4hep()

Geant4Output2EDM4hep::~Geant4Output2EDM4hep ( )

virtual

Default destructor.

Definition at line 233 of file Geant4Output2EDM4hep.cpp.

Member Function Documentation

◆ begin()

void Geant4Output2EDM4hep::begin ( const G4Event * event )

virtual

begin-of-event callback - creates EDM4hep event and adds it to the event context

Create event frame object

Reimplemented from dd4hep::sim::Geant4OutputAction.

Definition at line 324 of file Geant4Output2EDM4hep.cpp.

◆ beginRun()

void Geant4Output2EDM4hep::beginRun ( const G4Run * run )

virtual

Callback to store the Geant4 run information.

Reimplemented from dd4hep::sim::Geant4OutputAction.

Definition at line 240 of file Geant4Output2EDM4hep.cpp.

◆ commit()

void Geant4Output2EDM4hep::commit ( OutputContext< G4Event > & ctxt )

virtual

Commit data at end of filling procedure.

Reimplemented from dd4hep::sim::Geant4OutputAction.

Definition at line 279 of file Geant4Output2EDM4hep.cpp.

◆ endRun()

void Geant4Output2EDM4hep::endRun ( const G4Run * run )

virtual

Callback to store the Geant4 run information.

Reimplemented from dd4hep::sim::Geant4OutputAction.

Definition at line 260 of file Geant4Output2EDM4hep.cpp.

◆ saveCollection()

void Geant4Output2EDM4hep::saveCollection	(	OutputContext< G4Event > &	ctxt,
		G4VHitsCollection *	collection
	)

virtual

Callback to store each Geant4 hit collection.

Reimplemented from dd4hep::sim::Geant4OutputAction.

Definition at line 504 of file Geant4Output2EDM4hep.cpp.

◆ saveEvent()

void Geant4Output2EDM4hep::saveEvent ( OutputContext< G4Event > & ctxt )

virtual

Callback to store the Geant4 event.

Reimplemented from dd4hep::sim::Geant4OutputAction.

Definition at line 436 of file Geant4Output2EDM4hep.cpp.

◆ saveEventParameters()

template<typename T >

void dd4hep::sim::Geant4Output2EDM4hep::saveEventParameters ( const std::map< std::string, std::string > & parameters )

inlineprotected

Fill event parameters in EDM4hep event.

Definition at line 111 of file Geant4Output2EDM4hep.cpp.

◆ saveFileMetaData()

void Geant4Output2EDM4hep::saveFileMetaData ( )

protected

Store the metadata frame with e.g. the cellID encoding strings.

Definition at line 269 of file Geant4Output2EDM4hep.cpp.

◆ saveParticles()

void Geant4Output2EDM4hep::saveParticles ( Geant4ParticleMap * particles )

protected

Data conversion interface for MC particles to EDM4hep format.

Definition at line 334 of file Geant4Output2EDM4hep.cpp.

◆ saveRun()

void Geant4Output2EDM4hep::saveRun ( const G4Run * run )

virtual

Callback to store the Geant4 run information.

Reimplemented from dd4hep::sim::Geant4OutputAction.

Definition at line 301 of file Geant4Output2EDM4hep.cpp.

Member Data Documentation

◆ m_calorimeterHits

calorimetermap_t dd4hep::sim::Geant4Output2EDM4hep::m_calorimeterHits

protected

Definition at line 70 of file Geant4Output2EDM4hep.cpp.

◆ m_cellIDEncodingStrings

stringmap_t dd4hep::sim::Geant4Output2EDM4hep::m_cellIDEncodingStrings {}

protected

Definition at line 75 of file Geant4Output2EDM4hep.cpp.

◆ m_eventNo

int dd4hep::sim::Geant4Output2EDM4hep::m_eventNo { 0 }

protected

Definition at line 79 of file Geant4Output2EDM4hep.cpp.

◆ m_eventNumberOffset

int dd4hep::sim::Geant4Output2EDM4hep::m_eventNumberOffset { 0 }

protected

Definition at line 80 of file Geant4Output2EDM4hep.cpp.

◆ m_eventParametersFloat

stringmap_t dd4hep::sim::Geant4Output2EDM4hep::m_eventParametersFloat

protected

Definition at line 73 of file Geant4Output2EDM4hep.cpp.

◆ m_eventParametersInt

stringmap_t dd4hep::sim::Geant4Output2EDM4hep::m_eventParametersInt

protected

Definition at line 72 of file Geant4Output2EDM4hep.cpp.

◆ m_eventParametersString

stringmap_t dd4hep::sim::Geant4Output2EDM4hep::m_eventParametersString

protected

Definition at line 74 of file Geant4Output2EDM4hep.cpp.

◆ m_file

std::unique_ptr<writer_t> dd4hep::sim::Geant4Output2EDM4hep::m_file { }

protected

Definition at line 66 of file Geant4Output2EDM4hep.cpp.

◆ m_filesByRun

bool dd4hep::sim::Geant4Output2EDM4hep::m_filesByRun { false }

protected

Definition at line 81 of file Geant4Output2EDM4hep.cpp.

◆ m_frame

podio::Frame dd4hep::sim::Geant4Output2EDM4hep::m_frame { }

protected

Definition at line 67 of file Geant4Output2EDM4hep.cpp.

◆ m_particles

edm4hep::MCParticleCollection dd4hep::sim::Geant4Output2EDM4hep::m_particles { }

protected

Definition at line 68 of file Geant4Output2EDM4hep.cpp.

◆ m_runHeader

stringmap_t dd4hep::sim::Geant4Output2EDM4hep::m_runHeader

protected

Definition at line 71 of file Geant4Output2EDM4hep.cpp.

◆ m_runNo

int dd4hep::sim::Geant4Output2EDM4hep::m_runNo { 0 }

protected

Definition at line 77 of file Geant4Output2EDM4hep.cpp.

◆ m_runNumberOffset

int dd4hep::sim::Geant4Output2EDM4hep::m_runNumberOffset { 0 }

protected

Definition at line 78 of file Geant4Output2EDM4hep.cpp.

◆ m_section_name

std::string dd4hep::sim::Geant4Output2EDM4hep::m_section_name { "events" }

protected

Definition at line 76 of file Geant4Output2EDM4hep.cpp.

◆ m_trackerHits

trackermap_t dd4hep::sim::Geant4Output2EDM4hep::m_trackerHits

protected

Definition at line 69 of file Geant4Output2EDM4hep.cpp.

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

DDG4/edm4hep/Geant4Output2EDM4hep.cpp

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ calorimetermap_t

◆ calorimeterpair_t

◆ stringmap_t

◆ trackermap_t

◆ writer_t

Constructor & Destructor Documentation

◆ Geant4Output2EDM4hep()

◆ ~Geant4Output2EDM4hep()

Member Function Documentation

◆ begin()

◆ beginRun()

◆ commit()

◆ endRun()

◆ saveCollection()

◆ saveEvent()

◆ saveEventParameters()

◆ saveFileMetaData()

◆ saveParticles()

◆ saveRun()

Member Data Documentation

◆ m_calorimeterHits

◆ m_cellIDEncodingStrings

◆ m_eventNo

◆ m_eventNumberOffset

◆ m_eventParametersFloat

◆ m_eventParametersInt

◆ m_eventParametersString

◆ m_file

◆ m_filesByRun

◆ m_frame

◆ m_particles

◆ m_runHeader

◆ m_runNo

◆ m_runNumberOffset

◆ m_section_name

◆ m_trackerHits