remage
Simulation framework for HPGe-based experiments
Loading...
Searching...
No Matches
RMGOpticalOutputScheme Class Reference

Output scheme writing optical photon detector hits. More...

#include <RMGOpticalOutputScheme.hh>

Inheritance diagram for RMGOpticalOutputScheme:
Collaboration diagram for RMGOpticalOutputScheme:

Public Member Functions

void AssignOutputNames (G4AnalysisManager *) override
 Register the columns of the optical ntuple with the analysis manager.
void StoreEvent (const G4Event *) override
 Fill one row with the optical photon counts.
Public Member Functions inherited from RMGVOutputScheme
virtual void ClearBeforeEvent ()
 Clear any event-specific data.
virtual bool ShouldDiscardEvent (const G4Event *)
 Decide whether to discard the current event.
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 writing optical photon detector hits.

Member Function Documentation

◆ AssignOutputNames()

void RMGOpticalOutputScheme::AssignOutputNames ( G4AnalysisManager * ana_man)
overridevirtual

Register the columns of the optical ntuple with the analysis manager.

Reimplemented from RMGVOutputScheme.

◆ GetNtupleNameFlat()

std::string RMGOpticalOutputScheme::GetNtupleNameFlat ( ) const
inlinenodiscardoverrideprotectedvirtual

Reimplemented from RMGVOutputScheme.

◆ StoreEvent()

void RMGOpticalOutputScheme::StoreEvent ( const G4Event * event)
overridevirtual

Fill one row with the optical photon counts.

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/RMGOpticalOutputScheme.hh
  • /home/docs/checkouts/readthedocs.org/user_builds/remage/checkouts/latest/src/RMGOpticalOutputScheme.cc