eventDispenser_options.cc

Go to the documentation of this file.

// eventDispenser
#include "eventDispenser_options.h"
 
// gemc
#include "gdynamicdigitization_options.h"

 
// namespace to define options
namespace eventDispenser {
// returns array of options definitions
GOptions defineOptions() {
    // Create the module option set. The logger name is used for consistent diagnostics.
    GOptions goptions(EVENTDISPENSER_LOGGER);
 
    // Option: number of events
    std::string help = "Example: -n=200\n";
    goptions.defineOption(GVariable("n", 1, "number of events to process"), help);
 
    // Option: run number
    // Clarify that this is the *event* run number, distinct from -runno (geometry selection)
    // and from the Geant4 internal run id (g4runno, set automatically).
    help = "Run number assigned to the generated events; it is also the key looked up in the\n";
    help += "-run_weights file. This is distinct from -runno, which selects the geometry/conditions\n";
    help += "variation from the database, and from the Geant4 run id g4runno, set automatically.\n \n";
    help += "Example: -run=12\n";
    goptions.defineOption(GVariable("run", 1, "event run number"), help);
 
    // Option: run weights file
    help = "Text file with run number and their weights.\n \n";
    help += guts::GTAB;
    help +=
        "The text file must have two columns: run# and weight. The weight represents the ratio of events desired for a run number.\n";
    help += guts::GTAB;
    help += "For example a \"weights.txt\" file that contains:\n \n";
    help += guts::GTABTAB;
    help += "11 0.1\n";
    help += guts::GTABTAB;
    help += "12 0.7\n";
    help += guts::GTABTAB;
    help += "13 0.2\n \n";
    help += guts::GTAB;
    help += "will simulate 10% of events with run number 11 conditions, 70% for run 12 and 20% for run 13.\n";
 
    goptions.defineOption(
        GVariable("run_weights", std::nullopt, "File with run number and weights"),
        help
    );
 
    // Append options required by the dynamic digitization module.
    goptions += gdynamicdigitization::defineOptions();
 
    return goptions;
}
} // namespace eventDispenser