RMGScintillatorOutputScheme Class Reference

Output scheme for Scintillator detectors. More...

#include <RMGScintillatorOutputScheme.hh>

Inheritance diagram for RMGScintillatorOutputScheme:

Collaboration diagram for RMGScintillatorOutputScheme:

Public Member Functions
void	AssignOutputNames (G4AnalysisManager *ana_man) override
	Sets the names of the output columns, invoked in RMGRunAction::SetupAnalysisManager.
void	StoreEvent (const G4Event *) override
	Store the information from the event, invoked in RMGEventAction::EndOfEventAction.
bool	ShouldDiscardEvent (const G4Event *) override
	Decide whether to store the event, invoked in RMGEventAction::EndOfEventAction.
void	SetEdepCutLow (double threshold)
	Set a lower cut on the energy deposited in the event to store it.
void	SetEdepCutHigh (double threshold)
	Set a upper cut on the energy deposited in the event to store it.
void	AddEdepCutDetector (int det_uid)
	Add a detector uid to the list of detectors to apply the energy cut for.
void	SetPositionMode (RMGOutputTools::PositionMode mode)
	Set which position is used for the steps.
void	SetClusterDistance (double threshold)
	Set a distance to compute together steps in the bulk.
void	SetClusterTimeThreshold (double threshold)
	Set the time threshold for pre-clustering.
void	SetElectronTrackEnergyThreshold (double threshold)
	Set the energy threshold to merge electron tracks.
Public Member Functions inherited from RMGVOutputScheme
virtual void	ClearBeforeEvent ()
	Clear any event-specific data.
virtual bool	StoreAlways () const
	Indicates whether the output scheme always stores event data.
virtual std::optional< G4ClassificationOfNewTrack >	StackingActionClassify (const G4Track *, const int)
	Hook for classifying new tracks during the stacking phase.
virtual std::optional< bool >	StackingActionNewStage (const int)
	Hook for transitioning to a new stacking stage.
virtual void	TrackingActionPre (const G4Track *)
	Hook called before tracking a new particle.
virtual void	TrackingActionPost (const G4Track *)
	Hook called after tracking a new particle.
virtual void	SteppingAction (const G4Step *)
	Hook called after each step.
virtual void	EndOfRunAction (const G4Run *)
	Perform final actions at the end of a run.
void	SetNtuplePerDetector (bool ntuple_per_det)
	Specify whether to create separate ntuples for each detector.
void	SetNtupleUseVolumeName (bool use_vol_name)
	Specify whether to use the physical volume name for naming ntuples.
void	SetEventIDOffset (int offset)

Protected Member Functions
std::string	GetNtupleNameFlat () const override
Protected Member Functions inherited from RMGVOutputScheme
virtual std::string	GetNtupleName (RMGDetectorMetadata det) const
void	CreateNtupleFOrDColumn (G4AnalysisManager *ana_man, int nt, std::string name, bool use_float)
void	FillNtupleFOrDColumn (G4AnalysisManager *ana_man, int nt, int col, double val, bool use_float)
int	GetEventIDForStorage (const G4Event *evt) const

Additional Inherited Members
Static Public Attributes inherited from RMGVOutputScheme
static std::string	fUIDKeyFormatString = "det{:03}"
Protected Attributes inherited from RMGVOutputScheme
bool	fNtuplePerDetector = true
bool	fNtupleUseVolumeName = false
int	fEventIDOffset = 0

Detailed Description

Output scheme for Scintillator detectors.

This output scheme records the hits in the Scintillator detectors. The properties of each RMGDetectorHit are recorded:

• event index,
• particle type,
• time,
• position,
• energy deposition,
• velocity of the particle (optional),

Optionally, the track ID and parent track ID can be stored as well as the detector ID for the single table output mode.

Member Function Documentation

AssignOutputNames()

void RMGScintillatorOutputScheme::AssignOutputNames ( G4AnalysisManager * ana_man )

overridevirtual

Sets the names of the output columns, invoked in RMGRunAction::SetupAnalysisManager.

Reimplemented from RMGVOutputScheme.

GetNtupleNameFlat()

std::string RMGScintillatorOutputScheme::GetNtupleNameFlat ( ) const

inlinenodiscardoverrideprotectedvirtual

Reimplemented from RMGVOutputScheme.

ShouldDiscardEvent()

bool RMGScintillatorOutputScheme::ShouldDiscardEvent ( const G4Event * event )

overridevirtual

Decide whether to store the event, invoked in RMGEventAction::EndOfEventAction.

true if the event should be discarded, else false . The event is discarded if there is no hit in the Scintillator volumes or the energy range condition is not met.

Reimplemented from RMGVOutputScheme.

StoreEvent()

void RMGScintillatorOutputScheme::StoreEvent ( const G4Event * event )

overridevirtual

Store the information from the event, invoked in RMGEventAction::EndOfEventAction.

Only steps with non-zero energy are stored, unless fDiscardZeroEnergyHits is false.

Reimplemented from RMGVOutputScheme.

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/remage/checkouts/latest/include/RMGScintillatorOutputScheme.hh
• /home/docs/checkouts/readthedocs.org/user_builds/remage/checkouts/latest/src/RMGScintillatorOutputScheme.cc