biasing::TargetENProcessFilter Class Reference

Public Member Functions
	TargetENProcessFilter (const std::string &name, framework::config::Parameters &parameters)
	Class constructor.
	~TargetENProcessFilter ()
	Destructor.
void	stepping (const G4Step *step) override
	Implementmthe stepping action which performs the target volume biasing.
void	EndOfEventAction (const G4Event *) override
	End of event action.
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	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
std::string	volumeName_ {"target_PV"}
	The volume name of the LDMX target.
bool	reactionOccurred_ {false}
	Flag indicating if the reaction of intereset occurred.
double	recoilEnergyThreshold_ {1500}
	Energy that the recoil electron must not surpass.
std::string	process_ {"electronNuclear"}
	Process to filter on.

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

Definition at line 22 of file TargetENProcessFilter.h.

Constructor & Destructor Documentation

TargetENProcessFilter()

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

Class constructor.

Definition at line 17 of file TargetENProcessFilter.cxx.

    : simcore::UserAction(name, parameters) {
  recoilEnergyThreshold_ = parameters.getParameter<double>("recoilThreshold");
}

References framework::config::Parameters::getParameter(), and recoilEnergyThreshold_.

~TargetENProcessFilter()

biasing::TargetENProcessFilter::~TargetENProcessFilter

(

)

Destructor.

Definition at line 23 of file TargetENProcessFilter.cxx.

{}

Member Function Documentation

EndOfEventAction()

void biasing::TargetENProcessFilter::EndOfEventAction ( const G4Event *  )

overridevirtual

End of event action.

Reimplemented from simcore::UserAction.

Definition at line 100 of file TargetENProcessFilter.cxx.

                                                           {
  reactionOccurred_ = false;
}

References reactionOccurred_.

getTypes()

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

inlineoverridevirtual

Retrieve the type of actions this class defines.

Implements simcore::UserAction.

Definition at line 45 of file TargetENProcessFilter.h.

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

stepping()

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

overridevirtual

Implementmthe stepping action which performs the target volume biasing.

Parameters

step	The Geant4 step.

Reimplemented from simcore::UserAction.

Definition at line 25 of file TargetENProcessFilter.cxx.

                                                       {
  if (reactionOccurred_) return;
 
  // Get the track associated with this step.
  G4Track* track = step->GetTrack();
 
  // Only process tracks whose parent is the primary particle
  if (track->GetParentID() != 0) return;
 
  // get the PDGID of the track.
  G4int pdgID = track->GetParticleDefinition()->GetPDGEncoding();
 
  // Make sure that the particle being processed is an electron.
  if (pdgID != 11) return;  // Throw an exception
 
  // Get the volume the particle is in.
  G4VPhysicalVolume* volume = track->GetVolume();
  G4String volumeName = volume->GetName();
 
  // If the particle isn't in the target, don't continue with the processing.
  if (volumeName.compareTo(volumeName_) != 0) return;
 
  /*std::cout << "*******************************" << std::endl;
  std::cout << "*   Step " << track->GetCurrentStepNumber() << std::endl;
  std::cout << "********************************" << std::endl;*/
 
  if (track->GetMomentum().mag() > recoilEnergyThreshold_) {
    track->SetTrackStatus(fKillTrackAndSecondaries);
    G4RunManager::GetRunManager()->AbortEvent();
    return;
  }
 
  // Get the particles daughters.
  const G4TrackVector* secondaries = step->GetSecondary();
 
  // If the brem photon doesn't undergo any reaction in the target, stop
  // processing the rest of the event.
  if (secondaries->size() == 0) {
    /*std::cout << "[ TargetENProcessFilter ]: "
                << "Electron did not interact in the target. --> Postponing
       tracks."
                << std::endl;*/
 
    track->SetTrackStatus(fKillTrackAndSecondaries);
    G4RunManager::GetRunManager()->AbortEvent();
    return;
  } else {
    G4String processName =
        secondaries->at(0)->GetCreatorProcess()->GetProcessName();
 
    /*std::cout << "[ TargetENProcessFilter ]: "
              << "Electron produced " << secondaries->size()
              << " particle via " << processName << " process."
              << std::endl;*/
 
    // Only record the process that is being biased
    if (!processName.contains(process_)) {
      /*std::cout << "[ TargetENProcessFilter ]: "
                << "Process was not " << BiasingMessenger::getProcess() << "-->
         Killing all tracks!"
                << std::endl;*/
 
      track->SetTrackStatus(fKillTrackAndSecondaries);
      G4RunManager::GetRunManager()->AbortEvent();
      return;
    }
 
    std::cout << "[ TargetENProcessFilter ]: "
              << "Electronuclear reaction resulted in " << secondaries->size()
              << " particles via " << processName << " process." << std::endl;
    // BiasingMessenger::setEventWeight(track->GetWeight());
    reactionOccurred_ = true;
  }
}

References process_, reactionOccurred_, recoilEnergyThreshold_, and volumeName_.

Member Data Documentation

process_

std::string biasing::TargetENProcessFilter::process_ {"electronNuclear"}

private

Process to filter on.

Definition at line 68 of file TargetENProcessFilter.h.

{"electronNuclear"};

Referenced by stepping().

reactionOccurred_

bool biasing::TargetENProcessFilter::reactionOccurred_ {false}

private

Flag indicating if the reaction of intereset occurred.

Definition at line 62 of file TargetENProcessFilter.h.

{false};

Referenced by EndOfEventAction(), and stepping().

recoilEnergyThreshold_

double biasing::TargetENProcessFilter::recoilEnergyThreshold_ {1500}

private

Energy that the recoil electron must not surpass.

Definition at line 65 of file TargetENProcessFilter.h.

{1500};

Referenced by stepping(), and TargetENProcessFilter().

volumeName_

std::string biasing::TargetENProcessFilter::volumeName_ {"target_PV"}

private

The volume name of the LDMX target.

The 'target_PV' volume name is automatically constructed by Geant4's GDML parser and was found by inspecting the geometry using a visualization. This Physical Volume (PV) is associated with the target parent volume and so it will break if the target parent volume changes its name.

Definition at line 59 of file TargetENProcessFilter.h.

{"target_PV"};

Referenced by stepping().

---

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

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