HGCSiliconDetId.h

Go to the documentation of this file.

#ifndef DataFormats_ForwardDetId_HGCSiliconDetId_H
#define DataFormats_ForwardDetId_HGCSiliconDetId_H 1

#include <iosfwd>
#include "DataFormats/DetId/interface/DetId.h"
#include "DataFormats/ForwardDetId/interface/ForwardSubdetector.h"

/* \brief description of the bit assigment
   [0:4]   u-coordinate of the cell (measured from the lower left
   [5:9]   v-coordinate of the cell  corner of the wafer)
   [10:13] abs(u) of the wafer (u-axis points along -x axis)
   [14:14] sign of u (0:+u; 1:-u) (u=0 is at the center of beam line)
   [15:18] abs(v) of the wafer (v-axis points 60-degree wrt x-axis)
   [19:19] sign of v (0:+v; 1:-v) (v=0 is at the center of beam line)
   [20:24] layer number 
   [25:25] z-side (0 for +z; 1 for -z)
   [26:27] Type (0 fine divisions of wafer with 120 mum thick silicon
                 1 coarse divisions of wafer with 200 mum thick silicon
                 2 coarse divisions of wafer with 300 mum thick silicon)
   [28:31] Detector type (HGCalEE or HGCalHSi)
*/
class HGCSiliconDetId : public DetId {

public:

  enum waferType {HGCalFine=0, HGCalCoarseThin=1, HGCalCoarseThick=2};
  static const int HGCalFineN  =12;
  static const int HGCalCoarseN=8;
  static const int HGCalFineTrigger  =3;
  static const int HGCalCoarseTrigger=2;

  HGCSiliconDetId();
  HGCSiliconDetId(uint32_t rawid);
  HGCSiliconDetId(DetId::Detector det, int zp, int type, int layer, int waferU,
         int waferV, int cellU, int cellV);
  HGCSiliconDetId(const DetId& id);
  HGCSiliconDetId& operator=(const DetId& id);
  
  HGCSiliconDetId geometryCell () const {return HGCSiliconDetId (det(), zside(), 0, layer(), waferU(), waferV(), 0, 0);}

  DetId::Detector subdet() const { return det(); }

  int type() const { return (id_>>kHGCalTypeOffset)&kHGCalTypeMask; }

  int zside() const { return (((id_>>kHGCalZsideOffset) & kHGCalZsideMask) ? -1 : 1); }

  int layer() const { return (id_>>kHGCalLayerOffset)&kHGCalLayerMask; }

  int cellU() const { return (id_>>kHGCalCellUOffset)&kHGCalCellUMask; }
  int cellV() const { return (id_>>kHGCalCellVOffset)&kHGCalCellVMask; }
  std::pair<int,int> cellUV() const { return std::pair<int,int>(cellU(),cellV()); }
  int cellX() const {
    int N = (type() == HGCalFine) ? HGCalFineN : HGCalCoarseN;
    return (3*(cellV()-N)+2);
  }
  int cellY() const {
    int N = (type() == HGCalFine) ? HGCalFineN : HGCalCoarseN;
    return (2*cellU()-(N+cellV()));
  }
  std::pair<int,int> cellXY() const { return std::pair<int,int>(cellX(),cellY()); }

  int waferUAbs() const { return (id_>>kHGCalWaferUOffset)&kHGCalWaferUMask; }
  int waferVAbs() const { return (id_>>kHGCalWaferVOffset)&kHGCalWaferVMask; }
  int waferU() const { return (((id_>>kHGCalWaferUSignOffset) & kHGCalWaferUSignMask) ? -waferUAbs() : waferUAbs()); }
  int waferV() const { return (((id_>>kHGCalWaferVSignOffset) & kHGCalWaferVSignMask) ? -waferVAbs() : waferVAbs()); }
  std::pair<int,int> waferUV() const { return std::pair<int,int>(waferU(),waferV()); }
  int waferX() const { return (-2*waferU()+waferV()); }
  int waferY() const { return (2*waferV()); }
  std::pair<int,int> waferXY() const { return std::pair<int,int>(waferX(),waferY()); }

  // get trigger cell u,v
  int triggerCellU() const {
    int N  = (type() == HGCalFine) ? HGCalFineN : HGCalCoarseN;
    int NT = (type() == HGCalFine) ? HGCalFineTrigger : HGCalCoarseTrigger;
    return (cellU() >= N && cellV() >= N) ? cellU()/NT :
      ((cellU() < N && cellU() <= cellV()) ? cellU()/NT : 
       (1+(cellU()-(cellV()%NT+1))/NT));
  }
  int triggerCellV() const {
    int N  = (type() == HGCalFine) ? HGCalFineN : HGCalCoarseN;
    int NT = (type() == HGCalFine) ? HGCalFineTrigger : HGCalCoarseTrigger;
    return (cellU() >= N && cellV() >= N) ? cellV()/NT :
      ((cellU() < N && cellU() <= cellV()) ? ((cellV()-cellU())/NT+cellU()/NT) : 
       cellV()/NT);
  }
  std::pair<int,int> triggerCellUV() const {
    return std::pair<int,int>(triggerCellU(),triggerCellV());
  }

  bool isEE()      const { return (det() == HGCalEE); }
  bool isHE()      const { return (det() == HGCalHSi); }
  bool isForward() const { return true; }
  
  static const HGCSiliconDetId Undefined;

public:

  static const int kHGCalCellUOffset      = 0;
  static const int kHGCalCellUMask        = 0x1F;
  static const int kHGCalCellVOffset      = 5;
  static const int kHGCalCellVMask        = 0x1F;
  static const int kHGCalWaferUOffset     = 10;
  static const int kHGCalWaferUMask       = 0xF;
  static const int kHGCalWaferUSignOffset = 14;
  static const int kHGCalWaferUSignMask   = 0x1;
  static const int kHGCalWaferVOffset     = 15;
  static const int kHGCalWaferVMask       = 0xF;
  static const int kHGCalWaferVSignOffset = 19;
  static const int kHGCalWaferVSignMask   = 0x1;
  static const int kHGCalLayerOffset      = 20;
  static const int kHGCalLayerMask        = 0x1F;
  static const int kHGCalZsideOffset      = 25;
  static const int kHGCalZsideMask        = 0x1;
  static const int kHGCalTypeOffset       = 26;
  static const int kHGCalTypeMask         = 0x3;
};

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

#endif