GEMC options




options. This table is produced with the option: -help-html
Category Option Help
INTEGRATEDDGT
De-activates integrated digitized output for system(s). Example: -INTEGRATEDDGT="DC, TOF"
control CHECK_OVERLAPS
Checks Overlapping Volumes:
      1.  Check Overlaps at Construction Time
      2.  Check Overlaps based on standard lines grid setup
      3.  Check Overlaps by shooting lines according to a cylindrical pattern
control DAWN_N
Number of events to be displayed with the DAWN driver (also activate the DAWN driver).
control ENERGY_CUT
Set an energy cut in MeV below which no particle will be tracked further. -1. turns this off.
control EVN
Initial Event Number.
control EXEC_MACRO
Executes commands in macro file.
control GUIPOS
Specify the position of the QT display window. Default is at 50, 50 
control HIGH_RES
Use High Resolution Graphics
control HIT_PROCESS_LIST
Registers Hit Process Routines. Can register multiple experiments, separated by space, e.v. "clas12 aprime"
      clas12.  CLAS12 hit process routines (default)
      aprime.  aprime hit process routines
      gluex.   GlueX  hit process routines
control MAX_X_POS
Max X Position in millimeters. Beyond this the track will be killed
control MAX_Y_POS
Max Y Position in millimeters. Beyond this the track will be killed
control MAX_Z_POS
Max Z Position in millimeters. Beyond this the track will be killed
control QTSTYLE
Sets the GUI Style. Available options: 
      - QCleanlooksStyle 
      - QMacStyle 
      - QPlastiqueStyle 
      - QWindowsStyle 
      - QMotifStyle
control RANDOM
Random Engine Initialization. The argument (seed) can be an integer or the string TIME.
control RECORD_MIRRORS
Set to one if you want to save mirror hits in the output. Default is 0.
control RECORD_PASSBY
Set to one if you want to save zero energy hits in the output. Default is 0.
control RFSETUP
Radio-frequency signal. This are a minium of 2 parameters for one given RF signal:
      1. radioFrequency (GHz)
      2. radioInterval (number of bunches)
     Any additional parameter (in ns) will add an RF signal with that time distance from the original.
     Example1:  250MHz (0.25 GHz) RF signal, 1 output, output frequency is 50 bunches: 
      -RFSETUP="0.25, 50" 
     Example2: two 500MHz (0.5 GHz) RF signals, they are separated by 30 ns and both output frequency is 80 bunches: 
      -RFSETUP="0.5, 80, 30" 
control RFSTART
Radio-frequency time model. Available options are:
      "eventVertex, 0, 0, 0" (default): the RF time is the event start time + the light time-distance of the first particle from the point (0,0,0)
      "eventTime".....................: the RF time is identical to the event start time
control RUNNO
Run Number. Controls the geometry and calibration parameters. Default is 1
control RUN_WEIGHTS
Simulate events based on run based conditions table (text file)
      The text file must have two columns, run# and weight.
      For example:

        11 0.1
        12 0.7
        13 0.2

      Will simulate 10% of events with run number 11 conditions, 70% run 12 and 20% run 13.
control SAVE_ALL_MOTHERS
Set to 1 to save mother vertex and pid infos in output. High Memory Usage. Default is 0.
Set to 2 to save in LUND format particles that generate hits (unless mother also generate hits)
Set to 3 to save in LUND format particles that generate hits (even if mother also generate hits)
control USE_GUI
 GUI switch
      0.  Don't use the graphical interface
      1.  OGLSQt (OGL, OGLS, OGLSQt)
      2.  OGLIQt (OGLI, OGLIQt) 
control gcard
gemc card file.
control geometry
Specify the size of the QT display window. Default '600x600' 
general DF
Selects Detector System and Factory type. 
      Example:
        -DF="CTOF, MYSQL"  selects the MYSQL factory for the detector CTOF
generator ALIGN_ZAXIS
Align z axis to a custom direction. Options:
      - "beamp"  aligns z axis to the beam directions specified by BEAM_P.
      - "custom, theta*unit, phi*unit" aligns z axis to a custom direction, changes BEAM_P reference frame.
generator BEAM_P
Beam particle, momentum, angles (in respect of z-axis). 
      Example: -BEAM_P="e-, 6*GeV, 15*deg, 20*deg" sets 6 GeV electrons 15 degrees in theta, 20 degrees in phi. 
      Use -BEAM_P="show_all" to print the list of G4 supported particles.
      An optional string "KE" can be appended to this option to specify Kinetic energy instead of momentum.
generator BEAM_V
Primary Particle Vertex. Example: -BEAM_V="(0, 0, -20)cm". 
generator COSMICAREA
Target (x,y,z) location and radius of area of interest
generator COSMICRAYS
Cosmic Generator. The model has a (cos(theta), p) probability function:

              a^(b*cos(theta))/(c*p^2). 

      The COSMICRAYS option sets the parameters and the momentum range in the last two numbers. 
      By default the parameters are: 
       a = 55.6: 
       b = 1.04: 
       c = 64: 
      One can use the defaults or set the pars with the options: 
      example 1: -COSMICRAYS="default, 1, 10" will use the default parameterization, and momentum range [1-10] GeV 
      example 2: -COSMICRAYS="55, 2, 66, 3, 4" will set the parameterization, and momentum range [3-4] GeV 
generator EVTN
Starting Event Number
generator FORCE_MUON_RADIATIVE_DECAY
Force muon radiative decay
generator INPUT_GEN_FILE
Generator Input. Current availables file formats:
      LUND. 
      example: -INPUT_GEN_FILE="LUND, input.dat" or -INPUT_GEN_FILE="StdHEP, darkphoton.stdhep" 
generator ION_P
Primary particle is an ion. Sets Z, A and Charge of the primary particle. Setting the charge is optional. 
      Example 1: -ION_P="6 12" sets the Z to 6, A to 12. Charge will be Z. 
      Example 2: -ION_P="6 12 -4" sets the Z to 6, A to 12, and charge to -4. 
      Notice: BEAM_P still sets the particle momentum, and its type must be GenericIon
generator LUMI2_SPREAD_P
Spread Luminosity Particle 2 energy and angles (in respect of z-axis). 
      Example: -LUMI2_SPREAD_P="0*GeV, 10*deg, 20*deg" spreads 10 degrees in theta, 20 degrees in phi. 
      If the word flat is added to the option, theta is flat instead of cos(theta). 
generator LUMI_SPREAD_P
Spread Luminosity Particle energy and angles (in respect of z-axis). 
      Example: -LUMI_SPREAD_P="0*GeV, 10*deg, 20*deg" spreads 10 degrees in theta, 20 degrees in phi. 
      If the word flat is added to the option, theta is flat instead of cos(theta). 
generator MERGE_BGHITS
ASCII file to merge background hits
      example: -MERGE_BGHITS="background.dat" 
generator MERGE_LUND_BG
LUND Input file to merge background events
      example: -MERGE_LUND_BG="background.dat" 
generator N
Number of events to be simulated.
generator NGENP
Max Number of Generated Particles to save in the Output.
generator POLAR
Primary Particle polarization percentage and angles  (in respect of z-axis). 
      Example: -POLAR="90, 90*deg, 270*deg" sets 90% polarization 90 degrees in theta, 270 degrees in phi. 
      Use -POLAR="show_all" to print the list of G4 supported particles.
generator PROPAGATE_DVERTEXTIME
Calculate propogation time of detached vertex events and fire them at this later time. 
         0: Off (default)
         1: On
generator SKIPNGEN
Skip N events
generator SPREAD_P
Spread Primary Particle energy and angles (in respect of z-axis). 
      Example: -SPREAD_P="0*GeV, 10*deg, 20*deg" spreads 10 degrees in theta, 20 degrees in phi. 
      If the word flat is added as last argument to the option, theta is flat instead of cos(theta). 
      An optional argument "KE" can be appended to this option to specify Kinetic energy instead of momentum.
generator SPREAD_V
Spread Primary Particle Radius, Z position. Example: -SPREAD_V="(0.1, 10)cm". 
generator STEER_BEAM
Steer the beam, and translate the vertex, of an StdHep file by the amount specified in Beam_P, Beam_V, Spread_V 
luminosity LUMI2_EVENT
Luminosity Particle 2 Parameters: number of Particles/Event, Time Between Bunches. The Time Window is specified with the LUMI_EVENT flag
            Example: -LUMI2_EVENT="10000, 2*ns" simulate 10K particles per event at 2ns intervals. 
luminosity LUMI2_P
Luminosity Particle 2, momentum, angles (in respect of z-axis). 
            Example: -LUMI2_P="proton, 1*GeV, 25*deg, 2*deg" sets 1 GeV protons, 25 degrees in theta, 2 degrees in phi. 
            Use -LUMI2_P="show_all" to print the list of G4 supported particles.
luminosity LUMI2_SPREAD_V
Spread Luminosity Particle 2 Radius, Z position. Example: -SPREAD_V="(0.1, 10)cm". 
luminosity LUMI2_V
Luminosity Particle 2 Vertex. Example: -LUMI2_V="(0, 0, -20)cm". 
luminosity LUMI_EVENT
Luminosity Particle Parameters: number of Particles/Event, Time Window, Time Between Bunches
            Example: -LUMI_EVENT="10000, 120*ns, 2*ns" simulate 10K particles per event distributed over 120 ns, at 2ns intervals. 
luminosity LUMI_P
Luminosity Particle, momentum, angles (in respect of z-axis). 
            Example: -LUMI_P="proton, 1*GeV, 25*deg, 2*deg" sets 1 GeV protons, 25 degrees in theta, 2 degrees in phi. 
            Use -LUMI_P="show_all" to print the list of G4 supported particles.
luminosity LUMI_SPREAD_V
Spread Luminosity Particle Radius, Z position. Example: -SPREAD_V="(0.1, 10)cm". 
luminosity LUMI_V
Luminosity Particle Vertex. Example: -LUMI_V="(0, 0, -20)cm". 
mysql DATABASE
Selects mysql Database.
mysql DBHOST
Selects mysql server host name.
mysql DBPORT
Select mysql server port.
mysql DBPSWD
mysql password
mysql DBUSER
Select mysql user name
output ALLRAWS
Activates step-by-step output for system(s). Example: -ALLRAWS="DC, TOF"
output ELECTRONICNOISE
Activates electronic noise routines for system(s). Example: -ELECTRONICNOISE="dc, ftof"
output FASTMCMODE
Activate FASTMC Mode. Possible values: 

       0: No FASTMC (default).
       1: Disable secondaries, disable hit processes.
       2: Disable all physics but transportation, disable hit process.
       10: Disable secondaries, hit processes are enabled.
       20: Disable all physics but transportation, hit processes are enabled.
output FILTER_NULL_VARIABLES
If set to 1, filters out variables with no valuable info in the output.
output INTEGRATEDRAW
Activates integrated geant4 raw output for system(s). Example: -INTEGRATEDRAW="DC, TOF"
output OUTPUT
Type of output, output filename. Supported output: evio, txt. Example: -OUTPUT="evio, out.ev"
output SIGNALVT
Activates voltage (t) output for system(s). Example: -SIGNALVT="DC, TOF"
output TSAMPLING
Sampling time of electronics (typically FADC)
output VTRESOLUTION
Voltage versus time resolution, in ns
physics ACTIVEFIELDS
List of activated fields
physics CHANGEVOLUMEMATERIALTO
Changes a volume material. Usage: -CHANGEVOLUMEMATERIALTO="volume, new material" 
physics DEFAULT_MATERIAL
Default material for missing material field.
physics DISPLACE_FIELDMAP
Displace Magnetic Field map from the lab origin.
      Usage:
      -DISPLACE_FIELDMAP="fieldname, dx*unit, dy*unit, dz*unit"
      Example: -DISPLACE_FIELDMAP="srr-solenoid, 3.5*mm, 0*mm, 0*mm"
physics FIELD_DIR
Magnetic Field Maps Location. 
physics FIELD_PROPERTIES
Mapped field minimum step, integration method, interpolation

      Usage:
      -FIELD_PROPERTIES="fieldname, minStep, integralAlgorithm, (interpolationMethod)"

      Example: -FIELD_PROPERTIES="srr-solenoid, 1*mm, G4ClassicalRK4, linear"

      Available Integration Methods:
       - G4CashKarpRKF45: Fift Order Range Kutta, for very smooth fields
       - G4ClassicalRK4: Fourth Order Range Kutta. Robust for every field.
       - G4SimpleHeum: Third order stepper.
       - G4SimpleRunge: Simplified (second order) Range Kutta (faster).
       - G4ImplicitEuler: Second order stepper, for faster varying fields.
       - G4ExplicitEuler: First order stepper, for rough fields.
       - G4HelixImplicitEuler: Second order, specialized for helix-like trajectories.
       - G4HelixExplicitEuler: First order, specialized for helix-like trajectories.
       - G4HelixSimpleRunge: Second order Range Kutta, specialized for helix-like trajectories.
       - G4NystromRK4: provides accuracy near that of G4ClassicalRK4 with a significantly reduced cost in field evaluation.

       Available Interpolation Methods:
       - none: closest grid point.
       - linear: linear interpolation.

       Note: specifying interpolation method is optional. "linear" is the default.
physics G4FIELDCACHESIZE
Sets Geant4 Magnetic Field Cache Size (in mm) 
physics HALL_DIMENSIONS
(x,y,z) semi-dimensions of the experimental Hall.
physics HALL_FIELD
Magnetic Field of the Hall. 
physics HALL_MATERIAL
Composition of the Experimental Hall. 
            Air normal simulation
            Air_Opt Simulation with Optical Physics
            Vacuum (default)
physics MAX_FIELD_STEP
Sets Maximum Acceptable Step in Magnetic Field (in mm).
physics NO_FIELD
Sets Magnetic Field of a volume to zero. "all" means no magnetic field at all. 
physics PHYSICS
  Physics List. The list is modular. 

     For example, 'STD' would only activate the standard electromagnetic processes, while
     'QGSC_BERT + STD + HP + Optical' would also activate high precision hadronic and optical physics.

     For a complete list, see http://geant4.cern.ch/support/physicsLists/referencePL/referencePL.shtml'

     Available modules:

      Hadronic: 
      The FTF model is based on the FRITIOF description of string excitation and fragmentation.
      - FTFP_BERT
      - FTFP_BERT_HP
      - FTFP_BERT_TRV
      - FTF_BIC

      QGSP is the basic physics list applying the quark gluon string model for high  energy interactions of protons, neutrons, pions, and Kaons and nuclei.
      - QGSC_BERT
      - QGSP_BERT_HP
      - QGSP_BIC
      - QGSP_BIC_HP
      - QGSP_FTFP_BERT

      Electromagnetic: 
      - STD
      - EMV: Designed for HEP productions. Production thresholds are enabled on secondary particles for all EM processes.
      - EMX: Designed for HEP productions. Alternative G4Generator2BS angular generator is used for the bremsstrahlung process.
      - EMY: Higher accuracy of electrons, hadrons and ion tracking without magnetic field
      - EMZ: Higher accuracy of electrons, hadrons and ion tracking. Use the most accurate standard and low-energy models.
      - LIV: Higher accuracy of electrons, hadrons and ion tracking without magnetic field. Livermore model on top of emstandard_opt4.
      - PEN: Higher accuracy of electrons, hadrons and ion tracking without magnetic field. Penelope model on top of emstandard_opt4.
physics PHYS_VERBOSITY
Physics List Verbosity
physics PRODUCTIONCUT
Production cut for root, in mm
physics PRODUCTIONCUTFORVOLUMES
Production cut for volumes (separated by commas), in mm
      Example: "outerMount, taggerInnerShield, 50" will set the production cut for the volumes outerMount and taggerInnerShield to 5cm
physics REMOVESENSITIVITY
Removes a volumes sensitivity. Usage: -REMOVESENSITIVITY=volumename1, volumename2, ... 
physics ROTATE_FIELDMAP
Rotate Magnetic Field map.
      Usage:
      -ROTATE_FIELDMAP="fieldname, alpha*unit, beta*unit, gamma*unit"
      Example: -ROTATE_FIELDMAP="srr-solenoid, 0*deg, 0*deg, 2*deg"
physics SCALE_FIELD
Scales Magnetic Field by a factor.
      Usage:
      -SCALE_FIELD="fieldname, scalefactor"
      Example: -SCALE_FIELD="srr-solenoid, 0.5"
physics SWITCH_MATERIALTO
Switches a material for another. Usage: -SWITCH_MATERIALTO="old, new" 
physics SYNRAD
 Adds Synchrotron Radiation     Possible values:
     0: no Synchrotron Radiation (default)
     1: vacuum Synchrotron Radiation 
     2: material Synchrotron Radiation 
verbosity BANK_VERBOSITY
Controls Bank Log Output.
verbosity CATCH
Catch volumes matching the given string.
verbosity FIELD_VERBOSITY
Controls Electro-Magnetic Fields Log Output:
  0: no log  1: field definitions log  2: max field details
verbosity G4P_VERBOSITY
Controls Physical Volumes Construction Log Output.
verbosity G4TRACK_VERBOSITY
Controls Geant4 Track Verbosity.
verbosity GEN_VERBOSITY
Controls Geant4 Generator Verbosity.
verbosity GEO_VERBOSITY
Controls Geometry Construction Log Output.
verbosity GUI_VERBOSITY
Controls GUI Construction Log Output.
verbosity HIT_VERBOSITY
Controls Hits Log Output. 
verbosity LOG_VERBOSITY
Controls General Log Verbosity.
verbosity MATERIAL_VERBOSITY
Controls Geant4 Material Verbosity.
verbosity MIRROR_VERBOSITY
Controls Mirrors Verbosity.
verbosity PARAMETER_VERBOSITY
Controls Parameters Verbosity.
verbosity PHY_VERBOSITY
Controls Physics List Log Output.
verbosity PRINT_EVENT
-PRINT_EVENT=N: Print Event Number every N events.