SiStripDetId Class Reference

Detector identifier class for the strip tracker. More...

#include <SiStripDetId.h>

Inheritance diagram for SiStripDetId:

Public Types
enum	ModuleGeometry {   UNKNOWNGEOMETRY, IB1, IB2, OB1,   OB2, W1A, W2A, W3A,   W1B, W2B, W3B, W4,   W5, W6, W7 }
enum	SubDetector {   UNKNOWN = 0, TIB = 3, TID = 4, TOB = 5,   TEC = 6 }
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
uint32_t	glued () const
ModuleGeometry	moduleGeometry () const
uint32_t	partnerDetId () const
uint16_t	reserved () const
	SiStripDetId ()
	SiStripDetId (const uint32_t &raw_id)
	SiStripDetId (const DetId &det_id)
	SiStripDetId (Detector det, int subdet)
	SiStripDetId (const uint32_t &raw_id, const uint16_t &reserved)
	SiStripDetId (const DetId &det_id, const uint16_t &reserved)
uint32_t	stereo () const
double	stripLength () const
SubDetector	subDetector () 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 Private Attributes
static const unsigned	layerMask_ = 0x7
static const unsigned	layerStartBit_ = 14
static const uint16_t	reservedMask_ = 0x7
static const uint16_t	reservedStartBit_ = 20
static const unsigned	ringMaskTEC_ = 0x7
static const unsigned	ringMaskTID_ = 0x3
static const unsigned	ringStartBitTEC_ = 5
static const unsigned	ringStartBitTID_ = 9
static const uint32_t	sterMask_ = 0x3
static const uint32_t	sterStartBit_ = 0

Additional Inherited Members
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
Protected Attributes inherited from DetId
uint32_t	id_

Detailed Description

Detector identifier class for the strip tracker.

Author

R.Bainbridge

Definition at line 17 of file SiStripDetId.h.

Member Enumeration Documentation

enum SiStripDetId::ModuleGeometry

Enumerated type for tracker module geometries.

Enumerator
UNKNOWNGEOMETRY
IB1
IB2
OB1
OB2
W1A
W2A
W3A
W1B
W2B
W3B
W4
W5
W6
W7

Definition at line 37 of file SiStripDetId.h.

{ UNKNOWNGEOMETRY, IB1, IB2, OB1, OB2, W1A, W2A, W3A, W1B, W2B, W3B, W4, W5, W6, W7 };

enum SiStripDetId::SubDetector

Enumerated type for tracker sub-deteector systems.

Enumerator
UNKNOWN
TIB
TID
TOB
TEC

Definition at line 34 of file SiStripDetId.h.

{ UNKNOWN = 0, TIB = 3, TID = 4, TOB = 5, TEC = 6 };

Constructor & Destructor Documentation

SiStripDetId::SiStripDetId ( )

inline

Construct a null id

Definition at line 22 of file SiStripDetId.h.

: DetId() { ; }

SiStripDetId::SiStripDetId ( const uint32_t &  raw_id )

inline

Construct from a raw value

Definition at line 25 of file SiStripDetId.h.

: DetId(raw_id) { ; }

SiStripDetId::SiStripDetId ( const DetId &  det_id )

inline

Construct from generic DetId

Definition at line 28 of file SiStripDetId.h.

: DetId(det_id.rawId()) { ; }

SiStripDetId::SiStripDetId ( Detector  det, int  subdet  )

inline

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

Definition at line 31 of file SiStripDetId.h.

: DetId(det, subdet) { ; }

SiStripDetId::SiStripDetId ( const uint32_t &  raw_id, const uint16_t &  reserved  )

inline

Construct from a raw value and set "reserved" field.

Definition at line 62 of file SiStripDetId.h.

References DetId::id_, reservedMask_, and reservedStartBit_.

                                                                 : DetId(raw_id) {
    id_ &= (~static_cast<uint32_t>(reservedMask_ << reservedStartBit_));
    id_ |= ((reserved & reservedMask_) << reservedStartBit_);
  }

SiStripDetId::SiStripDetId ( const DetId &  det_id, const uint16_t &  reserved  )

inline

Construct from generic DetId and set "reserved" field.

Definition at line 71 of file SiStripDetId.h.

References DetId::id_, reserved(), reservedMask_, and reservedStartBit_.

                                                              : DetId(det_id.rawId()) {
    id_ &= (~static_cast<uint32_t>(reservedMask_ << reservedStartBit_));
    id_ |= ((reserved & reservedMask_) << reservedStartBit_);
  }

Member Function Documentation

uint32_t SiStripDetId::glued ( ) const

inline

A non-zero value means a glued module, null means not glued.

Definition at line 158 of file SiStripDetId.h.

References DetId::id_, sterMask_, and sterStartBit_.

Referenced by OverlapValidation::analyze(), and TrackingRecoMaterialAnalyser::isDoubleSided().

                                   {
  uint32_t testId = (id_ >> sterStartBit_) & sterMask_;
  return (testId == 0) ? 0 : (id_ - testId);
}

SiStripDetId::ModuleGeometry SiStripDetId::moduleGeometry ( ) const

inline

Returns enumerated type specifying sub-detector.

Definition at line 106 of file SiStripDetId.h.

References geometry, IB1, IB2, DetId::id_, createfilelist::int, layerMask_, layerStartBit_, OB1, OB2, ringMaskTEC_, ringMaskTID_, ringStartBitTEC_, ringStartBitTID_, subDetector(), TEC, TIB, TID, TOB, UNKNOWN, UNKNOWNGEOMETRY, W1A, W1B, W2A, W2B, W3A, W3B, W4, W5, W6, and W7.

Referenced by SiPixelErrorEstimation::analyze(), HITrackClusterRemover::sensorThickness(), and siStripClusterTools::sensorThicknessInverse().

                                                              {
  SiStripDetId::ModuleGeometry geometry = UNKNOWNGEOMETRY;
  switch (subDetector()) {
    case TIB:
      geometry = int((id_ >> layerStartBit_) & layerMask_) < 3 ? IB1 : IB2;
      break;
    case TOB:
      geometry = int((id_ >> layerStartBit_) & layerMask_) < 5 ? OB2 : OB1;
      break;
    case TID:
      switch ((id_ >> ringStartBitTID_) & ringMaskTID_) {
        case 1:
          geometry = W1A;
          break;
        case 2:
          geometry = W2A;
          break;
        case 3:
          geometry = W3A;
          break;
      }
      break;
    case TEC:
      switch ((id_ >> ringStartBitTEC_) & ringMaskTEC_) {
        case 1:
          geometry = W1B;
          break;
        case 2:
          geometry = W2B;
          break;
        case 3:
          geometry = W3B;
          break;
        case 4:
          geometry = W4;
          break;
        case 5:
          geometry = W5;
          break;
        case 6:
          geometry = W6;
          break;
        case 7:
          geometry = W7;
          break;
      }
    case UNKNOWN:
    default:;
  }
  return geometry;
}

uint32_t SiStripDetId::partnerDetId ( ) const

inline

Returns DetId of the partner module if glued, otherwise null.

Definition at line 165 of file SiStripDetId.h.

References DetId::id_, sterMask_, and sterStartBit_.

Referenced by TrackAssociatorByHitsImpl::associateSimToReco().

                                          {
  uint32_t testId = (id_ >> sterStartBit_) & sterMask_;
  if (testId == 1) {
    testId = id_ + 1;
  } else if (testId == 2) {
    testId = id_ - 1;
  } else {
    testId = 0;
  }
  return testId;
}

uint16_t SiStripDetId::reserved ( ) const

inline

Returns value of "reserved" field.

Definition at line 179 of file SiStripDetId.h.

References DetId::id_, reservedMask_, and reservedStartBit_.

Referenced by SiStripDetId().

{ return static_cast<uint16_t>((id_ >> reservedStartBit_) & reservedMask_); }

uint32_t SiStripDetId::stereo ( ) const

inline

A non-zero value means a stereo module, null means not stereo.

Definition at line 163 of file SiStripDetId.h.

References DetId::id_, sterMask_, and sterStartBit_.

Referenced by OverlapValidation::analyze(), helper::ClusterStorer::ClusterHitRecord< SiStripRecHit2D::ClusterRef >rekey(), AlignmentTrackSelector::isHit2D(), ApeEstimator::isHit2D(), TkAlCaOverlapTagger::produce(), and reco::modules::TrackerTrackHitFilter::produceFromTrajectory().

{ return (((id_ >> sterStartBit_) & sterMask_) == 1) ? 1 : 0; }

double SiStripDetId::stripLength ( ) const

inline

Returns strip length of strip tracker sensor, otherwise null.

Definition at line 177 of file SiStripDetId.h.

{ return 0.; }

SiStripDetId::SubDetector SiStripDetId::subDetector ( ) const

inline

Returns enumerated type specifying sub-detector.

Definition at line 102 of file SiStripDetId.h.

References DetId::subdetId().

Referenced by sistrip::MeasureLA::calibration_key(), LA_Filler_Fitter::fill(), SiStripFolderOrganizer::getFolderName(), SiStripFolderOrganizer::getLayerFolderName(), TrackingRecoMaterialAnalyser::isDoubleSided(), moduleGeometry(), ShallowClustersProducer::moduleVars::moduleVars(), SiStripTrackerMapCreator::printBadModuleList(), SiStripTrackerMapCreator::printTopModules(), SiStripFolderOrganizer::setLayerFolder(), LA_Filler_Fitter::subdetLabel(), and TrackerDpgAnalysis::toStringName().

                                                        {
  return static_cast<SiStripDetId::SubDetector>(subdetId());
}

Member Data Documentation

const unsigned SiStripDetId::layerMask_ = 0x7

staticprivate

Definition at line 93 of file SiStripDetId.h.

Referenced by moduleGeometry().

const unsigned SiStripDetId::layerStartBit_ = 14

staticprivate

Definition at line 92 of file SiStripDetId.h.

Referenced by moduleGeometry().

const uint16_t SiStripDetId::reservedMask_ = 0x7

staticprivate

Mask for "reserved" bit field (3-bits wide).

Definition at line 87 of file SiStripDetId.h.

Referenced by reserved(), and SiStripDetId().

const uint16_t SiStripDetId::reservedStartBit_ = 20

staticprivate

Position of "reserved" bit field.

Definition at line 81 of file SiStripDetId.h.

Referenced by reserved(), and SiStripDetId().

const unsigned SiStripDetId::ringMaskTEC_ = 0x7

staticprivate

Definition at line 97 of file SiStripDetId.h.

Referenced by moduleGeometry().

const unsigned SiStripDetId::ringMaskTID_ = 0x3

staticprivate

Definition at line 95 of file SiStripDetId.h.

Referenced by moduleGeometry().

const unsigned SiStripDetId::ringStartBitTEC_ = 5

staticprivate

Definition at line 96 of file SiStripDetId.h.

Referenced by moduleGeometry().

const unsigned SiStripDetId::ringStartBitTID_ = 9

staticprivate

Definition at line 94 of file SiStripDetId.h.

Referenced by moduleGeometry().

const uint32_t SiStripDetId::sterMask_ = 0x3

staticprivate

Definition at line 90 of file SiStripDetId.h.

Referenced by glued(), partnerDetId(), and stereo().

const uint32_t SiStripDetId::sterStartBit_ = 0

staticprivate

Definition at line 84 of file SiStripDetId.h.

Referenced by glued(), partnerDetId(), and stereo().