DigitReaderSpec.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 <vector>
 
#include "TTree.h"
 
#include "Framework/ControlService.h"
#include "Framework/ConfigParamRegistry.h"
#include "Framework/Logger.h"
#include "ITSMFTWorkflow/DigitReaderSpec.h"
#include "ITSMFTBase/DPLAlpideParam.h"
#include "ITSMFTReconstruction/ChipMappingITS.h"
#include "ITSMFTReconstruction/ChipMappingMFT.h"
#include "SimulationDataFormat/MCCompLabel.h"
#include "SimulationDataFormat/ConstMCTruthContainer.h"
#include "DataFormatsITSMFT/PhysTrigger.h"
#include "CommonUtils/NameConf.h"
#include "CommonDataFormat/IRFrame.h"
#include "CommonUtils/IRFrameSelector.h"
#include "CCDB/BasicCCDBManager.h"
#include <cassert>
 
using namespace o2::framework;
using namespace o2::itsmft;
 
namespace o2
{
namespace itsmft
{
 
DigitReader::DigitReader(o2::detectors::DetID id, bool useMC, bool useCalib, bool triggerOut)
{
  assert(id == o2::detectors::DetID::ITS || id == o2::detectors::DetID::MFT);
  mDetNameLC = mDetName = id.getName();
  mDigTreeName = "o2sim";
 
  mDigitBranchName = mDetName + mDigitBranchName;
  mDigROFBranchName = mDetName + mDigROFBranchName;
  mCalibBranchName = mDetName + mCalibBranchName;
 
  mDigtMCTruthBranchName = mDetName + mDigtMCTruthBranchName;
  mDigtMC2ROFBranchName = mDetName + mDigtMC2ROFBranchName;
  mTriggerOut = triggerOut;
  mUseMC = useMC;
  mUseCalib = useCalib;
  std::transform(mDetNameLC.begin(), mDetNameLC.end(), mDetNameLC.begin(), ::tolower);
}
 
void DigitReader::init(InitContext& ic)
{
  mFileName = o2::utils::Str::concat_string(o2::utils::Str::rectifyDirectory(ic.options().get<std::string>("input-dir")),
                                            ic.options().get<std::string>((mDetNameLC + "-digit-infile").c_str()));
  if (ic.options().hasOption("ignore-irframes") && !ic.options().get<bool>("ignore-irframes")) {
    mUseIRFrames = true;
  }
  connectTree(mFileName);
}
 
void DigitReader::run(ProcessingContext& pc)
{
  const auto& tinfo = pc.services().get<o2::framework::TimingInfo>();
  if (tinfo.globalRunNumberChanged && mUseIRFrames) { // new run is starting: 1st call
    // TODO: we have to find a way define CCDBInput for IRFrames mode only using DPL fetcher
    auto& ccdb = o2::ccdb::BasicCCDBManager::instance();
    auto rlim = ccdb.getRunDuration(tinfo.runNumber);
    long ts = (rlim.first + rlim.second) / 2;
    if (mOrigin == o2::header::gDataOriginITS) {
      ccdb.getForTimeStamp<o2::itsmft::DPLAlpideParam<o2::detectors::DetID::ITS>>("ITS/Config/AlpideParam", ts);
      const auto& alpideParam = o2::itsmft::DPLAlpideParam<o2::detectors::DetID::ITS>::Instance();
      mROFBiasInBC = alpideParam.roFrameBiasInBC;
      mROFLengthInBC = alpideParam.roFrameLengthInBC;
      mNRUs = o2::itsmft::ChipMappingITS::getNRUs();
    } else {
      ccdb.getForTimeStamp<o2::itsmft::DPLAlpideParam<o2::detectors::DetID::MFT>>("MFT/Config/AlpideParam", ts);
      const auto& alpideParam = o2::itsmft::DPLAlpideParam<o2::detectors::DetID::MFT>::Instance();
      mROFBiasInBC = alpideParam.roFrameBiasInBC;
      mROFLengthInBC = alpideParam.roFrameLengthInBC;
      mNRUs = o2::itsmft::ChipMappingMFT::getNRUs();
    }
  }
  gsl::span<const o2::dataformats::IRFrame> irFrames{};
  if (mUseIRFrames) {
    irFrames = pc.inputs().get<gsl::span<o2::dataformats::IRFrame>>("driverInfo");
  }
  static o2::dataformats::IOMCTruthContainerView* plabels = nullptr;
  if (mUseMC && !plabels) {
    mTree->SetBranchAddress(mDigtMCTruthBranchName.c_str(), &plabels);
  }
  auto ent = mTree->GetReadEntry();
 
  if (!mUseIRFrames) {
    ent++;
    assert(ent < mTree->GetEntries()); // this should not happen
    mTree->GetEntry(ent);
    LOG(info) << mDetName << "DigitReader pushes " << mDigROFRec.size() << " ROFRecords, " << mDigits.size() << " digits at entry " << ent;
    pc.outputs().snapshot(Output{mOrigin, "DIGITSROF", 0}, mDigROFRec);
    pc.outputs().snapshot(Output{mOrigin, "DIGITS", 0}, mDigits);
    if (mUseCalib) {
      pc.outputs().snapshot(Output{mOrigin, "GBTCALIB", 0}, mCalib);
    }
    if (mTriggerOut) {
      std::vector<o2::itsmft::PhysTrigger> dummyTrig;
      pc.outputs().snapshot(Output{mOrigin, "PHYSTRIG", 0}, dummyTrig);
    }
    if (mUseMC) {
      auto& sharedlabels = pc.outputs().make<o2::dataformats::ConstMCTruthContainer<o2::MCCompLabel>>(Output{mOrigin, "DIGITSMCTR", 0});
      plabels->copyandflatten(sharedlabels);
      delete plabels;
      plabels = nullptr;
      pc.outputs().snapshot(Output{mOrigin, "DIGITSMC2ROF", 0}, mDigMC2ROFs);
    }
    if (mTree->GetReadEntry() + 1 >= mTree->GetEntries()) {
      pc.services().get<ControlService>().endOfStream();
      pc.services().get<ControlService>().readyToQuit(QuitRequest::Me);
    }
  } else { // need to select particulars IRs range, presumably from the same tree entry
    std::vector<o2::itsmft::Digit> digitsSel;
    std::vector<o2::itsmft::GBTCalibData> calibSel;
    std::vector<o2::itsmft::ROFRecord> digROFRecSel;
    std::vector<o2::itsmft::MC2ROFRecord> digMC2ROFsSel;
    o2::dataformats::MCTruthContainer<o2::MCCompLabel> digitLabelsSel;
 
    if (irFrames.size()) { // we assume the IRFrames are in the increasing order
      if (ent < 0) {
        ent++;
      }
      o2::utils::IRFrameSelector irfSel;
      irfSel.setSelectedIRFrames(irFrames, 0, 0, -mROFBiasInBC, true);
      const auto irMin = irfSel.getIRFrames().front().getMin(); // use processed IRframes for rough comparisons (possible shift!)
      const auto irMax = irfSel.getIRFrames().back().getMax();
      LOGP(info, "Selecting IRFrame {}-{}", irMin.asString(), irMax.asString());
      while (ent < mTree->GetEntries()) {
        // do we need to read a new entry?
        if (ent > mTree->GetReadEntry()) {
          if (mUseMC) {
            delete plabels;
            plabels = nullptr;
            mConstLabels.clear();
            mTree->SetBranchAddress(mDigtMCTruthBranchName.c_str(), &plabels);
          }
          mTree->GetEntry(ent);
          if (mUseMC) {
            plabels->copyandflatten(mConstLabels);
            delete plabels;
            plabels = nullptr;
          }
        }
        std::vector<int> rofOld2New;
        rofOld2New.resize(mDigROFRec.size(), -1);
 
        if (mDigROFRec.front().getBCData() <= irMax && (mDigROFRec.back().getBCData() + mROFLengthInBC - 1) >= irMin) { // there is an overlap
          for (int irof = 0; irof < (int)mDigROFRec.size(); irof++) {
            const auto& rof = mDigROFRec[irof];
            if (irfSel.check({rof.getBCData(), rof.getBCData() + mROFLengthInBC - 1}) != -1) {
              rofOld2New[irof] = (int)digROFRecSel.size();
              LOGP(debug, "Adding selected ROF {}", rof.getBCData().asString());
              digROFRecSel.push_back(rof);
              int offs = digitsSel.size();
              digROFRecSel.back().setFirstEntry(offs);
              std::copy(mDigits.begin() + rof.getFirstEntry(), mDigits.begin() + rof.getFirstEntry() + rof.getNEntries(), std::back_inserter(digitsSel));
              for (int id = 0; id < rof.getNEntries(); id++) { // copy MC info
                digitLabelsSel.addElements(id + offs, mConstLabels.getLabels(id + rof.getFirstEntry()));
              }
              if (mCalib.size() >= size_t((irof + 1) * mNRUs)) {
                std::copy(mCalib.begin() + irof * mNRUs, mCalib.begin() + (irof + 1) * mNRUs, std::back_inserter(calibSel));
              }
            }
          }
        }
        if (mUseMC) {
          digMC2ROFsSel = mDigMC2ROFs;
          for (auto& mc2rof : digMC2ROFsSel) {
            if (mc2rof.rofRecordID < 0) {
              continue; // did not contribute even to the original data
            }
            unsigned int mn = 0xffff, mx = 0;
            for (int ir = mc2rof.minROF; ir <= mc2rof.maxROF; ir++) {
              if (rofOld2New[ir] >= 0) { // used
                mx = rofOld2New[ir];
                if (mn > mx) {
                  mn = mx;
                }
              }
            }
            mc2rof.rofRecordID = mn == 0xffff ? -1 : int(mn);
            mc2rof.minROF = mn;
            mc2rof.maxROF = mx;
          }
        }
        if (mDigROFRec.back().getBCData() + mROFLengthInBC - 1 < irMax) { // need to check the next entry
          ent++;
          continue;
        }
        break; // push collected data
      }
    }
    pc.outputs().snapshot(Output{mOrigin, "DIGITSROF", 0}, digROFRecSel);
    pc.outputs().snapshot(Output{mOrigin, "DIGITS", 0}, digitsSel);
    if (mUseCalib) {
      pc.outputs().snapshot(Output{mOrigin, "GBTCALIB", 0}, calibSel);
    }
    if (mTriggerOut) {
      std::vector<o2::itsmft::PhysTrigger> dummyTrig;
      pc.outputs().snapshot(Output{mOrigin, "PHYSTRIG", 0}, dummyTrig);
    }
    if (mUseMC) {
      auto& sharedlabels = pc.outputs().make<o2::dataformats::ConstMCTruthContainer<o2::MCCompLabel>>(Output{mOrigin, "DIGITSMCTR", 0});
      digitLabelsSel.flatten_to(sharedlabels);
      pc.outputs().snapshot(Output{mOrigin, "DIGITSMC2ROF", 0}, digMC2ROFsSel);
    }
 
    if (!irFrames.size() || irFrames.back().isLast()) {
      pc.services().get<ControlService>().endOfStream();
      pc.services().get<ControlService>().readyToQuit(QuitRequest::Me);
    }
  }
}
 
void DigitReader::connectTree(const std::string& filename)
{
  mTree.reset(nullptr); // in case it was already loaded
  mFile.reset(TFile::Open(filename.c_str()));
  assert(mFile && !mFile->IsZombie());
  mTree.reset((TTree*)mFile->Get(mDigTreeName.c_str()));
  assert(mTree);
 
  mTree->SetBranchAddress(mDigROFBranchName.c_str(), &mDigROFRecPtr);
  mTree->SetBranchAddress(mDigitBranchName.c_str(), &mDigitsPtr);
  if (mUseCalib) {
    if (!mTree->GetBranch(mCalibBranchName.c_str())) {
      throw std::runtime_error("GBT calibration data requested but not found in the tree");
    }
    mTree->SetBranchAddress(mCalibBranchName.c_str(), &mCalibPtr);
  }
  if (mUseMC) {
    if (!mTree->GetBranch(mDigtMC2ROFBranchName.c_str()) || !mTree->GetBranch(mDigtMCTruthBranchName.c_str())) {
      throw std::runtime_error("MC data requested but not found in the tree");
    }
    mTree->SetBranchAddress(mDigtMC2ROFBranchName.c_str(), &mDigMC2ROFsPtr);
  }
  LOG(info) << "Loaded tree from " << filename << " with " << mTree->GetEntries() << " entries";
}
 
DataProcessorSpec getITSDigitReaderSpec(bool useMC, bool useCalib, bool useTriggers, std::string defname)
{
  std::vector<OutputSpec> outputSpec;
  outputSpec.emplace_back("ITS", "DIGITS", 0, Lifetime::Timeframe);
  outputSpec.emplace_back("ITS", "DIGITSROF", 0, Lifetime::Timeframe);
  if (useCalib) {
    outputSpec.emplace_back("ITS", "GBTCALIB", 0, Lifetime::Timeframe);
  }
  if (useMC) {
    outputSpec.emplace_back("ITS", "DIGITSMCTR", 0, Lifetime::Timeframe);
    outputSpec.emplace_back("ITS", "DIGITSMC2ROF", 0, Lifetime::Timeframe);
  }
  if (useTriggers) {
    outputSpec.emplace_back("ITS", "PHYSTRIG", 0, Lifetime::Timeframe);
  }
  return DataProcessorSpec{
    "its-digit-reader",
    Inputs{},
    outputSpec,
    AlgorithmSpec{adaptFromTask<ITSDigitReader>(useMC, useCalib)},
    Options{
      {"its-digit-infile", VariantType::String, defname, {"Name of the input digit file"}},
      {"input-dir", VariantType::String, "none", {"Input directory"}}}};
}
 
DataProcessorSpec getMFTDigitReaderSpec(bool useMC, bool useCalib, bool useTriggers, std::string defname)
{
  std::vector<OutputSpec> outputSpec;
  outputSpec.emplace_back("MFT", "DIGITS", 0, Lifetime::Timeframe);
  outputSpec.emplace_back("MFT", "DIGITSROF", 0, Lifetime::Timeframe);
  if (useCalib) {
    outputSpec.emplace_back("MFT", "GBTCALIB", 0, Lifetime::Timeframe);
  }
  if (useMC) {
    outputSpec.emplace_back("MFT", "DIGITSMCTR", 0, Lifetime::Timeframe);
    outputSpec.emplace_back("MFT", "DIGITSMC2ROF", 0, Lifetime::Timeframe);
  }
  if (useTriggers) {
    outputSpec.emplace_back("MFT", "PHYSTRIG", 0, Lifetime::Timeframe);
  }
  return DataProcessorSpec{
    "mft-digit-reader",
    Inputs{},
    outputSpec,
    AlgorithmSpec{adaptFromTask<MFTDigitReader>(useMC, useCalib)},
    Options{
      {"mft-digit-infile", VariantType::String, defname, {"Name of the input digit file"}},
      {"input-dir", VariantType::String, "none", {"Input directory"}}}};
}
 
} // namespace itsmft
} // namespace o2