Interface that defines a user action. More...

#include <UserAction.h>

Public Member Functions
	UserAction (const std::string &name, framework::config::Parameters &parameters)
	Constructor.

	DECLARE_FACTORY (UserAction, std::shared_ptr< UserAction >, const std::string &, framework::config::Parameters &)
	factory for user actions

virtual	~UserAction ()=default
	Destructor.

virtual void	BeginOfEventAction (const G4Event *)
	Method called at the beginning of every event.

virtual void	EndOfEventAction (const G4Event *)
	Method called at the end of every event.

virtual void	BeginOfRunAction (const G4Run *)
	Method called at the beginning of a run.

virtual void	EndOfRunAction (const G4Run *)
	Method called at the end of a run.

virtual void	PreUserTrackingAction (const G4Track *)
	Method called before the UserTrackingAction.

virtual void	PostUserTrackingAction (const G4Track *)
	Method called after the UserTrackingAction.

virtual void	stepping (const G4Step *)
	Method called after each simulation step.

virtual G4ClassificationOfNewTrack	ClassifyNewTrack (const G4Track *, const G4ClassificationOfNewTrack &cl)
	Method called when a track is updated.

virtual void	NewStage ()
	Method called at the beginning of a new stage.

virtual void	PrepareNewEvent ()
	Method called at the beginning of a new event.

virtual std::vector< TYPE >	getTypes ()=0

Protected Member Functions
UserEventInformation *	getEventInfo () const
	Get a handle to the event information.

const std::map< int, ldmx::SimParticle > &	getCurrentParticleMap () const
	Get the current particle map.

Protected Attributes
std::string	name_ {""}
	Name of the UserAction.

framework::config::Parameters	parameters_
	The set of parameters used to configure this class.

mutable::framework::logging::logger	the_log_
	the logging channel user actions can use `ldmx_log` with

Detailed Description

Interface that defines a user action.

Definition at line 47 of file UserAction.h.

Constructor & Destructor Documentation

◆ UserAction()

simcore::UserAction::UserAction	(	const std::string &	name,
		framework::config::Parameters &	parameters )

Constructor.

Parameters

name	Name given the to class instance.

Definition at line 16 of file UserAction.cxx.

    : name_{name},
      parameters_{parameters},
      the_log_{::framework::logging::makeLogger(name)} {}

Member Function Documentation

◆ BeginOfEventAction()

virtual void simcore::UserAction::BeginOfEventAction ( const G4Event * )

inlinevirtual

Method called at the beginning of every event.

TYPE::EVENT

Parameters

event Geant4 event object.

Reimplemented in biasing::DeepEcalProcessFilter, biasing::EcalDarkBremFilter, biasing::MidShowerDiMuonBkgdFilter, biasing::MidShowerNuclearBkgdFilter, biasing::TaggerVetoFilter, biasing::TargetDarkBremFilter, and biasing::utility::PartialEnergySorter.

Definition at line 71 of file UserAction.h.

71{};

◆ BeginOfRunAction()

virtual void simcore::UserAction::BeginOfRunAction ( const G4Run * )

inlinevirtual

Method called at the beginning of a run.

TYPE::RUN

Parameters

run	Current Geant4 run object.

Definition at line 89 of file UserAction.h.

89{};

◆ ClassifyNewTrack()

virtual G4ClassificationOfNewTrack simcore::UserAction::ClassifyNewTrack	(	const G4Track *	,
		const G4ClassificationOfNewTrack &	cl )

inlinevirtual

Method called when a track is updated.

TYPE::STEPPING

Parameters

current	Geant4 track
current	tracks' classification

Reimplemented in biasing::EcalDarkBremFilter, biasing::EcalProcessFilter, biasing::TargetBremFilter, biasing::TargetProcessFilter, and biasing::utility::PartialEnergySorter.

Definition at line 135 of file UserAction.h.

                                                            {
    return cl;
  };

◆ EndOfEventAction()

virtual void simcore::UserAction::EndOfEventAction ( const G4Event * )

inlinevirtual

Method called at the end of every event.

TYPE::EVENT

Parameters

event Geant4 event object.

Reimplemented in biasing::NonFiducialFilter, biasing::TaggerHitFilter, biasing::TaggerVetoFilter, biasing::TargetBremFilter, biasing::TargetDarkBremFilter, biasing::TargetENProcessFilter, and biasing::TargetProcessFilter.

Definition at line 80 of file UserAction.h.

80{};

◆ EndOfRunAction()

virtual void simcore::UserAction::EndOfRunAction ( const G4Run * )

inlinevirtual

Method called at the end of a run.

TYPE::RUN

Parameters

run	Current Geant4 run object.

Definition at line 98 of file UserAction.h.

98{};

◆ getCurrentParticleMap()

const std::map< int, ldmx::SimParticle > & simcore::UserAction::getCurrentParticleMap ( ) const

protected

Get the current particle map.

Note: The current particle map will only have the particles already fully processed and chosen to be saved. The ancestry of the particles will not have been traced yet.

Definition at line 27 of file UserAction.cxx.

          {
  return g4user::TrackingAction::get()->getTrackMap().getParticleMap();
}

References simcore::g4user::TrackingAction::get(), simcore::TrackMap::getParticleMap(), and simcore::g4user::TrackingAction::getTrackMap().

Referenced by biasing::utility::DecayChildrenKeeper::PostUserTrackingAction().

◆ getEventInfo()

UserEventInformation * simcore::UserAction::getEventInfo ( ) const

protected

Get a handle to the event information.

This is static just to point out that it doesn't depend on any of the member variables of this class. It is just a helper function for shortening any code that interacts with our event information.

Returns: pointer to the current event information

Definition at line 22 of file UserAction.cxx.

                                                     {
  return static_cast<UserEventInformation*>(
      G4EventManager::GetEventManager()->GetUserInformation());
}

Referenced by biasing::DeepEcalProcessFilter::stepping(), biasing::MidShowerNuclearBkgdFilter::stepping(), biasing::TargetBremFilter::stepping(), and biasing::TargetProcessFilter::stepping().

◆ getTypes()

virtual std::vector< TYPE > simcore::UserAction::getTypes ( )

pure virtual

Returns: The user action types

Must be defined by any UserActions so that we know what functions to call.

Implemented in biasing::DeepEcalProcessFilter, biasing::EcalDarkBremFilter, biasing::EcalProcessFilter, biasing::MidShowerDiMuonBkgdFilter, biasing::MidShowerNuclearBkgdFilter, biasing::NonFiducialFilter, biasing::PhotoNuclearProductsFilter, biasing::PhotoNuclearTopologyFilter, biasing::PrimaryToEcalFilter, biasing::TaggerHitFilter, biasing::TaggerVetoFilter, biasing::TargetBremFilter, biasing::TargetDarkBremFilter, biasing::TargetENProcessFilter, biasing::TargetProcessFilter, biasing::utility::DecayChildrenKeeper, biasing::utility::PartialEnergySorter, biasing::utility::StepPrinter, and biasing::utility::TrackProcessFilter.

◆ NewStage()

virtual void simcore::UserAction::NewStage ( )

inlinevirtual

Method called at the beginning of a new stage.

TYPE::STACKING

Reimplemented in biasing::DeepEcalProcessFilter, biasing::EcalDarkBremFilter, biasing::MidShowerDiMuonBkgdFilter, biasing::MidShowerNuclearBkgdFilter, and biasing::utility::PartialEnergySorter.

Definition at line 145 of file UserAction.h.

145{};

◆ PostUserTrackingAction()

virtual void simcore::UserAction::PostUserTrackingAction ( const G4Track * )

inlinevirtual

Method called after the UserTrackingAction.

TYPE::TRACKING

Parameters

track current Geant4 track

Reimplemented in biasing::EcalDarkBremFilter, biasing::utility::DecayChildrenKeeper, and biasing::utility::TrackProcessFilter.

Definition at line 116 of file UserAction.h.

116{};

◆ PrepareNewEvent()

virtual void simcore::UserAction::PrepareNewEvent ( )

inlinevirtual

Method called at the beginning of a new event.

TYPE::STACKING

Definition at line 152 of file UserAction.h.

152{};

◆ PreUserTrackingAction()

virtual void simcore::UserAction::PreUserTrackingAction ( const G4Track * )

inlinevirtual

Method called before the UserTrackingAction.

TYPE::TRACKING

Parameters

track current Geant4 track

Definition at line 107 of file UserAction.h.

107{};

◆ stepping()

virtual void simcore::UserAction::stepping ( const G4Step * )

inlinevirtual

Method called after each simulation step.

TYPE::STEPPING

Parameters

current Geant4 step

Reimplemented in biasing::DeepEcalProcessFilter, biasing::EcalProcessFilter, biasing::MidShowerDiMuonBkgdFilter, biasing::MidShowerNuclearBkgdFilter, biasing::NonFiducialFilter, biasing::PhotoNuclearProductsFilter, biasing::PhotoNuclearTopologyFilter, biasing::PrimaryToEcalFilter, biasing::TaggerHitFilter, biasing::TaggerVetoFilter, biasing::TargetBremFilter, biasing::TargetDarkBremFilter, biasing::TargetENProcessFilter, biasing::TargetProcessFilter, biasing::utility::PartialEnergySorter, and biasing::utility::StepPrinter.

Definition at line 125 of file UserAction.h.

125{};

Member Data Documentation

◆ name_

std::string simcore::UserAction::name_ {""}

protected

Name of the UserAction.

Definition at line 185 of file UserAction.h.

185{""};

◆ parameters_

framework::config::Parameters simcore::UserAction::parameters_

protected

The set of parameters used to configure this class.

Definition at line 188 of file UserAction.h.

◆ the_log_

mutable::framework::logging::logger simcore::UserAction::the_log_

protected

the logging channel user actions can use ldmx_log with

Definition at line 191 of file UserAction.h.

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

SimCore/include/SimCore/G4User/UserAction.h
SimCore/src/SimCore/G4User/UserAction.cxx

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ UserAction()

Member Function Documentation

◆ BeginOfEventAction()

◆ BeginOfRunAction()

◆ ClassifyNewTrack()

◆ EndOfEventAction()

◆ EndOfRunAction()

◆ getCurrentParticleMap()

◆ getEventInfo()

◆ getTypes()

◆ NewStage()

◆ PostUserTrackingAction()

◆ PrepareNewEvent()

◆ PreUserTrackingAction()

◆ stepping()

Member Data Documentation

◆ name_

◆ parameters_

◆ the_log_