AliceO2Group
@@ -22,75 +22,77 @@ namespace trd
 {
 namespace constants
 {
-constexpr int NSECTOR = 18;          // the number of sectors
-constexpr int NSTACK = 5;            // the number of stacks per sector
-constexpr int NLAYER = 6;            // the number of layers
-constexpr int NCHAMBERPERSEC = 30;   // the number of chambers per sector
-constexpr int NHCPERSEC = 60;        // the number of half-chambers per sector
-constexpr int MAXCHAMBER = 540;      // the maximum number of installed chambers
-constexpr int MAXHALFCHAMBER = 1080; // the maximum number of installed half-chambers
-constexpr int NCHAMBER = 521;        // the number of chambers actually installed
-constexpr int NHALFCRU = 72;         // the number of half cru (link bundles)
-constexpr int NLINKSPERHALFCRU = 15; // the number of links per half cru or cru end point.
-constexpr int NLINKSPERCRU = 30;     // the number of links per CRU (two CRUs serve one supermodule)
-constexpr int NCRU = 36;             // the number of CRU we have
-constexpr int NFLP = 12;             // the number of FLP we have.
-constexpr int NCRUPERFLP = 3;        // the number of CRU per FLP
-constexpr int TRDLINKID = 15;        // hard coded link id, specific to TRD
+constexpr int NSECTOR = 18;          ///< the number of sectors
+constexpr int NSTACK = 5;            ///< the number of stacks per sector
+constexpr int NLAYER = 6;            ///< the number of layers
+constexpr int NCHAMBERPERSEC = 30;   ///< the number of chambers per sector
+constexpr int NHCPERSEC = 60;        ///< the number of half-chambers per sector
+constexpr int MAXCHAMBER = 540;      ///< the maximum number of installed chambers
+constexpr int MAXHALFCHAMBER = 1080; ///< the maximum number of installed half-chambers
+constexpr int NCHAMBER = 521;        ///< the number of chambers actually installed
+constexpr int NHALFCRU = 72;         ///< the number of half cru (link bundles)
+constexpr int NLINKSPERHALFCRU = 15; ///< the number of links per half cru or cru end point.
+constexpr int NLINKSPERCRU = 30;     ///< the number of links per CRU (two CRUs serve one supermodule)
+constexpr int NCRU = 36;             ///< the number of CRU we have
+constexpr int NFLP = 12;             ///< the number of FLP we have.
+constexpr int NCRUPERFLP = 3;        ///< the number of CRU per FLP
+constexpr int TRDLINKID = 15;        ///< hard coded link id, specific to TRD
 
-constexpr int NCOLUMN = 144; // the number of pad columns for each chamber
-constexpr int NROWC0 = 12;   // the number of pad rows for chambers of type C0 (installed in stack 2)
-constexpr int NROWC1 = 16;   // the number of pad rows for chambers of type C1 (installed in stacks 0, 1, 3 and 4)
+constexpr int NCOLUMN = 144; ///< the number of pad columns for each chamber
+constexpr int NROWC0 = 12;   ///< the number of pad rows for chambers of type C0 (installed in stack 2)
+constexpr int NROWC1 = 16;   ///< the number of pad rows for chambers of type C1 (installed in stacks 0, 1, 3 and 4)
 
-constexpr int NMCMROB = 16;     // the number of MCMs per ROB
-constexpr int NMCMHCMAX = 64;   // the maximum number of MCMs for one half chamber (C1 type)
-constexpr int NMCMROBINROW = 4; // the number of MCMs per ROB in row direction
-constexpr int NMCMROBINCOL = 4; // the number of MCMs per ROB in column direction
-constexpr int NROBC0 = 6;       // the number of ROBs per C0 chamber
-constexpr int NROBC1 = 8;       // the number of ROBs per C1 chamber
-constexpr int NADCMCM = 21;     // the number of ADC channels per MCM
-constexpr int NCOLMCM = 18;     // the number of pads per MCM
-constexpr int NCPU = 4;         // the number of CPUs inside the TRAP chip
-constexpr int NCHARGES = 3;     // the number of charges per tracklet (Q0/1/2)
+constexpr int NMCMROB = 16;     ///< the number of MCMs per ROB
+constexpr int NMCMHCMAX = 64;   ///< the maximum number of MCMs for one half chamber (C1 type)
+constexpr int NMCMROBINROW = 4; ///< the number of MCMs per ROB in row direction
+constexpr int NMCMROBINCOL = 4; ///< the number of MCMs per ROB in column direction
+constexpr int NROBC0 = 6;       ///< the number of ROBs per C0 chamber
+constexpr int NROBC1 = 8;       ///< the number of ROBs per C1 chamber
+constexpr int NADCMCM = 21;     ///< the number of ADC channels per MCM
+constexpr int NCOLMCM = 18;     ///< the number of pads per MCM
+constexpr int NCPU = 4;         ///< the number of CPUs inside the TRAP chip
+constexpr int NCHARGES = 3;     ///< the number of charges per tracklet (Q0/1/2)
 
 // the values below should come out of the TRAP config in the future
-constexpr int NBITSTRKLPOS = 11;                                      // number of bits for position in tracklet64 word
-constexpr int NBITSTRKLSLOPE = 8;                                     // number of bits for slope in tracklet64 word
-constexpr int ADDBITSHIFTSLOPE = 1 << 3;                              // in the TRAP the slope is shifted by 3 additional bits compared to the position
-constexpr int PADGRANULARITYTRKLPOS = 40;                             // tracklet position is stored in units of 1/40 pad
-constexpr int PADGRANULARITYTRKLSLOPE = 128;                          // tracklet deflection is stored in units of 1/128 pad per time bin
-constexpr float GRANULARITYTRKLPOS = 1.f / PADGRANULARITYTRKLPOS;     // granularity of position in tracklet64 word in pad-widths
-constexpr float GRANULARITYTRKLSLOPE = 1.f / PADGRANULARITYTRKLSLOPE; // granularity of slope in tracklet64 word in pads/timebin
-constexpr int ADCBASELINE = 10;                                       // baseline in ADC units
+constexpr int NBITSTRKLPOS = 11;                                      ///< number of bits for position in tracklet64 word
+constexpr int NBITSTRKLSLOPE = 8;                                     ///< number of bits for slope in tracklet64 word
+constexpr int ADDBITSHIFTSLOPE = 1 << 3;                              ///< in the TRAP the slope is shifted by 3 additional bits compared to the position
+constexpr int PADGRANULARITYTRKLPOS = 40;                             ///< tracklet position is stored in units of 1/40 pad
+constexpr int PADGRANULARITYTRKLSLOPE = 128;                          ///< tracklet deflection is stored in units of 1/128 pad per time bin
+constexpr float GRANULARITYTRKLPOS = 1.f / PADGRANULARITYTRKLPOS;     ///< granularity of position in tracklet64 word in pad-widths
+constexpr float GRANULARITYTRKLSLOPE = 1.f / PADGRANULARITYTRKLSLOPE; ///< granularity of slope in tracklet64 word in pads/timebin
+constexpr int ADCBASELINE = 10;                                       ///< baseline in ADC units
 
 // OS: Should this not be flexible for example in case of Kr calib?
-constexpr int TIMEBINS = 30;           // the number of time bins
-constexpr float MAXIMPACTANGLE = 25.f; // the maximum impact angle for tracks relative to the TRD detector plane to be considered for vDrift and ExB calibration
-constexpr int NBINSANGLEDIFF = 25;     // the number of bins for the track angle used for the vDrift and ExB calibration based on the tracking
+constexpr int TIMEBINS = 30;            ///< the number of time bins
+constexpr float MAXIMPACTANGLE = 25.f;  ///< the maximum impact angle for tracks relative to the TRD detector plane to be considered for vDrift and ExB calibration
+constexpr int NBINSANGLEDIFF = 25;      ///< the number of bins for the track angle used for the vDrift and ExB calibration based on the tracking
+constexpr double VDRIFTDEFAULT = 1.546; ///< default value for vDrift
+constexpr double EXBDEFAULT = 0.0;      ///< default value for LorentzAngle
 
 // Trigger parameters
-constexpr double READOUT_TIME = 3000;                  // the time the readout takes, as 30 TB = 3 micro-s.
-constexpr double DEAD_TIME = 200;                      // trigger deadtime, 2 micro-s
-constexpr double BUSY_TIME = READOUT_TIME + DEAD_TIME; // the time for which no new trigger can be received in nanoseconds
+constexpr double READOUT_TIME = 3000;                  ///< the time the readout takes, as 30 TB = 3 micro-s.
+constexpr double DEAD_TIME = 200;                      ///< trigger deadtime, 2 micro-s
+constexpr double BUSY_TIME = READOUT_TIME + DEAD_TIME; ///< the time for which no new trigger can be received in nanoseconds
 
 // array size to store incoming half cru payload.
-constexpr int HBFBUFFERMAX = 1048576;          // max buffer size for data read from a half cru, (all events)
-constexpr unsigned int CRUPADDING32 = 0xeeeeeeee; // padding word used in the cru.
-constexpr int CHANNELNRNOTRKLT = 23;           // this marks channels in the ADC mask which don't contribute to a tracklet
-constexpr int NOTRACKLETFIT = 31;              // this value is assigned to the fit pointer in case no tracklet is available
-constexpr int TRACKLETENDMARKER = 0x10001000;  // marker for the end of tracklets in raw data, 2 of these.
-constexpr int PADDINGWORD = 0xeeeeeeee;        // half-CRU links will be padded with this words to get an even number of 256bit words
-constexpr int DIGITENDMARKER = 0x0;            // marker for the end of digits in raw data, 2 of these
-constexpr int MAXDATAPERLINK32 = 13824;        // max number of 32 bit words per link ((21x12+2+4)*64) 64 mcm, 21 channels, 10 words per channel 2 header words(DigitMCMHeader DigitMCMADCmask) 4 words for tracklets.
-constexpr int MAXDATAPERLINK256 = 1728;        // max number of linkwords per cru link. (256bit words)
-constexpr int MAXEVENTCOUNTERSEPERATION = 200; // how far apart can subsequent mcmheader event counters be before we flag for concern, used as a sanity check in rawreader.
-constexpr int MAXMCMCOUNT = 69120;             // at most mcm count maxchamber x nrobc1 nmcmrob
-constexpr int MAXLINKERRORHISTOGRAMS = 10;     // size of the array holding the link error plots from the raw reader
-constexpr int MAXPARSEERRORHISTOGRAMS = 60;    // size of the array holding the parsing error plots from the raw reader
-constexpr unsigned int ETYPEPHYSICSTRIGGER = 0x2;     // CRU Half Chamber header eventtype definition
-constexpr unsigned int ETYPECALIBRATIONTRIGGER = 0x3; // CRU Half Chamber header eventtype definition
-constexpr int MAXCRUERRORVALUE = 0x2;          // Max possible value for a CRU Halfchamber link error. As of may 2022, can only be 0x0, 0x1, and 0x2, at least that is all so far(may2022).
-constexpr int INVALIDPRETRIGGERPHASE = 0xf;    // Invalid value for phase, used to signify there is no hcheader.
+constexpr int HBFBUFFERMAX = 1048576;                 ///< max buffer size for data read from a half cru, (all events)
+constexpr unsigned int CRUPADDING32 = 0xeeeeeeee;     ///< padding word used in the cru.
+constexpr int CHANNELNRNOTRKLT = 23;                  ///< this marks channels in the ADC mask which don't contribute to a tracklet
+constexpr int NOTRACKLETFIT = 31;                     ///< this value is assigned to the fit pointer in case no tracklet is available
+constexpr int TRACKLETENDMARKER = 0x10001000;         ///< marker for the end of tracklets in raw data, 2 of these.
+constexpr int PADDINGWORD = 0xeeeeeeee;               ///< half-CRU links will be padded with this words to get an even number of 256bit words
+constexpr int DIGITENDMARKER = 0x0;                   ///< marker for the end of digits in raw data, 2 of these
+constexpr int MAXDATAPERLINK32 = 13824;               ///< max number of 32 bit words per link ((21x12+2+4)*64) 64 mcm, 21 channels, 10 words per channel 2 header words(DigitMCMHeader DigitMCMADCmask) 4 words for tracklets.
+constexpr int MAXDATAPERLINK256 = 1728;               ///< max number of linkwords per cru link. (256bit words)
+constexpr int MAXEVENTCOUNTERSEPERATION = 200;        ///< how far apart can subsequent mcmheader event counters be before we flag for concern, used as a sanity check in rawreader.
+constexpr int MAXMCMCOUNT = 69120;                    ///< at most mcm count maxchamber x nrobc1 nmcmrob
+constexpr int MAXLINKERRORHISTOGRAMS = 10;            ///< size of the array holding the link error plots from the raw reader
+constexpr int MAXPARSEERRORHISTOGRAMS = 60;           ///< size of the array holding the parsing error plots from the raw reader
+constexpr unsigned int ETYPEPHYSICSTRIGGER = 0x2;     ///< CRU Half Chamber header eventtype definition
+constexpr unsigned int ETYPECALIBRATIONTRIGGER = 0x3; ///< CRU Half Chamber header eventtype definition
+constexpr int MAXCRUERRORVALUE = 0x2;                 ///< Max possible value for a CRU Halfchamber link error. As of may 2022, can only be 0x0, 0x1, and 0x2, at least that is all so far(may2022).
+constexpr int INVALIDPRETRIGGERPHASE = 0xf;           ///< Invalid value for phase, used to signify there is no hcheader.
 
 } // namespace constants
 } // namespace trd

@@ -17,6 +17,7 @@ o2_add_library(TRDCalibration
                        src/CalibratorNoise.cxx
                        src/KrClusterFinder.cxx
                        src/DCSProcessor.cxx
+                       src/CalibrationParams.cxx
                PUBLIC_LINK_LIBRARIES O2::TRDBase
                                      O2::DataFormatsTRD
                                      O2::DataFormatsGlobalTracking
@@ -30,6 +31,7 @@ o2_add_library(TRDCalibration
                            HEADERS include/TRDCalibration/TrackBasedCalib.h
                                    include/TRDCalibration/CalibratorVdExB.h
                                    include/TRDCalibration/CalibratorNoise.h
+                                   include/TRDCalibration/CalibrationParams.h
                                    include/TRDCalibration/KrClusterFinder.h
                                    include/TRDCalibration/DCSProcessor.h)
 

@@ -15,13 +15,21 @@ The histograms are send to aggregator nodes which calculate for each TRD chamber
 
 To run the calibration one can start the following workflow:
 
-    o2-trd-global-tracking -b --disable-root-output --enable-trackbased-calib | o2-calibration-trd-workflow --vDriftAndExB -b --calib-vdexb-calibration '--tf-per-slot 5 --min-entries 50000 --max-delay 90000'
+    o2-trd-global-tracking -b --disable-root-output --enable-trackbased-calib | o2-calibration-trd-workflow --vDriftAndExB -b --calib-vdexb-calibration '--tf-per-slot 5 --max-delay 90000'
+
+For 'o2-calibration-trd-workflow --vDriftAndExB' there are also the following keyConfig values available:
+
+    TRDCalibParams.
+    - nTrackletsMin; minimum amount of tracklets in tracks
+    - chi2RedMax; maximum reduced chi2 acceptable for tracks quality
+    - minEntriesChamber; minimum number of entries per chamber to fit in a single time slot
+    - minEntriesTotal; minimum total required for meaningful fits
 
 *Hint: You can get information on the meaning of the parameters by running `o2-calibration-trd-workflow --vDriftAndExB -b --help full`*
 
 If you want to run the calibration from a local file with residuals, trdangreshistos.root, you can run:
 
-    o2-calibration-trd-workflow --vDriftAndExB -b --enable-root-input --calib-vdexb-calibration '--tf-per-slot 1 --min-entries 50000'
+    o2-calibration-trd-workflow --vDriftAndExB -b --enable-root-input --calib-vdexb-calibration '--tf-per-slot 1' --configKeyValues "TRDCalibParams.minEntriesChamber=100;TRDCalibParams.minEntriesTotal=50000"
 
 Additionally it is possible to perform the calibrations fit manually per chamber if you have TPC-TRD or ITS-TPC-TRD tracks, you can run:
 
@@ -32,7 +40,7 @@ Then run the macro `Detectors/TRD/calibration/macros/manualCalibFit.C`.
 This produces a file of similar name with the fitted data and prints out the fit results.
 This is equivalent to running:
 
-    o2-calibration-trd-workflow --vDriftAndExB -b --enable-root-input '--tf-per-slot 1 --min-entries 2000 --enable-root-output'
+    o2-calibration-trd-workflow --vDriftAndExB -b --enable-root-input '--tf-per-slot 1 --enable-root-output'
 
 You can plot the calibration values for VDrift and ExB for a given Run by using the macro at `Detectors/TRD/cailbration/macros/plotVdriftExB.C`.
 This produces a root file of similar name which holds the time-series plots (reference the macro).

@@ -0,0 +1,39 @@
+// Copyright 2019-2020 CERN and copyright holders of ALICE O2.
+// See https://alice-o2.web.cern.ch/copyright for details of the copyright holders.
+// All rights not expressly granted are reserved.
+//
+// This software is distributed under the terms of the GNU General Public
+// License v3 (GPL Version 3), copied verbatim in the file "COPYING".
+//
+// In applying this license CERN does not waive the privileges and immunities
+// granted to it by virtue of its status as an Intergovernmental Organization
+// or submit itself to any jurisdiction.
+
+// \brief Collect all possible configurable parameters for any QC task
+
+#ifndef O2_CALIBRATION_PARAMS_H
+#define O2_CALIBRATION_PARAMS_H
+
+#include "CommonUtils/ConfigurableParam.h"
+#include "CommonUtils/ConfigurableParamHelper.h"
+
+namespace o2
+{
+namespace trd
+{
+
+/// VDrift and ExB calibration parameters.
+struct TRDCalibParams : public o2::conf::ConfigurableParamHelper<TRDCalibParams> {
+  unsigned int nTrackletsMin = 5;  ///< minimum amount of tracklets
+  unsigned int chi2RedMax = 6;     ///< maximum reduced chi2 acceptable for track quality
+  size_t minEntriesChamber = 75;   ///< minimum number of entries per chamber to fit single time slot
+  size_t minEntriesTotal = 40'500; ///< minimum total required for meaningful fits
+
+  // boilerplate
+  O2ParamDef(TRDCalibParams, "TRDCalibParams");
+};
+
+} // namespace trd
+} // namespace o2
+
+#endif