MCH: make reco more parametrizable

aphecetche · web-flow · commit de78a8f3334e · 2022-05-10T23:38:00.000+02:00
diff --git a/Detectors/MUON/MCH/Base/CMakeLists.txt b/Detectors/MUON/MCH/Base/CMakeLists.txt
@@ -12,6 +12,7 @@
 o2_add_library(MCHBase
          SOURCES
            src/PreCluster.cxx
+           src/SanityCheck.cxx
            src/TrackBlock.cxx
            src/Trackable.cxx
          PUBLIC_LINK_LIBRARIES O2::DataFormatsMCH)
diff --git a/Detectors/MUON/MCH/Base/include/MCHBase/SanityCheck.h b/Detectors/MUON/MCH/Base/include/MCHBase/SanityCheck.h
diff --git a/Detectors/MUON/MCH/Base/src/SanityCheck.cxx b/Detectors/MUON/MCH/Base/src/SanityCheck.cxx
@@ -9,7 +9,7 @@
 // granted to it by virtue of its status as an Intergovernmental Organization
 // or submit itself to any jurisdiction.
 
-#include "SanityCheck.h"
+#include "MCHBase/SanityCheck.h"
 #include <fmt/core.h>
 
 namespace o2::mch
diff --git a/Detectors/MUON/MCH/CMakeLists.txt b/Detectors/MUON/MCH/CMakeLists.txt
@@ -12,6 +12,7 @@
 add_subdirectory(Base)
 add_subdirectory(Contour)
 add_subdirectory(Mapping)
+add_subdirectory(DigitFiltering)
 add_subdirectory(Triggering)
 add_subdirectory(TimeClustering)
 add_subdirectory(PreClustering)
diff --git a/Detectors/MUON/MCH/DigitFiltering/CMakeLists.txt b/Detectors/MUON/MCH/DigitFiltering/CMakeLists.txt
@@ -0,0 +1,22 @@
+# 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.
+
+o2_add_library(MCHDigitFiltering
+        SOURCES src/DigitFilterParam.cxx src/DigitFilteringSpec.cxx
+        PUBLIC_LINK_LIBRARIES O2::MCHBase O2::Framework O2::SimulationDataFormat)
+
+o2_add_executable(
+        digits-filtering-workflow
+        SOURCES src/digits-filtering-workflow.cxx
+        COMPONENT_NAME mch
+        PUBLIC_LINK_LIBRARIES O2::MCHDigitFiltering)
+
+o2_target_root_dictionary(MCHDigitFiltering HEADERS include/MCHDigitFiltering/DigitFilterParam.h)
diff --git a/Detectors/MUON/MCH/DigitFiltering/README.md b/Detectors/MUON/MCH/DigitFiltering/README.md
@@ -0,0 +1,8 @@
+
+<!-- doxy
+\page refDetectorsMUONMCHDigitFiltering Digit filtering
+/doxy -->
+
+# MCH Digit Filtering
+
+
diff --git a/Detectors/MUON/MCH/DigitFiltering/include/MCHDigitFiltering/DigitFilterParam.h b/Detectors/MUON/MCH/DigitFiltering/include/MCHDigitFiltering/DigitFilterParam.h
@@ -0,0 +1,35 @@
+// 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.
+
+#ifndef O2_MCH_DIGITFILTERING_DIGIT_FILTER_PARAM_H_
+#define O2_MCH_DIGITFILTERING_DIGIT_FILTER_PARAM_H_
+
+#include "CommonUtils/ConfigurableParam.h"
+#include "CommonUtils/ConfigurableParamHelper.h"
+
+namespace o2::mch
+{
+
+/**
+ * @class DigitFilterParam
+ * @brief Configurable parameters for the digit filtering
+ */
+struct DigitFilterParam : public o2::conf::ConfigurableParamHelper<DigitFilterParam> {
+
+  bool sanityCheck = false; ///< whether or not to perform some sanity checks on the input digits
+  uint32_t minADC = 1;      ///< digits with an ADC below this value are discarded
+
+  O2ParamDef(DigitFilterParam, "MCHDigitFilter");
+};
+
+} // namespace o2::mch
+
+#endif
diff --git a/Detectors/MUON/MCH/DigitFiltering/include/MCHDigitFiltering/DigitFilteringSpec.h b/Detectors/MUON/MCH/DigitFiltering/include/MCHDigitFiltering/DigitFilteringSpec.h
diff --git a/Detectors/MUON/MCH/DigitFiltering/src/DigitFilterParam.cxx b/Detectors/MUON/MCH/DigitFiltering/src/DigitFilterParam.cxx
@@ -0,0 +1,15 @@
+// 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.
+
+#include "MCHDigitFiltering/DigitFilterParam.h"
+#include "CommonUtils/ConfigurableParam.h"
+
+O2ParamImpl(o2::mch::DigitFilterParam)
diff --git a/Detectors/MUON/MCH/DigitFiltering/src/DigitFilteringSpec.cxx b/Detectors/MUON/MCH/DigitFiltering/src/DigitFilteringSpec.cxx
@@ -9,7 +9,7 @@
 // granted to it by virtue of its status as an Intergovernmental Organization
 // or submit itself to any jurisdiction.
 
-#include "DigitFilteringSpec.h"
+#include "MCHDigitFiltering/DigitFilteringSpec.h"
 
 #include "DataFormatsMCH/Digit.h"
 #include "DataFormatsMCH/ROFRecord.h"
@@ -19,7 +19,8 @@
 #include "Framework/OutputSpec.h"
 #include "Framework/Task.h"
 #include "Framework/WorkflowSpec.h"
-#include "SanityCheck.h"
+#include "MCHBase/SanityCheck.h"
+#include "MCHDigitFiltering/DigitFilterParam.h"
 #include "SimulationDataFormat/MCCompLabel.h"
 #include "SimulationDataFormat/MCTruthContainer.h"
 #include <fmt/format.h>
@@ -39,13 +40,13 @@ class DigitFilteringTask
 
   void init(InitContext& ic)
   {
-    mSanityCheck = ic.options().get<bool>("sanity-check");
-    mMinADC = ic.options().get<int>("min-adc-value");
+    mSanityCheck = DigitFilterParam::Instance().sanityCheck;
+    mMinADC = DigitFilterParam::Instance().minADC;
   }
 
   bool isGoodDigit(const Digit& digit) const
   {
-    return digit.getADC() > mMinADC;
+    return digit.getADC() >= mMinADC;
   }
 
   void run(ProcessingContext& pc)
@@ -58,6 +59,7 @@ class DigitFilteringTask
     bool abort{false};
 
     if (mSanityCheck) {
+      LOGP(info, "performing sanity checks");
       auto error = sanityCheck(iRofs, iDigits);
 
       if (!isOK(error)) {
@@ -76,9 +78,7 @@ class DigitFilteringTask
 
     if (!abort) {
       int cursor{0};
-      for (auto i = 0; i < iRofs.size(); i++) {
-        const ROFRecord& irof = iRofs[i];
-
+      for (const auto& irof : iRofs) {
         const auto digits = iDigits.subspan(irof.getFirstIdx(), irof.getNEntries());
 
         // filter the digits from the current ROF
@@ -87,7 +87,7 @@ class DigitFilteringTask
           if (isGoodDigit(d)) {
             oDigits.emplace_back(d);
             if (iLabels) {
-              oLabels->addElements(oLabels->getIndexedSize(), iLabels->getLabels(i + cursor));
+              oLabels->addElements(oLabels->getIndexedSize(), iLabels->getLabels(i + irof.getFirstIdx()));
             }
           }
         }
@@ -160,8 +160,6 @@ framework::DataProcessorSpec
     Inputs{select(input.c_str())},
     outputs,
     AlgorithmSpec{adaptFromTask<DigitFilteringTask>(useMC)},
-    Options{
-      {"sanity-check", VariantType::Bool, false, {"perform a few sanity checks on input digits"}},
-      {"min-adc-value", VariantType::Int, 1, {"minumum ADC value to consider"}}}};
+    Options{}};
 }
 } // namespace o2::mch
diff --git a/Detectors/MUON/MCH/DigitFiltering/src/MCHDigitFilteringLinkDef.h b/Detectors/MUON/MCH/DigitFiltering/src/MCHDigitFilteringLinkDef.h
@@ -0,0 +1,21 @@
+// 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.
+
+#ifdef __CLING__
+
+#pragma link off all globals;
+#pragma link off all classes;
+#pragma link off all functions;
+
+#pragma link C++ class o2::mch::DigitFilterParam + ;
+#pragma link C++ class o2::conf::ConfigurableParamHelper < o2::mch::DigitFilterParam> + ;
+
+#endif
diff --git a/Detectors/MUON/MCH/DigitFiltering/src/digits-filtering-workflow.cxx b/Detectors/MUON/MCH/DigitFiltering/src/digits-filtering-workflow.cxx
@@ -12,7 +12,8 @@
 #include "Framework/CallbackService.h"
 #include "Framework/ControlService.h"
 #include "Framework/Task.h"
-#include "DigitFilteringSpec.h"
+#include "MCHDigitFiltering/DigitFilteringSpec.h"
+#include "CommonUtils/ConfigurableParam.h"
 
 using namespace o2;
 using namespace o2::framework;
@@ -26,12 +27,15 @@ void customize(std::vector<ConfigParamSpec>& workflowOptions)
   workflowOptions.push_back(ConfigParamSpec{"input-digitlabels-data-description", VariantType::String, "DIGITLABELS", {"description string for the input digit labels data (not used if disable-mc is true)"}});
   workflowOptions.push_back(ConfigParamSpec{"output-digitlabels-data-description", VariantType::String, "F-DIGITLABELS", {"description string for the output digit labels data (not used if disable-mc is true)"}});
   workflowOptions.push_back(ConfigParamSpec{"disable-mc", VariantType::Bool, false, {"Do not propagate MC info"}});
+  workflowOptions.push_back(ConfigParamSpec{"configKeyValues", VariantType::String, "", {"Semicolon separated key=value strings"}});
 }
 
 #include "Framework/runDataProcessing.h"
 
 WorkflowSpec defineDataProcessing(const ConfigContext& cc)
 {
+  o2::conf::ConfigurableParam::updateFromString(cc.options().get<std::string>("configKeyValues"));
+
   WorkflowSpec wf;
 
   wf.emplace_back(o2::mch::getDigitFilteringSpec(
diff --git a/Detectors/MUON/MCH/README.md b/Detectors/MUON/MCH/README.md
@@ -13,6 +13,7 @@ This is a top page for the MCH detector documentation.
 \subpage refDetectorsMUONMCHConditions
 \subpage refDetectorsMUONMCHContour
 \subpage refDetectorsMUONMCHDevIO
+\subpage refDetectorsMUONMCHDigitFiltering
 \subpage refDetectorsMUONMCHGeometry
 \subpage refDetectorsMUONMCHMapping
 \subpage refDetectorsMUONMCHRaw
diff --git a/Detectors/MUON/MCH/TimeClustering/CMakeLists.txt b/Detectors/MUON/MCH/TimeClustering/CMakeLists.txt
@@ -10,9 +10,11 @@
 # or submit itself to any jurisdiction.
 
 o2_add_library(MCHTimeClustering
-        SOURCES src/ROFTimeClusterFinder.cxx
+        SOURCES src/ROFTimeClusterFinder.cxx src/TimeClusterizerParam.cxx
         PUBLIC_LINK_LIBRARIES O2::MCHBase O2::Framework)
 
+o2_target_root_dictionary(MCHTimeClustering HEADERS include/MCHTimeClustering/TimeClusterizerParam.h)
+
 if(BUILD_TESTING)
 
         o2_add_test(time-cluster-finder
diff --git a/Detectors/MUON/MCH/TimeClustering/include/MCHTimeClustering/TimeClusterizerParam.h b/Detectors/MUON/MCH/TimeClustering/include/MCHTimeClustering/TimeClusterizerParam.h
@@ -0,0 +1,37 @@
+// 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.
+
+#ifndef O2_MCH_TIMECLUSTERING_TIMECLUSTERIZER_PARAM_H_
+#define O2_MCH_TIMECLUSTERING_TIMECLUSTERIZER_PARAM_H_
+
+#include "CommonUtils/ConfigurableParam.h"
+#include "CommonUtils/ConfigurableParamHelper.h"
+
+namespace o2::mch
+{
+
+/**
+ * @class TimeClusterizerParam
+ * @brief Configurable parameters for the time clustering
+ */
+struct TimeClusterizerParam : public o2::conf::ConfigurableParamHelper<TimeClusterizerParam> {
+
+  bool onlyTrackable = true;       ///< only output ROFs that match the trackable condition @see MCHBase/Trackable.h
+  int maxClusterWidth = 1000 / 25; ///< maximum time width of time clusters, in BC units
+  int peakSearchNbins = 5;         ///< number of time bins for the peak search algorithm (must be an odd number >= 3)
+  int minDigitsPerROF = 0;         ///< minimum number of digits per ROF (below that threshold ROF is discarded)
+
+  O2ParamDef(TimeClusterizerParam, "MCHTimeClusterizer");
+};
+
+} // namespace o2::mch
+
+#endif
diff --git a/Detectors/MUON/MCH/TimeClustering/src/MCHTimeClusteringLinkDef.h b/Detectors/MUON/MCH/TimeClustering/src/MCHTimeClusteringLinkDef.h
@@ -0,0 +1,21 @@
+// 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.
+
+#ifdef __CLING__
+
+#pragma link off all globals;
+#pragma link off all classes;
+#pragma link off all functions;
+
+#pragma link C++ class o2::mch::TimeClusterizerParam + ;
+#pragma link C++ class o2::conf::ConfigurableParamHelper < o2::mch::TimeClusterizerParam> + ;
+
+#endif
diff --git a/Detectors/MUON/MCH/TimeClustering/src/TimeClusterizerParam.cxx b/Detectors/MUON/MCH/TimeClustering/src/TimeClusterizerParam.cxx
@@ -0,0 +1,15 @@
+// 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.
+
+#include "MCHTimeClustering/TimeClusterizerParam.h"
+#include "CommonUtils/ConfigurableParam.h"
+
+O2ParamImpl(o2::mch::TimeClusterizerParam)
diff --git a/Detectors/MUON/MCH/Workflow/CMakeLists.txt b/Detectors/MUON/MCH/Workflow/CMakeLists.txt
@@ -23,7 +23,6 @@ o2_add_library(MCHWorkflow
                    src/ClusterWriterSpec.cxx
                    src/DataDecoderSpec.cxx
                    src/PreClusterFinderSpec.cxx
-                   src/SanityCheck.cxx
                    src/TrackReaderSpec.cxx
                    src/TrackTreeReader.cxx
                    src/TrackWriterSpec.cxx
@@ -91,12 +90,6 @@ o2_add_executable(
         TARGETVARNAME mch-time-cluster-finder)
 target_link_libraries(${mch-time-cluster-finder} PRIVATE obj-mch-reco)
 
-o2_add_executable(
-        digits-filtering-workflow
-        SOURCES src/digits-filtering-workflow.cxx src/DigitFilteringSpec.cxx src/SanityCheck.cxx
-        COMPONENT_NAME mch
-        PUBLIC_LINK_LIBRARIES O2::Framework O2::MCHBase O2::SimulationDataFormat)
-
 o2_add_executable(
         digits-to-preclusters-workflow
         SOURCES src/digits-to-preclusters-workflow.cxx
@@ -167,7 +160,7 @@ o2_add_executable(
 
 o2_add_executable(
         clusters-to-tracks-workflow
-        SOURCES src/TrackFinderSpec.cxx src/clusters-to-tracks-workflow.cxx src/SanityCheck.cxx
+        SOURCES src/TrackFinderSpec.cxx src/clusters-to-tracks-workflow.cxx
         COMPONENT_NAME mch
         PUBLIC_LINK_LIBRARIES O2::DataFormatsParameters O2::Framework O2::DataFormatsMCH O2::MCHTracking O2::DataFormatsParameters)
 
@@ -234,14 +227,14 @@ o2_add_executable(
         reco-workflow
         SOURCES
             src/ClusterTransformerSpec.cxx
-            src/DigitFilteringSpec.cxx
             src/DigitReaderSpec.cxx
             src/EventFinderSpec.cxx
             src/TrackFinderSpec.cxx
             src/TrackMCLabelFinderSpec.cxx
             src/reco-workflow.cxx
         COMPONENT_NAME mch
         PUBLIC_LINK_LIBRARIES
+            O2::MCHDigitFiltering
             O2::MCHGeometryTransformer
             O2::MCHMappingImpl4
             O2::MCHTriggering
diff --git a/Detectors/MUON/MCH/Workflow/README.md b/Detectors/MUON/MCH/Workflow/README.md
@@ -104,10 +104,16 @@ o2-mch-digits-to-timeclusters-workflow
 
 Take as input the list of all digits ([Digit](/DataFormats/Detectors/MUON/MCH/include/DataFormatsMCH/Digit.h)) in the current time frame, with the data description "DIGITS", and the list of ROF records ([ROFRecord](../../../../DataFormats/Detectors/MUON/MCH/include/DataFormatsMCH/ROFRecord.h)) pointing to the digits associated to each interaction, with the data description "DIGITROFS". Send a new list of ROF records that combine all the digits correlated in time within a user-defined time window, with the data description "TIMECLUSTERROFS".
 
-The option `--time-cluster-width xxx` allows to set the width of the time correlation window.
+The option `--max-cluster-width xxx` allows to set the width of the time correlation window.
 
 The time clustering is based on a brute-force peak search algorithm, which arranges the input digits into coarse time bins. The number of bins in one time cluster window can be set via the `--peak-search-nbins` option.
 
+Alternatively, one can also configure the time clustering using `--configKeyValues` :
+
+```shell
+o2-mch-digits-to-timeclusters-workflow --configKeyValues="MCHTimeClustering.maxClusterWidth=xx;MCHTimeClustering.peakSearchNbins=yy"
+```
+
 ## Event finding
 
 ```shell
diff --git a/Detectors/MUON/MCH/Workflow/src/PreClusterFinderSpec.cxx b/Detectors/MUON/MCH/Workflow/src/PreClusterFinderSpec.cxx
diff --git a/Detectors/MUON/MCH/Workflow/src/TimeClusterFinderSpec.cxx b/Detectors/MUON/MCH/Workflow/src/TimeClusterFinderSpec.cxx
diff --git a/Detectors/MUON/MCH/Workflow/src/digits-to-timeclusters-workflow.cxx b/Detectors/MUON/MCH/Workflow/src/digits-to-timeclusters-workflow.cxx
diff --git a/Detectors/MUON/MCH/Workflow/src/reco-workflow.cxx b/Detectors/MUON/MCH/Workflow/src/reco-workflow.cxx
