MFTDCSDataProcessorSpec.h

Go to the documentation of this file.

// 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_MFT_DATAPROCESSOR_H
#define O2_MFT_DATAPROCESSOR_H
 
 
#include <unistd.h>
#include <TRandom.h>
#include <TStopwatch.h>
#include "DetectorsDCS/DataPointIdentifier.h"
#include "DetectorsDCS/DataPointValue.h"
#include "DetectorsDCS/DataPointCompositeObject.h"
#include "DetectorsDCS/DeliveryType.h"
#include "DetectorsDCS/AliasExpander.h"
#include "MFTCondition/MFTDCSProcessor.h"
#include "MFTCondition/DCSNameResolver.h"
#include "DetectorsCalibration/Utils.h"
#include "CCDB/CcdbApi.h"
#include "CCDB/BasicCCDBManager.h"
#include "Framework/DeviceSpec.h"
#include "Framework/ConfigParamRegistry.h"
#include "Framework/ControlService.h"
#include "Framework/WorkflowSpec.h"
#include "Framework/Task.h"
#include "Framework/Logger.h"
 
using namespace o2::framework;
 
namespace o2
{
namespace mft
{
 
using DPID = o2::dcs::DataPointIdentifier;
using DPVAL = o2::dcs::DataPointValue;
using DPCOM = o2::dcs::DataPointCompositeObject;
using namespace o2::ccdb;
using CcdbManager = o2::ccdb::BasicCCDBManager;
using clbUtils = o2::calibration::Utils;
using HighResClock = std::chrono::high_resolution_clock;
using Duration = std::chrono::duration<double, std::ratio<1, 1>>;
 
class MFTDCSDataProcessor : public o2::framework::Task
{
 public:
  //________________________________________________________________
  void init(o2::framework::InitContext& ic) final
  {
    std::vector<DPID> vect;
    mDPsUpdateInterval = ic.options().get<int64_t>("DPs-update-interval");
    if (mDPsUpdateInterval == 0) {
      LOG(error) << "MFT DPs update interval set to zero seconds --> changed to 60";
      mDPsUpdateInterval = 60;
    }
    LOG(info) << "mDPsUpdateInterval " << mDPsUpdateInterval << "[sec.]";
 
    bool useCCDBtoConfigure = ic.options().get<bool>("use-ccdb-to-configure");
 
    mStart = ic.options().get<int64_t>("tstart");
    mEnd = ic.options().get<int64_t>("tend");
 
    mThreBBCurrent = ic.options().get<float>("thre-bb-current");
    mThreAnalogCurrent = ic.options().get<float>("thre-analog-current");
    mThreDigitCurrent = ic.options().get<float>("thre-digit-current");
    mThreBBValtage = ic.options().get<float>("thre-bb-voltage");
    mThreRULV = ic.options().get<float>("thre-ru-low-voltage");
 
    LOG(info) << "mThreBBCurrent" << mThreBBCurrent;
    LOG(info) << "mThreAnalogCurrent" << mThreAnalogCurrent;
    LOG(info) << "mThreDigitCurrent" << mThreDigitCurrent;
    LOG(info) << "mThreBBValtage" << mThreBBValtage;
    LOG(info) << "mThreRULV" << mThreRULV;
 
    if (useCCDBtoConfigure) {
      LOG(info) << "Configuring via CCDB";
 
      auto& mgr = CcdbManager::instance();
      mgr.setURL(o2::base::NameConf::getCCDBServer());
      long ts = std::chrono::duration_cast<std::chrono::milliseconds>(std::chrono::system_clock::now().time_since_epoch()).count();
      std::unordered_map<DPID, std::string>* dpid2DataDesc = mgr.getForTimeStamp<std::unordered_map<DPID, std::string>>("MFT/Config/DCSDPconfig", ts);
      for (auto& i : *dpid2DataDesc) {
        vect.push_back(i.first);
      }
    }
 
    else {
      LOG(info) << "Configuring via hardcoded strings";
      std::vector<std::string> aliases = {"MFT_PSU_ZONE/H[0..1]/D[0..4]/F[0..1]/Z[0..3]/Current/Analog",
                                          "MFT_PSU_ZONE/H[0..1]/D[0..4]/F[0..1]/Z[0..3]/Current/BackBias",
                                          "MFT_PSU_ZONE/H[0..1]/D[0..4]/F[0..1]/Z[0..3]/Current/Digital",
                                          "MFT_PSU_ZONE/H[0..1]/D[0..4]/F[0..1]/Z[0..3]/Voltage/BackBias",
                                          "MFT_RU_LV/H0/D0/F0/Z[0..3]/iMon",
                                          "MFT_RU_LV/H0/D1/F0/Z[0..3]/iMon",
                                          "MFT_RU_LV/H0/D2/F0/Z[0..3]/iMon",
                                          "MFT_RU_LV/H0/D3/F0/Z[0..3]/iMon",
                                          "MFT_RU_LV/H0/D4/F0/Z[0..3]/iMon",
                                          "MFT_RU_LV/H0/D0/F1/Z[0..3]/iMon",
                                          "MFT_RU_LV/H0/D1/F1/Z[0..3]/iMon",
                                          "MFT_RU_LV/H0/D2/F1/Z[0..3]/iMon",
                                          "MFT_RU_LV/H0/D3/F1/Z[0..3]/iMon",
                                          "MFT_RU_LV/H0/D4/F1/Z[0..3]/iMon",
                                          "MFT_RU_LV/H1/D0/F0/Z[0..3]/iMon",
                                          "MFT_RU_LV/H1/D1/F0/Z[0..3]/iMon",
                                          "MFT_RU_LV/H1/D2/F0/Z[0..3]/iMon",
                                          "MFT_RU_LV/H1/D3/F0/Z[0..3]/iMon",
                                          "MFT_RU_LV/H1/D4/F0/Z[0..3]/iMon",
                                          "MFT_RU_LV/H1/D0/F1/Z[0..3]/iMon",
                                          "MFT_RU_LV/H1/D1/F1/Z[0..3]/iMon",
                                          "MFT_RU_LV/H1/D2/F1/Z[0..3]/iMon",
                                          "MFT_RU_LV/H1/D3/F1/Z[0..3]/iMon",
                                          "MFT_RU_LV/H1/D4/F1/Z[0..3]/iMon"};
 
      std::vector<std::string> expaliases = o2::dcs::expandAliases(aliases);
      for (const auto& i : expaliases) {
        vect.emplace_back(i, o2::dcs::DPVAL_DOUBLE);
      }
    }
 
    LOG(info) << "Listing Data Points for MFT:";
    for (auto& i : vect) {
      LOG(info) << i;
    }
 
    mProcessor = std::make_unique<o2::mft::MFTDCSProcessor>();
    bool useVerboseMode = ic.options().get<bool>("use-verbose-mode");
    LOG(info) << " ************************* Verbose?" << useVerboseMode;
 
    if (useVerboseMode) {
      mProcessor->useVerboseMode();
    }
    mProcessor->init(vect);
 
    mTimer = HighResClock::now();
    mReportTiming = ic.options().get<bool>("report-timing") || useVerboseMode;
  }
 
  //________________________________________________________________
  void run(o2::framework::ProcessingContext& pc) final
  {
    TStopwatch sw;
    auto tfid = o2::header::get<o2::framework::DataProcessingHeader*>(pc.inputs().get("input").header)->startTime;
    auto dps = pc.inputs().get<gsl::span<DPCOM>>("input");
 
    mProcessor->setThreBackBiasCurrent(mThreBBCurrent);
    mProcessor->setThreAnalogCurrent(mThreAnalogCurrent);
    mProcessor->setThreDigitCurrent(mThreDigitCurrent);
    mProcessor->setThreBackBiasVoltage(mThreBBValtage);
    mProcessor->setThreRULV(mThreRULV);
    mProcessor->setTF(tfid);
    mProcessor->process(dps);
 
    auto timeNow = HighResClock::now();
    Duration elapsedTime = timeNow - mTimer; // in seconds
    if (elapsedTime.count() >= mDPsUpdateInterval || mProcessor->sendDPsCCDB()) {
      sendDPsoutput(pc.outputs());
      mTimer = timeNow;
    }
    sw.Stop();
    if (mReportTiming) {
      LOGP(info, "Timing CPU:{:.3e} Real:{:.3e} at slice {}", sw.CpuTime(), sw.RealTime(), pc.services().get<o2::framework::TimingInfo>().timeslice);
    }
  }
 
  //________________________________________________________________
  void endOfStream(o2::framework::EndOfStreamContext& ec) final
  {
    sendDPsoutput(ec.outputs());
  }
 
 private:
  bool mReportTiming = false;
  std::unique_ptr<MFTDCSProcessor> mProcessor;
  HighResClock::time_point mTimer;
  int64_t mDPsUpdateInterval;
  long mStart;
  long mEnd;
 
  float mThreBBCurrent;
  float mThreAnalogCurrent;
  float mThreDigitCurrent;
  float mThreBBValtage;
  float mThreRULV;
 
  //________________________________________________________________
  void sendDPsoutput(DataAllocator& output)
  {
    // extract CCDB infos and calibration object for DPs
    mProcessor->updateDPsCCDB();
    const auto& payload = mProcessor->getMFTDPsInfo();
    auto& info = mProcessor->getccdbDPsInfo();
 
    long tstart = mStart;
    long tend = mEnd;
 
    if (tstart == -1) {
      tstart = o2::ccdb::getCurrentTimestamp();
    }
 
    if (tend == -1) {
      tend = tstart + o2::ccdb::CcdbObjectInfo::MONTH;
    }
 
    info.setStartValidityTimestamp(tstart);
    info.setEndValidityTimestamp(tend);
 
    auto image = o2::ccdb::CcdbApi::createObjectImage(&payload, &info);
    LOG(info) << "Sending object " << info.getPath() << "/" << info.getFileName() << " of size " << image->size()
              << " bytes, valid for " << info.getStartValidityTimestamp() << " : " << info.getEndValidityTimestamp();
    output.snapshot(Output{o2::calibration::Utils::gDataOriginCDBPayload, "MFT_DCSDPs", 0}, *image.get());
    output.snapshot(Output{o2::calibration::Utils::gDataOriginCDBWrapper, "MFT_DCSDPs", 0}, info);
    mProcessor->clearDPsinfo();
  }
  //________________________________________________________________
}; // end class
} // namespace mft
 
namespace framework
{
 
DataProcessorSpec getMFTDCSDataProcessorSpec()
{
 
  using clbUtils = o2::calibration::Utils;
 
  std::vector<OutputSpec> outputs;
 
  outputs.emplace_back(ConcreteDataTypeMatcher{o2::calibration::Utils::gDataOriginCDBPayload, "MFT_DCSDPs"}, Lifetime::Sporadic);
  outputs.emplace_back(ConcreteDataTypeMatcher{o2::calibration::Utils::gDataOriginCDBWrapper, "MFT_DCSDPs"}, Lifetime::Sporadic);
 
  return DataProcessorSpec{
    "mft-dcs-data-processor",
    Inputs{{"input", "DCS", "MFTDATAPOINTS"}},
    outputs,
    AlgorithmSpec{adaptFromTask<o2::mft::MFTDCSDataProcessor>()},
    Options{
      {"tstart", VariantType::Int64, -1ll, {"Start of validity timestamp"}},
      {"tend", VariantType::Int64, -1ll, {"End of validity timestamp"}},
      {"use-ccdb-to-configure", VariantType::Bool, false, {"Use CCDB to configure"}},
      {"use-verbose-mode", VariantType::Bool, false, {"Use verbose mode"}},
      {"report-timing", VariantType::Bool, false, {"Report timing for every slice"}},
      {"thre-analog-current", VariantType::Float, 999.f, {"Threshold for Analog Currect to send to CCDB"}},
      {"thre-digit-current", VariantType::Float, 999.f, {"Threshold for Digital Currect to send to CCDB"}},
      {"thre-bb-current", VariantType::Float, 999.f, {"Threshold for BackBias Currect to send to CCDB"}},
      {"thre-bb-voltage", VariantType::Float, 999.f, {"Threshold for BackBias Voltage to send to CCDB"}},
      {"thre-ru-low-voltage", VariantType::Float, 999.f, {"Threshold for RU LV to send to CCDB"}},
      {"DPs-update-interval", VariantType::Int64, 600ll, {"Interval (in s) after which to update the DPs CCDB entry"}}}};
}
 
} // namespace framework
} // namespace o2
 
#endif