Macro commands#

Command table

/RMG/#

Sub-directories:

  • /RMG/Manager/ – General commands for controlling the application

  • /RMG/Output/ – Commands for controlling the simulation output

  • /RMG/Processes/ – Commands for controlling physics processes

  • /RMG/Geometry/ – Commands for controlling geometry definitions

  • /RMG/Generator/ – Commands for controlling generators

  • /RMG/GrabmayrGammaCascades/ – Control Peters gamma cascade model

/RMG/Manager/#

General commands for controlling the application

Sub-directories:

  • /RMG/Manager/Logging/ – Commands for controlling application logging

  • /RMG/Manager/Randomization/ – Commands for controlling randomization settings

Commands:

  • Interactive – Enable interactive mode

  • PrintProgressModulo – How many processed events before progress information is displayed

/RMG/Manager/Interactive#

Enable interactive mode

  • Parameter – interactive

    • Parameter type – b

    • Omittable – True

    • Default value – true

/RMG/Manager/PrintProgressModulo#

How many processed events before progress information is displayed

  • Range of parameters – n > 0

  • Parameter – n

    • Parameter type – i

    • Omittable – False

/RMG/Manager/Logging/#

Commands for controlling application logging

Commands:

  • LogLevel – Set verbosity level of application log

/RMG/Manager/Logging/LogLevel#

Set verbosity level of application log

  • Parameter – level

    • Parameter type – s

    • Omittable – False

    • Candidates – debug detail summary warning error fatal nothing

/RMG/Manager/Randomization/#

Commands for controlling randomization settings

Commands:

  • RandomEngine – Select the random engine (CLHEP)

  • Seed – Select the initial seed for randomization (CLHEP::HepRandom::setTheSeed)

  • InternalSeed – Select the initial seed for randomization by using the internal CLHEP table

  • UseSystemEntropy – Select a random initial seed from system entropy

/RMG/Manager/Randomization/RandomEngine#

Select the random engine (CLHEP)

  • Parameter – name

    • Parameter type – s

    • Omittable – False

    • Candidates – JamesRandom RanLux MTwist MixMaxRng

/RMG/Manager/Randomization/Seed#

Select the initial seed for randomization (CLHEP::HepRandom::setTheSeed)

  • Range of parameters – n >= 0

  • Parameter – n

    • Parameter type – i

    • Omittable – False

    • Default value – 1

/RMG/Manager/Randomization/InternalSeed#

Select the initial seed for randomization by using the internal CLHEP table

  • Range of parameters – index >= 0 && index < 430

  • Parameter – index

    • Parameter type – i

    • Omittable – False

/RMG/Manager/Randomization/UseSystemEntropy#

Select a random initial seed from system entropy

/RMG/Output/#

Commands for controlling the simulation output

Sub-directories:

  • /RMG/Output/Germanium/ – Commands for controlling output from hits in germanium detectors.

  • /RMG/Output/Vertex/ – Commands for controlling output of primary vertices.

  • /RMG/Output/Scintillator/ – Commands for controlling output from hits in scintillator detectors.

  • /RMG/Output/IsotopeFilter/ – Commands for filtering event out by created isotopes.

  • /RMG/Output/Track/ – Commands for controlling output of track vertices.

Commands:

  • FileName – Set output file name for object persistency

  • NtuplePerDetector – Create a ntuple for each sensitive detector to store hits. Otherwise, store all hits of one detector type in one ntuple.

  • NtupleUseVolumeName – Use the sensitive volume name to name output ntuples.

  • ActivateOutputScheme – Activates the output scheme that had been registered under the given name.

  • NtupleDirectory – Change the default output directory/group for ntuples in output files.

/RMG/Output/FileName#

Set output file name for object persistency

  • Parameter – filename

    • Parameter type – s

    • Omittable – False

/RMG/Output/NtuplePerDetector#

Create a ntuple for each sensitive detector to store hits. Otherwise, store all hits of one detector type in one ntuple.

  • Parameter – nt_per_det

    • Parameter type – b

    • Omittable – False

/RMG/Output/NtupleUseVolumeName#

Use the sensitive volume name to name output ntuples.

Note

this only works if NtuplePerDetector is set to true.

  • Parameter – nt_vol_name

    • Parameter type – b

    • Omittable – False

/RMG/Output/ActivateOutputScheme#

Activates the output scheme that had been registered under the given name.

  • Parameter – oscheme

    • Parameter type – s

    • Omittable – False

/RMG/Output/NtupleDirectory#

Change the default output directory/group for ntuples in output files.

Note

This setting is not respected by all output formats.

  • Parameter – nt_directory

    • Parameter type – s

    • Omittable – False

/RMG/Output/Germanium/#

Commands for controlling output from hits in germanium detectors.

Commands:

  • SetEdepCutLow – Set a lower energy cut that has to be met for this event to be stored.

  • SetEdepCutHigh – Set an upper energy cut that has to be met for this event to be stored.

  • AddDetectorForEdepThreshold – Take this detector into account for the filtering by /EdepThreshold.

  • DiscardPhotonsIfNoGermaniumEdep – Discard optical photons (before simulating them), if no edep in germanium detectors occurred in the same event.

  • StoreSinglePrecisionPosition – Use float32 (instead of float64) for position output.

  • StoreSinglePrecisionEnergy – Use float32 (instead of float64) for energy output.

  • StoreTrackID – Store Track IDs for hits in the output file.

/RMG/Output/Germanium/SetEdepCutLow#

Set a lower energy cut that has to be met for this event to be stored.

  • Parameter – threshold

    • Parameter type – d

    • Omittable – False

  • Parameter – Unit

    • Parameter type – s

    • Omittable – True

    • Default value – keV

    • Candidates – eV keV MeV GeV TeV PeV meV J electronvolt kiloelectronvolt megaelectronvolt gigaelectronvolt teraelectronvolt petaelectronvolt millielectronVolt joule

/RMG/Output/Germanium/SetEdepCutHigh#

Set an upper energy cut that has to be met for this event to be stored.

  • Parameter – threshold

    • Parameter type – d

    • Omittable – False

  • Parameter – Unit

    • Parameter type – s

    • Omittable – True

    • Default value – keV

    • Candidates – eV keV MeV GeV TeV PeV meV J electronvolt kiloelectronvolt megaelectronvolt gigaelectronvolt teraelectronvolt petaelectronvolt millielectronVolt joule

/RMG/Output/Germanium/AddDetectorForEdepThreshold#

Take this detector into account for the filtering by /EdepThreshold.

  • Parameter – det_uid

    • Parameter type – i

    • Omittable – False

/RMG/Output/Germanium/DiscardPhotonsIfNoGermaniumEdep#

Discard optical photons (before simulating them), if no edep in germanium detectors occurred in the same event.

Note

If another output scheme also requests the photons to be discarded, the germanium edep filter does not force the photons to be simulated.

  • Parameter – value

    • Parameter type – b

    • Omittable – False

/RMG/Output/Germanium/StoreSinglePrecisionPosition#

Use float32 (instead of float64) for position output.

  • Parameter – value

    • Parameter type – b

    • Omittable – False

/RMG/Output/Germanium/StoreSinglePrecisionEnergy#

Use float32 (instead of float64) for energy output.

  • Parameter – value

    • Parameter type – b

    • Omittable – False

/RMG/Output/Germanium/StoreTrackID#

Store Track IDs for hits in the output file.

  • Parameter – value

    • Parameter type – b

    • Omittable – False

/RMG/Output/Vertex/#

Commands for controlling output of primary vertices.

Commands:

  • StorePrimaryParticleInformation – Store information on primary particle details (not only vertex data).

  • SkipPrimaryVertexOutput – Do not store vertex/primary particle data.

  • StoreSinglePrecisionPosition – Use float32 (instead of float64) for position output.

  • StoreSinglePrecisionEnergy – Use float32 (instead of float64) for energy output.

/RMG/Output/Vertex/StorePrimaryParticleInformation#

Store information on primary particle details (not only vertex data).

  • Parameter – value

    • Parameter type – b

    • Omittable – False

/RMG/Output/Vertex/SkipPrimaryVertexOutput#

Do not store vertex/primary particle data.

  • Parameter – value

    • Parameter type – b

    • Omittable – False

/RMG/Output/Vertex/StoreSinglePrecisionPosition#

Use float32 (instead of float64) for position output.

  • Parameter – value

    • Parameter type – b

    • Omittable – False

/RMG/Output/Vertex/StoreSinglePrecisionEnergy#

Use float32 (instead of float64) for energy output.

  • Parameter – value

    • Parameter type – b

    • Omittable – False

/RMG/Output/Scintillator/#

Commands for controlling output from hits in scintillator detectors.

Commands:

  • SetEdepCutLow – Set a lower energy cut that has to be met for this event to be stored.

  • SetEdepCutHigh – Set an upper energy cut that has to be met for this event to be stored.

  • AddDetectorForEdepThreshold – Take this detector into account for the filtering by /EdepThreshold.

  • StoreSinglePrecisionPosition – Use float32 (instead of float64) for position output.

  • StoreSinglePrecisionEnergy – Use float32 (instead of float64) for energy output.

/RMG/Output/Scintillator/SetEdepCutLow#

Set a lower energy cut that has to be met for this event to be stored.

  • Parameter – threshold

    • Parameter type – d

    • Omittable – False

  • Parameter – Unit

    • Parameter type – s

    • Omittable – True

    • Default value – keV

    • Candidates – eV keV MeV GeV TeV PeV meV J electronvolt kiloelectronvolt megaelectronvolt gigaelectronvolt teraelectronvolt petaelectronvolt millielectronVolt joule

/RMG/Output/Scintillator/SetEdepCutHigh#

Set an upper energy cut that has to be met for this event to be stored.

  • Parameter – threshold

    • Parameter type – d

    • Omittable – False

  • Parameter – Unit

    • Parameter type – s

    • Omittable – True

    • Default value – keV

    • Candidates – eV keV MeV GeV TeV PeV meV J electronvolt kiloelectronvolt megaelectronvolt gigaelectronvolt teraelectronvolt petaelectronvolt millielectronVolt joule

/RMG/Output/Scintillator/AddDetectorForEdepThreshold#

Take this detector into account for the filtering by /EdepThreshold.

  • Parameter – det_uid

    • Parameter type – i

    • Omittable – False

/RMG/Output/Scintillator/StoreSinglePrecisionPosition#

Use float32 (instead of float64) for position output.

  • Parameter – value

    • Parameter type – b

    • Omittable – False

/RMG/Output/Scintillator/StoreSinglePrecisionEnergy#

Use float32 (instead of float64) for energy output.

  • Parameter – value

    • Parameter type – b

    • Omittable – False

/RMG/Output/IsotopeFilter/#

Commands for filtering event out by created isotopes.

Commands:

  • AddIsotope – Add an isotope to the list. Only events that have a track with this isotope at any point in time will be persisted.

  • DiscardPhotonsIfIsotopeNotProduced – Discard optical photons (before simulating them), if the specified isotopes had not been produced in the same event.

/RMG/Output/IsotopeFilter/AddIsotope#

Add an isotope to the list. Only events that have a track with this isotope at any point in time will be persisted.

  • Parameter – A

    • Parameter type – i

    • Omittable – False

  • Parameter – Z

    • Parameter type – i

    • Omittable – False

/RMG/Output/IsotopeFilter/DiscardPhotonsIfIsotopeNotProduced#

Discard optical photons (before simulating them), if the specified isotopes had not been produced in the same event.

Note

If another output scheme also requests the photons to be discarded, the isotope filter does not force the photons to be simulated.

  • Parameter – value

    • Parameter type – b

    • Omittable – False

/RMG/Output/Track/#

Commands for controlling output of track vertices.

Commands:

  • AddProcessFilter – Only include tracks created by this process.

  • AddParticleFilter – Only include tracks with this particle.

  • SetEnergyFilter – Only include tracks with kinetic energy above this threshold.

  • StoreSinglePrecisionPosition – Use float32 (instead of float64) for position output.

  • StoreSinglePrecisionEnergy – Use float32 (instead of float64) for energy output.

/RMG/Output/Track/AddProcessFilter#

Only include tracks created by this process.

  • Parameter – process

    • Parameter type – s

    • Omittable – False

/RMG/Output/Track/AddParticleFilter#

Only include tracks with this particle.

  • Parameter – pdgid

    • Parameter type – i

    • Omittable – False

/RMG/Output/Track/SetEnergyFilter#

Only include tracks with kinetic energy above this threshold.

  • Parameter – energy

    • Parameter type – d

    • Omittable – False

/RMG/Output/Track/StoreSinglePrecisionPosition#

Use float32 (instead of float64) for position output.

  • Parameter – value

    • Parameter type – b

    • Omittable – False

/RMG/Output/Track/StoreSinglePrecisionEnergy#

Use float32 (instead of float64) for energy output.

  • Parameter – value

    • Parameter type – b

    • Omittable – False

/RMG/Processes/#

Commands for controlling physics processes

Sub-directories:

  • /RMG/Processes/Stepping/ – Commands for controlling physics processes

Commands:

  • Realm – Set simulation realm (cut values for particles in (sensitive) detector

  • OpticalPhysics – Add optical processes to the physics list

  • OpticalPhysicsMaxOneWLSPhoton – Use a custom wavelegth shifting process that produces at maximum one secondary photon.

  • LowEnergyEMPhysics – Add low energy electromagnetic processes to the physics list

  • HadronicPhysics – Add hadronic processes to the physics list

  • ThermalScattering – Use thermal scattering cross sections for neutrons

  • EnableGammaAngularCorrelation – Set correlated gamma emission flag

  • GammaTwoJMAX – Set max 2J for sampling of angular correlations

  • StoreICLevelData – Store e- internal conversion data

  • UseGrabmayrsGammaCascades – Use custom RMGNeutronCapture to apply Grabmayrs gamma cascades.

/RMG/Processes/Realm#

Set simulation realm (cut values for particles in (sensitive) detector

  • Parameter – realm

    • Parameter type – s

    • Omittable – False

    • Candidates – DoubleBetaDecay DarkMatter CosmicRays LArScintillation

/RMG/Processes/OpticalPhysics#

Add optical processes to the physics list

  • Parameter – value

    • Parameter type – b

    • Omittable – False

/RMG/Processes/OpticalPhysicsMaxOneWLSPhoton#

Use a custom wavelegth shifting process that produces at maximum one secondary photon.

  • Parameter – value

    • Parameter type – b

    • Omittable – False

/RMG/Processes/LowEnergyEMPhysics#

Add low energy electromagnetic processes to the physics list

  • Parameter – arg0

    • Parameter type – s

    • Omittable – False

    • Default value – Livermore

    • Candidates – Option1 Option2 Option3 Option4 Penelope Livermore LivermorePolarized None

/RMG/Processes/HadronicPhysics#

Add hadronic processes to the physics list

  • Parameter – arg0

    • Parameter type – s

    • Omittable – False

    • Default value – Shielding

    • Candidates – QGSP_BIC_HP QGSP_BERT_HP FTFP_BERT_HP Shielding None

/RMG/Processes/ThermalScattering#

Use thermal scattering cross sections for neutrons

  • Parameter – arg0

    • Parameter type – b

    • Omittable – False

    • Candidates – 0 1

/RMG/Processes/EnableGammaAngularCorrelation#

Set correlated gamma emission flag

  • Parameter – arg0

    • Parameter type – b

    • Omittable – False

    • Candidates – 0 1

/RMG/Processes/GammaTwoJMAX#

Set max 2J for sampling of angular correlations

  • Range of parameters – x > 0

  • Parameter – x

    • Parameter type – i

    • Omittable – False

/RMG/Processes/StoreICLevelData#

Store e- internal conversion data

  • Parameter – arg0

    • Parameter type – b

    • Omittable – False

    • Candidates – 0 1

/RMG/Processes/UseGrabmayrsGammaCascades#

Use custom RMGNeutronCapture to apply Grabmayrs gamma cascades.

  • Parameter – value

    • Parameter type – b

    • Omittable – False

/RMG/Processes/Stepping/#

Commands for controlling physics processes

Commands:

  • DaughterNucleusMaxLifetime – Determines which unstable daughter nuclei will be killed, if they are at rest, depending on their lifetime.

  • ResetInitialDecayTime – If the initial step is a radioactive decay, reset the global time of all its secondary tracks to 0.

  • LargeGlobalTimeUncertaintyWarning – Warn if the global times of tracks get too large to provide the requested time uncertainty.

/RMG/Processes/Stepping/DaughterNucleusMaxLifetime#

Determines which unstable daughter nuclei will be killed, if they are at rest, depending on their lifetime.

This applies to the defined lifetime of the nucleus, and not on the sampled actual halflife of the simulated particle.

Set to -1 to disable this feature.

  • Parameter – max_lifetime

    • Parameter type – d

    • Omittable – False

    • Default value – -1

  • Parameter – Unit

    • Parameter type – s

    • Omittable – True

    • Default value – us

    • Candidates – s ms us ns ps min h d y second millisecond microsecond nanosecond picosecond minute hour day year

/RMG/Processes/Stepping/ResetInitialDecayTime#

If the initial step is a radioactive decay, reset the global time of all its secondary tracks to 0.

  • Parameter – value

    • Parameter type – b

    • Omittable – False

    • Default value – true

/RMG/Processes/Stepping/LargeGlobalTimeUncertaintyWarning#

Warn if the global times of tracks get too large to provide the requested time uncertainty.

  • Parameter – value

    • Parameter type – d

    • Omittable – False

    • Default value – 1

  • Parameter – Unit

    • Parameter type – s

    • Omittable – True

    • Default value – us

    • Candidates – s ms us ns ps min h d y second millisecond microsecond nanosecond picosecond minute hour day year

/RMG/Geometry/#

Commands for controlling geometry definitions

Commands:

  • GDMLDisableOverlapCheck – Disable the automatic overlap check after loading a GDML file

  • GDMLOverlapCheckNumPoints – Change the number of points sampled for overlap checks

  • IncludeGDMLFile – Use GDML file for geometry definition

  • PrintListOfLogicalVolumes – Print list of defined logical volumes

  • PrintListOfPhysicalVolumes – Print list of defined physical volumes

  • RegisterDetector – register a sensitive detector

/RMG/Geometry/GDMLDisableOverlapCheck#

Disable the automatic overlap check after loading a GDML file

  • Parameter – value

    • Parameter type – b

    • Omittable – False

/RMG/Geometry/GDMLOverlapCheckNumPoints#

Change the number of points sampled for overlap checks

  • Parameter – value

    • Parameter type – i

    • Omittable – False

/RMG/Geometry/IncludeGDMLFile#

Use GDML file for geometry definition

  • Parameter – filename

    • Parameter type – s

    • Omittable – False

/RMG/Geometry/PrintListOfLogicalVolumes#

Print list of defined logical volumes

/RMG/Geometry/PrintListOfPhysicalVolumes#

Print list of defined physical volumes

/RMG/Geometry/RegisterDetector#

register a sensitive detector

  • Parameter – type – Detector type

    • Parameter type – s

    • Omittable – False

    • Candidates – Germanium Optical Scintillator

  • Parameter – pv_name – Detector physical volume

    • Parameter type – s

    • Omittable – False

  • Parameter – uid – unique detector id

    • Parameter type – i

    • Omittable – False

  • Parameter – copy_nr – copy nr (default 0)

    • Parameter type – i

    • Omittable – True

    • Default value – 0

  • Parameter – allow_id_reuse – append this volume to a previously allocated unique detector id, instead of erroring out.

    • Parameter type – b

    • Omittable – True

    • Default value – false

/RMG/Generator/#

Commands for controlling generators

Sub-directories:

  • /RMG/Generator/MUSUNCosmicMuons/ – Commands for controlling the MUSUN µ generator

  • /RMG/Generator/CosmicMuons/ – Commands for controlling the µ generator

  • /RMG/Generator/FromFile/ – Commands for controlling reading event data from file

  • /RMG/Generator/Confinement/ – Commands for controlling primary confinement

Commands:

  • Confine – Select primary confinement strategy

  • Select – Select event generator

/RMG/Generator/Confine#

Select primary confinement strategy

  • Parameter – strategy

    • Parameter type – s

    • Omittable – False

    • Candidates – UnConfined Volume FromFile

/RMG/Generator/Select#

Select event generator

  • Parameter – generator

    • Parameter type – s

    • Omittable – False

    • Candidates – G4gun GPS BxDecay0 FromFile CosmicMuons MUSUNCosmicMuons UserDefined Undefined

/RMG/Generator/MUSUNCosmicMuons/#

Commands for controlling the MUSUN µ generator

Commands:

  • SetMUSUNFile – Set the MUSUN input file

/RMG/Generator/MUSUNCosmicMuons/SetMUSUNFile#

Set the MUSUN input file

  • Parameter – MUSUNFileName

    • Parameter type – s

    • Omittable – False

/RMG/Generator/CosmicMuons/#

Commands for controlling the µ generator

Commands:

  • SkyShape – Geometrical shape of the µ generation surface

  • SkyPlaneSize – Length of the side of the sky, if it has a planar shape

  • SkyPlaneHeight – Height of the sky, if it has a planar shape

  • MomentumMin – Minimum momentum of the generated muon

  • MomentumMax – Maximum momentum of the generated muon

  • ThetaMin – Minimum azimutal angle of the generated muon momentum

  • ThetaMax – Maximum azimutal angle of the generated muon momentum

  • PhiMin – Minimum zenith angle of the generated muon momentum

  • PhiMax – Maximum zenith angle of the generated muon momentum

  • SpherePositionThetaMin – Minimum azimutal angle of the generated muon position on the sphere

  • SpherePositionThetaMax – Maximum azimutal angle of the generated muon position on the sphere

  • SpherePositionPhiMin – Minimum zenith angle of the generated muon position on the sphere

  • SpherePositionPhiMax – Maximum zenith angle of the generated muon position on the sphere

/RMG/Generator/CosmicMuons/SkyShape#

Geometrical shape of the µ generation surface

  • Parameter – shape

    • Parameter type – s

    • Omittable – False

    • Candidates – Plane Sphere

/RMG/Generator/CosmicMuons/SkyPlaneSize#

Length of the side of the sky, if it has a planar shape

  • Range of parameters – l > 0

  • Parameter – l

    • Parameter type – d

    • Omittable – False

  • Parameter – Unit

    • Parameter type – s

    • Omittable – True

    • Default value – m

    • Candidates – pc km m cm mm um nm Ang fm parsec kilometer meter centimeter millimeter micrometer nanometer angstrom fermi

/RMG/Generator/CosmicMuons/SkyPlaneHeight#

Height of the sky, if it has a planar shape

  • Range of parameters – l > 0

  • Parameter – l

    • Parameter type – d

    • Omittable – False

  • Parameter – Unit

    • Parameter type – s

    • Omittable – True

    • Default value – m

    • Candidates – pc km m cm mm um nm Ang fm parsec kilometer meter centimeter millimeter micrometer nanometer angstrom fermi

/RMG/Generator/CosmicMuons/MomentumMin#

Minimum momentum of the generated muon

  • Range of parameters – p >= 0 && p < 1000

  • Parameter – p

    • Parameter type – d

    • Omittable – False

  • Parameter – Unit

    • Parameter type – s

    • Omittable – True

    • Default value – GeV/c

    • Candidates – eV/c keV/c MeV/c GeV/c TeV/c eV/c keV/c MeV/c GeV/c TeV/c

/RMG/Generator/CosmicMuons/MomentumMax#

Maximum momentum of the generated muon

  • Range of parameters – p > 0 && p <= 1000

  • Parameter – p

    • Parameter type – d

    • Omittable – False

  • Parameter – Unit

    • Parameter type – s

    • Omittable – True

    • Default value – GeV/c

    • Candidates – eV/c keV/c MeV/c GeV/c TeV/c eV/c keV/c MeV/c GeV/c TeV/c

/RMG/Generator/CosmicMuons/ThetaMin#

Minimum azimutal angle of the generated muon momentum

  • Range of parameters – a >= 0 && a < 90

  • Parameter – a

    • Parameter type – d

    • Omittable – False

  • Parameter – Unit

    • Parameter type – s

    • Omittable – True

    • Default value – deg

    • Candidates – rad mrad deg radian milliradian degree

/RMG/Generator/CosmicMuons/ThetaMax#

Maximum azimutal angle of the generated muon momentum

  • Range of parameters – a > 0 && a <= 90

  • Parameter – a

    • Parameter type – d

    • Omittable – False

  • Parameter – Unit

    • Parameter type – s

    • Omittable – True

    • Default value – deg

    • Candidates – rad mrad deg radian milliradian degree

/RMG/Generator/CosmicMuons/PhiMin#

Minimum zenith angle of the generated muon momentum

  • Range of parameters – a >= 0 && a < 360

  • Parameter – a

    • Parameter type – d

    • Omittable – False

  • Parameter – Unit

    • Parameter type – s

    • Omittable – True

    • Default value – deg

    • Candidates – rad mrad deg radian milliradian degree

/RMG/Generator/CosmicMuons/PhiMax#

Maximum zenith angle of the generated muon momentum

  • Range of parameters – a > 0 && a <= 360

  • Parameter – a

    • Parameter type – d

    • Omittable – False

  • Parameter – Unit

    • Parameter type – s

    • Omittable – True

    • Default value – deg

    • Candidates – rad mrad deg radian milliradian degree

/RMG/Generator/CosmicMuons/SpherePositionThetaMin#

Minimum azimutal angle of the generated muon position on the sphere

  • Range of parameters – a >= 0 && a < 90

  • Parameter – a

    • Parameter type – d

    • Omittable – False

  • Parameter – Unit

    • Parameter type – s

    • Omittable – True

    • Default value – deg

    • Candidates – rad mrad deg radian milliradian degree

/RMG/Generator/CosmicMuons/SpherePositionThetaMax#

Maximum azimutal angle of the generated muon position on the sphere

  • Range of parameters – a > 0 && a <= 90

  • Parameter – a

    • Parameter type – d

    • Omittable – False

  • Parameter – Unit

    • Parameter type – s

    • Omittable – True

    • Default value – deg

    • Candidates – rad mrad deg radian milliradian degree

/RMG/Generator/CosmicMuons/SpherePositionPhiMin#

Minimum zenith angle of the generated muon position on the sphere

  • Range of parameters – a >= 0 && a < 360

  • Parameter – a

    • Parameter type – d

    • Omittable – False

  • Parameter – Unit

    • Parameter type – s

    • Omittable – True

    • Default value – deg

    • Candidates – rad mrad deg radian milliradian degree

/RMG/Generator/CosmicMuons/SpherePositionPhiMax#

Maximum zenith angle of the generated muon position on the sphere

  • Range of parameters – a > 0 && a <= 360

  • Parameter – a

    • Parameter type – d

    • Omittable – False

  • Parameter – Unit

    • Parameter type – s

    • Omittable – True

    • Default value – deg

    • Candidates – rad mrad deg radian milliradian degree

/RMG/Generator/FromFile/#

Commands for controlling reading event data from file

Commands:

  • FileName – Set name of the file containing vertex kinetics for the next run. See the documentation for a specification of the format.

  • NtupleDirectory – Change the default input directory/group for ntuples.

/RMG/Generator/FromFile/FileName#

Set name of the file containing vertex kinetics for the next run. See the documentation for a specification of the format.

  • Parameter – filename

    • Parameter type – s

    • Omittable – False

/RMG/Generator/FromFile/NtupleDirectory#

Change the default input directory/group for ntuples.

Note

this option only has an effect for LH5 or HDF5 input files.

  • Parameter – nt_directory

    • Parameter type – s

    • Omittable – False

    • Default value – vtx

/RMG/Generator/Confinement/#

Commands for controlling primary confinement

Sub-directories:

  • /RMG/Generator/Confinement/Physical/ – Commands for setting physical volumes up for primary confinement

  • /RMG/Generator/Confinement/Geometrical/ – Commands for setting geometrical volumes up for primary confinement

  • /RMG/Generator/Confinement/FromFile/ – Commands for controlling reading event vertex positions from file

Commands:

  • Reset – Reset all parameters of vertex confinement, so that it can be reconfigured.

  • SampleOnSurface – If true (or omitted argument), sample on the surface of solids

  • SamplingMode – Select sampling mode for volume confinement

  • FirstSamplingVolume – Select the type of volume which will be sampled first for intersections

  • MaxSamplingTrials – Set maximum number of attempts for sampling primary positions in a volume

  • SurfaceSampleMaxIntersections – Set maximum number of intersections of a line with the surface. Note: can be set to an overestimate.

  • ForceContainmentCheck – If true (or omitted argument), perform a containment check even after sampling from a natively sampleable object. This is only an extra sanity check that does not alter the behaviour.

/RMG/Generator/Confinement/Reset#

Reset all parameters of vertex confinement, so that it can be reconfigured.

/RMG/Generator/Confinement/SampleOnSurface#

If true (or omitted argument), sample on the surface of solids

  • Parameter – flag

    • Parameter type – b

    • Omittable – True

/RMG/Generator/Confinement/SamplingMode#

Select sampling mode for volume confinement

  • Parameter – mode

    • Parameter type – s

    • Omittable – False

    • Candidates – IntersectPhysicalWithGeometrical UnionAll SubtractGeometrical

/RMG/Generator/Confinement/FirstSamplingVolume#

Select the type of volume which will be sampled first for intersections

  • Parameter – type

    • Parameter type – s

    • Omittable – False

    • Candidates – Physical Geometrical Unset

/RMG/Generator/Confinement/MaxSamplingTrials#

Set maximum number of attempts for sampling primary positions in a volume

  • Range of parameters – N > 0

  • Parameter – N

    • Parameter type – i

    • Omittable – False

/RMG/Generator/Confinement/SurfaceSampleMaxIntersections#

Set maximum number of intersections of a line with the surface. Note: can be set to an overestimate.

  • Range of parameters – N > 1

  • Parameter – N

    • Parameter type – i

    • Omittable – False

/RMG/Generator/Confinement/ForceContainmentCheck#

If true (or omitted argument), perform a containment check even after sampling from a natively sampleable object. This is only an extra sanity check that does not alter the behaviour.

  • Parameter – flag

    • Parameter type – b

    • Omittable – True

/RMG/Generator/Confinement/Physical/#

Commands for setting physical volumes up for primary confinement

Commands:

  • AddVolume – Add physical volume(s) to sample primaries from.

/RMG/Generator/Confinement/Physical/AddVolume#

Add physical volume(s) to sample primaries from.

  • Parameter – regex

    • Parameter type – s

    • Omittable – False

  • Parameter – copy_nr_regex

    • Parameter type – s

    • Omittable – True

/RMG/Generator/Confinement/Geometrical/#

Commands for setting geometrical volumes up for primary confinement

Sub-directories:

  • /RMG/Generator/Confinement/Geometrical/Sphere/ – Commands for setting geometrical dimensions of a sampling sphere

  • /RMG/Generator/Confinement/Geometrical/Cylinder/ – Commands for setting geometrical dimensions of a sampling cylinder

  • /RMG/Generator/Confinement/Geometrical/Box/ – Commands for setting geometrical dimensions of a sampling box

Commands:

  • AddSolid – Add geometrical solid to sample primaries from

  • AddExcludedSolid – Add geometrical solid to exclude samples from

  • CenterPositionX – Set center position (X coordinate)

  • CenterPositionY – Set center position (Y coordinate)

  • CenterPositionZ – Set center position (Z coordinate)

/RMG/Generator/Confinement/Geometrical/AddSolid#

Add geometrical solid to sample primaries from

  • Parameter – solid

    • Parameter type – s

    • Omittable – False

    • Candidates – Sphere Cylinder Box

/RMG/Generator/Confinement/Geometrical/AddExcludedSolid#

Add geometrical solid to exclude samples from

  • Parameter – solid

    • Parameter type – s

    • Omittable – False

    • Candidates – Sphere Cylinder Box

/RMG/Generator/Confinement/Geometrical/CenterPositionX#

Set center position (X coordinate)

  • Parameter – value

    • Parameter type – d

    • Omittable – False

  • Parameter – Unit

    • Parameter type – s

    • Omittable – True

    • Default value – cm

    • Candidates – pc km m cm mm um nm Ang fm parsec kilometer meter centimeter millimeter micrometer nanometer angstrom fermi

/RMG/Generator/Confinement/Geometrical/CenterPositionY#

Set center position (Y coordinate)

  • Parameter – value

    • Parameter type – d

    • Omittable – False

  • Parameter – Unit

    • Parameter type – s

    • Omittable – True

    • Default value – cm

    • Candidates – pc km m cm mm um nm Ang fm parsec kilometer meter centimeter millimeter micrometer nanometer angstrom fermi

/RMG/Generator/Confinement/Geometrical/CenterPositionZ#

Set center position (Z coordinate)

  • Parameter – value

    • Parameter type – d

    • Omittable – False

  • Parameter – Unit

    • Parameter type – s

    • Omittable – True

    • Default value – cm

    • Candidates – pc km m cm mm um nm Ang fm parsec kilometer meter centimeter millimeter micrometer nanometer angstrom fermi

/RMG/Generator/Confinement/Geometrical/Sphere/#

Commands for setting geometrical dimensions of a sampling sphere

Commands:

  • InnerRadius – Set inner radius

  • OuterRadius – Set outer radius

/RMG/Generator/Confinement/Geometrical/Sphere/InnerRadius#

Set inner radius

  • Range of parameters – L >= 0

  • Parameter – L

    • Parameter type – d

    • Omittable – False

  • Parameter – Unit

    • Parameter type – s

    • Omittable – True

    • Default value – cm

    • Candidates – pc km m cm mm um nm Ang fm parsec kilometer meter centimeter millimeter micrometer nanometer angstrom fermi

/RMG/Generator/Confinement/Geometrical/Sphere/OuterRadius#

Set outer radius

  • Range of parameters – L > 0

  • Parameter – L

    • Parameter type – d

    • Omittable – False

  • Parameter – Unit

    • Parameter type – s

    • Omittable – True

    • Default value – cm

    • Candidates – pc km m cm mm um nm Ang fm parsec kilometer meter centimeter millimeter micrometer nanometer angstrom fermi

/RMG/Generator/Confinement/Geometrical/Cylinder/#

Commands for setting geometrical dimensions of a sampling cylinder

Commands:

  • InnerRadius – Set inner radius

  • OuterRadius – Set outer radius

  • Height – Set height

  • StartingAngle – Set starting angle

  • SpanningAngle – Set spanning angle

/RMG/Generator/Confinement/Geometrical/Cylinder/InnerRadius#

Set inner radius

  • Range of parameters – L >= 0

  • Parameter – L

    • Parameter type – d

    • Omittable – False

  • Parameter – Unit

    • Parameter type – s

    • Omittable – True

    • Default value – cm

    • Candidates – pc km m cm mm um nm Ang fm parsec kilometer meter centimeter millimeter micrometer nanometer angstrom fermi

/RMG/Generator/Confinement/Geometrical/Cylinder/OuterRadius#

Set outer radius

  • Range of parameters – L > 0

  • Parameter – L

    • Parameter type – d

    • Omittable – False

  • Parameter – Unit

    • Parameter type – s

    • Omittable – True

    • Default value – cm

    • Candidates – pc km m cm mm um nm Ang fm parsec kilometer meter centimeter millimeter micrometer nanometer angstrom fermi

/RMG/Generator/Confinement/Geometrical/Cylinder/Height#

Set height

  • Range of parameters – L > 0

  • Parameter – L

    • Parameter type – d

    • Omittable – False

  • Parameter – Unit

    • Parameter type – s

    • Omittable – True

    • Default value – cm

    • Candidates – pc km m cm mm um nm Ang fm parsec kilometer meter centimeter millimeter micrometer nanometer angstrom fermi

/RMG/Generator/Confinement/Geometrical/Cylinder/StartingAngle#

Set starting angle

  • Parameter – A

    • Parameter type – d

    • Omittable – False

  • Parameter – Unit

    • Parameter type – s

    • Omittable – True

    • Default value – deg

    • Candidates – rad mrad deg radian milliradian degree

/RMG/Generator/Confinement/Geometrical/Cylinder/SpanningAngle#

Set spanning angle

  • Parameter – A

    • Parameter type – d

    • Omittable – False

  • Parameter – Unit

    • Parameter type – s

    • Omittable – True

    • Default value – deg

    • Candidates – rad mrad deg radian milliradian degree

/RMG/Generator/Confinement/Geometrical/Box/#

Commands for setting geometrical dimensions of a sampling box

Commands:

  • XLength – Set X length

  • YLength – Set Y length

  • ZLength – Set Z length

/RMG/Generator/Confinement/Geometrical/Box/XLength#

Set X length

  • Range of parameters – L > 0

  • Parameter – L

    • Parameter type – d

    • Omittable – False

  • Parameter – Unit

    • Parameter type – s

    • Omittable – True

    • Default value – cm

    • Candidates – pc km m cm mm um nm Ang fm parsec kilometer meter centimeter millimeter micrometer nanometer angstrom fermi

/RMG/Generator/Confinement/Geometrical/Box/YLength#

Set Y length

  • Range of parameters – L > 0

  • Parameter – L

    • Parameter type – d

    • Omittable – False

  • Parameter – Unit

    • Parameter type – s

    • Omittable – True

    • Default value – cm

    • Candidates – pc km m cm mm um nm Ang fm parsec kilometer meter centimeter millimeter micrometer nanometer angstrom fermi

/RMG/Generator/Confinement/Geometrical/Box/ZLength#

Set Z length

  • Range of parameters – L > 0

  • Parameter – L

    • Parameter type – d

    • Omittable – False

  • Parameter – Unit

    • Parameter type – s

    • Omittable – True

    • Default value – cm

    • Candidates – pc km m cm mm um nm Ang fm parsec kilometer meter centimeter millimeter micrometer nanometer angstrom fermi

/RMG/Generator/Confinement/FromFile/#

Commands for controlling reading event vertex positions from file

Commands:

  • FileName – Set name of the file containing vertex positions for the next run. See the documentation for a specification of the format.

  • NtupleDirectory – Change the default input directory/group for ntuples.

/RMG/Generator/Confinement/FromFile/FileName#

Set name of the file containing vertex positions for the next run. See the documentation for a specification of the format.

  • Parameter – filename

    • Parameter type – s

    • Omittable – False

/RMG/Generator/Confinement/FromFile/NtupleDirectory#

Change the default input directory/group for ntuples.

Note

this option only has an effect for LH5 or HDF5 input files.

  • Parameter – nt_directory

    • Parameter type – s

    • Omittable – False

    • Default value – vtx

/RMG/GrabmayrGammaCascades/#

Control Peters gamma cascade model

Commands:

  • SetGammaCascadeRandomStartLocation – Set the whether the start location in the gamma cascade file is random or not

  • SetGammaCascadeFile – Set a gamma cascade file for neutron capture on a specified isotope

/RMG/GrabmayrGammaCascades/SetGammaCascadeRandomStartLocation#

Set the whether the start location in the gamma cascade file is random or not

0 = don’t

1 = do

  • Parameter – arg0

    • Parameter type – i

    • Omittable – False

    • Default value – 0

    • Candidates – 0 1

/RMG/GrabmayrGammaCascades/SetGammaCascadeFile#

Set a gamma cascade file for neutron capture on a specified isotope

  • Parameter – Z – Z of isotope

    • Parameter type – i

    • Omittable – False

  • Parameter – A – A of isotope

    • Parameter type – i

    • Omittable – False

  • Parameter – file – /path/to/file of gamma cascade

    • Parameter type – s

    • Omittable – False