DigitContainer.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 "TPCSimulation/DigitContainer.h"
#include <memory>
#include <fairlogger/Logger.h>
#include "TPCBase/Mapper.h"
#include "TPCBase/CDBInterface.h"
#include "TPCBase/ParameterElectronics.h"
#include "TPCBase/IonTailSettings.h"
#include "SimConfig/DigiParams.h"
 
using namespace o2::tpc;
 
void DigitContainer::fillOutputContainer(std::vector<Digit>& output,
                                         dataformats::MCTruthContainer<MCCompLabel>& mcTruth, std::vector<CommonMode>& commonModeOutput, const Sector& sector, TimeBin eventTimeBin, bool isContinuous, bool finalFlush)
{
  using Streamer = o2::utils::DebugStreamer;
  Streamer* debugStream = nullptr;
  if (Streamer::checkStream(o2::utils::StreamFlags::streamDigitFolding) || Streamer::checkStream(o2::utils::StreamFlags::streamDigits)) {
    mStreamer.setStreamer("debug_digits", "UPDATE");
    debugStream = &mStreamer;
  }
 
  const auto& eleParam = ParameterElectronics::Instance();
  const auto digitizationMode = eleParam.DigiMode;
  int nProcessedTimeBins = 0;
  TimeBin timeBin = (isContinuous) ? mFirstTimeBin : 0;
 
  // Set the TPC timebin limit, after which digits should be truncated.
  // Without this we might get crashes in the clusterization step.
  static const int maxTimeBinForTimeFrame = o2::conf::DigiParams::Instance().maxOrbitsToDigitize != -1 ? ((o2::conf::DigiParams::Instance().maxOrbitsToDigitize * 3564 + 2 * 8 - 2) / 8) : -1;
 
  auto& cdb = CDBInterface::instance();
 
  // ion tail per pad parameters
  const CalPad* padParams[3] = {nullptr, nullptr, nullptr};
 
  if (eleParam.doIonTailPerPad) {
    const auto& itSettings = IonTailSettings::Instance();
    if (itSettings.padITCorrFile.size()) {
      cdb.setFEEParamsFromFile(itSettings.padITCorrFile);
    }
    padParams[0] = &cdb.getITFraction();
    padParams[1] = &cdb.getITExpLambda();
  }
  if (eleParam.doCommonModePerPad) {
    padParams[2] = &cdb.getCMkValues();
  }
 
  const bool needsPrevDigArray = eleParam.doIonTail || eleParam.doIonTailPerPad || eleParam.doSaturationTail;
  const bool needsEmptyTimeBins = needsPrevDigArray || eleParam.doNoiseEmptyPads;
 
  // TODO: make creation conditional
  if (needsPrevDigArray && !mPrevDigArr) {
    mPrevDigArr = std::make_unique<DigitTime::PrevDigitInfoArray>();
  }
 
  // dead channel map
  const CalDet<bool>* deadMap = {nullptr};
  if (eleParam.applyDeadMap) {
    deadMap = &cdb.getDeadChannelMap();
  }
 
  static bool reportedSettings = false;
  if (!reportedSettings) {
    reportSettings();
    if (deadMap) {
      LOGP(info, "Using dead map with {} masked pads", deadMap->getSum<int>());
    }
    reportedSettings = true;
  }
 
  for (auto& time : mTimeBins) {
    if (!((nProcessedTimeBins + mFirstTimeBin < eventTimeBin) || !isContinuous || finalFlush)) {
      break;
    }
 
    if (!isContinuous && timeBin > mTmaxTriggered) {
      continue;
    }
 
    // fill also time bins without signal to get noise, ion tail and saturated signals
    if (needsEmptyTimeBins && !time) {
      time = new DigitTime;
    }
 
    if (maxTimeBinForTimeFrame != -1 && timeBin >= maxTimeBinForTimeFrame) {
      LOG(warn) << "Timebin going beyond timeframe limit .. truncating flush " << timeBin;
      break;
    }
 
    // fmt::print("Processing secotor: {}, time bin: {}, mFirstTimeBin: {}, dgitTime: {}\n", sector.getSector(), timeBin, mFirstTimeBin, (void*)time);
 
    if (time) {
      switch (digitizationMode) {
        case DigitzationMode::FullMode: {
          time->fillOutputContainer<DigitzationMode::FullMode>(output, mcTruth, commonModeOutput, sector, timeBin, mPrevDigArr.get(), debugStream, padParams, deadMap);
          break;
        }
        case DigitzationMode::ZeroSuppression: {
          time->fillOutputContainer<DigitzationMode::ZeroSuppression>(output, mcTruth, commonModeOutput, sector, timeBin, mPrevDigArr.get(), debugStream, padParams, deadMap);
          break;
        }
        case DigitzationMode::ZeroSuppressionCMCorr: {
          time->fillOutputContainer<DigitzationMode::ZeroSuppressionCMCorr>(output, mcTruth, commonModeOutput, sector, timeBin, mPrevDigArr.get(), debugStream, padParams, deadMap);
          break;
        }
        case DigitzationMode::SubtractPedestal: {
          time->fillOutputContainer<DigitzationMode::SubtractPedestal>(output, mcTruth, commonModeOutput, sector, timeBin, mPrevDigArr.get(), debugStream, padParams, deadMap);
          break;
        }
        case DigitzationMode::NoSaturation: {
          time->fillOutputContainer<DigitzationMode::NoSaturation>(output, mcTruth, commonModeOutput, sector, timeBin, mPrevDigArr.get(), debugStream, padParams, deadMap);
          break;
        }
        case DigitzationMode::PropagateADC: {
          time->fillOutputContainer<DigitzationMode::PropagateADC>(output, mcTruth, commonModeOutput, sector, timeBin, mPrevDigArr.get(), debugStream, padParams, deadMap);
          break;
        }
        case DigitzationMode::Auto: {
          const auto& feeConfig = cdb.getFEEConfig();
          if (feeConfig.isCMCEnabled()) {
            time->fillOutputContainer<DigitzationMode::ZeroSuppressionCMCorr>(output, mcTruth, commonModeOutput, sector, timeBin, mPrevDigArr.get(), debugStream, padParams, deadMap);
          } else {
            time->fillOutputContainer<DigitzationMode::ZeroSuppression>(output, mcTruth, commonModeOutput, sector, timeBin, mPrevDigArr.get(), debugStream, padParams, deadMap);
          }
          break;
        }
      }
    }
 
    ++nProcessedTimeBins;
    ++timeBin;
  }
 
  if (nProcessedTimeBins > 0) {
    mFirstTimeBin += nProcessedTimeBins;
    while (nProcessedTimeBins--) {
      auto popped = mTimeBins.front();
      mTimeBins.pop_front();
      delete popped;
    }
  }
}
 
void DigitContainer::reportSettings()
{
  auto& cdb = CDBInterface::instance();
  const auto& eleParam = ParameterElectronics::Instance();
  const auto& feeConfig = cdb.getFEEConfig();
  LOGP(info, "ParameterElectronics:  doIonTail={}, doIonTailPerPad={}, doCommonModePerPad={}, doSaturationTail={}, doNoiseEmptyPads={}, applyDeadMap={}, commonModeCoupling={}, DigiMode={}",
       eleParam.doIonTail, eleParam.doIonTailPerPad, eleParam.doCommonModePerPad, eleParam.doSaturationTail, eleParam.doNoiseEmptyPads, eleParam.applyDeadMap, eleParam.commonModeCoupling, (int)eleParam.DigiMode);
  feeConfig.printShort();
}