User action that allows a user to filter out events that are non-fiducial, i.e. More...

#include <NonFiducialFilter.h>

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

virtual	~NonFiducialFilter ()=default
	Destructor.

void	stepping (const G4Step *step) override
	Implement the stepping action which performs the target volume biasing.

void	endOfEventAction (const G4Event *) override
	Method called at the end of every event.

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	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	recoil_max_p_ {1500}
	Recoil electron threshold.

bool	abort_fiducial_ {true}
	If turned on, this aborts fiducial events.

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.

void	abortEvent (const std::string &reason) const
	Helper to abort an event with a message.

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 action that allows a user to filter out events that are non-fiducial, i.e.

the electron is not contained in the ECAL and so can act like the signal

Definition at line 30 of file NonFiducialFilter.h.

Constructor & Destructor Documentation

◆ NonFiducialFilter()

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

Constructor.

Definition at line 26 of file NonFiducialFilter.cxx.

    : simcore::UserAction(name, parameters) {
  recoil_max_p_ = parameters.get<double>("recoil_max_p");
  abort_fiducial_ = parameters.get<bool>("abort_fiducial");
}

References abort_fiducial_, framework::config::Parameters::get(), and recoil_max_p_.

Member Function Documentation

◆ endOfEventAction()

void NonFiducialFilter::endOfEventAction ( const G4Event * )

overridevirtual

Method called at the end of every event.

Parameters

event Geant4 event object.

Reimplemented from simcore::UserAction.

Definition at line 101 of file NonFiducialFilter.cxx.

                                                       {
  if (non_fiducial) {
    ldmx_log(debug) << "  >> This event is non-fiducial in ECAL, keeping it";
  } else {
    ldmx_log(debug) << ">> This event is fiducial, exiting";
  }
}

◆ getTypes()

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

inlineoverridevirtual

Retrieve the type of actions this class defines.

Implements simcore::UserAction.

Definition at line 52 of file NonFiducialFilter.h.

                                             {
    return {simcore::TYPE::EVENT, simcore::TYPE::STACKING,
            simcore::TYPE::STEPPING};
  }

◆ stepping()

void NonFiducialFilter::stepping ( const G4Step * step )

overridevirtual

Implement the stepping action which performs the target volume biasing.

Parameters

step	The Geant4 step.

Reimplemented from simcore::UserAction.

Definition at line 33 of file NonFiducialFilter.cxx.

                                                   {
  // Get the track associated with this step.
  auto track{step->GetTrack()};
 
  // Get the PDG ID of the track and make sure it's an electron.
  if (auto pdg_id{track->GetParticleDefinition()->GetPDGEncoding()};
      pdg_id != 11) {
    return;
  }
 
  // Only process the primary electron track
  int parent_id{step->GetTrack()->GetParentID()};
  if (parent_id != 0) {
    return;
  }
 
  // Check in which volume the electron is currently
  auto phys_vol = track->GetVolume();
  auto volume{phys_vol ? phys_vol->GetLogicalVolume() : nullptr};
 
  // Check if the track is tagged.
  auto electron_check{simcore::UserTrackInformation::get(track)};
  if (electron_check->isRecoilElectron() == true) {
    if (track->GetMomentum().mag() > recoil_max_p_) {
      // Kill the track if its momemntum is too high
      track->SetTrackStatus(fKillTrackAndSecondaries);
      G4RunManager::GetRunManager()->AbortEvent();
      ldmx_log(debug) << " Recoil track momentum is too high, expected to be "
                         "fiducial, exiting\n";
      return;
    }
    // Check if the track ever enters the ECal. If it does, kill the track and
    // abort the event.
    auto volume_name{volume ? volume->GetName() : "undefined"};
    auto is_in_ecal =
        simcore::g4user::volumechecks::isInEcal(volume, volume_name);
    if (abort_fiducial_ && is_in_ecal) {
      track->SetTrackStatus(fKillTrackAndSecondaries);
      G4RunManager::GetRunManager()->AbortEvent();
      ldmx_log(debug) << ">> This event is fiducial, exiting";
      non_fiducial = false;
      return;
    }
    // I comment the following debug out since it would print per step and it's
    // hard to read but it could be otherwise useful if somebody wants to do a
    // step-by-step debugging ldmx_log(debug) << "  >> In this step this is
    // non-fiducial, keeping it so far";
    non_fiducial = true;
    return;
  } else {
    // Check if the particle enters the recoil tracker.
    static auto recoil_volume =
        simcore::g4user::ptrretrieval::getLogicalVolume("recoil");
    if (!recoil_volume) {
      ldmx_log(warn) << "Volume 'recoil' not found in Geant4 volume store";
    }
    if (volume == recoil_volume) {
      /* Tag the tracks that:
       1) Have a recoil electron
       2) Enter/Exit the Target */
      auto track_info{simcore::UserTrackInformation::get(track)};
      track_info->tagRecoilElectron();  // tag the target recoil electron
      ldmx_log(debug) << "  >> This track is the recoil electron, tagging it";
      return;
    }
  }
}

References abort_fiducial_, simcore::UserTrackInformation::get(), and recoil_max_p_.

Member Data Documentation

◆ abort_fiducial_

bool biasing::NonFiducialFilter::abort_fiducial_ {true}

private

If turned on, this aborts fiducial events.

Definition at line 61 of file NonFiducialFilter.h.

61{true};

Referenced by NonFiducialFilter(), and stepping().

◆ recoil_max_p_

double biasing::NonFiducialFilter::recoil_max_p_ {1500}

private

Recoil electron threshold.

Definition at line 59 of file NonFiducialFilter.h.

59{1500}; // MeV