CalorimeterDefinitions.h

Go to the documentation of this file.

#ifndef RecoParticleFlow_PFRecHitProducer_interface_alpaka_CalorimeterDefinitions_h
#define RecoParticleFlow_PFRecHitProducer_interface_alpaka_CalorimeterDefinitions_h

#include <limits>

#include "DataFormats/DetId/interface/DetId.h"
#include "DataFormats/EcalDetId/interface/EcalSubdetector.h"
#include "DataFormats/EcalRecHit/interface/EcalRecHit.h"
#include "DataFormats/HcalDetId/interface/HcalDetId.h"
#include "DataFormats/HcalDetId/interface/HcalSubdetector.h"
#include "DataFormats/HcalRecHit/interface/HBHERecHit.h"
#include "DataFormats/ParticleFlowReco/interface/CaloRecHitHostCollection.h"
#include "DataFormats/ParticleFlowReco/interface/alpaka/CaloRecHitDeviceCollection.h"
#include "RecoParticleFlow/PFRecHitProducer/interface/PFRecHitTopologyHostCollection.h"
#include "RecoParticleFlow/PFRecHitProducer/interface/alpaka/PFRecHitParamsDeviceCollection.h"
#include "RecoParticleFlow/PFRecHitProducer/interface/alpaka/PFRecHitTopologyDeviceCollection.h"

#include "DataFormats/HcalRecHit/interface/HcalRecHitHostCollection.h"
#include "DataFormats/HcalRecHit/interface/alpaka/HcalRecHitDeviceCollection.h"

// Forward declaration of EventSetup records, to avoid propagating the dependency on framework headers to device code
class PFRecHitHCALParamsRecord;
class PFRecHitHCALTopologyRecord;
class EcalPFRecHitThresholdsRcd;
class PFRecHitECALTopologyRecord;

// This file defines two structs:
// 1) ALPAKA_ACCELERATOR_NAMESPACE::particleFlowRecHitProducer::HCAL
// 2) ALPAKA_ACCELERATOR_NAMESPACE::particleFlowRecHitProducer::ECAL
// These are used as template arguments of the PFRecHitSoAProducer class and
// related classes. This allows to specialise behaviour for the two calorimeter
// types.
namespace ALPAKA_ACCELERATOR_NAMESPACE::particleFlowRecHitProducer {

  // Get subdetector encoded in detId to narrow the range of reference table values to search
  constexpr inline uint32_t getSubdet(uint32_t detId) { return DetId(detId).subdetId(); }

  struct HCAL {
    using CaloRecHitType = HBHERecHit;
    using CaloRecHitSoATypeHost = hcal::RecHitHostCollection;
    using CaloRecHitSoATypeDevice = hcal::RecHitDeviceCollection;
    using ParameterType = reco::PFRecHitHCALParamsDeviceCollection;
    using ParameterRecordType = PFRecHitHCALParamsRecord;
    using TopologyTypeHost = reco::PFRecHitHCALTopologyHostCollection;
    using TopologyTypeDevice = reco::PFRecHitHCALTopologyDeviceCollection;
    using TopologyRecordType = PFRecHitHCALTopologyRecord;

    static constexpr DetId::Detector kDetectorId = DetId::Detector::Hcal;
    static constexpr int kSubdetectorBarrelId = HcalSubdetector::HcalBarrel;
    static constexpr int kSubdetectorEndcapId = HcalSubdetector::HcalEndcap;

    static constexpr uint32_t kMaxDepthHB = 4;
    static constexpr uint32_t kMaxDepthHE = 7;
    static constexpr uint32_t kFirstHBRing = 1;
    static constexpr uint32_t kLastHBRing = 16;
    static constexpr uint32_t kFirstHERing = 16;
    static constexpr uint32_t kLastHERing = 29;
    static constexpr uint32_t kMaxIPhi = 72;
    static constexpr uint32_t kSizeBarrel = kMaxDepthHB * (kLastHBRing - kFirstHBRing + 1) * kMaxIPhi * 2;
    static constexpr uint32_t kSizeEndcap = kMaxDepthHE * (kLastHERing - kFirstHERing + 1) * kMaxIPhi * 2;
    static constexpr uint32_t kSize = kSizeBarrel + kSizeEndcap;  // maximum possible HCAL denseId (=23328)

    static constexpr bool detIdInRange(uint32_t detId) {
      return detId != 0 && DetId(detId).det() == DetId::Detector::Hcal &&
             (getSubdet(detId) == HcalSubdetector::HcalBarrel || getSubdet(detId) == HcalSubdetector::HcalEndcap);
    }

    static constexpr uint32_t getDepth(uint32_t detId) { return HcalDetId(detId).depth(); }
    static constexpr uint32_t getIetaAbs(uint32_t detId) { return HcalDetId(detId).ietaAbs(); }
    static constexpr uint32_t getIphi(uint32_t detId) { return HcalDetId(detId).iphi(); }
    static constexpr int getZside(uint32_t detId) { return HcalDetId(detId).zside(); }

    // https://cmssdt.cern.ch/lxr/source/Geometry/CaloTopology/src/HcalTopology.cc#1170
    static constexpr uint32_t detId2denseIdHB(uint32_t detId) {
      const uint32_t nEtaHB = (kLastHBRing - kFirstHBRing + 1);
      const uint32_t ip = getIphi(detId);
      const uint32_t ie = getIetaAbs(detId);
      const uint32_t dp = getDepth(detId);
      const int zn = getZside(detId);
      uint32_t retval = (dp - 1) + kMaxDepthHB * (ip - 1);
      if (zn > 0)
        retval += kMaxDepthHB * kMaxIPhi * (ie * zn - kFirstHBRing);
      else
        retval += kMaxDepthHB * kMaxIPhi * (ie * zn + kLastHBRing + nEtaHB);

      return retval;
    }

    // https://cmssdt.cern.ch/lxr/source/Geometry/CaloTopology/src/HcalTopology.cc#1189
    static constexpr uint32_t detId2denseIdHE(uint32_t detId) {
      const uint32_t nEtaHE = (kLastHERing - kFirstHERing + 1);
      const uint32_t ip = getIphi(detId);
      const uint32_t ie = getIetaAbs(detId);
      const uint32_t dp = getDepth(detId);
      const int zn = getZside(detId);
      uint32_t retval = (dp - 1) + kMaxDepthHE * (ip - 1);
      if (zn > 0)
        retval += kMaxDepthHE * kMaxIPhi * (ie * zn - kFirstHERing);
      else
        retval += kMaxDepthHE * kMaxIPhi * (ie * zn + kLastHERing + nEtaHE);

      return retval + kSizeBarrel;
    }

    static constexpr uint32_t kInvalidDenseId = std::numeric_limits<uint32_t>::max();

    static constexpr uint32_t detId2denseId(uint32_t detId) {
      const uint32_t subdet = getSubdet(detId);
      if (subdet == HcalBarrel)
        return detId2denseIdHB(detId);
      if (subdet == HcalEndcap)
        return detId2denseIdHE(detId);

      printf("invalid detId: %u\n", detId);
      return kInvalidDenseId;
    }
  };

  struct ECAL {
    using CaloRecHitType = EcalRecHit;
    using CaloRecHitSoATypeHost = reco::CaloRecHitHostCollection;
    using CaloRecHitSoATypeDevice = reco::CaloRecHitDeviceCollection;
    using ParameterType = reco::PFRecHitECALParamsDeviceCollection;
    using ParameterRecordType = EcalPFRecHitThresholdsRcd;
    using TopologyTypeHost = reco::PFRecHitECALTopologyHostCollection;
    using TopologyTypeDevice = reco::PFRecHitECALTopologyDeviceCollection;
    using TopologyRecordType = PFRecHitECALTopologyRecord;

    static constexpr DetId::Detector kDetectorId = DetId::Detector::Ecal;
    static constexpr int kSubdetectorBarrelId = EcalSubdetector::EcalBarrel;
    static constexpr int kSubdetectorEndcapId = EcalSubdetector::EcalEndcap;

    using Flags = EcalRecHit::Flags;

    // https://cmssdt.cern.ch/lxr/source/DataFormats/EcalDetId/interface/EBDetId.h
    struct Barrel {
      static constexpr int kMaxIEta = 85;
      static constexpr int kMaxIPhi = 360;
      static constexpr int kSize = 2 * kMaxIPhi * kMaxIEta;

      static constexpr int ietaAbs(uint32_t detId) { return (detId >> 9) & 0x7F; }
      static constexpr int iphi(uint32_t detId) { return detId & 0x1FF; }
      static constexpr bool positiveZ(uint32_t detId) { return detId & 0x10000; }
      static constexpr uint32_t denseIndex(uint32_t detId) {
        return (kMaxIEta + (positiveZ(detId) ? ietaAbs(detId) - 1 : -ietaAbs(detId))) * kMaxIPhi + iphi(detId) - 1;
      }
    };

    // https://cmssdt.cern.ch/lxr/source/DataFormats/EcalDetId/interface/EEDetId.h
    struct Endcap {
      static constexpr uint32_t kEEhalf = 7324;
      static constexpr uint32_t kSize = kEEhalf * 2;

      static constexpr int ix(uint32_t detId) { return (detId >> 7) & 0x7F; }
      static constexpr int iy(uint32_t detId) { return detId & 0x7F; }
      static constexpr bool positiveZ(uint32_t detId) { return detId & 0x4000; }

      static constexpr uint32_t denseIndex(uint32_t detId) {
        const unsigned short kxf[] = {
            41, 51, 41, 51, 41, 51, 36, 51, 36, 51, 26, 51, 26, 51, 26, 51, 21, 51, 21, 51, 21, 51, 21, 51, 21,
            51, 16, 51, 16, 51, 14, 51, 14, 51, 14, 51, 14, 51, 14, 51, 9,  51, 9,  51, 9,  51, 9,  51, 9,  51,
            6,  51, 6,  51, 6,  51, 6,  51, 6,  51, 6,  51, 6,  51, 6,  51, 6,  51, 6,  51, 4,  51, 4,  51, 4,
            51, 4,  51, 4,  56, 1,  58, 1,  59, 1,  60, 1,  61, 1,  61, 1,  62, 1,  62, 1,  62, 1,  62, 1,  62,
            1,  62, 1,  62, 1,  62, 1,  62, 1,  62, 1,  61, 1,  61, 1,  60, 1,  59, 1,  58, 4,  56, 4,  51, 4,
            51, 4,  51, 4,  51, 6,  51, 6,  51, 6,  51, 6,  51, 6,  51, 6,  51, 6,  51, 6,  51, 6,  51, 6,  51,
            9,  51, 9,  51, 9,  51, 9,  51, 9,  51, 14, 51, 14, 51, 14, 51, 14, 51, 14, 51, 16, 51, 16, 51, 21,
            51, 21, 51, 21, 51, 21, 51, 21, 51, 26, 51, 26, 51, 26, 51, 36, 51, 36, 51, 41, 51, 41, 51, 41, 51};

        const unsigned short kdi[] = {
            0,    10,   20,   30,   40,   50,   60,   75,   90,   105,  120,  145,  170,  195,  220,  245,  270,
            300,  330,  360,  390,  420,  450,  480,  510,  540,  570,  605,  640,  675,  710,  747,  784,  821,
            858,  895,  932,  969,  1006, 1043, 1080, 1122, 1164, 1206, 1248, 1290, 1332, 1374, 1416, 1458, 1500,
            1545, 1590, 1635, 1680, 1725, 1770, 1815, 1860, 1905, 1950, 1995, 2040, 2085, 2130, 2175, 2220, 2265,
            2310, 2355, 2400, 2447, 2494, 2541, 2588, 2635, 2682, 2729, 2776, 2818, 2860, 2903, 2946, 2988, 3030,
            3071, 3112, 3152, 3192, 3232, 3272, 3311, 3350, 3389, 3428, 3467, 3506, 3545, 3584, 3623, 3662, 3701,
            3740, 3779, 3818, 3857, 3896, 3935, 3974, 4013, 4052, 4092, 4132, 4172, 4212, 4253, 4294, 4336, 4378,
            4421, 4464, 4506, 4548, 4595, 4642, 4689, 4736, 4783, 4830, 4877, 4924, 4969, 5014, 5059, 5104, 5149,
            5194, 5239, 5284, 5329, 5374, 5419, 5464, 5509, 5554, 5599, 5644, 5689, 5734, 5779, 5824, 5866, 5908,
            5950, 5992, 6034, 6076, 6118, 6160, 6202, 6244, 6281, 6318, 6355, 6392, 6429, 6466, 6503, 6540, 6577,
            6614, 6649, 6684, 6719, 6754, 6784, 6814, 6844, 6874, 6904, 6934, 6964, 6994, 7024, 7054, 7079, 7104,
            7129, 7154, 7179, 7204, 7219, 7234, 7249, 7264, 7274, 7284, 7294, 7304, 7314};

        const uint32_t jx = ix(detId);
        const uint32_t jd = 2 * (iy(detId) - 1) + (jx - 1) / 50;
        return ((positiveZ(detId) ? kEEhalf : 0) + kdi[jd] + jx - kxf[jd]);
      }
    };

    static constexpr bool checkFlag(uint32_t flagBits, int flag) { return flagBits & (0x1 << flag); }

    static constexpr uint32_t kInvalidDenseId = std::numeric_limits<uint32_t>::max();

    static constexpr uint32_t detId2denseId(uint32_t detId) {
      const uint32_t subdet = getSubdet(detId);
      if (subdet == EcalBarrel)
        return Barrel::denseIndex(detId);
      if (subdet == EcalEndcap)
        return Barrel::kSize + Endcap::denseIndex(detId);

      printf("invalid detId: %u\n", detId);
      return kInvalidDenseId;
    }

    static constexpr bool detIdInRange(uint32_t detId) {
      return detId != 0 && DetId(detId).det() == DetId::Detector::Ecal &&
             (getSubdet(detId) == EcalSubdetector::EcalBarrel || getSubdet(detId) == EcalSubdetector::EcalEndcap);
    }

    static constexpr int getZside(uint32_t detId) {
      return ((getSubdet(detId) == EcalSubdetector::EcalBarrel) ? Barrel::positiveZ(detId) : Endcap::positiveZ(detId))
                 ? (1)
                 : (-1);
    }

    static constexpr uint32_t kSize = Barrel::kSize + Endcap::kSize;  // maximum possible ECAL denseId (=75848)
  };

}  // namespace ALPAKA_ACCELERATOR_NAMESPACE::particleFlowRecHitProducer

#endif  // RecoParticleFlow_PFRecHitProducer_interface_alpaka_CalorimeterDefinitions_h