BTLDetId.h

Go to the documentation of this file.

#ifndef DataFormats_BTLDetId_BTLDetId_h
#define DataFormats_BTLDetId_BTLDetId_h

#include "DataFormats/ForwardDetId/interface/MTDDetId.h"
#include <ostream>
#include <array>

class BTLDetId : public MTDDetId {
public:
  static constexpr uint32_t kBTLmoduleOffset = 10;
  static constexpr uint32_t kBTLmoduleMask = 0x3F;
  static constexpr uint32_t kBTLmodTypeOffset = 8;
  static constexpr uint32_t kBTLmodTypeMask = 0x3;
  static constexpr uint32_t kBTLRUOffset = 6;
  static constexpr uint32_t kBTLRUMask = 0x3;
  static constexpr uint32_t kBTLCrystalOffset = 0;
  static constexpr uint32_t kBTLCrystalMask = 0x3F;

  static constexpr uint32_t HALF_ROD = 36;
  static constexpr uint32_t kModulesPerRODBarPhiFlat = 48;
  static constexpr uint32_t kModulePerTypeBarPhiFlat = 48 / 3;
  static constexpr uint32_t kRUPerTypeV2 = 2;
  static constexpr uint32_t kModulesPerRUV2 = 24;
  static constexpr uint32_t kCrystalsPerModuleV2 = 16;
  static constexpr uint32_t kModulesPerTrkV2 = 3;
  static constexpr uint32_t kCrystalTypes = 3;

  // Number of crystals in BTL according to TDR design, valid also for barphiflat scenario:
  // 16 crystals x 24 modules x 2 readout units/type x 3 types x 36 rods/side x 2 sides
  //
  static constexpr uint32_t kCrystalsBTL =
      kCrystalsPerModuleV2 * kModulesPerRUV2 * kRUPerTypeV2 * kCrystalTypes * HALF_ROD * 2;

  enum class CrysLayout { tile = 1, bar = 2, barzflat = 3, barphiflat = 4, v2 = 5, v3 = 6 };

  // ---------- Constructors, enumerated types ----------

  BTLDetId() : MTDDetId(DetId::Forward, ForwardSubdetector::FastTime) {
    id_ |= (MTDType::BTL & kMTDsubdMask) << kMTDsubdOffset;
  }

  BTLDetId(const uint32_t& raw_id) : MTDDetId(raw_id) { ; }

  BTLDetId(const DetId& det_id) : MTDDetId(det_id.rawId()) { ; }

  BTLDetId(uint32_t zside, uint32_t rod, uint32_t module, uint32_t modtyp, uint32_t crystal)
      : MTDDetId(DetId::Forward, ForwardSubdetector::FastTime) {
    id_ |= (MTDType::BTL & kMTDsubdMask) << kMTDsubdOffset | (zside & kZsideMask) << kZsideOffset |
           (rod & kRodRingMask) << kRodRingOffset | (module & kBTLmoduleMask) << kBTLmoduleOffset |
           (modtyp & kBTLmodTypeMask) << kBTLmodTypeOffset | ((crystal - 1) & kBTLCrystalMask) << kBTLCrystalOffset;
  }

  BTLDetId(uint32_t zside, uint32_t rod, uint32_t runit, uint32_t module, uint32_t modtyp, uint32_t crystal)
      : MTDDetId(DetId::Forward, ForwardSubdetector::FastTime) {
    id_ |= (MTDType::BTL & kMTDsubdMask) << kMTDsubdOffset | (zside & kZsideMask) << kZsideOffset |
           (rod & kRodRingMask) << kRodRingOffset | (module & kBTLmoduleMask) << kBTLmoduleOffset |
           (modtyp & kBTLmodTypeMask) << kBTLmodTypeOffset | (runit & kBTLRUMask) << kBTLRUOffset |
           ((crystal - 1) & kBTLCrystalMask) << kBTLCrystalOffset;
  }

  // ---------- Common methods ----------

  inline int module() const { return (id_ >> kBTLmoduleOffset) & kBTLmoduleMask; }

  inline int modType() const { return (id_ >> kBTLmodTypeOffset) & kBTLmodTypeMask; }

  inline int crystal() const { return ((id_ >> kBTLCrystalOffset) & kBTLCrystalMask) + 1; }

  inline int runit() const { return (id_ >> kBTLRUOffset) & kBTLRUMask; }

  inline int globalRunit() const {
    if (runit() == 0) {
      // pre-V2: build a RU identifier from available information
      return (module() - 1) / kModulePerTypeBarPhiFlat / kRUPerTypeV2 + 1;
    } else if (runit() > 0 && modType() > 0) {
      // V2/V3: build global RU identifier from RU per type and type
      return (modType() - 1) * kRUPerTypeV2 + runit();
    }
    return 0;
  }

  inline int row(unsigned nrows = kCrystalsPerModuleV2) const {
    return (crystal() - 1) % nrows;  // anything else for now
  }

  inline int column(unsigned nrows = kCrystalsPerModuleV2) const { return (crystal() - 1) / nrows; }

  BTLDetId geographicalId(CrysLayout lay) const;
};

std::ostream& operator<<(std::ostream&, const BTLDetId&);

#endif  // DataFormats_BTLDetId_BTLDetId_h