HGCSiliconDetId Class Reference

#include <HGCSiliconDetId.h>

Inheritance diagram for HGCSiliconDetId:

Public Types
enum	waferType { HGCalFine =0, HGCalCoarseThin =1, HGCalCoarseThick =2 }
Public Types inherited from DetId
enum	Detector {   Tracker =1, Muon =2, Ecal =3, Hcal =4,   Calo =5, Forward =6, VeryForward =7, HGCalEE =8,   HGCalHSi =9, HGCalHSc =10, HGCalTrigger =11 }

Public Member Functions
int	cellU () const
	get the cell #'s in u,v or in x,y More...
std::pair< int, int >	cellUV () const
int	cellV () const
int	cellX () const
std::pair< int, int >	cellXY () const
int	cellY () const
HGCSiliconDetId	geometryCell () const
	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)
bool	isEE () const
	consistency check : no bits left => no overhead More...
bool	isForward () const
bool	isHE () const
int	layer () const
	get the layer # More...
HGCSiliconDetId &	operator= (const DetId &id)
DetId::Detector	subdet () const
	get the subdetector More...
int	triggerCellU () const
std::pair< int, int >	triggerCellUV () const
int	triggerCellV () const
int	type () const
	get the type More...
int	waferU () const
int	waferUAbs () const
	get the wafer #'s in u,v or in x,y More...
std::pair< int, int >	waferUV () const
int	waferV () const
int	waferVAbs () const
int	waferX () const
std::pair< int, int >	waferXY () const
int	waferY () const
int	zside () const
	get the z-side of the cell (1/-1) More...
Public Member Functions inherited from DetId
constexpr Detector	det () const
	get the detector field from this detid More...
constexpr	DetId ()
	Create an empty or null id (also for persistence) More...
constexpr	DetId (uint32_t id)
	Create an id from a raw number. More...
constexpr	DetId (Detector det, int subdet)
	Create an id, filling the detector and subdetector fields as specified. More...
constexpr bool	null () const
	is this a null id ? More...
constexpr	operator uint32_t () const
constexpr bool	operator!= (DetId id) const
	inequality More...
constexpr uint32_t	operator() () const
constexpr bool	operator< (DetId id) const
	comparison More...
constexpr bool	operator== (DetId id) const
	equality More...
constexpr uint32_t	rawId () const
	get the raw id More...
constexpr int	subdetId () const
	get the contents of the subdetector field (not cast into any detector's numbering enum) More...

Static Public Attributes
static const int	HGCalCoarseN =8
static const int	HGCalCoarseTrigger =2
static const int	HGCalFineN =12
static const int	HGCalFineTrigger =3
static const HGCSiliconDetId	Undefined
Static Public Attributes inherited from DetId
static const int	kDetMask = 0xF
static const int	kDetOffset = 28
static const int	kSubdetMask = 0x7
static const int	kSubdetOffset = 25

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

Additional Inherited Members
Protected Attributes inherited from DetId
uint32_t	id_

Detailed Description

Definition at line 22 of file HGCSiliconDetId.h.

Member Enumeration Documentation

enum HGCSiliconDetId::waferType

Enumerator
HGCalFine
HGCalCoarseThin
HGCalCoarseThick

Definition at line 26 of file HGCSiliconDetId.h.

{HGCalFine=0, HGCalCoarseThin=1, HGCalCoarseThick=2};

Constructor & Destructor Documentation

HGCSiliconDetId::HGCSiliconDetId

(

)

Create a null cellid

Definition at line 8 of file HGCSiliconDetId.cc.

Referenced by geometryCell().

                                 : DetId() {
}

HGCSiliconDetId::HGCSiliconDetId

(

uint32_t

rawid

)

Create cellid from raw id (0=invalid tower id)

Definition at line 11 of file HGCSiliconDetId.cc.

                                               : DetId(rawid) {
}

HGCSiliconDetId::HGCSiliconDetId	(	DetId::Detector	det,
		int	zp,
		int	type,
		int	layer,
		int	waferU,
		int	waferV,
		int	cellU,
		int	cellV
	)

Constructor from subdetector, zplus, layer, module, cell numbers

Definition at line 14 of file HGCSiliconDetId.cc.

References funct::abs(), DetId::id_, kHGCalCellUMask, kHGCalCellUOffset, kHGCalCellVMask, kHGCalCellVOffset, kHGCalLayerMask, kHGCalLayerOffset, kHGCalTypeMask, kHGCalTypeOffset, kHGCalWaferUMask, kHGCalWaferUOffset, kHGCalWaferUSignMask, kHGCalWaferUSignOffset, kHGCalWaferVMask, kHGCalWaferVOffset, kHGCalWaferVSignMask, kHGCalWaferVSignOffset, kHGCalZsideMask, kHGCalZsideOffset, and zside().

                            : DetId(det,ForwardEmpty) {  

  int waferUabs(std::abs(waferU)), waferVabs(std::abs(waferV));
  int waferUsign = (waferU >= 0) ? 0 : 1;
  int waferVsign = (waferV >= 0) ? 0 : 1;
  int zside      = (zp < 0) ? 1 : 0;
  id_ |= (((cellU     & kHGCalCellUMask) << kHGCalCellUOffset) |
      ((cellV     & kHGCalCellVMask) << kHGCalCellVOffset) |
      ((waferUabs & kHGCalWaferUMask) << kHGCalWaferUOffset) |
      ((waferUsign& kHGCalWaferUSignMask) << kHGCalWaferUSignOffset) |
      ((waferVabs & kHGCalWaferVMask) << kHGCalWaferVOffset) |
      ((waferVsign& kHGCalWaferVSignMask) << kHGCalWaferVSignOffset) |
      ((layer     & kHGCalLayerMask) << kHGCalLayerOffset) |
      ((zside     & kHGCalZsideMask) << kHGCalZsideOffset) |
      ((type      & kHGCalTypeMask)  << kHGCalTypeOffset));
}

HGCSiliconDetId::HGCSiliconDetId

(

const DetId &

id

)

Constructor from a generic cell id

Definition at line 33 of file HGCSiliconDetId.cc.

References TauDecayModes::dec, DetId::det(), Exception, DetId::HGCalEE, DetId::HGCalHSi, DetId::id_, DetId::null(), and DetId::rawId().

                                                 {
  if (!gen.null()) {
    if ((gen.det()!=HGCalEE) && (gen.det()!=HGCalHSi)) {
      throw cms::Exception("Invalid DetId") << "Cannot initialize HGCSiliconDetId from " << std::hex << gen.rawId() << std::dec; 
    }  
  }
  id_ = gen.rawId();
}

Member Function Documentation

int HGCSiliconDetId::cellU ( ) const

inline

get the cell #'s in u,v or in x,y

Definition at line 60 of file HGCSiliconDetId.h.

References DetId::id_, kHGCalCellUMask, and kHGCalCellUOffset.

Referenced by HGCalSimHitValidation::analyzeHits(), cellUV(), cellY(), triggerCellU(), and triggerCellV().

{ return (id_>>kHGCalCellUOffset)&kHGCalCellUMask; }

std::pair<int,int> HGCSiliconDetId::cellUV ( ) const

inline

Definition at line 62 of file HGCSiliconDetId.h.

References cellU(), and cellV().

{ return std::pair<int,int>(cellU(),cellV()); }

int HGCSiliconDetId::cellV ( ) const

inline

Definition at line 61 of file HGCSiliconDetId.h.

References DetId::id_, kHGCalCellVMask, and kHGCalCellVOffset.

Referenced by HGCalSimHitValidation::analyzeHits(), cellUV(), cellX(), cellY(), triggerCellU(), and triggerCellV().

{ return (id_>>kHGCalCellVOffset)&kHGCalCellVMask; }

int HGCSiliconDetId::cellX ( ) const

inline

Definition at line 63 of file HGCSiliconDetId.h.

References cellV(), HGCalFine, N, and type().

Referenced by cellXY().

                    {
    int N = (type() == HGCalFine) ? HGCalFineN : HGCalCoarseN;
    return (3*(cellV()-N)+2);
  }

std::pair<int,int> HGCSiliconDetId::cellXY ( ) const

inline

Definition at line 71 of file HGCSiliconDetId.h.

References cellX(), and cellY().

{ return std::pair<int,int>(cellX(),cellY()); }

int HGCSiliconDetId::cellY ( ) const

inline

Definition at line 67 of file HGCSiliconDetId.h.

References cellU(), cellV(), HGCalFine, N, and type().

Referenced by cellXY().

                    {
    int N = (type() == HGCalFine) ? HGCalFineN : HGCalCoarseN;
    return (2*cellU()-(N+cellV()));
  }

HGCSiliconDetId HGCSiliconDetId::geometryCell ( ) const

inline

Converter for a geometry cell id

Definition at line 45 of file HGCSiliconDetId.h.

References DetId::det(), HGCSiliconDetId(), layer(), waferU(), waferV(), and zside().

Referenced by HGCalGeometry::getGeometry(), HGCalGeometry::indexFor(), HGCalGeometry::newCell(), and HGCalGeometry::present().

{return HGCSiliconDetId (det(), zside(), 0, layer(), waferU(), waferV(), 0, 0);}

bool HGCSiliconDetId::isEE ( ) const

inline

consistency check : no bits left => no overhead

Definition at line 103 of file HGCSiliconDetId.h.

References DetId::det(), and DetId::HGCalEE.

{ return (det() == HGCalEE); }

bool HGCSiliconDetId::isForward ( ) const

inline

Definition at line 105 of file HGCSiliconDetId.h.

{ return true; }

bool HGCSiliconDetId::isHE ( ) const

inline

Definition at line 104 of file HGCSiliconDetId.h.

References DetId::det(), and DetId::HGCalHSi.

{ return (det() == HGCalHSi); }

int HGCSiliconDetId::layer ( ) const

inline

get the layer #

Definition at line 57 of file HGCSiliconDetId.h.

References DetId::id_, kHGCalLayerMask, and kHGCalLayerOffset.

Referenced by HGCalRecHitValidation::analyze(), HGCalDigiValidation::analyze(), HGCalSimHitValidation::analyzeHits(), geometryCell(), hgcal::RecHitTools::getLayer(), hgcal::RecHitTools::getSiThickness(), HGCalGeometry::getSummary(), geometryXMLparser.DTAlignable::index(), geometryXMLparser.CSCAlignable::index(), and HGCalRecHitSimpleAlgo::makeRecHit().

{ return (id_>>kHGCalLayerOffset)&kHGCalLayerMask; }

HGCSiliconDetId & HGCSiliconDetId::operator=

(

const DetId &

id

)

Assignment from a generic cell id

Definition at line 42 of file HGCSiliconDetId.cc.

References TauDecayModes::dec, DetId::det(), Exception, DetId::HGCalEE, DetId::HGCalHSi, DetId::id_, DetId::null(), and DetId::rawId().

                                                            {
  if (!gen.null()) {
    if ((gen.det()!=HGCalEE) && (gen.det()!=HGCalHSi)) {
      throw cms::Exception("Invalid DetId") << "Cannot assign HGCSiliconDetId from " << std::hex << gen.rawId() << std::dec; 
    }  
  }
  id_ = gen.rawId();
  return (*this);
}

DetId::Detector HGCSiliconDetId::subdet ( ) const

inline

get the subdetector

Definition at line 48 of file HGCSiliconDetId.h.

References DetId::det().

{ return det(); }

int HGCSiliconDetId::triggerCellU ( ) const

inline

Definition at line 84 of file HGCSiliconDetId.h.

References cellU(), cellV(), HGCalFine, N, and type().

Referenced by triggerCellUV().

                           {
    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));
  }

std::pair<int,int> HGCSiliconDetId::triggerCellUV ( ) const

inline

Definition at line 98 of file HGCSiliconDetId.h.

References triggerCellU(), and triggerCellV().

                                         {
    return std::pair<int,int>(triggerCellU(),triggerCellV());
  }

int HGCSiliconDetId::triggerCellV ( ) const

inline

Definition at line 91 of file HGCSiliconDetId.h.

References cellU(), cellV(), HGCalFine, N, and type().

Referenced by triggerCellUV().

                           {
    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);
  }

int HGCSiliconDetId::type ( ) const

inline

get the type

Definition at line 51 of file HGCSiliconDetId.h.

References DetId::id_, kHGCalTypeMask, and kHGCalTypeOffset.

Referenced by HGCalSimHitValidation::analyzeHits(), cellX(), cellY(), hgcal::RecHitTools::getRadiusToSide(), hgcal::RecHitTools::getSiThickIndex(), Vispa.Plugins.ConfigEditor.ConfigDataAccessor.ConfigDataAccessor::inputCommands(), Vispa.Plugins.ConfigEditor.ConfigDataAccessor.ConfigDataAccessor::outputCommands(), Vispa.Plugins.ConfigEditor.ConfigDataAccessor.ConfigDataAccessor::outputEventContent(), Vispa.Plugins.ConfigEditor.ConfigDataAccessor.ConfigDataAccessor::properties(), HGCalRecHitWorkerSimple::run(), triggerCellU(), triggerCellV(), and HGCalDDDConstants::waferType().

{ return (id_>>kHGCalTypeOffset)&kHGCalTypeMask; }

int HGCSiliconDetId::waferU ( ) const

inline

Definition at line 76 of file HGCSiliconDetId.h.

References DetId::id_, kHGCalWaferUSignMask, kHGCalWaferUSignOffset, and waferUAbs().

Referenced by HGCalSimHitValidation::analyzeHits(), geometryCell(), hgcal::RecHitTools::getSiThickness(), waferUV(), and waferX().

{ return (((id_>>kHGCalWaferUSignOffset) & kHGCalWaferUSignMask) ? -waferUAbs() : waferUAbs()); }

int HGCSiliconDetId::waferUAbs ( ) const

inline

get the wafer #'s in u,v or in x,y

Definition at line 74 of file HGCSiliconDetId.h.

References DetId::id_, kHGCalWaferUMask, and kHGCalWaferUOffset.

Referenced by waferU().

{ return (id_>>kHGCalWaferUOffset)&kHGCalWaferUMask; }

std::pair<int,int> HGCSiliconDetId::waferUV ( ) const

inline

Definition at line 78 of file HGCSiliconDetId.h.

References waferU(), and waferV().

Referenced by HGCalSD::setDetUnitId().

{ return std::pair<int,int>(waferU(),waferV()); }

int HGCSiliconDetId::waferV ( ) const

inline

Definition at line 77 of file HGCSiliconDetId.h.

References DetId::id_, kHGCalWaferVSignMask, kHGCalWaferVSignOffset, and waferVAbs().

Referenced by HGCalSimHitValidation::analyzeHits(), geometryCell(), hgcal::RecHitTools::getSiThickness(), waferUV(), waferX(), and waferY().

{ return (((id_>>kHGCalWaferVSignOffset) & kHGCalWaferVSignMask) ? -waferVAbs() : waferVAbs()); }

int HGCSiliconDetId::waferVAbs ( ) const

inline

Definition at line 75 of file HGCSiliconDetId.h.

References DetId::id_, kHGCalWaferVMask, and kHGCalWaferVOffset.

Referenced by waferV().

{ return (id_>>kHGCalWaferVOffset)&kHGCalWaferVMask; }

int HGCSiliconDetId::waferX ( ) const

inline

Definition at line 79 of file HGCSiliconDetId.h.

References waferU(), and waferV().

Referenced by waferXY().

{ return (-2*waferU()+waferV()); }

std::pair<int,int> HGCSiliconDetId::waferXY ( ) const

inline

Definition at line 81 of file HGCSiliconDetId.h.

References waferX(), and waferY().

{ return std::pair<int,int>(waferX(),waferY()); }

int HGCSiliconDetId::waferY ( ) const

inline

Definition at line 80 of file HGCSiliconDetId.h.

References waferV().

Referenced by waferXY().

{ return (2*waferV()); }

int HGCSiliconDetId::zside ( ) const

inline

get the z-side of the cell (1/-1)

Definition at line 54 of file HGCSiliconDetId.h.

References DetId::id_, kHGCalZsideMask, and kHGCalZsideOffset.

Referenced by HGCalSimHitValidation::analyzeHits(), geometryCell(), HGCSiliconDetId(), and hgcal::RecHitTools::zside().

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

Member Data Documentation

const int HGCSiliconDetId::HGCalCoarseN =8

static

Definition at line 28 of file HGCSiliconDetId.h.

const int HGCSiliconDetId::HGCalCoarseTrigger =2

static

Definition at line 30 of file HGCSiliconDetId.h.

Referenced by HGCalTriggerDetId::cellU(), HGCalTriggerDetId::cellV(), HGCalTriggerDetId::triggerCellX(), and HGCalTriggerDetId::triggerCellY().

const int HGCSiliconDetId::HGCalFineN =12

static

Definition at line 27 of file HGCSiliconDetId.h.

const int HGCSiliconDetId::HGCalFineTrigger =3

static

Definition at line 29 of file HGCSiliconDetId.h.

Referenced by HGCalTriggerDetId::cellU(), HGCalTriggerDetId::cellV(), HGCalTriggerDetId::triggerCellX(), and HGCalTriggerDetId::triggerCellY().

const int HGCSiliconDetId::kHGCalCellUMask = 0x1F

staticprivate

Definition at line 112 of file HGCSiliconDetId.h.

Referenced by cellU(), and HGCSiliconDetId().

const int HGCSiliconDetId::kHGCalCellUOffset = 0

staticprivate

Definition at line 111 of file HGCSiliconDetId.h.

Referenced by cellU(), and HGCSiliconDetId().

const int HGCSiliconDetId::kHGCalCellVMask = 0x1F

staticprivate

Definition at line 114 of file HGCSiliconDetId.h.

Referenced by cellV(), and HGCSiliconDetId().

const int HGCSiliconDetId::kHGCalCellVOffset = 5

staticprivate

Definition at line 113 of file HGCSiliconDetId.h.

Referenced by cellV(), and HGCSiliconDetId().

const int HGCSiliconDetId::kHGCalLayerMask = 0x1F

staticprivate

Definition at line 124 of file HGCSiliconDetId.h.

Referenced by HGCSiliconDetId(), and layer().

const int HGCSiliconDetId::kHGCalLayerOffset = 20

staticprivate

Definition at line 123 of file HGCSiliconDetId.h.

Referenced by HGCSiliconDetId(), and layer().

const int HGCSiliconDetId::kHGCalTypeMask = 0x3

staticprivate

Definition at line 128 of file HGCSiliconDetId.h.

Referenced by HGCSiliconDetId(), and type().

const int HGCSiliconDetId::kHGCalTypeOffset = 26

staticprivate

Definition at line 127 of file HGCSiliconDetId.h.

Referenced by HGCSiliconDetId(), and type().

const int HGCSiliconDetId::kHGCalWaferUMask = 0xF

staticprivate

Definition at line 116 of file HGCSiliconDetId.h.

Referenced by HGCSiliconDetId(), and waferUAbs().

const int HGCSiliconDetId::kHGCalWaferUOffset = 10

staticprivate

Definition at line 115 of file HGCSiliconDetId.h.

Referenced by HGCSiliconDetId(), and waferUAbs().

const int HGCSiliconDetId::kHGCalWaferUSignMask = 0x1

staticprivate

Definition at line 118 of file HGCSiliconDetId.h.

Referenced by HGCSiliconDetId(), and waferU().

const int HGCSiliconDetId::kHGCalWaferUSignOffset = 14

staticprivate

Definition at line 117 of file HGCSiliconDetId.h.

Referenced by HGCSiliconDetId(), and waferU().

const int HGCSiliconDetId::kHGCalWaferVMask = 0xF

staticprivate

Definition at line 120 of file HGCSiliconDetId.h.

Referenced by HGCSiliconDetId(), and waferVAbs().

const int HGCSiliconDetId::kHGCalWaferVOffset = 15

staticprivate

Definition at line 119 of file HGCSiliconDetId.h.

Referenced by HGCSiliconDetId(), and waferVAbs().

const int HGCSiliconDetId::kHGCalWaferVSignMask = 0x1

staticprivate

Definition at line 122 of file HGCSiliconDetId.h.

Referenced by HGCSiliconDetId(), and waferV().

const int HGCSiliconDetId::kHGCalWaferVSignOffset = 19

staticprivate

Definition at line 121 of file HGCSiliconDetId.h.

Referenced by HGCSiliconDetId(), and waferV().

const int HGCSiliconDetId::kHGCalZsideMask = 0x1

staticprivate

Definition at line 126 of file HGCSiliconDetId.h.

Referenced by HGCSiliconDetId(), and zside().

const int HGCSiliconDetId::kHGCalZsideOffset = 25

staticprivate

Definition at line 125 of file HGCSiliconDetId.h.

Referenced by HGCSiliconDetId(), and zside().

const HGCSiliconDetId HGCSiliconDetId::Undefined

static

Definition at line 107 of file HGCSiliconDetId.h.