EventLoaderATLASPix: rename parameters - several are not documented! See #47

src/modules/EventLoaderATLASpix/EventLoaderATLASpix.cpp

@@ -7,21 +7,21 @@ using namespace std;
 EventLoaderATLASpix::EventLoaderATLASpix(Configuration config, std::shared_ptr<Detector> detector)
     : Module(std::move(config), detector), m_detector(detector) {
 
-    m_timewalkCorrectionFactors = m_config.getArray<double>("timewalkCorrectionFactors", std::vector<double>());
+    m_timewalkCorrectionFactors = m_config.getArray<double>("timewalk_correction_factors", std::vector<double>());
 
-    m_inputDirectory = m_config.getPath("inputDirectory");
+    m_inputDirectory = m_config.getPath("input_directory");
 
-    if(m_config.has("calibrationFile")) {
-        m_calibrationFile = m_config.getPath("calibrationFile");
+    if(m_config.has("calibration_file")) {
+        m_calibrationFile = m_config.getPath("calibration_file");
     }
 
-    m_clockCycle = m_config.get<double>("clockCycle", static_cast<double>(Units::convert(6.25, "ns")));
+    m_clockCycle = m_config.get<double>("clock_cycle", static_cast<double>(Units::convert(6.25, "ns")));
 
     // Allow reading of legacy data format using the Karlsruhe readout system:
-    m_legacyFormat = m_config.get<bool>("legacyFormat", false);
+    m_legacyFormat = m_config.get<bool>("legacy_format", false);
 
-    m_startTime = m_config.get<double>("startTime", 0.);
-    m_toaMode = m_config.get<bool>("toaMode", false);
+    m_startTime = m_config.get<double>("start_time", 0.);
+    m_toaMode = m_config.get<bool>("toa_mode", false);
 
     // m_clkdivendM = m_config.get<int>("clkdivend", 0.) + 1;
     m_clkdivend2M = m_config.get<int>("clkdivend2", 0.) + 1;

src/modules/EventLoaderATLASpix/README.md

@@ -12,9 +12,8 @@ The module opens and reads one data file named `data.bin` in the specified input
 This module requires either another event loader of another detector type before which defines the event start and end times (variables `eventStart` and `eventEnd` on the clipboard) or an instance of the Metronome module which provides this information.
 
 ### Parameters
-* `inputDirectory`: Path to the directory containing the `data.bin` file. This path should lead to the directory above the ALTASpix directory, as this string is added to the input directory in the module.
-* `clockCycle`: Period of the clock used to count the trigger timestamps in, defaults to `6.25ns`.
-* `DUT`: Name of the DUT plane.
+* `input_directory`: Path to the directory containing the `data.bin` file. This path should lead to the directory above the ALTASpix directory, as this string is added to the input directory in the module.
+* `clock_cycle`: Period of the clock used to count the trigger timestamps in, defaults to `6.25ns`.
 * `clkdivend2`: Value of clkdivend2 register in ATLASPix specifying the speed of TS2 counter. Default is `0`.
 
 ### Plots produced
@@ -26,5 +25,5 @@ This module requires either another event loader of another detector type before
 ```toml
 [ATLASpixEventLoader]
 DUT = "W0005_H03"
-inputDirectory = /user/data/directory
+input_directory = /user/data/directory
 ```