TOFDigitizerSpec.cxx

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.
 
#include "TOFDigitizerSpec.h"
#include "Framework/ControlService.h"
#include "Framework/ConfigParamRegistry.h"
#include "Framework/DataProcessorSpec.h"
#include "Framework/DataRefUtils.h"
#include "Framework/Lifetime.h"
#include "Framework/Task.h"
#include "TStopwatch.h"
#include "Steer/HitProcessingManager.h" // for DigitizationContext
#include "TChain.h"
#include "DetectorsBase/GeometryManager.h"
#include "TOFSimulation/Digitizer.h"
#include "DataFormatsParameters/GRPObject.h"
#include <SimulationDataFormat/MCCompLabel.h>
#include <SimulationDataFormat/MCTruthContainer.h>
#include "DataFormatsTOF/CalibLHCphaseTOF.h"
#include "DataFormatsTOF/CalibTimeSlewingParamTOF.h"
#include "TOFBase/CalibTOFapi.h"
#include "SimConfig/DigiParams.h"
#include "DetectorsBase/BaseDPLDigitizer.h"
#include "DetectorsRaw/HBFUtils.h"
#include "TOFBase/Geo.h"
#include "Framework/CCDBParamSpec.h"
#include "DataFormatsTOF/ParameterContainers.h"
#include "SimConfig/DigiParams.h"
 
using namespace o2::framework;
using namespace o2::dataformats;
 
using SubSpecificationType = o2::framework::DataAllocator::SubSpecificationType;
 
namespace o2
{
namespace tof
{
 
class TOFDPLDigitizerTask : public o2::base::BaseDPLDigitizer
{
 public:
  TOFDPLDigitizerTask(bool useCCDB, std::string ccdb_url, int timestamp, uint32_t mask) : mUseCCDB{useCCDB}, mCCDBurl(ccdb_url), mTimestamp(timestamp), o2::base::BaseDPLDigitizer(o2::base::InitServices::FIELD | o2::base::InitServices::GEOM), mPass(o2::conf::DigiParams::Instance().passName), mMaskDRM(mask){};
 
  void initDigitizerTask(framework::InitContext& ic) override
  {
    LOG(info) << "Initializing TOF digitization";
 
    mSimChains = std::move(std::make_unique<std::vector<TChain*>>());
 
    // the instance of the actual digitizer
    mDigitizer = std::move(std::make_unique<o2::tof::Digitizer>());
    // containers for digits and labels
    mDigits = std::move(std::make_unique<std::vector<o2::tof::Digit>>());
    mLabels = std::move(std::make_unique<o2::dataformats::MCTruthContainer<o2::MCCompLabel>>());
 
    // init digitizer
    mDigitizer->init();
    const bool isContinuous = ic.options().get<int>("pileup");
    LOG(info) << "CONTINUOUS " << isContinuous;
    mDigitizer->setContinuous(isContinuous);
    mDigitizer->setMCTruthContainer(mLabels.get());
    LOG(info) << "TOF initialization done";
  }
 
  void finaliseCCDB(o2::framework::ConcreteDataMatcher matcher, void* obj)
  {
    if (matcher == ConcreteDataMatcher("TOF", "DiagnosticCal", 0)) {
      mUpdateCCDB = true;
      return;
    }
    if (matcher == ConcreteDataMatcher("TOF", "DiagnosticDRM", 0)) {
      mUpdateCCDB = true;
      return;
    }
    if (matcher == ConcreteDataMatcher("TOF", "LHCphaseCal", 0)) {
      mUpdateCCDB = true;
      return;
    }
    if (matcher == ConcreteDataMatcher("TOF", "ChannelCalibCal", 0)) {
      mUpdateCCDB = true;
      return;
    }
    if (matcher == ConcreteDataMatcher("TOF", "StatusTOF", 0)) {
      mUpdateCCDB = true;
      return;
    }
    if (matcher == ConcreteDataMatcher("TOF", "parameters", 0)) {
      mUpdateCCDB = true;
      return;
    }
  }
 
  void run(framework::ProcessingContext& pc)
  {
    static bool finished = false;
    if (finished) {
      return;
    }
    // RS: at the moment using hardcoded flag for continuos readout
    static o2::parameters::GRPObject::ROMode roMode = o2::parameters::GRPObject::CONTINUOUS;
 
    // read collision context from input
    auto context = pc.inputs().get<o2::steer::DigitizationContext*>("collisioncontext");
    auto& timesview = context->getEventRecords();
    LOG(debug) << "GOT " << timesview.size() << " COLLISSION TIMES";
 
    context->initSimChains(o2::detectors::DetID::TOF, *mSimChains.get());
 
    // if there is nothing to do ... return
    if (timesview.size() == 0) {
      return;
    }
 
    TStopwatch timer;
    timer.Start();
 
    LOG(info) << " CALLING TOF DIGITIZATION ";
    o2::dataformats::CalibLHCphaseTOF* lhcPhase = new o2::dataformats::CalibLHCphaseTOF;
    o2::dataformats::CalibTimeSlewingParamTOF* channelCalib = new o2::dataformats::CalibTimeSlewingParamTOF;
 
    if (mUseCCDB) {
      const auto lhcPhaseIn = pc.inputs().get<o2::dataformats::CalibLHCphaseTOF*>("tofccdbLHCphase");
      const auto channelCalibIn = pc.inputs().get<o2::dataformats::CalibTimeSlewingParamTOF*>("tofccdbChannelCalib");
      const auto diagnosticIn = pc.inputs().get<o2::tof::Diagnostic*>("tofccdbDia");
      const auto diagnosticDRM = pc.inputs().get<o2::tof::Diagnostic*>("tofccdbDrm");
      const auto statusIn = pc.inputs().get<o2::tof::TOFFEElightInfo*>("tofccdbStatus");
      const auto tofParams = pc.inputs().get<o2::tof::ParameterCollection*>("tofccdbParams");
 
      if (tofParams->getSize(mPass) < 0) { // this is supposed to be temporary till all the pieces are in place
        LOG(info) << "Pass " << mPass << " requested but not found in the tofParams object -> using unanchored";
        mPass = "unanchored";
      }
 
      if (tofParams->getSize(mPass) < 0) {
        LOG(fatal) << "Pass " << mPass << " not found in the tofParams object (stop here!)";
      } else {
        const auto& params = tofParams->getPars(mPass);
        if (params.count("time_resolution")) {
          mDigitizer->setResolution(params.at("time_resolution"));
          LOG(info) << "time_resolution load from ccdb -> " << params.at("time_resolution");
        }
        if (params.count("eff_center")) {
          mDigitizer->setEffCenter(params.at("eff_center"));
          LOG(info) << "eff_center load from ccdb -> " << params.at("eff_center");
        }
        if (params.count("eff_boundary1")) {
          mDigitizer->setEffBoundary1(params.at("eff_boundary1"));
          LOG(info) << "eff_boundary1 load from ccdb -> " << params.at("eff_boundary1");
        }
        if (params.count("eff_boundary2")) {
          mDigitizer->setEffBoundary2(params.at("eff_boundary2"));
          LOG(info) << "eff_boundary2 load from ccdb -> " << params.at("eff_boundary2");
        }
        if (params.count("eff_boundary3")) {
          mDigitizer->setEffBoundary3(params.at("eff_boundary3"));
          LOG(info) << "eff_boundary3 load from ccdb -> " << params.at("eff_boundary3");
        }
      }
 
      if (!mCalibApi) {
        o2::dataformats::CalibLHCphaseTOF* lhcPhase = new o2::dataformats::CalibLHCphaseTOF(std::move(*lhcPhaseIn));
        o2::dataformats::CalibTimeSlewingParamTOF* channelCalib = new o2::dataformats::CalibTimeSlewingParamTOF(std::move(*channelCalibIn));
        o2::tof::Diagnostic* diagnostic = new o2::tof::Diagnostic(std::move(*diagnosticIn));
        o2::tof::Diagnostic* diagnosticDRMerr = new o2::tof::Diagnostic(std::move(*diagnosticDRM));
        o2::tof::TOFFEElightInfo* status = new o2::tof::TOFFEElightInfo(std::move(*statusIn));
 
        mCalibApi = new o2::tof::CalibTOFapi(long(0), lhcPhase, channelCalib, diagnostic, diagnosticDRMerr);
        mCalibApi->setDRMCriticalErrorMask(mMaskDRM);
        mCalibApi->loadDiagnosticFrequencies();
        mCalibApi->loadDiagnosticDRMFrequencies();
        mCalibApi->loadActiveMap(status);
 
        mUpdateCCDB = false;
      } else { // update if necessary
        if (mUpdateCCDB) {
          LOG(info) << "Update CCDB objects since new";
          delete mCalibApi;
          o2::dataformats::CalibLHCphaseTOF* lhcPhase = new o2::dataformats::CalibLHCphaseTOF(*lhcPhaseIn);
          o2::dataformats::CalibTimeSlewingParamTOF* channelCalib = new o2::dataformats::CalibTimeSlewingParamTOF(*channelCalibIn);
          o2::tof::Diagnostic* diagnostic = new o2::tof::Diagnostic(std::move(*diagnosticIn));
          o2::tof::Diagnostic* diagnosticDRMerr = new o2::tof::Diagnostic(std::move(*diagnosticDRM));
          o2::tof::TOFFEElightInfo* status = new o2::tof::TOFFEElightInfo(std::move(*statusIn));
          mCalibApi = new o2::tof::CalibTOFapi(long(0), lhcPhase, channelCalib, diagnostic);
          mCalibApi->setDRMCriticalErrorMask(mMaskDRM);
          mCalibApi->loadDiagnosticFrequencies();
          mCalibApi->loadDiagnosticDRMFrequencies();
          mCalibApi->loadActiveMap(status);
 
          mUpdateCCDB = false;
        } else {
          // do nothing
        }
      }
    } else if (!mCalibApi) { // calibration objects set to zero
      auto* lhcPhaseDummy = new o2::dataformats::CalibLHCphaseTOF();
      auto* channelCalibDummy = new o2::dataformats::CalibTimeSlewingParamTOF();
 
      lhcPhaseDummy->addLHCphase(0, 0);
      lhcPhaseDummy->addLHCphase(2000000000, 0);
 
      for (int ich = 0; ich < o2::dataformats::CalibTimeSlewingParamTOF::NCHANNELS; ich++) {
        channelCalibDummy->addTimeSlewingInfo(ich, 0, 0);
        int sector = ich / o2::dataformats::CalibTimeSlewingParamTOF::NCHANNELXSECTOR;
        int channelInSector = ich % o2::dataformats::CalibTimeSlewingParamTOF::NCHANNELXSECTOR;
        channelCalibDummy->setFractionUnderPeak(sector, channelInSector, 1);
      }
      mCalibApi = new o2::tof::CalibTOFapi(long(mTimestamp), lhcPhaseDummy, channelCalibDummy);
      mCalibApi->setDRMCriticalErrorMask(mMaskDRM);
 
      if (mUseCCDB) {
        mCalibApi->setURL(mCCDBurl);
        mCalibApi->readDiagnosticFrequencies();
        mCalibApi->readDiagnosticDRMFrequencies();
        mCalibApi->readLHCphase();
        mCalibApi->readActiveMap();
        mCalibApi->readTimeSlewingParam();
      }
    }
 
    mDigitizer->setCalibApi(mCalibApi);
 
    mCalibApi->setTimeStamp(o2::raw::HBFUtils::Instance().startTime / 1000);
 
    static std::vector<o2::tof::HitType> hits;
 
    auto& eventParts = context->getEventParts();
    // loop over all composite collisions given from context
    // (aka loop over all the interaction records)
    // o2::InteractionTimeRecord firstorbit(o2::InteractionRecord(0, o2::raw::HBFUtils::Instance().orbitFirstSampled), 0.0);
    for (int collID = 0; collID < timesview.size(); ++collID) {
      o2::InteractionTimeRecord orbit(timesview[collID]);
      // orbit += firstorbit;
      mDigitizer->setEventTime(orbit);
 
      // for each collision, loop over the constituents event and source IDs
      // (background signal merging is basically taking place here)
      for (auto& part : eventParts[collID]) {
        mDigitizer->setEventID(part.entryID);
        mDigitizer->setSrcID(part.sourceID);
 
        // get the hits for this event and this source
        hits.clear();
        context->retrieveHits(*mSimChains.get(), "TOFHit", part.sourceID, part.entryID, &hits);
 
        //        LOG(info) << "For collision " << collID << " eventID " << part.entryID << " found " << hits.size() << " hits ";
 
        // call actual digitization procedure
        mLabels->clear();
        mDigits->clear();
        mDigitizer->process(&hits, mDigits.get());
      }
    }
    if (mDigitizer->isContinuous()) {
      LOG(info) << "clear all";
      mDigits->clear();
      mLabels->clear();
      LOG(info) << "finalize";
      mDigitizer->flushOutputContainer(*mDigits.get());
    }
 
    std::vector<Digit>* digitsVector = mDigitizer->getDigitPerTimeFrame();
    std::vector<ReadoutWindowData>* readoutwindow = mDigitizer->getReadoutWindowData();
    std::vector<o2::dataformats::MCTruthContainer<o2::MCCompLabel>>* mcLabVecOfVec = mDigitizer->getMCTruthPerTimeFrame();
 
    LOG(info) << "Post " << digitsVector->size() << " digits in " << readoutwindow->size() << " RO windows";
 
    // here we have all digits and we can send them to consumer (aka snapshot it onto output)
    pc.outputs().snapshot(Output{o2::header::gDataOriginTOF, "DIGITS", 0}, *digitsVector);
    if (pc.outputs().isAllowed({o2::header::gDataOriginTOF, "DIGITSMCTR", 0})) {
      pc.outputs().snapshot(Output{o2::header::gDataOriginTOF, "DIGITSMCTR", 0}, *mcLabVecOfVec);
    }
    pc.outputs().snapshot(Output{o2::header::gDataOriginTOF, "READOUTWINDOW", 0}, *readoutwindow);
 
    // send empty pattern from digitizer (it may change in future)
    std::vector<uint8_t>& patterns = mDigitizer->getPatterns();
    pc.outputs().snapshot(Output{o2::header::gDataOriginTOF, "PATTERNS", 0}, patterns);
 
    DigitHeader& digitH = mDigitizer->getDigitHeader();
    pc.outputs().snapshot(Output{o2::header::gDataOriginTOF, "DIGITHEADER", 0}, digitH);
 
    LOG(info) << "TOF: Sending ROMode= " << roMode << " to GRPUpdater";
    pc.outputs().snapshot(Output{o2::header::gDataOriginTOF, "ROMode", 0}, roMode);
 
    timer.Stop();
    LOG(info) << "Digitization took " << timer.CpuTime() << "s";
 
    // we should be only called once; tell DPL that this process is ready to exit
    pc.services().get<ControlService>().endOfStream();
 
    finished = true;
  }
 
  void endOfStream(EndOfStreamContext& ec)
  {
    LOGF(debug, "TOF Digitizer endOfStream");
  }
 
 private:
  std::unique_ptr<std::vector<TChain*>> mSimChains;
  std::unique_ptr<o2::tof::Digitizer> mDigitizer;
  std::unique_ptr<std::vector<o2::tof::Digit>> mDigits;
  std::unique_ptr<o2::dataformats::MCTruthContainer<o2::MCCompLabel>> mLabels;
  bool mUseCCDB = false;
  std::string mCCDBurl;
  int mTimestamp = 0;
  bool mUpdateCCDB = false;
  o2::tof::CalibTOFapi* mCalibApi = nullptr;
  std::string mPass;
  uint32_t mMaskDRM = 0;
};
 
DataProcessorSpec getTOFDigitizerSpec(int channel, bool useCCDB, bool mctruth, std::string ccdb_url, int timestamp, uint32_t maskDRM)
{
  // create the full data processor spec using
  //  a name identifier
  //  input description
  //  algorithmic description (here a lambda getting called once to setup the actual processing function)
  //  options that can be used for this processor (here: input file names where to take the hits)
  std::vector<InputSpec> inputs;
  inputs.emplace_back("collisioncontext", "SIM", "COLLISIONCONTEXT", static_cast<SubSpecificationType>(channel), Lifetime::Timeframe);
  //  if (useCCDB) {
  //    inputs.emplace_back("tofccdbLHCphase", o2::header::gDataOriginTOF, "LHCphase");
  //    inputs.emplace_back("tofccdbChannelCalib", o2::header::gDataOriginTOF, "ChannelCalib");
  //  }
 
  if (useCCDB) {
    inputs.emplace_back("tofccdbStatus", "TOF", "StatusTOF", 0, Lifetime::Condition, ccdbParamSpec("TOF/Calib/FEELIGHT"));
    inputs.emplace_back("tofccdbDia", "TOF", "DiagnosticCal", 0, Lifetime::Condition, ccdbParamSpec("TOF/Calib/Diagnostic"));
    inputs.emplace_back("tofccdbDrm", "TOF", "DiagnosticDRM", 0, Lifetime::Condition, ccdbParamSpec("TOF/Calib/DRMerrors"));
    inputs.emplace_back("tofccdbLHCphase", "TOF", "LHCphaseCal", 0, Lifetime::Condition, ccdbParamSpec("TOF/Calib/LHCphase"));
    inputs.emplace_back("tofccdbChannelCalib", "TOF", "ChannelCalibCal", 0, Lifetime::Condition, ccdbParamSpec("TOF/Calib/ChannelCalib"));
    inputs.emplace_back("tofccdbParams", "TOF", "parameters", 0, Lifetime::Condition, ccdbParamSpec("TOF/Calib/Params"));
  }
 
  std::vector<OutputSpec> outputs;
  outputs.emplace_back(o2::header::gDataOriginTOF, "DIGITHEADER", 0, Lifetime::Timeframe);
  outputs.emplace_back(o2::header::gDataOriginTOF, "DIGITS", 0, Lifetime::Timeframe);
  outputs.emplace_back(o2::header::gDataOriginTOF, "READOUTWINDOW", 0, Lifetime::Timeframe);
  outputs.emplace_back(o2::header::gDataOriginTOF, "PATTERNS", 0, Lifetime::Timeframe);
  if (mctruth) {
    outputs.emplace_back(o2::header::gDataOriginTOF, "DIGITSMCTR", 0, Lifetime::Timeframe);
  }
  outputs.emplace_back(o2::header::gDataOriginTOF, "ROMode", 0, Lifetime::Timeframe);
  return DataProcessorSpec{
    "TOFDigitizer",
    inputs,
    outputs,
    AlgorithmSpec{adaptFromTask<TOFDPLDigitizerTask>(useCCDB, ccdb_url, timestamp, maskDRM)},
    Options{{"pileup", VariantType::Int, 1, {"whether to run in continuous time mode"}}}
    // I can't use VariantType::Bool as it seems to have a problem
  };
}
} // end namespace tof
} // end namespace o2