L1CPCMXTools.cxx

Go to the documentation of this file.

/*
  Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
*/
 
#include <map>
#include <memory>
#include <numeric>
#include <utility> // Temporary
 
#include "TrigConfL1Data/CTPConfig.h"
#include "TrigConfL1Data/ClusterThresholdValue.h"
#include "TrigConfL1Data/L1DataDef.h"
#include "TrigConfL1Data/Menu.h"
#include "TrigConfL1Data/TriggerThreshold.h"
#include "TrigConfL1Data/TriggerThresholdValue.h"
#include "TrigT1CaloEvent/CPMTobRoI.h"
#include "TrigT1CaloEvent/EmTauROI.h"
#include "L1CPCMXTools.h"
#include "TrigT1CaloUtils/ClusterProcessorModuleKey.h"
#include "TrigT1CaloUtils/DataError.h"
#include "TrigT1Interfaces/CPRoIDecoder.h"
#include "TrigT1Interfaces/CoordinateRange.h"
#include "TrigT1Interfaces/RecEmTauRoI.h" 
#include "TrigT1Interfaces/TrigT1CaloDefs.h"
 
namespace LVL1 {

 
L1CPCMXTools::L1CPCMXTools(const std::string &type, const std::string &name,
                           const IInterface *parent)
    : AthAlgTool(type, name, parent),
      m_crates(4),
      m_modules(14), m_maxTobs(5), m_sysCrate(3), m_debug(false) {
  declareInterface<IL1CPCMXTools>(this);
 
}

 
StatusCode L1CPCMXTools::initialize() {
  m_debug = msgLvl(MSG::DEBUG);
 
  return StatusCode::SUCCESS;
}

 
std::pair<uint32_t, uint32_t> L1CPCMXTools::roiWord(const EmTauROI *roi) const {
  const uint32_t oldRoi = roi->roiWord();
  CPRoIDecoder decoder;
  const int crate = decoder.crate(oldRoi);
  const int module = decoder.module(oldRoi);
  const int chip = decoder.chip(oldRoi);
  const int coord = decoder.localcoord(oldRoi);
  bool em = false;
  bool tau = false;
  for (unsigned int thresh = 1; thresh <= TrigT1CaloDefs::numOfCPThresholds;
       ++thresh) {
    if (roi->thresholdPassed(thresh)) {
      if (roi->thresholdType(thresh) == TrigT1CaloDefs::EMAlg)
        em = true;
      else
        tau = true;
    }
  }
  uint32_t emRoi = 0;
  uint32_t tauRoi = 0;
  if (em) {
    int isolation =
        isolationEm(roi->clusterEnergy(), roi->emRingIsolationEnergy(),
                    roi->hadRingIsolationEnergy(), roi->hadCoreEnergy());
    const CPMTobRoI newRoi(crate, module, chip, coord, 0, roi->clusterEnergy(),
                           isolation);
    emRoi = newRoi.roiWord();
  }
  if (tau) {
    int isolation =
        isolationTau(roi->tauClusterEnergy(), roi->emRingIsolationEnergy(),
                     roi->hadRingIsolationEnergy());
    const CPMTobRoI newRoi(crate, module, chip, coord, 1,
                           roi->tauClusterEnergy(), isolation);
    tauRoi = newRoi.roiWord();
  }
  return std::make_pair(emRoi, tauRoi);
}
 
int L1CPCMXTools::isolationEm(unsigned int /*clusterEnergy*/,
                              unsigned int /*emIsol*/, unsigned int /*hadIsol*/,
                              unsigned int hadVeto) const {
  int isol = 0;
  if (hadVeto > 1)
    isol = 1;
  return isol;
}
 
int L1CPCMXTools::isolationTau(unsigned int /*clusterEnergy*/,
                               unsigned int emIsol,
                               unsigned int /*hadIsol*/) const {
  int isol = 0;
  if (emIsol > 4)
    isol = 1;
  return isol;
}
 
void L1CPCMXTools::unpackEmIsol(int /*energy*/, int isol, unsigned int &emIsol,
                                unsigned int &hadIsol,
                                unsigned int &hadVeto) const {
  emIsol = 0;
  hadIsol = 0;
  hadVeto = (isol == 1) ? 2 : 0;
}
 
void L1CPCMXTools::unpackTauIsol(int /*energy*/, int isol, unsigned int &emIsol,
                                 unsigned int &hadIsol) const {
  emIsol = (isol == 1) ? 5 : 0;
  hadIsol = 0;
}

 
void L1CPCMXTools::formCMXCPTob(const xAOD::CPMTobRoIContainer *cpmRoiVec,
                                xAOD::CMXCPTobContainer *cmxTobVec) const {
  std::vector<const xAOD::CPMTobRoIContainer *> cpmRoiColls(1, cpmRoiVec);
  formCMXCPTob(cpmRoiColls, cmxTobVec, 0);
}

 
void L1CPCMXTools::formCMXCPTob(
    const std::vector<const xAOD::CPMTobRoIContainer *> &cpmRoiColls,
    xAOD::CMXCPTobContainer *cmxTobVec, uint8_t peak) const {
  std::map<uint32_t, const xAOD::CPMTobRoI *> cpmRoiMap;
  std::map<int, xAOD::CMXCPTob *> cmxTobMap;
  xAOD::CPMTobRoIContainer::const_iterator it;
  int timeslices = cpmRoiColls.size();
  for (int slice = 0; slice < timeslices; ++slice) {
    const xAOD::CPMTobRoIContainer *cpmRoiVec = cpmRoiColls[slice];
    cpmRoiMap.clear();
    std::vector<unsigned int> presenceMaps(2 * m_crates * m_modules);
    std::vector<int> tobCount(2 * m_crates * m_modules);
    xAOD::CPMTobRoIContainer::const_iterator it = cpmRoiVec->begin();
    xAOD::CPMTobRoIContainer::const_iterator itE = cpmRoiVec->end();
    for (; it != itE; ++it) { // get sorted list
      const xAOD::CPMTobRoI *roi = *it;
      const int type = roi->type();
      const int crate = roi->crate();
      const int cpm = roi->cpm();
      const int index = ((type * m_crates) + crate) * m_modules + cpm - 1;
      const int presenceBit =
          (roi->chip() << 1) |
          ((roi->location() >> 2) &
           0x1); // <<== CHECK   THIS SHIFT LOOKS OK @@vkousk
      presenceMaps[index] |= (1 << presenceBit);
      tobCount[index]++;
      uint32_t key = roi->roiWord();
      cpmRoiMap.insert(std::make_pair(key, roi));
    }
    std::map<uint32_t, const xAOD::CPMTobRoI *>::const_iterator mit =
        cpmRoiMap.begin();
    std::map<uint32_t, const xAOD::CPMTobRoI *>::const_iterator mitE =
        cpmRoiMap.end();
    for (; mit != mitE; ++mit) {
      const xAOD::CPMTobRoI *roi = mit->second;
      const int type = roi->type();
      const int crate = roi->crate();
      const int cmx = 1 - type; // <<== CHECK
      const int cpm = roi->cpm();
      const int chip = (roi->chip() << 1) | ((roi->location() >> 2) & 0x1);
      const int loc = roi->location() & 0x3;
      const int index = ((type * m_crates) + crate) * m_modules + cpm - 1;
      const int energy = roi->energy();
      const int isolation = roi->isolation();
      const unsigned int presence = presenceMaps[index];
      int error = 0;
      if (tobCount[index] > m_maxTobs) { // overflow
        int count = 0;
        for (int bit = 0; bit <= chip; ++bit)
          count += (presence >> bit) & 0x1;
        if (count > m_maxTobs)
          continue;
        LVL1::DataError err;
        err.set(LVL1::DataError::Overflow);
        error = err.error();
      }
      const int key =
          (((((((crate << 1) | cmx) << 4) | cpm) << 4) | chip) << 2) | loc;
      xAOD::CMXCPTob *tob = 0;
      std::map<int, xAOD::CMXCPTob *>::iterator xit = cmxTobMap.find(key);
      if (xit == cmxTobMap.end()) {
        tob = new xAOD::CMXCPTob();
        tob->makePrivateStore(); // make temp store
        tob->initialize(crate, cmx, cpm, chip, loc);
        std::vector<uint8_t> vecI(timeslices);
        std::vector<uint32_t> vecU32(timeslices);
        std::vector<uint16_t> vecU(timeslices);
        tob->addTob(vecI, vecI, vecU32, vecU);
        tob->setPeak(peak);
        cmxTobMap.insert(std::make_pair(key, tob));
        cmxTobVec->push_back(tob);
      } else
        tob = xit->second;
      std::vector<uint8_t> energyVec(tob->energyVec());
      std::vector<uint8_t> isolationVec(tob->isolationVec());
      std::vector<uint32_t> errorVec(tob->errorVec());
      std::vector<uint16_t> presenceMapVec(tob->presenceMapVec());
      energyVec[slice] = energy;
      isolationVec[slice] = isolation;
      errorVec[slice] = error;
      presenceMapVec[slice] = presence;
      tob->addTob(energyVec, isolationVec, errorVec, presenceMapVec);
    }
  }
}

 
void L1CPCMXTools::formCMXCPHits(const TrigConf::L1Menu* l1menu,
                 const xAOD::CMXCPTobContainer *cmxTobVec,
                                 xAOD::CMXCPHitsContainer *cmxHitsVec) const {
  xAOD::CMXCPHitsContainer *cmxHitsCrate = new xAOD::CMXCPHitsContainer;
  xAOD::CMXCPHitsContainer *cmxHitsSys = new xAOD::CMXCPHitsContainer;
  // @@vkousk
  // temporarily comment out cmxHitsTopo, see Jira ticket: ATLLONECAL-13
  // xAOD::CMXCPHitsContainer* cmxHitsTopo  = new xAOD::CMXCPHitsContainer;
  formCMXCPHitsCrate(l1menu, cmxTobVec, cmxHitsCrate);
  formCMXCPHitsSystem(cmxHitsCrate, cmxHitsSys);
  // formCMXCPHitsTopo(cmxTobVec, cmxHitsTopo);
  mergeCMXCPHits(cmxHitsVec, cmxHitsCrate);
  mergeCMXCPHits(cmxHitsVec, cmxHitsSys);
  // mergeCMXCPHits(cmxHitsVec, cmxHitsTopo);
  delete cmxHitsCrate;
  delete cmxHitsSys;
  // delete cmxHitsTopo;
}

 
void L1CPCMXTools::formCMXCPHitsCrate(
    const TrigConf::L1Menu* l1menu,
    const xAOD::CMXCPTobContainer *cmxTobVec,
    xAOD::CMXCPHitsContainer *cmxHitsCrate) const {
  uint8_t peakm = 0;
  std::vector<HitsVector> hitVec(4 * m_crates);
  std::vector<ErrorVector> errVec(4 *
                                  m_crates); // Need overflow for neutral format
  HitsVector hit0;
  HitsVector hit1;
  HitsVector hits;
  xAOD::CMXCPTobContainer::const_iterator pos = cmxTobVec->begin();
  xAOD::CMXCPTobContainer::const_iterator pose = cmxTobVec->end();
  for (; pos != pose; ++pos) {
    const xAOD::CMXCPTob *tob = *pos;
    uint8_t crate = tob->crate();
    uint8_t cmx = tob->cmx();
    const int index = (crate * 2 + cmx) * 2;
    const std::vector<uint32_t> &error(tob->errorVec());
    hit0.clear();
    hit1.clear();
    getHits(l1menu, tob, hit0, hit1);
 
    addCMXCPHits(hitVec[index], hit0);
    addCMXCPHits(hitVec[index + 1], hit1);
    addOverflow(errVec[index], error);
    addOverflow(errVec[index + 1], error);
    uint8_t peak = tob->peak();
    if (peak > peakm)
      peakm = peak;
  }
  // Save non-zero crate totals
  for (uint8_t crate = 0; crate < m_crates; ++crate) {
    for (uint8_t cmx = 0; cmx < 2; ++cmx) {
      const int index = (crate * 2 + cmx) * 2;
      saveCMXCPHits(cmxHitsCrate, hitVec[index], hitVec[index + 1],
                    errVec[index], errVec[index + 1], crate, cmx,
                    xAOD::CMXCPHits::LOCAL, peakm);
      if (crate != m_sysCrate) { // REMOTE totals
        uint8_t source = crate;
        saveCMXCPHits(cmxHitsCrate, hitVec[index], hitVec[index + 1],
                      errVec[index], errVec[index + 1], m_sysCrate, cmx, source,
                      peakm);
      }
    }
  }
}
 
void L1CPCMXTools::getHits(const TrigConf::L1Menu* l1menu, const xAOD::CMXCPTob *tob, HitsVector &hit0,
                           HitsVector &hit1) const {
  using namespace TrigConf;
  const std::vector<uint8_t> &energy(tob->energyVec());
  const std::vector<uint8_t> &isolation(tob->isolationVec());
 
  int cmx = tob->cmx();
  int crate = tob->crate();
  int cpm = tob->cpm();
  int chip = (tob->chip() >> 1) & 0x7;
  int loc = tob->location() | ((tob->chip() & 1) << 2);
  auto err = LVL1::DataError(tob->error());
 
  const int type = 1 - cmx;
  const int timeslices = energy.size();
  hit0.resize(timeslices);
  hit1.resize(timeslices);
 
  // Get thresholds from menu
  const std::string thrType = (type == 0) ? L1DataDef::typeAsString(L1DataDef::EM) : L1DataDef::typeAsString(L1DataDef::TAU);
 
  // Get EM and TAU trigger thresholds
  std::vector<std::shared_ptr<TrigConf::L1Threshold>> allThresholds = l1menu->thresholds();
  std::vector<std::shared_ptr<TrigConf::L1Threshold>> thresholds;
  thresholds.reserve(16);
 
  for ( const auto& thresh : allThresholds ) {
    if (thresh->type() == thrType) {
      thresholds.push_back(thresh);
    }
  }
 
  if (thresholds.size() > 16) {
    ATH_MSG_ERROR("Wrong number of thresholds " << thresholds.size());
    return;
  }
 
  for (int slice = 0; slice < timeslices; ++slice) {
    if (energy[slice] == 0)
      continue;
 
    if (err.get(LVL1::DataError::Overflow)) {
      hit0[slice] = 0xffffff;
      hit1[slice] = 0xffffff;
      continue;
    }
    /* Form an RoI word from the information present
       Simplest way without duplication is to create a CPMTobRoI */
    int et = energy[slice];
    int isol = isolation[slice];
    std::unique_ptr<LVL1::CPMTobRoI> roi(
        new CPMTobRoI(crate, cpm, chip, loc, type, et, isol));
 
    /* Now get the hit information using RecEmTauroI */
    RecEmTauRoI recRoI(roi->roiWord(), &(*l1menu));
    auto mask = recRoI.thresholdPattern();
    for (const auto& threshold : thresholds) {
      auto numThresh = threshold->mapping();
      if (!recRoI.isValidThreshold(numThresh) ||
          (((1 << numThresh) & mask) == 0)) {
        continue;
      }
      if (numThresh < 8) {
        hit0[slice] |= (1 << (numThresh * 3));
      } else {
        hit1[slice] |= (1 << ((numThresh - 8) * 3));
      }
    }
  }
}
 
void L1CPCMXTools::addOverflow(ErrorVector &hitErr,
                               const ErrorVector &tobErr) const {
  const int timeslices = tobErr.size();
  hitErr.resize(timeslices);
  for (int slice = 0; slice < timeslices; ++slice) {
    int error = tobErr[slice];
    if (error) {
      LVL1::DataError err(error);
      int overflow = err.get(LVL1::DataError::Overflow);
      LVL1::DataError err2;
      err2.set(LVL1::DataError::Overflow, overflow);
      hitErr[slice] |= err2.error();
    }
  }
}

 
void L1CPCMXTools::formCMXCPHitsSystem(
    const xAOD::CMXCPHitsContainer *cmxHitsCrate,
    xAOD::CMXCPHitsContainer *cmxHitsSys) const {
  uint8_t peakm = 0;
  std::vector<HitsVector> systemHit0(2);
  std::vector<HitsVector> systemHit1(2);
  std::vector<ErrorVector> systemErr0(2);
  std::vector<ErrorVector> systemErr1(2);
  DataVector<xAOD::CMXCPHits>::const_iterator pos = cmxHitsCrate->begin();
  DataVector<xAOD::CMXCPHits>::const_iterator pose = cmxHitsCrate->end();
  for (; pos != pose; ++pos) {
    const xAOD::CMXCPHits *hits = *pos;
    if (hits->crate() != m_sysCrate)
      continue;
    uint8_t source = hits->sourceComponent();
    if (source != xAOD::CMXCPHits::LOCAL &&
        source != xAOD::CMXCPHits::REMOTE_0 &&
        source != xAOD::CMXCPHits::REMOTE_1 &&
        source != xAOD::CMXCPHits::REMOTE_2)
      continue;
    const uint8_t peak = hits->peak();
    if (peak > peakm)
      peakm = peak;
    HitsVector hits0(hits->hitsVec0());
    HitsVector hits1(hits->hitsVec1());
    ErrorVector err0(hits->errorVec0());
    ErrorVector err1(hits->errorVec1());
    uint8_t cmx = hits->cmx();
    addCMXCPHits(systemHit0[cmx], hits0);
    addCMXCPHits(systemHit1[cmx], hits1);
    addOverflow(systemErr0[cmx], err0);
    addOverflow(systemErr1[cmx], err1);
  }
  // Save non-zero system totals
  for (uint8_t cmx = 0; cmx < 2; ++cmx) {
    saveCMXCPHits(cmxHitsSys, systemHit0[cmx], systemHit1[cmx], systemErr0[cmx],
                  systemErr1[cmx], m_sysCrate, cmx, xAOD::CMXCPHits::TOTAL,
                  peakm);
  }
}
 // Temporary for
                                                        // testing
 
void L1CPCMXTools::formCMXCPHitsTopo(
    const xAOD::CMXCPTobContainer *cmxTobVec,
    xAOD::CMXCPHitsContainer *cmxHitsTopo) const {
  uint8_t peakm = 0;
  int timeslices = 0;
  std::vector<HitsVector> hitVec(8 * m_crates);
  xAOD::CMXCPTobContainer::const_iterator pos = cmxTobVec->begin();
  xAOD::CMXCPTobContainer::const_iterator pose = cmxTobVec->end();
  for (; pos != pose; ++pos) {
    const xAOD::CMXCPTob *tob = *pos;
    uint8_t crate = tob->crate();
    uint8_t cmx = tob->cmx();
    const uint8_t cpm = tob->cpm();
    const uint8_t chip = tob->chip() >> 1;
    const uint8_t loc = ((tob->chip() & 0x1) << 2) | tob->location();
    const int index = (crate * 2 + cmx) * 4;
    const std::vector<uint8_t> &energy(tob->energyVec());
    const std::vector<uint8_t> &isolation(tob->isolationVec());
    const std::vector<uint32_t> &error(tob->errorVec());
    timeslices = energy.size();
    HitsVector &checksum(hitVec[index]);
    HitsVector &map(hitVec[index + 1]);
    HitsVector &countsLow(hitVec[index + 2]);
    HitsVector &countsHigh(hitVec[index + 3]);
    checksum.resize(timeslices);
    map.resize(timeslices);
    countsLow.resize(timeslices);
    countsHigh.resize(timeslices);
    for (int slice = 0; slice < timeslices; ++slice) {
      if (energy[slice] == 0)
        continue;
      // checksum
      LVL1::DataError err(error[slice]);
      int overflow = err.get(LVL1::DataError::Overflow);
      checksum[slice] +=
          cpm + chip + loc + energy[slice] + isolation[slice] + overflow;
      checksum[slice] &= 0xff;
      // occupancy map
      map[slice] |= (1 << (cpm - 1));
      // occupancy counts
      if (cpm <= 7) {
        countsLow[slice] += (1 << (3 * (cpm - 1))); // can't saturate
      } else {
        countsHigh[slice] += (1 << (3 * (cpm - 8)));
      }
    }
    uint8_t peak = tob->peak();
    if (peak > peakm)
      peakm = peak;
  }
  // Save non-zero crate totals
  HitsVector dummy(timeslices);
  std::vector<uint32_t> dummyE(timeslices);
  for (uint8_t crate = 0; crate < m_crates; ++crate) {
    for (uint8_t cmx = 0; cmx < 2; ++cmx) {
      const int index = (crate * 2 + cmx) * 4;
      saveCMXCPHits(cmxHitsTopo, hitVec[index], dummy, dummyE, dummyE, crate,
                    cmx, xAOD::CMXCPHits::TOPO_CHECKSUM, peakm);
      saveCMXCPHits(cmxHitsTopo, hitVec[index + 1], dummy, dummyE, dummyE,
                    crate, cmx, xAOD::CMXCPHits::TOPO_OCCUPANCY_MAP, peakm);
      saveCMXCPHits(cmxHitsTopo, hitVec[index + 2], hitVec[index + 3], dummyE,
                    dummyE, crate, cmx, xAOD::CMXCPHits::TOPO_OCCUPANCY_COUNTS,
                    peakm);
    }
  }
}

 
void L1CPCMXTools::addCMXCPHits(HitsVector &vec1,
                                const HitsVector &vec2) const {
  int size1 = vec1.size();
  int size2 = vec2.size();
  if (size1 < size2)
    vec1.resize(size2);
  HitsVector::iterator pos1 = vec1.begin();
  HitsVector::iterator pose1 = vec1.end();
  HitsVector::const_iterator pos2 = vec2.begin();
  HitsVector::const_iterator pose2 = vec2.end();
  for (; pos1 != pose1 && pos2 != pose2; ++pos1, ++pos2) {
    *pos1 = addHits(*pos1, *pos2, 24, 24);
  }
}

 
unsigned int L1CPCMXTools::addHits(unsigned int hitMult, unsigned int hitVec,
                                   int multBits, int vecBits) const {
  if (m_debug)
    msg() << MSG::DEBUG << "addHits: Original hitMult = " << std::hex << hitMult
          << ". Add hitWord = " << hitVec << std::dec << endmsg;
 
  // Results transmitted in 2 words, each reporting half of the CP thresholds
  int nthresh = TrigT1CaloDefs::numOfCPThresholds / 2;
 
  int nbitsOut = multBits / nthresh;
  int nbitsIn = vecBits / nthresh;
 
  if (m_debug)
    msg() << MSG::DEBUG << " Bits per threshold = " << nbitsOut << endmsg;
 
  int max = (1 << nbitsOut) - 1;
  unsigned int multMask = max;
  unsigned int hitMask = (1 << nbitsIn) - 1;
  unsigned int shift = 0;
 
  unsigned int hits = 0;
 
  for (int i = 0; i < nthresh; i++) {
    int mult = (hitMult & multMask) + (hitVec & hitMask);
    mult = ((mult <= max) ? mult : max);
    hits += (mult << shift);
 
    hitMult >>= nbitsOut;
    hitVec >>= nbitsIn;
    shift += nbitsOut;
  }
 
  if (m_debug)
    msg() << MSG::DEBUG << "addHits returning hitMult = " << std::hex << hits
          << std::dec << endmsg;
 
  return hits;
}

 
void L1CPCMXTools::mergeCMXCPHits(xAOD::CMXCPHitsContainer *cmxHitsVec1,
                                  xAOD::CMXCPHitsContainer *cmxHitsVec2) const {
  int size = cmxHitsVec2->size();
  for (int index = 0; index < size; ++index) {
    xAOD::CMXCPHits *hitsIn = 0;
    xAOD::CMXCPHits *hitsOut = 0;
    cmxHitsVec2->swapElement(index, hitsIn, hitsOut);
    cmxHitsVec1->push_back(hitsOut);
  }
  cmxHitsVec2->clear();
}

 
void L1CPCMXTools::saveCMXCPHits(
    xAOD::CMXCPHitsContainer *cmxHitsVec, const HitsVector &hits0,
    const HitsVector &hits1, const ErrorVector &err0, const ErrorVector &err1,
    uint8_t crate, uint8_t cmx, uint8_t source, uint8_t peak) const {
  if (std::accumulate(hits0.begin(), hits0.end(), 0) ||
      std::accumulate(hits1.begin(), hits1.end(), 0)) {
    xAOD::CMXCPHits *cmxCpHits = new xAOD::CMXCPHits();
    cmxCpHits->makePrivateStore();
    cmxCpHits->initialize(crate, cmx, source, hits0, hits1, err0, err1, peak);
    cmxHitsVec->push_back(cmxCpHits);
  }
}
 
} // end of namespace