CMS 3D CMS Logo

List of all members | Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Private Member Functions | Static Private Attributes
HGCTriggerDetId Class Reference

#include <HGCTriggerDetId.h>

Inheritance diagram for HGCTriggerDetId:
DetId

Public Types

enum  { Subdet = HGCTrigger }
 
- 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 cell () const
 get the absolute value of the cell #'s in x and y More...
 
 HGCTriggerDetId ()
 
 HGCTriggerDetId (uint32_t rawid)
 
 HGCTriggerDetId (ForwardSubdetector subdet, int zp, int lay, int sector, int mod, int cell)
 
 HGCTriggerDetId (const DetId &id)
 
bool isEE () const
 consistency check : no bits left => no overhead More...
 
bool isForward () const
 
int layer () const
 get the layer # More...
 
int module () const
 get the degree module More...
 
HGCTriggerDetIdoperator= (const DetId &id)
 
int sector () const
 get the sector # More...
 
ForwardSubdetector subdet () const
 get the subdetector More...
 
int zside () const
 get the z-side of the cell (1/-1) More...
 
virtual ~HGCTriggerDetId ()
 
- 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 Member Functions

static const uint32_t UndefinedCell ()
 

Static Public Attributes

static const HGCTriggerDetId 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
 

Private Member Functions

const int getMaskedId (const uint32_t &shift, const uint32_t &mask) const
 
void setMaskedId (const uint32_t value, const uint32_t &shift, const uint32_t &mask)
 

Static Private Attributes

static const uint32_t cell_mask = 0x7F
 
static const uint32_t cell_shift = 0
 
static const uint32_t layer_mask = 0x1F
 
static const uint32_t layer_shift = 19
 
static const uint32_t module_mask = 0x3F
 
static const uint32_t module_shift = 7
 
static const uint32_t sector_mask = 0x3F
 
static const uint32_t sector_shift = 13
 
static const uint32_t zside_mask = 0x1
 
static const uint32_t zside_shift = 24
 

Additional Inherited Members

- Protected Attributes inherited from DetId
uint32_t id_
 

Detailed Description

Definition at line 8 of file HGCTriggerDetId.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
Subdet 

Definition at line 34 of file HGCTriggerDetId.h.

Constructor & Destructor Documentation

◆ HGCTriggerDetId() [1/4]

HGCTriggerDetId::HGCTriggerDetId ( )

Create a null cellid

Definition at line 19 of file HGCTriggerDetId.cc.

19 : DetId() {}
constexpr DetId()
Create an empty or null id (also for persistence)
Definition: DetId.h:38

◆ ~HGCTriggerDetId()

virtual HGCTriggerDetId::~HGCTriggerDetId ( )
inlinevirtual

Definition at line 37 of file HGCTriggerDetId.h.

37 {}

◆ HGCTriggerDetId() [2/4]

HGCTriggerDetId::HGCTriggerDetId ( uint32_t  rawid)

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

Definition at line 21 of file HGCTriggerDetId.cc.

21 : DetId(rawid) {}
constexpr DetId()
Create an empty or null id (also for persistence)
Definition: DetId.h:38

◆ HGCTriggerDetId() [3/4]

HGCTriggerDetId::HGCTriggerDetId ( ForwardSubdetector  subdet,
int  zp,
int  lay,
int  sector,
int  mod,
int  cell 
)

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

Definition at line 23 of file HGCTriggerDetId.cc.

References cell(), cell_mask, cell_shift, layer_mask, layer_shift, mod(), module_mask, module_shift, fileinputsource_cfi::sec, sector_mask, sector_shift, setMaskedId(), zside_mask, and zside_shift.

24  : DetId(Forward, subdet) {
25  if (zp < 0)
26  zp = 0;
27 
33 }
static const uint32_t cell_shift
static const uint32_t cell_mask
static const uint32_t layer_shift
static const uint32_t zside_mask
static const uint32_t sector_mask
static const uint32_t layer_mask
static const uint32_t zside_shift
ForwardSubdetector subdet() const
get the subdetector
void setMaskedId(const uint32_t value, const uint32_t &shift, const uint32_t &mask)
static const uint32_t sector_shift
static const uint32_t module_shift
int cell() const
get the absolute value of the cell #&#39;s in x and y
T mod(const T &a, const T &b)
Definition: ecalDccMap.h:4
static const uint32_t module_mask
constexpr DetId()
Create an empty or null id (also for persistence)
Definition: DetId.h:38

◆ HGCTriggerDetId() [4/4]

HGCTriggerDetId::HGCTriggerDetId ( const DetId id)

Constructor from a generic cell id

Definition at line 35 of file HGCTriggerDetId.cc.

References TauDecayModes::dec, Exception, DetId::Forward, HGCTrigger, DetId::id_, and subdet().

35  {
36  if (!gen.null()) {
38  if (gen.det() != Forward || (subdet != HGCTrigger)) {
39  throw cms::Exception("Invalid DetId")
40  << "Cannot initialize HGCTriggerDetId from " << std::hex << gen.rawId() << std::dec;
41  }
42  }
43  id_ = gen.rawId();
44 }
ForwardSubdetector
ForwardSubdetector subdet() const
get the subdetector
uint32_t id_
Definition: DetId.h:69

Member Function Documentation

◆ cell()

int HGCTriggerDetId::cell ( ) const
inline

get the absolute value of the cell #'s in x and y

Definition at line 56 of file HGCTriggerDetId.h.

References cell_mask, cell_shift, and getMaskedId().

Referenced by HGCTriggerDetId().

56 { return getMaskedId(cell_shift, cell_mask); }
static const uint32_t cell_shift
static const uint32_t cell_mask
const int getMaskedId(const uint32_t &shift, const uint32_t &mask) const

◆ getMaskedId()

const int HGCTriggerDetId::getMaskedId ( const uint32_t &  shift,
const uint32_t &  mask 
) const
inlineprivate

Definition at line 25 of file HGCTriggerDetId.h.

References DetId::id_, gpuClustering::pixelStatus::mask, and edm::shift.

Referenced by cell(), layer(), module(), sector(), and zside().

25 { return (id_ >> shift) & mask; }
constexpr uint32_t mask
Definition: gpuClustering.h:24
uint32_t id_
Definition: DetId.h:69
static unsigned int const shift

◆ isEE()

bool HGCTriggerDetId::isEE ( ) const
inline

consistency check : no bits left => no overhead

Definition at line 71 of file HGCTriggerDetId.h.

71 { return true; }

◆ isForward()

bool HGCTriggerDetId::isForward ( ) const
inline

Definition at line 72 of file HGCTriggerDetId.h.

72 { return true; }

◆ layer()

int HGCTriggerDetId::layer ( ) const
inline

get the layer #

Definition at line 65 of file HGCTriggerDetId.h.

References getMaskedId(), layer_mask, and layer_shift.

Referenced by geometryXMLparser.DTAlignable::index(), and geometryXMLparser.CSCAlignable::index().

static const uint32_t layer_shift
static const uint32_t layer_mask
const int getMaskedId(const uint32_t &shift, const uint32_t &mask) const

◆ module()

int HGCTriggerDetId::module ( ) const
inline

get the degree module

Definition at line 62 of file HGCTriggerDetId.h.

References getMaskedId(), module_mask, and module_shift.

static const uint32_t module_shift
const int getMaskedId(const uint32_t &shift, const uint32_t &mask) const
static const uint32_t module_mask

◆ operator=()

HGCTriggerDetId & HGCTriggerDetId::operator= ( const DetId id)

Assignment from a generic cell id

Definition at line 46 of file HGCTriggerDetId.cc.

References TauDecayModes::dec, Exception, DetId::Forward, HGCTrigger, DetId::id_, and subdet().

46  {
47  if (!gen.null()) {
49  if (gen.det() != Forward || (subdet != HGCTrigger)) {
50  throw cms::Exception("Invalid DetId")
51  << "Cannot assign HGCTriggerDetId from " << std::hex << gen.rawId() << std::dec;
52  }
53  }
54  id_ = gen.rawId();
55  return (*this);
56 }
ForwardSubdetector
ForwardSubdetector subdet() const
get the subdetector
uint32_t id_
Definition: DetId.h:69

◆ sector()

int HGCTriggerDetId::sector ( ) const
inline

get the sector #

Definition at line 59 of file HGCTriggerDetId.h.

References getMaskedId(), sector_mask, and sector_shift.

Referenced by geometryXMLparser.DTAlignable::index().

static const uint32_t sector_mask
static const uint32_t sector_shift
const int getMaskedId(const uint32_t &shift, const uint32_t &mask) const

◆ setMaskedId()

void HGCTriggerDetId::setMaskedId ( const uint32_t  value,
const uint32_t &  shift,
const uint32_t &  mask 
)
inlineprivate

Definition at line 26 of file HGCTriggerDetId.h.

References DetId::id_, gpuClustering::pixelStatus::mask, and edm::shift.

Referenced by HGCTriggerDetId().

26  {
27  id_ |= ((value & mask) << shift);
28  }
constexpr uint32_t mask
Definition: gpuClustering.h:24
Definition: value.py:1
uint32_t id_
Definition: DetId.h:69
static unsigned int const shift

◆ subdet()

ForwardSubdetector HGCTriggerDetId::subdet ( ) const
inline

get the subdetector

Converter for a geometry cell id

Parameters
idfull EKDetId

Definition at line 53 of file HGCTriggerDetId.h.

References HGCTrigger.

Referenced by HGCTriggerDetId(), and operator=().

53 { return HGCTrigger; }

◆ UndefinedCell()

static const uint32_t HGCTriggerDetId::UndefinedCell ( )
inlinestatic

Definition at line 32 of file HGCTriggerDetId.h.

References cell_mask.

32 { return cell_mask; }
static const uint32_t cell_mask

◆ zside()

int HGCTriggerDetId::zside ( ) const
inline

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

Definition at line 68 of file HGCTriggerDetId.h.

References getMaskedId(), zside_mask, and zside_shift.

68 { return (getMaskedId(zside_shift, zside_mask) ? 1 : -1); }
static const uint32_t zside_mask
static const uint32_t zside_shift
const int getMaskedId(const uint32_t &shift, const uint32_t &mask) const

Member Data Documentation

◆ cell_mask

const uint32_t HGCTriggerDetId::cell_mask = 0x7F
staticprivate

Definition at line 15 of file HGCTriggerDetId.h.

Referenced by cell(), HGCTriggerDetId(), and UndefinedCell().

◆ cell_shift

const uint32_t HGCTriggerDetId::cell_shift = 0
staticprivate

Definition at line 14 of file HGCTriggerDetId.h.

Referenced by cell(), and HGCTriggerDetId().

◆ layer_mask

const uint32_t HGCTriggerDetId::layer_mask = 0x1F
staticprivate

Definition at line 21 of file HGCTriggerDetId.h.

Referenced by HGCTriggerDetId(), and layer().

◆ layer_shift

const uint32_t HGCTriggerDetId::layer_shift = 19
staticprivate

Definition at line 20 of file HGCTriggerDetId.h.

Referenced by HGCTriggerDetId(), and layer().

◆ module_mask

const uint32_t HGCTriggerDetId::module_mask = 0x3F
staticprivate

Definition at line 16 of file HGCTriggerDetId.h.

Referenced by HGCTriggerDetId(), and module().

◆ module_shift

const uint32_t HGCTriggerDetId::module_shift = 7
staticprivate

Definition at line 17 of file HGCTriggerDetId.h.

Referenced by HGCTriggerDetId(), and module().

◆ sector_mask

const uint32_t HGCTriggerDetId::sector_mask = 0x3F
staticprivate

Definition at line 19 of file HGCTriggerDetId.h.

Referenced by HGCTriggerDetId(), and sector().

◆ sector_shift

const uint32_t HGCTriggerDetId::sector_shift = 13
staticprivate

Definition at line 18 of file HGCTriggerDetId.h.

Referenced by HGCTriggerDetId(), and sector().

◆ Undefined

const HGCTriggerDetId HGCTriggerDetId::Undefined
static

Definition at line 74 of file HGCTriggerDetId.h.

◆ zside_mask

const uint32_t HGCTriggerDetId::zside_mask = 0x1
staticprivate

Definition at line 23 of file HGCTriggerDetId.h.

Referenced by HGCTriggerDetId(), and zside().

◆ zside_shift

const uint32_t HGCTriggerDetId::zside_shift = 24
staticprivate

Definition at line 22 of file HGCTriggerDetId.h.

Referenced by HGCTriggerDetId(), and zside().