biasing::DeepEcalProcessFilter Class Reference

User action that allows a user to filter out events where the interaction happened deep in the ECAL. More...

#include <DeepEcalProcessFilter.h>

Public Member Functions
	DeepEcalProcessFilter (const std::string &name, framework::config::Parameters &parameters)
	Constructor.
virtual	~DeepEcalProcessFilter ()=default
	Destructor.
void	BeginOfEventAction (const G4Event *event) override
	Method to set flags in the beginning of the event.
void	stepping (const G4Step *step) override
	Implement the stepping action which performs the target volume biasing.
void	NewStage () override
	Method called at the beginning of a new stage.
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.
virtual	~UserAction ()=default
	Destructor.
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	PrepareNewEvent ()
	Method called at the beginning of a new event.

Private Member Functions
	enableLogging ("DeepEcalProcessFilter") bool photonFromTarget_
	Enable logging.

Private Attributes
double	bias_threshold_ {1500.}
	Minimal energy the products should have.
std::vector< std::string >	processes_ {"conv", "phot"}
	The allowed processes that can happen deep inside the ECAL, default is conversion (conv) and photoelectron (photo)
double	ecal_min_Z_ {400.}
	Minimum Z location where the deep process should happen.
bool	require_photon_fromTarget_ {false}
	Require that the hard brem photon originates from the target.
bool	hasDeepEcalProcess_ {false}
	member used to help tag events that have a deep-ecal process ocurr

Additional Inherited Members
Public Types inherited from simcore::UserAction
using	Factory = ::simcore::Factory< UserAction, std::shared_ptr< UserAction >, const std::string &, framework::config::Parameters & >
	factory for user actions
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.

Detailed Description

User action that allows a user to filter out events where the interaction happened deep in the ECAL.

Definition at line 35 of file DeepEcalProcessFilter.h.

Constructor & Destructor Documentation

DeepEcalProcessFilter()

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

Constructor.

Definition at line 20 of file DeepEcalProcessFilter.cxx.

    : simcore::UserAction(name, parameters) {
  bias_threshold_ = parameters.getParameter<double>("bias_threshold");
  processes_ = parameters.getParameter<std::vector<std::string>>("processes");
  ecal_min_Z_ = parameters.getParameter<double>("ecal_min_Z");
  require_photon_fromTarget_ =
      parameters.getParameter<bool>("require_photon_fromTarget");
}

References bias_threshold_, ecal_min_Z_, framework::config::Parameters::getParameter(), processes_, and require_photon_fromTarget_.

Member Function Documentation

BeginOfEventAction()

void DeepEcalProcessFilter::BeginOfEventAction ( const G4Event *  event )

overridevirtual

Method to set flags in the beginning of the event.

Reimplemented from simcore::UserAction.

Definition at line 30 of file DeepEcalProcessFilter.cxx.

                                                                   {
  hasDeepEcalProcess_ = false;
  photonFromTarget_ = false;
}

References hasDeepEcalProcess_.

enableLogging()

biasing::DeepEcalProcessFilter::enableLogging ( "DeepEcalProcessFilter"  )

inlineprivate

Enable logging.

member used to help tag events where the photon comes from the target

Definition at line 78 of file DeepEcalProcessFilter.h.

                            {false};

getTypes()

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

inlineoverridevirtual

Retrieve the type of actions this class defines.

Implements simcore::UserAction.

Definition at line 62 of file DeepEcalProcessFilter.h.

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

NewStage()

void DeepEcalProcessFilter::NewStage ( )

overridevirtual

Method called at the beginning of a new stage.

TYPE::STACKING

Reimplemented from simcore::UserAction.

Definition at line 119 of file DeepEcalProcessFilter.cxx.

                                     {
  if (hasDeepEcalProcess_) {
    ldmx_log(debug) << "> Event with a hard deep conversion found, yaaay!";
    ldmx_log(debug) << "> -----------------------------------------";
  } else {
    //    ldmx_log(debug) << "> -----------------------------------------";
    G4RunManager::GetRunManager()->AbortEvent();
  }
}

References hasDeepEcalProcess_.

stepping()

void DeepEcalProcessFilter::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 35 of file DeepEcalProcessFilter.cxx.

                                                       {
  // Get the track associated with this step.
  auto track{step->GetTrack()};
 
  // Check the creation process and PDG ID of the particle
  auto processName = track->GetCreatorProcess()
                         ? track->GetCreatorProcess()->GetProcessName()
                         : "unknown";
  auto PDGid = track->GetParticleDefinition()->GetPDGEncoding();
 
  // Skip the steps that are for the recoil electron
  // PrimaryToEcalFilter made sure there is a fiducial e-
  if (processName.contains("unknown")) return;
 
  // Energy of the particle is below threshold, move to next step
  if (track->GetKineticEnergy() < bias_threshold_) {
    return;
  }
 
  // Check in which volume the particle is currently
  auto volume{track->GetVolume()->GetLogicalVolume()
                  ? track->GetVolume()->GetLogicalVolume()->GetName()
                  : "undefined"};
 
  auto trackInfo{simcore::UserTrackInformation::get(track)};
  // Tag the brem photon from the primary electron
  if (processName.contains("eBrem") and (track->GetParentID() == 1)) {
    trackInfo->tagBremCandidate();
    getEventInfo()->incBremCandidateCount();
    trackInfo->setSaveFlag(true);
    if (volume.contains("target")) {
      photonFromTarget_ = true;
    }
  }
 
  // If we require that the photon comes from the target and
  // and if it does not, let's skip the event
  if (require_photon_fromTarget_ and !photonFromTarget_) {
    return;
  }
 
  // Tag if the event has the processes we are looking for
  bool hasProcessNeeded{false};
  for (auto& process : processes_) {
    // ldmx_log(debug) << "Allowed processed " << process << " now we have " <<
    // processName;
    if (processName.contains(process)) {
      hasProcessNeeded = true;
      break;
    }
  }
  // skip this step if it does not have any of the processes needed
  if (not hasProcessNeeded) return;
 
  // isInEcal should be taken from
  // simcore::logical_volume_tests::isInEcal(volume) but for now it's under
  // its own namespace so I cannot reach it here, see issue
  // https://github.com/LDMX-Software/ldmx-sw/issues/1286
  auto isInEcal{((volume.contains("Si") || volume.contains("W") ||
                  volume.contains("PCB") || volume.contains("strongback") ||
                  volume.contains("Glue") || volume.contains("CFMix") ||
                  volume.contains("Al") || volume.contains("C")) &&
                 volume.contains("volume")) ||
                (volume.contains("nohole_motherboard"))};
 
  // Skip this step if it does not have the processes needed
  // or if it's not in the ECAL
  if (not isInEcal) return;
 
  // Check the z position of the particle, and
  // flag if it is deeper than the min Z we are considering (but in ECAL)
  auto zPosition = step->GetPreStepPoint()->GetPosition().z();
  // Printout for testing
  if (zPosition > (0.75 * ecal_min_Z_)) {
    ldmx_log(debug) << " Particle ID " << PDGid << " with energy "
                    << track->GetKineticEnergy() << " on " << volume << " from "
                    << processName << " at Z = " << zPosition;
    if (zPosition > ecal_min_Z_) {
      hasDeepEcalProcess_ = true;
    }
  }
  return;
}

References bias_threshold_, ecal_min_Z_, simcore::UserTrackInformation::get(), simcore::UserAction::getEventInfo(), hasDeepEcalProcess_, simcore::UserEventInformation::incBremCandidateCount(), processes_, require_photon_fromTarget_, and simcore::UserTrackInformation::tagBremCandidate().

Member Data Documentation

bias_threshold_

double biasing::DeepEcalProcessFilter::bias_threshold_ {1500.}

private

Minimal energy the products should have.

Definition at line 69 of file DeepEcalProcessFilter.h.

{1500.};

Referenced by DeepEcalProcessFilter(), and stepping().

ecal_min_Z_

double biasing::DeepEcalProcessFilter::ecal_min_Z_ {400.}

private

Minimum Z location where the deep process should happen.

Definition at line 74 of file DeepEcalProcessFilter.h.

{400.};

Referenced by DeepEcalProcessFilter(), and stepping().

hasDeepEcalProcess_

bool biasing::DeepEcalProcessFilter::hasDeepEcalProcess_ {false}

private

member used to help tag events that have a deep-ecal process ocurr

Definition at line 82 of file DeepEcalProcessFilter.h.

{false};

Referenced by BeginOfEventAction(), NewStage(), and stepping().

processes_

std::vector<std::string> biasing::DeepEcalProcessFilter::processes_ {"conv", "phot"}

private

The allowed processes that can happen deep inside the ECAL, default is conversion (conv) and photoelectron (photo)

Definition at line 72 of file DeepEcalProcessFilter.h.

{"conv", "phot"};

Referenced by DeepEcalProcessFilter(), and stepping().

require_photon_fromTarget_

bool biasing::DeepEcalProcessFilter::require_photon_fromTarget_ {false}

private

Require that the hard brem photon originates from the target.

Definition at line 76 of file DeepEcalProcessFilter.h.

{false};

Referenced by DeepEcalProcessFilter(), and stepping().

---

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

• Biasing/include/Biasing/DeepEcalProcessFilter.h
• Biasing/src/Biasing/DeepEcalProcessFilter.cxx