EPN Waveform workflow

AliceO2Group · cortesep · May 5, 2022 · May 5, 2022 · May 5, 2022 · May 6, 2022
commit bc94ef26e19b0624d6ab58acd87825c7ca8ec006
@@ -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_ZDC_CALIBPARAMZDC_H
+#define O2_ZDC_CALIBPARAMZDC_H
+
+#include "CommonUtils/ConfigurableParam.h"
+#include "CommonUtils/ConfigurableParamHelper.h"
+#include "ZDCBase/Constants.h"
+
+/// \file CalibParamZDC.h
+/// \brief ZDC calibration common parameters
+/// \author P. Cortese
+
+namespace o2
+{
+namespace zdc
+{
+struct CalibParamZDC : public o2::conf::ConfigurableParamHelper<CalibParamZDC> {
+  int debug_output = -1; // Debug output
+  void print();
+  O2ParamDef(CalibParamZDC, "CalibParamZDC");
+};
+} // namespace zdc
+} // namespace o2
+
+#endif
@@ -0,0 +1,30 @@
+// 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 "Framework/Logger.h"
+#include "ZDCCalib/CalibParamZDC.h"
+
+O2ParamImpl(o2::zdc::CalibParamZDC);
+
+void o2::zdc::CalibParamZDC::print()
+{
+  bool printed = false;
+  if (debug_output >= 0) {
+    if (!printed) {
+      LOG(info) << "CalibParamZDC::print()";
+      printed = true;
+    }
+    if (debug_output >= 0) {
+      printf(" debug_output=%d", debug_output);
+    }
+    printf("\n");
+  }
+}
@@ -0,0 +1,141 @@
+// 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.
+
+/// @file   WaveformCalibEPNSpec.cxx
+/// @brief  ZDC reconstruction
+/// @author [email protected]
+
+#include <iostream>
+#include <vector>
+#include <string>
+#include "CCDB/BasicCCDBManager.h"
+#include "CCDB/CCDBTimeStampUtils.h"
+#include "Framework/Logger.h"
+#include "Framework/ControlService.h"
+#include "Framework/ConfigParamRegistry.h"
+#include "Framework/CCDBParamSpec.h"
+#include "Framework/DataRefUtils.h"
+#include "DetectorsCommonDataFormats/DetID.h"
+#include "DataFormatsZDC/BCData.h"
+#include "DataFormatsZDC/ChannelData.h"
+#include "DataFormatsZDC/OrbitData.h"
+#include "DataFormatsZDC/RecEvent.h"
+#include "ZDCBase/ModuleConfig.h"
+#include "CommonUtils/NameConf.h"
+#include "CCDB/BasicCCDBManager.h"
+#include "CCDB/CCDBTimeStampUtils.h"
+#include "ZDCCalib/WaveformCalibData.h"
+#include "ZDCCalib/WaveformCalibEPNSpec.h"
+
+using namespace o2::framework;
+
+namespace o2
+{
+namespace zdc
+{
+
+WaveformCalibEPNSpec::WaveformCalibEPNSpec()
+{
+  mTimer.Stop();
+  mTimer.Reset();
+}
+
+WaveformCalibEPNSpec::WaveformCalibEPNSpec(const int verbosity) : mVerbosity(verbosity)
+{
+  mTimer.Stop();
+  mTimer.Reset();
+}
+
+void WaveformCalibEPNSpec::init(o2::framework::InitContext& ic)
+{
+  mVerbosity = ic.options().get<int>("verbosity-level");
+}
+
+void WaveformCalibEPNSpec::updateTimeDependentParams(ProcessingContext& pc)
+{
+  // we call these methods just to trigger finaliseCCDB callback
+  pc.inputs().get<o2::zdc::WaveformCalibConfig*>("wavecalibconfig");
+}
+
+void WaveformCalibEPNSpec::run(ProcessingContext& pc)
+{
+  updateTimeDependentParams(pc);
+  if (!mInitialized) {
+    mInitialized = true;
+    std::string loadedConfFiles = "Loaded ZDC configuration files:";
+    // WaveformCalib configuration
+    auto interConfig = pc.inputs().get<o2::zdc::WaveformCalibConfig*>("wavecalibconfig");
+    if (!interConfig) {
+      LOG(fatal) << "Missing WaveformCalibConfig calibration object";
+      return;
+    } else {
+      loadedConfFiles += " WaveformCalibConfig";
+      if (mVerbosity > DbgZero) {
+        LOG(info) << "Loaded WaveformCalibConfig configuration object";
+        interConfig->print();
+      }
+    }
+
+    mWorker.setConfig(interConfig.get());
+
+    LOG(info) << loadedConfFiles;
+    mTimer.CpuTime();
+    mTimer.Start(false);
+  }
+
+  const auto ref = pc.inputs().getFirstValid(true);
+  auto creationTime = DataRefUtils::getHeader<DataProcessingHeader*>(ref)->creation; // approximate time in ms
+  WaveformCalibData& data = mWorker.getData();
+//  data.setCreationTime(creationTime);
+
+  auto bcrec = pc.inputs().get<gsl::span<o2::zdc::BCRecData>>("bcrec");
+  auto energy = pc.inputs().get<gsl::span<o2::zdc::ZDCEnergy>>("energy");
+  auto tdc = pc.inputs().get<gsl::span<o2::zdc::ZDCTDCData>>("tdc");
+  auto info = pc.inputs().get<gsl::span<uint16_t>>("info");
+  auto wave = pc.inputs().get<gsl::span<o2::zdc::ZDCWaveform>>("wave");
+
+  // Process reconstructed data
+  mWorker.process(bcrec, energy, tdc, info, wave);
+
+  // Send intermediate calibration data and debug histograms
+  o2::framework::Output output("ZDC", "WAVECALIBDATA", 0, Lifetime::Timeframe);
+  pc.outputs().snapshot(output, mWorker.mData);
+}
+
+void WaveformCalibEPNSpec::endOfStream(EndOfStreamContext& ec)
+{
+  mWorker.endOfRun();
+  mTimer.Stop();
+  LOGF(info, "ZDC EPN Waveform calibration total timing: Cpu: %.3e Real: %.3e s in %d slots", mTimer.CpuTime(), mTimer.RealTime(), mTimer.Counter() - 1);
+}
+
+framework::DataProcessorSpec getWaveformCalibEPNSpec()
+{
+  std::vector<InputSpec> inputs;
+  inputs.emplace_back("bcrec", "ZDC", "BCREC", 0, Lifetime::Timeframe);
+  inputs.emplace_back("energy", "ZDC", "ENERGY", 0, Lifetime::Timeframe);
+  inputs.emplace_back("tdc", "ZDC", "TDCDATA", 0, Lifetime::Timeframe);
+  inputs.emplace_back("info", "ZDC", "INFO", 0, Lifetime::Timeframe);
+  inputs.emplace_back("wave", "ZDC", "WAVE", 0, Lifetime::Timeframe);
+  inputs.emplace_back("wavecalibconfig", "ZDC", "WAVECALIBCONFIG", 0, Lifetime::Condition, o2::framework::ccdbParamSpec(fmt::format("{}", o2::zdc::CCDBPathWaveformCalibConfig.data())));
+
+  std::vector<OutputSpec> outputs;
+  outputs.emplace_back("ZDC", "WAVECALIBDATA", 0, Lifetime::Timeframe);
+  return DataProcessorSpec{
+    "zdc-waveformcalib-epn",
+    inputs,
+    outputs,
+    AlgorithmSpec{adaptFromTask<WaveformCalibEPNSpec>()},
+    o2::framework::Options{{"verbosity-level", o2::framework::VariantType::Int, 0, {"Verbosity level"}}}};
+}
+
+} // namespace zdc
+} // namespace o2
@@ -0,0 +1,42 @@
+// 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 "Framework/DataProcessorSpec.h"
+#include "DetectorsRaw/HBFUtilsInitializer.h"
+#include "ZDCCalib/WaveformCalibEPNSpec.h"
+
+using namespace o2::framework;
+
+// ------------------------------------------------------------------
+void customize(std::vector<o2::framework::CallbacksPolicy>& policies)
+{
+  o2::raw::HBFUtilsInitializer::addNewTimeSliceCallback(policies);
+}
+
+// we need to add workflow options before including Framework/runDataProcessing
+void customize(std::vector<o2::framework::ConfigParamSpec>& workflowOptions)
+{
+  // option allowing to set parameters
+  o2::raw::HBFUtilsInitializer::addConfigOption(workflowOptions);
+}
+
+// ------------------------------------------------------------------
+
+#include "Framework/runDataProcessing.h"
+
+WorkflowSpec defineDataProcessing(ConfigContext const& configcontext)
+{
+  WorkflowSpec specs;
+  specs.emplace_back(o2::zdc::getWaveformCalibEPNSpec());
+  // configure dpl timer to inject correct firstTFOrbit: start from the 1st orbit of TF containing 1st sampled orbit
+  o2::raw::HBFUtilsInitializer hbfIni(configcontext, specs);
+  return specs;
+}