CMS 3D CMS Logo

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

Detector identifier class for the Barrel Timing Layer. The crystal count must start from 0, copy number must be scaled by 1 unit. More...

#include <BTLDetId.h>

Inheritance diagram for BTLDetId:
MTDDetId DetId

Public Types

enum  CrysLayout {
  CrysLayout::tile = 1, CrysLayout::bar = 2, CrysLayout::barzflat = 3, CrysLayout::barphiflat = 4,
  CrysLayout::tdr = 5
}
 
- Public Types inherited from MTDDetId
enum  MTDType { typeUNKNOWN = 0, BTL = 1, ETL = 2 }
 
enum  SubDetector { subUNKNOWN = 0, FastTime = 1 }
 
- 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

 BTLDetId ()
 
 BTLDetId (const uint32_t &raw_id)
 
 BTLDetId (const DetId &det_id)
 
 BTLDetId (uint32_t zside, uint32_t rod, uint32_t module, uint32_t modtyp, uint32_t crystal)
 
int column (unsigned nrows=kCrystalsPerModuleTdr) const
 
int crystal () const
 
BTLDetId geographicalId (CrysLayout lay) const
 
int modType () const
 
int module () const
 
int row (unsigned nrows=kCrystalsPerModuleTdr) const
 
- Public Member Functions inherited from MTDDetId
 MTDDetId ()
 
 MTDDetId (const uint32_t &raw_id)
 
 MTDDetId (const DetId &det_id)
 
 MTDDetId (Detector det, int subdet)
 
int mtdRR () const
 
int mtdSide () const
 
int mtdSubDetector () const
 
SubDetector subDetector () const
 
int zside () const
 
- 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 constexpr uint32_t HALF_ROD = 36
 range constants, need two sets for the time being (one for tiles and one for bars) More...
 
static constexpr uint32_t kBTLCrystalMask = 0x3F
 
static constexpr uint32_t kBTLCrystalOffset = 0
 
static constexpr uint32_t kBTLmodTypeMask = 0x3
 
static constexpr uint32_t kBTLmodTypeOffset = 8
 
static constexpr uint32_t kBTLmoduleMask = 0x3F
 
static constexpr uint32_t kBTLmoduleOffset = 10
 
static constexpr uint32_t kCrystalsBTL = kCrystalsPerModuleTdr * 24 * 6 * HALF_ROD * 2
 
static constexpr uint32_t kCrystalsPerModuleTdr = 16
 
static constexpr uint32_t kModulePerTypeBarPhiFlat = 48 / 3
 
static constexpr uint32_t kModulesPerRODBarPhiFlat = 48
 
- Static Public Attributes inherited from MTDDetId
static const uint32_t kMTDsubdMask = 0x3
 
static const uint32_t kMTDsubdOffset = 23
 
static const uint32_t kRodRingMask = 0x3F
 
static const uint32_t kRodRingOffset = 16
 
static const uint32_t kZsideMask = 0x1
 
static const uint32_t kZsideOffset = 22
 
- 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
 

Additional Inherited Members

- Protected Attributes inherited from DetId
uint32_t id_
 

Detailed Description

Detector identifier class for the Barrel Timing Layer. The crystal count must start from 0, copy number must be scaled by 1 unit.

bit 15-10: module sequential number bit 9-8 : crystal type (1 - 3) bit 7-0 : crystal sequential number within a module ( 0 - 63 )

Definition at line 18 of file BTLDetId.h.

Member Enumeration Documentation

◆ CrysLayout

enum BTLDetId::CrysLayout
strong
Enumerator
tile 
bar 
barzflat 
barphiflat 
tdr 

Definition at line 38 of file BTLDetId.h.

Constructor & Destructor Documentation

◆ BTLDetId() [1/4]

BTLDetId::BTLDetId ( )
inline

Construct a null id

Definition at line 43 of file BTLDetId.h.

References DetId::id_, MTDDetId::kMTDsubdMask, and MTDDetId::kMTDsubdOffset.

Referenced by geographicalId().

44  id_ |= (MTDType::BTL & kMTDsubdMask) << kMTDsubdOffset;
45  }
MTDDetId()
Definition: MTDDetId.h:39
static const uint32_t kMTDsubdOffset
Definition: MTDDetId.h:29
static const uint32_t kMTDsubdMask
Definition: MTDDetId.h:30
uint32_t id_
Definition: DetId.h:69

◆ BTLDetId() [2/4]

BTLDetId::BTLDetId ( const uint32_t &  raw_id)
inline

Construct from a raw value

Definition at line 48 of file BTLDetId.h.

48 : MTDDetId(raw_id) { ; }
MTDDetId()
Definition: MTDDetId.h:39

◆ BTLDetId() [3/4]

BTLDetId::BTLDetId ( const DetId det_id)
inline

Construct from generic DetId

Definition at line 51 of file BTLDetId.h.

51 : MTDDetId(det_id.rawId()) { ; }
MTDDetId()
Definition: MTDDetId.h:39
constexpr uint32_t rawId() const
get the raw id
Definition: DetId.h:57

◆ BTLDetId() [4/4]

BTLDetId::BTLDetId ( uint32_t  zside,
uint32_t  rod,
uint32_t  module,
uint32_t  modtyp,
uint32_t  crystal 
)
inline

Construct and fill only the det and sub-det fields.

Definition at line 54 of file BTLDetId.h.

References crystal(), DetId::id_, kBTLCrystalMask, kBTLCrystalOffset, kBTLmodTypeMask, kBTLmodTypeOffset, kBTLmoduleMask, kBTLmoduleOffset, MTDDetId::kMTDsubdMask, MTDDetId::kMTDsubdOffset, MTDDetId::kRodRingMask, MTDDetId::kRodRingOffset, MTDDetId::kZsideMask, MTDDetId::kZsideOffset, module(), and MTDDetId::zside().

56  id_ |= (MTDType::BTL & kMTDsubdMask) << kMTDsubdOffset | (zside & kZsideMask) << kZsideOffset |
59  }
static const uint32_t kRodRingOffset
Definition: MTDDetId.h:33
MTDDetId()
Definition: MTDDetId.h:39
static constexpr uint32_t kBTLmodTypeOffset
Definition: BTLDetId.h:22
static constexpr uint32_t kBTLmodTypeMask
Definition: BTLDetId.h:23
static const uint32_t kZsideOffset
Definition: MTDDetId.h:31
static const uint32_t kMTDsubdOffset
Definition: MTDDetId.h:29
static const uint32_t kRodRingMask
Definition: MTDDetId.h:34
static constexpr uint32_t kBTLmoduleOffset
Definition: BTLDetId.h:20
static const uint32_t kMTDsubdMask
Definition: MTDDetId.h:30
static const uint32_t kZsideMask
Definition: MTDDetId.h:32
int module() const
Definition: BTLDetId.h:64
uint32_t id_
Definition: DetId.h:69
int zside() const
Definition: MTDDetId.h:61
static constexpr uint32_t kBTLCrystalOffset
Definition: BTLDetId.h:24
static constexpr uint32_t kBTLmoduleMask
Definition: BTLDetId.h:21
int crystal() const
Definition: BTLDetId.h:70
static constexpr uint32_t kBTLCrystalMask
Definition: BTLDetId.h:25

Member Function Documentation

◆ column()

int BTLDetId::column ( unsigned  nrows = kCrystalsPerModuleTdr) const
inline

return the column in GeomDetLanguage

Definition at line 78 of file BTLDetId.h.

References crystal().

Referenced by BtlDigiHitsValidation::analyze(), BtlSimHitsValidation::analyze(), BtlLocalRecoValidation::analyze(), MtdTracksValidation::analyze(), and BTLDeviceSim::getHitsResponse().

78 { return (crystal() - 1) / nrows; }
int crystal() const
Definition: BTLDetId.h:70

◆ crystal()

int BTLDetId::crystal ( ) const
inline

Returns BTL crystal number.

Definition at line 70 of file BTLDetId.h.

References DetId::id_, kBTLCrystalMask, and kBTLCrystalOffset.

Referenced by BTLDetId(), column(), and row().

70 { return ((id_ >> kBTLCrystalOffset) & kBTLCrystalMask) + 1; }
uint32_t id_
Definition: DetId.h:69
static constexpr uint32_t kBTLCrystalOffset
Definition: BTLDetId.h:24
static constexpr uint32_t kBTLCrystalMask
Definition: BTLDetId.h:25

◆ geographicalId()

BTLDetId BTLDetId::geographicalId ( CrysLayout  lay) const

create a Geographical DetId for Tracking

Definition at line 3 of file BTLDetId.cc.

References barphiflat, BTLDetId(), kModulePerTypeBarPhiFlat, modType(), module(), MTDDetId::mtdRR(), and MTDDetId::mtdSide().

Referenced by BtlDigiHitsValidation::analyze(), BtlSimHitsValidation::analyze(), BtlLocalRecoValidation::analyze(), MtdTracksValidation::analyze(), BTLDeviceSim::getHitsResponse(), and MTDTimeCalib::getTimeCalib().

3  {
4  // reorganize the modules to count from 0 to 54
5  // (0 to 42 in the case of BarZflat geometry)
6  // remove module type
7  // remove crystal index
8 
9  if (lay == CrysLayout::barphiflat) {
10  return BTLDetId(mtdSide(), mtdRR(), module() + kModulePerTypeBarPhiFlat * (modType() - 1), 0, 1);
11  }
12 
13  return 0;
14 }
static constexpr uint32_t kModulePerTypeBarPhiFlat
Definition: BTLDetId.h:30
int mtdSide() const
Definition: MTDDetId.h:59
int modType() const
Definition: BTLDetId.h:67
BTLDetId()
Definition: BTLDetId.h:43
int mtdRR() const
Definition: MTDDetId.h:64
int module() const
Definition: BTLDetId.h:64

◆ modType()

int BTLDetId::modType ( ) const
inline

Returns BTL crystal type number.

Definition at line 67 of file BTLDetId.h.

References DetId::id_, kBTLmodTypeMask, and kBTLmodTypeOffset.

Referenced by geographicalId().

67 { return (id_ >> kBTLmodTypeOffset) & kBTLmodTypeMask; }
static constexpr uint32_t kBTLmodTypeOffset
Definition: BTLDetId.h:22
static constexpr uint32_t kBTLmodTypeMask
Definition: BTLDetId.h:23
uint32_t id_
Definition: DetId.h:69

◆ module()

int BTLDetId::module ( ) const
inline

Returns BTL module number.

Definition at line 64 of file BTLDetId.h.

References DetId::id_, kBTLmoduleMask, and kBTLmoduleOffset.

Referenced by BTLDetId(), and geographicalId().

64 { return (id_ >> kBTLmoduleOffset) & kBTLmoduleMask; }
static constexpr uint32_t kBTLmoduleOffset
Definition: BTLDetId.h:20
uint32_t id_
Definition: DetId.h:69
static constexpr uint32_t kBTLmoduleMask
Definition: BTLDetId.h:21

◆ row()

int BTLDetId::row ( unsigned  nrows = kCrystalsPerModuleTdr) const
inline

return the row in GeomDet language

Definition at line 73 of file BTLDetId.h.

References crystal().

Referenced by BtlDigiHitsValidation::analyze(), BtlSimHitsValidation::analyze(), BtlLocalRecoValidation::analyze(), MtdTracksValidation::analyze(), and BTLDeviceSim::getHitsResponse().

73  {
74  return (crystal() - 1) % nrows; // anything else for now
75  }
int crystal() const
Definition: BTLDetId.h:70

Member Data Documentation

◆ HALF_ROD

constexpr uint32_t BTLDetId::HALF_ROD = 36
static

range constants, need two sets for the time being (one for tiles and one for bars)

Definition at line 28 of file BTLDetId.h.

Referenced by BTLDetLayerGeometryBuilder::buildLayers().

◆ kBTLCrystalMask

constexpr uint32_t BTLDetId::kBTLCrystalMask = 0x3F
static

Definition at line 25 of file BTLDetId.h.

Referenced by BTLDetId(), and crystal().

◆ kBTLCrystalOffset

constexpr uint32_t BTLDetId::kBTLCrystalOffset = 0
static

Definition at line 24 of file BTLDetId.h.

Referenced by BTLDetId(), and crystal().

◆ kBTLmodTypeMask

constexpr uint32_t BTLDetId::kBTLmodTypeMask = 0x3
static

Definition at line 23 of file BTLDetId.h.

Referenced by BTLDetId(), and modType().

◆ kBTLmodTypeOffset

constexpr uint32_t BTLDetId::kBTLmodTypeOffset = 8
static

Definition at line 22 of file BTLDetId.h.

Referenced by BTLDetId(), and modType().

◆ kBTLmoduleMask

constexpr uint32_t BTLDetId::kBTLmoduleMask = 0x3F
static

Definition at line 21 of file BTLDetId.h.

Referenced by BTLDetId(), and module().

◆ kBTLmoduleOffset

constexpr uint32_t BTLDetId::kBTLmoduleOffset = 10
static

Definition at line 20 of file BTLDetId.h.

Referenced by BTLDetId(), and module().

◆ kCrystalsBTL

constexpr uint32_t BTLDetId::kCrystalsBTL = kCrystalsPerModuleTdr * 24 * 6 * HALF_ROD * 2
static

Definition at line 36 of file BTLDetId.h.

Referenced by BtlLocalRecoHarvester::dqmEndJob(), and BtlSimHitsHarvester::dqmEndJob().

◆ kCrystalsPerModuleTdr

constexpr uint32_t BTLDetId::kCrystalsPerModuleTdr = 16
static

Definition at line 31 of file BTLDetId.h.

◆ kModulePerTypeBarPhiFlat

constexpr uint32_t BTLDetId::kModulePerTypeBarPhiFlat = 48 / 3
static

Definition at line 30 of file BTLDetId.h.

Referenced by geographicalId().

◆ kModulesPerRODBarPhiFlat

constexpr uint32_t BTLDetId::kModulesPerRODBarPhiFlat = 48
static

Definition at line 29 of file BTLDetId.h.

Referenced by BTLDetLayerGeometryBuilder::buildLayers().