GEMDetId.h

Go to the documentation of this file.

#ifndef DataFormats_MuonDetId_GEMDetId_h
#define DataFormats_MuonDetId_GEMDetId_h

#include "DataFormats/DetId/interface/DetId.h"
#include "DataFormats/MuonDetId/interface/MuonSubdetId.h"
#include "DataFormats/MuonDetId/interface/GEMSubDetId.h"
#include "FWCore/Utilities/interface/Exception.h"

#include <iosfwd>
#include <iostream>

class GEMDetId : public DetId {
public:
  static constexpr int32_t minRegionId = -1;
  static constexpr int32_t maxRegionId = 1;
  static constexpr int32_t minRingId = 1;
  static constexpr int32_t maxRingId = 3;
  static constexpr int32_t minStationId0 = 0;
  static constexpr int32_t minStationId = 1;
  // in the detId there is space to go up to 5 stations. Only 3 implemented now (0,1,2)
  static constexpr int32_t maxStationId = 2;
  static constexpr int32_t minChamberId = 0;
  static constexpr int32_t maxChamberId = 36;
  static constexpr int32_t minLayerId = 0;  // LayerId = 0 is superChamber
  static constexpr int32_t maxLayerId0 = 6;
  static constexpr int32_t maxLayerId = 2;  // GE1/GE2 has 2 layers
  static constexpr int32_t minEtaPartitionId = 0;
  static constexpr int32_t maxEtaPartitionId = 16;
  static constexpr int32_t minRollId = minEtaPartitionId;
  static constexpr int32_t maxRollId = maxEtaPartitionId;

private:
  static constexpr uint32_t RegionNumBits = 2;
  static constexpr uint32_t RegionStartBit = 0;
  static constexpr uint32_t RegionMask = 0x3;
  static constexpr uint32_t RingNumBits = 3;
  static constexpr uint32_t RingStartBit = RegionStartBit + RegionNumBits;
  static constexpr uint32_t RingMask = 0x7;
  static constexpr uint32_t StationNumBits = 3;
  static constexpr uint32_t StationStartBit = RingStartBit + RingNumBits;
  static constexpr uint32_t StationMask = 0x7;
  static constexpr uint32_t ChamberNumBits = 6;
  static constexpr uint32_t ChamberStartBit = StationStartBit + StationNumBits;
  static constexpr uint32_t ChamberStartBitM = RegionStartBit + RegionNumBits;
  static constexpr uint32_t ChamberMask = 0x3F;
  static constexpr uint32_t LayerNumBits = 5;
  static constexpr uint32_t LayerNumBitsP = 2;
  static constexpr uint32_t LayerStartBit = ChamberStartBit + ChamberNumBits;
  static constexpr uint32_t LayerStartBitM = ChamberStartBitM + ChamberNumBits;
  static constexpr uint32_t LayerMask = 0x1F;
  static constexpr uint32_t LayerMaskP = 0x3;
  static constexpr uint32_t EtaPartitionNumBits = 5;
  static constexpr uint32_t EtaPartitionStartBit = LayerStartBit + LayerNumBits;
  static constexpr uint32_t EtaPartitionStartBitP = LayerStartBit + LayerNumBitsP;
  static constexpr uint32_t EtaPartitionStartBitM = LayerStartBitM + LayerNumBits;
  static constexpr uint32_t EtaPartitionMask = 0x1F;
  static constexpr uint32_t FormatNumBits = 1;
  static constexpr uint32_t FormatStartBit = EtaPartitionStartBit + EtaPartitionNumBits;
  static constexpr uint32_t FormatMask = 0x1;
  static constexpr uint32_t kGEMIdFormat = 0x1000000;
  static constexpr uint32_t kMuonIdMask = 0xF0000000;

public:
  static constexpr uint32_t chamberIdMask = ~(EtaPartitionMask << EtaPartitionStartBit);
  static constexpr uint32_t superChamberIdMask = chamberIdMask + ~(LayerMask << LayerStartBit);

public:
  constexpr GEMDetId() : DetId(DetId::Muon, MuonSubdetId::GEM) {}
  constexpr GEMDetId(uint32_t id) : DetId(id) {
    if (det() != DetId::Muon || (subdetId() != MuonSubdetId::GEM && subdetId() != MuonSubdetId::ME0))
      throw cms::Exception("InvalidDetId")
          << "GEMDetId ctor: det: " << det() << " subdet: " << subdetId() << " is not a valid GEM id\n";

    if (v11Format())
      id_ = v12Form(id);
  }
  constexpr GEMDetId(DetId id) : DetId(id) {
    if (det() != DetId::Muon || (subdetId() != MuonSubdetId::GEM && subdetId() != MuonSubdetId::ME0))
      throw cms::Exception("InvalidDetId")
          << "GEMDetId ctor: det: " << det() << " subdet: " << subdetId() << " is not a valid GEM id\n";
    if (v11Format())
      id_ = v12Form(id.rawId());
  }
  constexpr GEMDetId(int region, int ring, int station, int layer, int chamber, int ieta)
      : DetId(DetId::Muon, MuonSubdetId::GEM) {
    if (region < minRegionId || region > maxRegionId || ring < minRingId || ring > maxRingId ||
        station < minStationId0 || station > maxStationId || layer < minLayerId || layer > maxLayerId0 ||
        chamber < minChamberId || chamber > maxChamberId || ieta < minEtaPartitionId || ieta > maxEtaPartitionId)
      throw cms::Exception("InvalidDetId")
          << "GEMDetId ctor: Invalid parameters:  region " << region << " ring " << ring << " station " << station
          << " layer " << layer << " chamber " << chamber << " ieta " << ieta << std::endl;

    int regionInBits = region - minRegionId;
    int ringInBits = ring - minRingId;
    int stationInBits = station - minStationId0;
    int layerInBits = layer - minLayerId;
    int chamberInBits = chamber - (minChamberId + 1);
    int ietaInBits = ieta;

    id_ |= ((regionInBits & RegionMask) << RegionStartBit | (ringInBits & RingMask) << RingStartBit |
            (stationInBits & StationMask) << StationStartBit | (layerInBits & LayerMask) << LayerStartBit |
            (chamberInBits & ChamberMask) << ChamberStartBit | (ietaInBits & EtaPartitionMask) << EtaPartitionStartBit |
            kGEMIdFormat);
  }

  constexpr GEMDetId& operator=(const DetId& gen) {
    if (!gen.null()) {
      int subdet = gen.subdetId();
      if (gen.det() != Muon || (subdet != MuonSubdetId::GEM && subdet != MuonSubdetId::ME0))
        throw cms::Exception("InvalidDetId")
            << "GEMDetId ctor: Cannot assign GEMDetID from  " << std::hex << gen.rawId() << std::dec;
      if (v11Format())
        id_ = v12Form(gen.rawId());
      else
        id_ = gen.rawId();
    } else {
      id_ = gen.rawId();
    }
    return (*this);
  }

  constexpr bool operator==(const GEMDetId& gen) const {
    uint32_t rawid = gen.rawId();
    if (rawid == id_)
      return true;
    int reg(0), ri(0), stn(-1), lay(0), chamb(0), iet(0);
    unpackId(rawid, reg, ri, stn, lay, chamb, iet);
    return (((id_ & kMuonIdMask) == (rawid & kMuonIdMask)) && (reg == region()) && (ri == ring()) &&
            (stn == station()) && (lay == layer()) && (chamb == chamber()) && (iet == ieta()));
  }
  constexpr bool operator!=(const GEMDetId& gen) const {
    uint32_t rawid = gen.rawId();
    if (rawid == id_)
      return false;
    int reg(0), ri(0), stn(-1), lay(0), chamb(0), iet(0);
    unpackId(rawid, reg, ri, stn, lay, chamb, iet);
    return (((id_ & kMuonIdMask) != (rawid & kMuonIdMask)) || (reg != region()) || (ri != ring()) ||
            (stn != station()) || (lay != layer()) || (chamb != chamber()) || (iet != ieta()));
  }

  constexpr bool operator<(const GEMDetId& r) const {
    if (r.station() == this->station()) {
      if (this->layer() == r.layer()) {
        return this->rawId() < r.rawId();
      } else {
        return (this->layer() < r.layer());
      }
    } else {
      return this->station() < r.station();
    }
  }

  constexpr bool v11Format() const { return ((id_ & kGEMIdFormat) == 0); }

  constexpr int region() const { return (static_cast<int>((id_ >> RegionStartBit) & RegionMask) + minRegionId); }

  constexpr int ring() const { return (static_cast<int>((id_ >> RingStartBit) & RingMask) + minRingId); }

  constexpr int station() const { return (static_cast<int>((id_ >> StationStartBit) & StationMask) + minStationId0); }

  constexpr int chamber() const {
    return (static_cast<int>((id_ >> ChamberStartBit) & ChamberMask) + (minChamberId + 1));
  }

  constexpr int layer() const { return (static_cast<int>((id_ >> LayerStartBit) & LayerMask) + minLayerId); }

  constexpr int roll() const {
    return (static_cast<int>((id_ >> EtaPartitionStartBit) & EtaPartitionMask));  // value 0 is used as wild card
  }

  constexpr int ieta() const {
    return (static_cast<int>((id_ >> EtaPartitionStartBit) & EtaPartitionMask));  // value 0 is used as wild card
  }

  constexpr GEMDetId chamberId() const { return GEMDetId(id_ & chamberIdMask); }

  constexpr GEMDetId superChamberId() const { return GEMDetId(id_ & superChamberIdMask); }

  constexpr GEMDetId layerId() const { return GEMDetId(id_ & chamberIdMask); }

  constexpr int nlayers() const {
    return ((station() == 0) ? maxLayerId0 : ((station() > maxStationId) ? 0 : maxLayerId));
  }

  constexpr uint32_t v12Form() const { return v12Form(id_); }

  constexpr static uint32_t v12Form(const uint32_t& inpid) {
    uint32_t rawid(inpid);
    if ((rawid & kGEMIdFormat) == 0) {
      int region(0), ring(0), station(-1), layer(0), chamber(0), ieta(0);
      unpackId(rawid, region, ring, station, layer, chamber, ieta);
      int regionInBits = region - minRegionId;
      int ringInBits = ring - minRingId;
      int stationInBits = station - minStationId0;
      int layerInBits = layer - minLayerId;
      int chamberInBits = chamber - (minChamberId + 1);
      int ietaInBits = ieta;
      rawid = (((DetId::Muon & DetId::kDetMask) << DetId::kDetOffset) |
               ((MuonSubdetId::GEM & DetId::kSubdetMask) << DetId::kSubdetOffset) |
               ((regionInBits & RegionMask) << RegionStartBit) | ((ringInBits & RingMask) << RingStartBit) |
               ((stationInBits & StationMask) << StationStartBit) | ((layerInBits & LayerMask) << LayerStartBit) |
               ((chamberInBits & ChamberMask) << ChamberStartBit) |
               ((ietaInBits & EtaPartitionMask) << EtaPartitionStartBit) | kGEMIdFormat);
    }
    return rawid;
  }

  // subsystem
  GEMSubDetId::Station subsystem() const;
  bool isGE11() const;
  bool isGE21() const;
  bool isME0() const;

private:
  constexpr void v12FromV11(const uint32_t& rawid) { id_ = v12Form(rawid); }

  constexpr static void unpackId(
      const uint32_t& rawid, int& region, int& ring, int& station, int& layer, int& chamber, int& ieta) {
    if (((rawid >> DetId::kDetOffset) & DetId::kDetMask) == DetId::Muon) {
      int subdet = ((rawid >> DetId::kSubdetOffset) & DetId::kSubdetMask);
      if (subdet == MuonSubdetId::GEM) {
        region = static_cast<int>(((rawid >> RegionStartBit) & RegionMask) + minRegionId);
        ring = (static_cast<int>((rawid >> RingStartBit) & RingMask) + minRingId);
        chamber = (static_cast<int>((rawid >> ChamberStartBit) & ChamberMask) + (minChamberId + 1));
        if ((rawid & kGEMIdFormat) == 0) {
          station = (static_cast<int>((rawid >> StationStartBit) & StationMask) + minStationId);
          layer = (static_cast<int>((rawid >> LayerStartBit) & LayerMaskP) + minLayerId);
          ieta = (static_cast<int>((rawid >> EtaPartitionStartBitP) & EtaPartitionMask));
        } else {
          station = (static_cast<int>((rawid >> StationStartBit) & StationMask) + minStationId0);
          layer = (static_cast<int>((rawid >> LayerStartBit) & LayerMask) + minLayerId);
          ieta = (static_cast<int>((rawid >> EtaPartitionStartBit) & EtaPartitionMask));
        }
      } else if (subdet == MuonSubdetId::ME0) {
        region = static_cast<int>(((rawid >> RegionStartBit) & RegionMask) + minRegionId);
        ring = 1;
        station = 0;
        chamber = (static_cast<int>((rawid >> ChamberStartBitM) & ChamberMask) + (minChamberId));
        layer = (static_cast<int>((rawid >> LayerStartBitM) & LayerMask) + minLayerId);
        ieta = (static_cast<int>((rawid >> EtaPartitionStartBitM) & EtaPartitionMask));
      }
    }
  }

};  // GEMDetId

std::ostream& operator<<(std::ostream& os, const GEMDetId& id);

#endif