HcalID.h

Go to the documentation of this file.

 
#ifndef DETDESCR_HCALID_H_
#define DETDESCR_HCALID_H_
 
// LDMX
#include "DetDescr/HcalAbstractID.h"
 
namespace ldmx {
 
class HcalID : public HcalAbstractID {
 public:
  enum HcalSection { BACK = 0, TOP = 1, BOTTOM = 2, RIGHT = 3, LEFT = 4 };
 
  static const RawValue SECTION_MASK{0x7};  // space for up to 7 sections
  static const RawValue SECTION_SHIFT{18};
  static const RawValue LAYER_MASK{0xFF};  // space for up to 255 layers
  static const RawValue LAYER_SHIFT{10};
  static const RawValue STRIP_MASK{0xFF};  // space for 255 strips/layer
  static const RawValue STRIP_SHIFT{0};
 
  HcalID() : HcalAbstractID() {}
 
  HcalID(RawValue rawid) : HcalAbstractID(rawid) {
    if (!null() && bar_type() != Global) {
      EXCEPTION_RAISE(
          "DetectorIDMismatch",
          "Attempted to create HcalID from mismatched Hcal bar_type " +
              std::to_string(bar_type()));
    }
  }
 
  HcalID(const HcalAbstractID id) : HcalAbstractID(id) {
    if (!null() && bar_type() != Global) {
      EXCEPTION_RAISE(
          "DetectorIDMismatch",
          "Attempted to create HcalID from mismatched Hcal bar_type " +
              std::to_string(bar_type()));
    }
  }
 
  HcalID(unsigned int section, unsigned int layer, unsigned int strip)
      : HcalAbstractID(Global, 0) {
    id_ |= (section & SECTION_MASK) << SECTION_SHIFT;
    id_ |= (layer & LAYER_MASK) << LAYER_SHIFT;
    id_ |= (strip & STRIP_MASK) << STRIP_SHIFT;
  }
 
  /*
   * Get the value of the 'section' field from the ID.
   * @return The value of the 'strip' field.
   */
  unsigned int getSection() const {
    return (id_ >> SECTION_SHIFT) & SECTION_MASK;
  }
 
  /*
   * Get the value of the 'section' field from the ID.
   * @return The value of the 'strip' field.
   */
  unsigned int section() const { return (id_ >> SECTION_SHIFT) & SECTION_MASK; }
 
  unsigned int layer() const { return (id_ >> LAYER_SHIFT) & LAYER_MASK; }
 
  unsigned int getLayerID() const { return (id_ >> LAYER_SHIFT) & LAYER_MASK; }
 
  unsigned int getStrip() const { return (id_ >> STRIP_SHIFT) & STRIP_MASK; }
 
  unsigned int strip() const { return (id_ >> STRIP_SHIFT) & STRIP_MASK; }
 
  static void createInterpreters();
};
}  // namespace ldmx
 
std::ostream& operator<<(std::ostream&, const ldmx::HcalID&);
 
#endif