User action plugin that filters events that don't see a hard brem from the target undergo a photo-nuclear reaction in the ECal. More...

#include <EcalProcessFilter.h>

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

virtual	~EcalProcessFilter ()=default
	Destructor.

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

G4ClassificationOfNewTrack	ClassifyNewTrack (const G4Track *aTrack, const G4ClassificationOfNewTrack &currentTrackClass) override
	Classify a new track which postpones track processing.

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 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
G4Track *	current_track_ {nullptr}
	Pointer to the current track being processed.

std::string	process_ {""}
	Process to filter.

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 action plugin that filters events that don't see a hard brem from the target undergo a photo-nuclear reaction in the ECal.

Definition at line 30 of file EcalProcessFilter.h.

Constructor & Destructor Documentation

◆ EcalProcessFilter()

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

Definition at line 22 of file EcalProcessFilter.cxx.

    : simcore::UserAction(name, parameters) {
  process_ = parameters.get<std::string>("process");
}

Member Function Documentation

◆ ClassifyNewTrack()

G4ClassificationOfNewTrack biasing::EcalProcessFilter::ClassifyNewTrack	(	const G4Track *	aTrack,
		const G4ClassificationOfNewTrack &	currentTrackClass )

overridevirtual

Classify a new track which postpones track processing.

Track processing resumes normally if a target PN interaction occurred.

Parameters

aTrack	The Geant4 track.
currentTrackClass	The current track classification.

Reimplemented from simcore::UserAction.

Definition at line 28 of file EcalProcessFilter.cxx.

                                                                               {
  // Get the particle type.
  G4String particle_name = track->GetParticleDefinition()->GetParticleName();
 
  if (track == current_track_) {
    /*
    std::cout << "[ EcalProcessFilter ]: "
        << "Putting track " << track->GetTrackID()
        << " onto waiting stack." << std::endl;
    */
    current_track_ = nullptr;
    return fWaiting;
  }
 
  // Use current classification by default so values from other plugins are not
  // overridden.
  G4ClassificationOfNewTrack classification = currentTrackClass;
 
  return classification;
}

◆ getTypes()

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

inlineoverridevirtual

Retrieve the type of actions this class defines.

Implements simcore::UserAction.

Definition at line 56 of file EcalProcessFilter.h.

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

◆ stepping()

void biasing::EcalProcessFilter::stepping ( const G4Step * )

overridevirtual

Method called after each simulation step.

TYPE::STEPPING

Parameters

current Geant4 step

Check if the photon will be exiting the ecal

The 'hadronic_calorimeter' logical volume name is the parent volume to all of the HCal components.

Reimplemented from simcore::UserAction.

Definition at line 50 of file EcalProcessFilter.cxx.

                                                   {
  static auto calorimeter_region =
      simcore::g4user::ptrretrieval::getRegion("CalorimeterRegion");
  if (!calorimeter_region) {
    ldmx_log(warn)
        << "Region 'CalorimeterRegion' not found in Geant4 region store";
  }
  // Get the track associated with this step.
  auto track{step->GetTrack()};
 
  if (G4EventManager::GetEventManager()->GetConstCurrentEvent()->IsAborted())
    return;
 
  // Get the track info and check if this track is a brem candidate
  auto track_info{simcore::UserTrackInformation::get(track)};
  if ((track_info != nullptr) && !track_info->isBremCandidate()) return;
 
  // Get the particles daughters.
  auto secondaries{step->GetSecondary()};
 
  // Get the region the particle is currently in.  Continue processing
  // the particle only if it's in the calorimeter region.
  auto phys_vol{track->GetVolume()};
  auto lv{phys_vol ? phys_vol->GetLogicalVolume() : nullptr};
  auto region{lv ? lv->GetRegion() : nullptr};
  if (region != calorimeter_region) {
    // If secondaries were produced outside of the volume of interest,
    // and there aren't additional brems to process, abort the
    // event.  Otherwise, suspend the track and move on to the next
    // brem.
    if (secondaries->size() != 0) {
      /*
      std::cout << "[ EcalProcessFilter ]: "
            <<
      G4EventManager::GetEventManager()->GetConstCurrentEvent()->GetEventID()
            << " secondaries outside ecal...";
      */
      if (getEventInfo()->bremCandidateCount() == 1) {
        // std::cout << "aborting the event." << std::endl;
        track->SetTrackStatus(fKillTrackAndSecondaries);
        G4RunManager::GetRunManager()->AbortEvent();
        current_track_ = nullptr;
      } else {
        /*
        std::cout << "suspending the track " << track->GetTrackID()
            << " , " << getEventInfo()->bremCandidateCount() << " brems left."
            << std::endl;
        */
        current_track_ = track;
        track->SetTrackStatus(fSuspend);
        getEventInfo()->decBremCandidateCount();
        track_info->tagBremCandidate(false);
      }
    }
    return;
  }
 
  // If the particle doesn't interact, then move on to the next step.
  if (secondaries->size() == 0) {
    static auto volume_after_exiting_ecal =
        simcore::g4user::ptrretrieval::getLogicalVolume("hadronic_calorimeter");
    if (!volume_after_exiting_ecal) {
      ldmx_log(warn) << "Unable to find 'hadronic_calorimeter' logical volume.";
    }
    auto next_phys_vol = track->GetNextVolume();
    auto next_log_vol{next_phys_vol ? next_phys_vol->GetLogicalVolume()
                                    : nullptr};
    if (next_log_vol == volume_after_exiting_ecal) {
      /*
      std::cout << "[ EcalProcessFilter ]: "
            <<
      G4EventManager::GetEventManager()->GetConstCurrentEvent()->GetEventID()
            << " no secondaries when leaving ecal...";
      */
      if (getEventInfo()->bremCandidateCount() == 1) {
        // std::cout << "aborting the event." << std::endl;
        track->SetTrackStatus(fKillTrackAndSecondaries);
        G4RunManager::GetRunManager()->AbortEvent();
        current_track_ = nullptr;
      } else {
        /*
        std::cout << "suspending the track " << track->GetTrackID()
            << " , " << getEventInfo()->bremCandidateCount() << " brems left."
            << std::endl;
        */
        current_track_ = track;
        track->SetTrackStatus(fSuspend);
        getEventInfo()->decBremCandidateCount();
        track_info->tagBremCandidate(false);
      }
    }
 
    return;
  } else {
    // If the brem gamma interacts and produces secondaries, get the
    // process used to create them.
    auto process_name{
        secondaries->at(0)->GetCreatorProcess()->GetProcessName()};
 
    // Only record the process that is being biased
    if (!process_name.contains(process_)) {
      /*
      std::cout << "[ EcalProcessFilter ]: "
            <<
      G4EventManager::GetEventManager()->GetConstCurrentEvent()->GetEventID()
            << " not PN products...";
      */
      if (getEventInfo()->bremCandidateCount() == 1) {
        // std::cout << "aborting the event." << std::endl;
        track->SetTrackStatus(fKillTrackAndSecondaries);
        G4RunManager::GetRunManager()->AbortEvent();
        current_track_ = nullptr;
      } else {
        /*
        std::cout << "suspending the track " << track->GetTrackID()
            << " , " << getEventInfo()->bremCandidateCount() << " brems left."
            << std::endl;
        */
        current_track_ = track;
        track->SetTrackStatus(fSuspend);
        getEventInfo()->decBremCandidateCount();
        track_info->tagBremCandidate(false);
      }
      return;
    }
 
    ldmx_log(info) << " Brem photon produced " << secondaries->size()
                   << " particles via " << process_name << " process.";
    track_info->tagBremCandidate(false);
    track_info->setSaveFlag(true);
    track_info->tagPNGamma();
    getEventInfo()->decBremCandidateCount();
  }
}

References simcore::UserTrackInformation::get().

Member Data Documentation

◆ current_track_

G4Track* biasing::EcalProcessFilter::current_track_ {nullptr}

private

Pointer to the current track being processed.

Definition at line 62 of file EcalProcessFilter.h.

62{nullptr};

◆ process_

std::string biasing::EcalProcessFilter::process_ {""}

private

Process to filter.

Definition at line 65 of file EcalProcessFilter.h.

65{""};

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

Biasing/include/Biasing/EcalProcessFilter.h
Biasing/src/Biasing/EcalProcessFilter.cxx

Public Member Functions

Private Attributes

Additional Inherited Members