User stepping action used to filter events where the primary particle falls below a threshold before reaching the CalorimeterRegion. More...

#include <PrimaryToEcalFilter.h>

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

	~PrimaryToEcalFilter ()
	Destructor.

void	stepping (const G4Step *step) override
	Only process if the track is a primary (parentID == 0) and if the event is not aborted and the particle is not in the CalorimeterRegion.

std::vector< simcore::TYPE >	getTypes () override
	Retrieve the type of actions this class defines.

Public Member Functions inherited from simcore::UserAction
	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 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.

Private Attributes
double	threshold_
	Energy [MeV] below which a primary should be vetoed.

Additional Inherited Members
Protected Member Functions inherited from simcore::UserAction
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 inherited from simcore::UserAction
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

User stepping action used to filter events where the primary particle falls below a threshold before reaching the CalorimeterRegion.

This is a simplistic filter designed similar to the TaggerVetoFilter.

Definition at line 37 of file PrimaryToEcalFilter.h.

Constructor & Destructor Documentation

◆ PrimaryToEcalFilter()

biasing::PrimaryToEcalFilter::PrimaryToEcalFilter	(	const std::string &	name,
		framework::config::Parameters &	parameters )

Constructor.

Parameters

[in]	name	the name of the instance of this UserAction.
[in]	parameters	the parameters used to configure this UserAction.

Definition at line 5 of file PrimaryToEcalFilter.cxx.

    : simcore::UserAction(name, parameters) {
  threshold_ = parameters.get<double>("threshold");
}

References framework::config::Parameters::get(), and threshold_.

◆ ~PrimaryToEcalFilter()

biasing::PrimaryToEcalFilter::~PrimaryToEcalFilter ( )

inline

Destructor.

Definition at line 50 of file PrimaryToEcalFilter.h.

50{}

Member Function Documentation

◆ getTypes()

std::vector< simcore::TYPE > biasing::PrimaryToEcalFilter::getTypes ( )

inlineoverridevirtual

Retrieve the type of actions this class defines.

Implements simcore::UserAction.

Definition at line 65 of file PrimaryToEcalFilter.h.

                                             {
    return {simcore::TYPE::STEPPING};
  }

◆ stepping()

void biasing::PrimaryToEcalFilter::stepping ( const G4Step * step )

overridevirtual

Only process if the track is a primary (parentID == 0) and if the event is not aborted and the particle is not in the CalorimeterRegion.

If the energy of the particle is below the input threshold, then the event is aborted.

Parameters

[in] step Geant4 step

Reimplemented from simcore::UserAction.

Definition at line 11 of file PrimaryToEcalFilter.cxx.

                                                     {
  // Only process the primary electron track
  if (int parent_id{step->GetTrack()->GetParentID()}; parent_id != 0) return;
 
  if (G4EventManager::GetEventManager()->GetConstCurrentEvent()->IsAborted())
    return;
 
  // Get the region the particle is currently in.  Continue processing
  // the particle only if it's NOT in the calorimeter region
  auto current_region =
      step->GetTrack()->GetVolume()->GetLogicalVolume()->GetRegion();
  auto calorimeter_region =
      simcore::g4user::ptrretrieval::getRegion("CalorimeterRegion");
  if (!calorimeter_region) {
    ldmx_log(warn)
        << "Region 'CalorimeterRegion' not found in Geant4 region store";
  }
  if (current_region == calorimeter_region) return;
 
  // If the energy of the particle fell below threshold, stop processing the
  // event.
  if (auto energy{step->GetPostStepPoint()->GetTotalEnergy()};
      energy < threshold_) {
    ldmx_log(trace) << "Aborting "
                    << G4EventManager::GetEventManager()
                           ->GetConstCurrentEvent()
                           ->GetEventID();
 
    step->GetTrack()->SetTrackStatus(fKillTrackAndSecondaries);
    G4RunManager::GetRunManager()->AbortEvent();
    return;
  }
}

References threshold_.

Member Data Documentation

◆ threshold_

double biasing::PrimaryToEcalFilter::threshold_

private

Energy [MeV] below which a primary should be vetoed.

Definition at line 71 of file PrimaryToEcalFilter.h.

Referenced by PrimaryToEcalFilter(), and stepping().

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

Biasing/include/Biasing/PrimaryToEcalFilter.h
Biasing/src/Biasing/PrimaryToEcalFilter.cxx

Public Member Functions

Private Attributes

Additional Inherited Members