EBDetId.h

Go to the documentation of this file.

#ifndef ECALDETID_EBDETID_H
#define ECALDETID_EBDETID_H

#include <iosfwd>
#include <cmath>
#include <cstdlib>
#include "DataFormats/DetId/interface/DetId.h"
#include "DataFormats/EcalDetId/interface/EcalSubdetector.h"
#include "DataFormats/EcalDetId/interface/EcalTrigTowerDetId.h"

class EBDetId : public DetId {
public:
  enum { Subdet = EcalBarrel };
  EBDetId() {}
  EBDetId(uint32_t rawid) : DetId(rawid) {}
  // fast
  EBDetId(int crystal_ieta, int crystal_iphi) : DetId(Ecal, EcalBarrel) {
    id_ |= ((crystal_ieta > 0) ? (0x10000 | (crystal_ieta << 9)) : ((-crystal_ieta) << 9)) | (crystal_iphi & 0x1FF);
  }
  // slow
  EBDetId(int index1, int index2, int mode);
  EBDetId(const DetId& id) : DetId(id) {}
  EBDetId& operator=(const DetId& id) {
    id_ = id.rawId();
    return *this;
  }

  // EcalSubdetector subdet() const { return EcalSubdetector(subdetId()); }
  static EcalSubdetector subdet() { return EcalBarrel; }

  int zside() const { return (id_ & 0x10000) ? (1) : (-1); }
  int ietaAbs() const { return (id_ >> 9) & 0x7F; }
  int ieta() const { return zside() * ietaAbs(); }
  int iphi() const { return id_ & 0x1FF; }
  int tower_ieta() const { return ((ietaAbs() - 1) / 5 + 1) * zside(); }
  int tower_iphi() const;
  EcalTrigTowerDetId tower() const { return EcalTrigTowerDetId(zside(), EcalBarrel, abs(tower_ieta()), tower_iphi()); }
  int ism() const {
    int id = (iphi() - 1) / kCrystalsInPhi + 1;
    return positiveZ() ? id : id + 18;
  }
  int im() const {
    int ii = (ietaAbs() - 26);
    return ii < 0 ? 1 : (ii / 20 + 2);
  }
  int ic() const;
  int ietaSM() const { return ietaAbs(); }
  int iphiSM() const { return ((ic() - 1) % kCrystalsInPhi) + 1; }

  // is z positive?
  bool positiveZ() const { return id_ & 0x10000; }
  // crystal number in eta-phi grid
  int numberByEtaPhi() const { return (MAX_IETA + (positiveZ() ? ietaAbs() - 1 : -ietaAbs())) * MAX_IPHI + iphi() - 1; }
  // index numbering crystal by SM
  int numberBySM() const;
  int hashedIndex() const { return numberByEtaPhi(); }

  uint32_t denseIndex() const { return hashedIndex(); }

  EBDetId offsetBy(int nrStepsEta, int nrStepsPhi) const;

  EBDetId switchZSide() const;

  static DetId offsetBy(const DetId startId, int nrStepsEta, int nrStepsPhi);
  static DetId switchZSide(const DetId startId);

  float approxEta() const { return ieta() * crystalUnitToEta; }
  static float approxEta(const DetId id);

  static bool validDenseIndex(uint32_t din) { return (din < kSizeForDenseIndexing); }

  static EBDetId detIdFromDenseIndex(uint32_t di) { return unhashIndex(di); }

  static EBDetId unhashIndex(int hi) {
    const int pseudo_eta = hi / MAX_IPHI - MAX_IETA;
    return (validHashIndex(hi) ? EBDetId(pseudo_eta < 0 ? pseudo_eta : pseudo_eta + 1, hi % MAX_IPHI + 1) : EBDetId());
  }

  static bool validHashIndex(int i) { return !(i < MIN_HASH || i > MAX_HASH); }

  static bool validDetId(int i, int j) {
    return i != 0 && (std::abs(i) <= MAX_IETA) && (j >= MIN_IPHI) && (j <= MAX_IPHI);
  }

  static bool isNextToBoundary(EBDetId id);

  static bool isNextToEtaBoundary(EBDetId id);

  static bool isNextToPhiBoundary(EBDetId id);

  //return the distance in eta units between two EBDetId
  static int distanceEta(const EBDetId& a, const EBDetId& b);
  //return the distance in phi units between two EBDetId
  static int distancePhi(const EBDetId& a, const EBDetId& b);

  static const int MIN_IETA = 1;
  static const int MIN_IPHI = 1;
  static const int MAX_IETA = 85;
  static const int MAX_IPHI = 360;
  static const int kChannelsPerCard = 5;
  static const int kTowersInPhi = 4;  // per SM
  static const int kModulesPerSM = 4;
  static const int kModuleBoundaries[4];
  static const int kCrystalsInPhi = 20;  // per SM
  static const int kCrystalsInEta = 85;  // per SM
  static const int kCrystalsPerSM = 1700;
  static const int MIN_SM = 1;
  static const int MAX_SM = 36;
  static const int MIN_C = 1;
  static const int MAX_C = kCrystalsPerSM;
  static const int MIN_HASH = 0;  // always 0 ...
  static const int MAX_HASH = 2 * MAX_IPHI * MAX_IETA - 1;

  // eta coverage of one crystal (approximate)
  static const float crystalUnitToEta;

  enum { kSizeForDenseIndexing = MAX_HASH + 1 };

  // function modes for (int, int) constructor
  static const int ETAPHIMODE = 0;
  static const int SMCRYSTALMODE = 1;
};

std::ostream& operator<<(std::ostream& s, const EBDetId& id);

#endif