SiStripDetId Class Reference

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

#include <SiStripDetId.h>

Inheritance diagram for SiStripDetId:

Public Types
using	SubDetector = SiStripSubdetector::Subdetector
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
SiStripModuleGeometry	moduleGeometry () const
unsigned int	numberOfAPVs () 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 Public Attributes
static constexpr auto	TEC = SiStripSubdetector::TEC
static constexpr auto	TIB = SiStripSubdetector::TIB
static constexpr auto	TID = SiStripSubdetector::TID
static constexpr auto	TOB = SiStripSubdetector::TOB
static constexpr auto	UNKNOWN = SiStripSubdetector::UNKNOWN
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 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
Protected Attributes inherited from DetId
uint32_t	id_

Detailed Description

Detector identifier class for the strip tracker.

Author

R.Bainbridge

Examples:

/tmp/cmsbuild/jenkins/workspace/cmssw-doxygen/cmsdoxy/TMP/CMSSW_14_2_0_pre4/src/CalibTracker/SiStripLorentzAngle/interface/SiStripLorentzAngleCalibrationHelpers.h.

Definition at line 19 of file SiStripDetId.h.

Member Typedef Documentation

SubDetector

using SiStripDetId::SubDetector = SiStripSubdetector::Subdetector

Enumerated type for tracker sub-deteector systems.

Definition at line 36 of file SiStripDetId.h.

Constructor & Destructor Documentation

SiStripDetId() [1/6]

SiStripDetId::SiStripDetId ( )

inline

Construct a null id

Definition at line 24 of file SiStripDetId.h.

: DetId() { ; }

SiStripDetId() [2/6]

SiStripDetId::SiStripDetId ( const uint32_t &  raw_id )

inline

Construct from a raw value

Definition at line 27 of file SiStripDetId.h.

: DetId(raw_id) { ; }

SiStripDetId() [3/6]

SiStripDetId::SiStripDetId ( const DetId &  det_id )

inline

Construct from generic DetId

Definition at line 30 of file SiStripDetId.h.

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

SiStripDetId() [4/6]

SiStripDetId::SiStripDetId ( Detector  det, int  subdet  )

inline

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

Definition at line 33 of file SiStripDetId.h.

: DetId(det, subdet) { ; }

SiStripDetId() [5/6]

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

inline

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

Definition at line 69 of file SiStripDetId.h.

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

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

SiStripDetId() [6/6]

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

inline

Construct from generic DetId and set "reserved" field.

Definition at line 78 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

glued()

uint32_t SiStripDetId::glued ( ) const

inline

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

Definition at line 167 of file SiStripDetId.h.

References DetId::id_, sterMask_, and sterStartBit_.

Referenced by OverlapValidation::analyzeTrajectory().

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

moduleGeometry()

SiStripModuleGeometry SiStripDetId::moduleGeometry ( ) const

inline

Returns enumerated type specifying sub-detector.

Definition at line 113 of file SiStripDetId.h.

References relativeConstraints::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(), SiStripDB2Tree::analyze(), numberOfAPVs(), siStripClusterTools::sensorThicknessInverse(), and APVGain::thickness().

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

numberOfAPVs()

unsigned int SiStripDetId::numberOfAPVs ( ) const

inline

Returns number of APVs connected to each strip tracker module

Definition at line 190 of file SiStripDetId.h.

References Exception, IB1, moduleGeometry(), OB1, DetId::rawId(), UNKNOWNGEOMETRY, W1A, W1B, W2A, W2B, and W5.

Referenced by SiStripZeroSuppression::processHybrid().

                                              {
  const auto &moduleGeometry = this->moduleGeometry();

  // Check for unknown geometry and throw a meaningful exception
  if (moduleGeometry == SiStripModuleGeometry::UNKNOWNGEOMETRY) {
    throw cms::Exception("InvalidModuleGeometry")
        << "Error in SiStripDetId::numberOfAPVs(): Module geometry is UNKNOWNGEOMETRY. "
        << "This indicates an invalid or unsupported module geometry for the current DetId: " << this->rawId();
  }

  // Determine the number of APVs based on the module geometry
  if (moduleGeometry == SiStripModuleGeometry::IB1 || moduleGeometry == SiStripModuleGeometry::OB1 ||
      moduleGeometry == SiStripModuleGeometry::W1A || moduleGeometry == SiStripModuleGeometry::W1B ||
      moduleGeometry == SiStripModuleGeometry::W2A || moduleGeometry == SiStripModuleGeometry::W2B ||
      moduleGeometry == SiStripModuleGeometry::W5) {
    return 6;
  } else {
    return 4;
  }
}

partnerDetId()

uint32_t SiStripDetId::partnerDetId ( ) const

inline

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

Definition at line 174 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;
}

reserved()

uint16_t SiStripDetId::reserved ( ) const

inline

Returns value of "reserved" field.

Definition at line 188 of file SiStripDetId.h.

References DetId::id_, reservedMask_, and reservedStartBit_.

Referenced by SiStripDetId().

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

stereo()

uint32_t SiStripDetId::stereo ( ) const

inline

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

Definition at line 172 of file SiStripDetId.h.

References DetId::id_, sterMask_, and sterStartBit_.

Referenced by OverlapValidation::analyzeTrajectory(), AlignmentTrackSelector::isHit2D(), ApeEstimator::isHit2D(), GeneralPurposeTrackAnalyzer::isHit2D(), DMRChecker::isHit2D(), TkAlCaOverlapTagger::produce(), reco::modules::TrackerTrackHitFilter::produceFromTrajectory(), and helper::ClusterStorer::ClusterHitRecord< ClusterRefType >::rekey().

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

stripLength()

double SiStripDetId::stripLength ( ) const

inline

Returns strip length of strip tracker sensor, otherwise null.

Definition at line 186 of file SiStripDetId.h.

{ return 0.; }

subDetector()

SiStripDetId::SubDetector SiStripDetId::subDetector ( ) const

inline

Returns enumerated type specifying sub-detector.

Definition at line 109 of file SiStripDetId.h.

References DetId::subdetId().

Referenced by sistrip::MeasureLA::calibration_key(), SiStripFolderOrganizer::getFolderName(), SiStripFolderOrganizer::getLayerFolderName(), moduleGeometry(), ShallowClustersProducer::moduleVars::moduleVars(), SiStripTrackerMapCreator::printBadModuleList(), SiStripTrackerMapCreator::printTopModules(), and SiStripFolderOrganizer::setLayerFolder().

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

Member Data Documentation

layerMask_

const unsigned SiStripDetId::layerMask_ = 0x7

staticprivate

Definition at line 100 of file SiStripDetId.h.

Referenced by moduleGeometry().

layerStartBit_

const unsigned SiStripDetId::layerStartBit_ = 14

staticprivate

Definition at line 99 of file SiStripDetId.h.

Referenced by moduleGeometry().

reservedMask_

const uint16_t SiStripDetId::reservedMask_ = 0x7

staticprivate

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

Definition at line 94 of file SiStripDetId.h.

Referenced by reserved(), and SiStripDetId().

reservedStartBit_

const uint16_t SiStripDetId::reservedStartBit_ = 20

staticprivate

Position of "reserved" bit field.

Definition at line 88 of file SiStripDetId.h.

Referenced by reserved(), and SiStripDetId().

ringMaskTEC_

const unsigned SiStripDetId::ringMaskTEC_ = 0x7

staticprivate

Definition at line 104 of file SiStripDetId.h.

Referenced by moduleGeometry().

ringMaskTID_

const unsigned SiStripDetId::ringMaskTID_ = 0x3

staticprivate

Definition at line 102 of file SiStripDetId.h.

Referenced by moduleGeometry().

ringStartBitTEC_

const unsigned SiStripDetId::ringStartBitTEC_ = 5

staticprivate

Definition at line 103 of file SiStripDetId.h.

Referenced by moduleGeometry().

ringStartBitTID_

const unsigned SiStripDetId::ringStartBitTID_ = 9

staticprivate

Definition at line 101 of file SiStripDetId.h.

Referenced by moduleGeometry().

sterMask_

const uint32_t SiStripDetId::sterMask_ = 0x3

staticprivate

Definition at line 97 of file SiStripDetId.h.

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

sterStartBit_

const uint32_t SiStripDetId::sterStartBit_ = 0

staticprivate

Definition at line 91 of file SiStripDetId.h.

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

TEC

constexpr auto SiStripDetId::TEC = SiStripSubdetector::TEC

static

Definition at line 41 of file SiStripDetId.h.

Referenced by FWConvTrackHitsDetailView::addModules(), SiStripHitEffFromCalibTree::algoAnalyze(), SegmentTrackAnalyzer::analyze(), AlignmentStats::analyze(), CosmicRateAnalyzer::analyze(), TrackerSystematicMisalignments::applySystematicMisalignment(), TrackAssociatorByHitsImpl::associateSimToReco(), SiStripLorentzAngleCalibration::beginOfJob(), SiStripBackplaneCalibration::beginOfJob(), MillePedeAlignmentAlgorithm::callMille2D(), AlignableTrackerBuilder::convertGeomDetsToAlignables(), AlignmentTrackSelector::detailedHitsCheck(), AlignmentParameterSelector::detUnitDeselected(), AlignmentStats::endRun(), SiStripMonitorTrack::fillControlViewHistos(), SiStripQualityDQM::fillGrandSummaryMEs(), MillePedeMonitor::fillTrack(), SiStripFolderOrganizer::getFolderName(), SiStripFolderOrganizer::getLayerFolderName(), SiStripFolderOrganizer::getSubDetLayerFolderName(), TkDetMap::getSubDetLayerSide(), track_associator::hitsToClusterRefs(), MeasurementTrackerImpl::initializeStripStatus(), SeedFromConsecutiveHitsTripletOnlyCreator::initialKinematic(), TkLayerMap::layerSearch(), SiStripCondVisualizer::module_location_type(), moduleGeometry(), ShallowClustersProducer::moduleVars::moduleVars(), AlignmentParameterSelector::outsideDetIdRanges(), SiStripTrackerMapCreator::printBadModuleList(), SiStripTrackerMapCreator::printTopModules(), TkAlCaOverlapTagger::produce(), GsfTrackProducerBase::putInEvt(), SiStripBadModuleConfigurableFakeESSource::selectDetectors(), SiStripFolderOrganizer::setLayerFolder(), and StripCPEfromTrackAngle::StripCPEfromTrackAngle().

TIB

constexpr auto SiStripDetId::TIB = SiStripSubdetector::TIB

static

Examples:

/tmp/cmsbuild/jenkins/workspace/cmssw-doxygen/cmsdoxy/TMP/CMSSW_14_2_0_pre4/src/CalibTracker/SiStripLorentzAngle/interface/SiStripLorentzAngleCalibrationHelpers.h.

Definition at line 38 of file SiStripDetId.h.

Referenced by FWConvTrackHitsDetailView::addModules(), SiStripHitEffFromCalibTree::algoAnalyze(), SegmentTrackAnalyzer::analyze(), AlignmentStats::analyze(), CosmicRateAnalyzer::analyze(), TrackerSystematicMisalignments::applySystematicMisalignment(), TrackAssociatorByHitsImpl::associateSimToReco(), SiStripLorentzAngleCalibration::beginOfJob(), SiStripBackplaneCalibration::beginOfJob(), sistrip::MeasureLA::calibration_key(), StripSubClusterShapeSeedFilter::compatible(), AlignableTrackerBuilder::convertGeomDetsToAlignables(), AlignmentTrackSelector::detailedHitsCheck(), AlignmentParameterSelector::detUnitDeselected(), AlignmentStats::endRun(), LA_Filler_Fitter::fill(), SiStripMonitorTrack::fillControlViewHistos(), SiStripQualityDQM::fillGrandSummaryMEs(), MillePedeMonitor::fillTrack(), SiStripFolderOrganizer::getFolderName(), SiStripFolderOrganizer::getLayerFolderName(), SiStripFolderOrganizer::getSubDetLayerFolderName(), TkDetMap::getSubDetLayerSide(), MultiHitGeneratorFromChi2::hitSets(), track_associator::hitsToClusterRefs(), MeasurementTrackerImpl::initializeStripStatus(), AlignmentParameterSelector::layerDeselected(), TkLayerMap::layerSearch(), MatchedHitRZCorrectionFromBending::MatchedHitRZCorrectionFromBending(), SiStripCondVisualizer::module_location_type(), moduleGeometry(), siStripLACalibration::moduleLocationType(), SiStripLorentzAnglePCLMonitor::moduleLocationType(), ShallowClustersProducer::moduleVars::moduleVars(), AlignmentParameterSelector::outsideDetIdRanges(), reco::DeDxHitInfo::pixelCluster(), SiStripTrackerMapCreator::printBadModuleList(), SiStripTrackerMapCreator::printTopModules(), TkAlCaOverlapTagger::produce(), GsfTrackProducerBase::putInEvt(), SiStripMonitorTrack::RecHitInfo(), SiStripBadModuleConfigurableFakeESSource::selectDetectors(), HITrackClusterRemover::sensorThickness(), siStripClusterTools::sensorThicknessInverse(), SiStripFolderOrganizer::setLayerFolder(), reco::DeDxHitInfo::stripCluster(), StripCPEfromTrackAngle::StripCPEfromTrackAngle(), StripSubClusterShapeTrajectoryFilter::testLastHit(), and APVGain::thickness().

TID

constexpr auto SiStripDetId::TID = SiStripSubdetector::TID

static

Definition at line 39 of file SiStripDetId.h.

Referenced by FWConvTrackHitsDetailView::addModules(), SiStripHitEffFromCalibTree::algoAnalyze(), SegmentTrackAnalyzer::analyze(), AlignmentStats::analyze(), CosmicRateAnalyzer::analyze(), TrackerSystematicMisalignments::applySystematicMisalignment(), TrackAssociatorByHitsImpl::associateSimToReco(), SiStripLorentzAngleCalibration::beginOfJob(), SiStripBackplaneCalibration::beginOfJob(), MillePedeAlignmentAlgorithm::callMille2D(), AlignableTrackerBuilder::convertGeomDetsToAlignables(), AlignmentTrackSelector::detailedHitsCheck(), AlignmentParameterSelector::detUnitDeselected(), AlignmentStats::endRun(), SiStripMonitorTrack::fillControlViewHistos(), SiStripQualityDQM::fillGrandSummaryMEs(), MillePedeMonitor::fillTrack(), SiStripFolderOrganizer::getFolderName(), SiStripFolderOrganizer::getLayerFolderName(), SiStripFolderOrganizer::getSubDetLayerFolderName(), TkDetMap::getSubDetLayerSide(), MultiHitGeneratorFromChi2::hitSets(), track_associator::hitsToClusterRefs(), MeasurementTrackerImpl::initializeStripStatus(), SeedFromConsecutiveHitsTripletOnlyCreator::initialKinematic(), TkLayerMap::layerSearch(), SiStripCondVisualizer::module_location_type(), moduleGeometry(), ShallowClustersProducer::moduleVars::moduleVars(), AlignmentParameterSelector::outsideDetIdRanges(), SiStripTrackerMapCreator::printBadModuleList(), SiStripTrackerMapCreator::printTopModules(), TkAlCaOverlapTagger::produce(), GsfTrackProducerBase::putInEvt(), SiStripBadModuleConfigurableFakeESSource::selectDetectors(), SiStripFolderOrganizer::setLayerFolder(), and StripCPEfromTrackAngle::StripCPEfromTrackAngle().

TOB

constexpr auto SiStripDetId::TOB = SiStripSubdetector::TOB

static

Examples:

/tmp/cmsbuild/jenkins/workspace/cmssw-doxygen/cmsdoxy/TMP/CMSSW_14_2_0_pre4/src/CalibTracker/SiStripLorentzAngle/interface/SiStripLorentzAngleCalibrationHelpers.h.

Definition at line 40 of file SiStripDetId.h.

Referenced by FWConvTrackHitsDetailView::addModules(), SiStripHitEffFromCalibTree::algoAnalyze(), SegmentTrackAnalyzer::analyze(), AlignmentStats::analyze(), CosmicRateAnalyzer::analyze(), TrackerSystematicMisalignments::applySystematicMisalignment(), TrackAssociatorByHitsImpl::associateSimToReco(), SiStripLorentzAngleCalibration::beginOfJob(), SiStripBackplaneCalibration::beginOfJob(), AlignableTrackerBuilder::convertGeomDetsToAlignables(), AlignmentTrackSelector::detailedHitsCheck(), AlignmentParameterSelector::detUnitDeselected(), AlignmentStats::endRun(), LA_Filler_Fitter::fill(), SiStripMonitorTrack::fillControlViewHistos(), SiStripQualityDQM::fillGrandSummaryMEs(), MillePedeMonitor::fillTrack(), SiStripFolderOrganizer::getFolderName(), SiStripFolderOrganizer::getLayerFolderName(), SiStripFolderOrganizer::getSubDetLayerFolderName(), TkDetMap::getSubDetLayerSide(), track_associator::hitsToClusterRefs(), MeasurementTrackerImpl::initializeStripStatus(), AlignmentParameterSelector::layerDeselected(), TkLayerMap::layerSearch(), SiStripCondVisualizer::module_location_type(), moduleGeometry(), siStripLACalibration::moduleLocationType(), SiStripLorentzAnglePCLMonitor::moduleLocationType(), ShallowClustersProducer::moduleVars::moduleVars(), AlignmentParameterSelector::outsideDetIdRanges(), SiStripTrackerMapCreator::printBadModuleList(), SiStripTrackerMapCreator::printTopModules(), TkAlCaOverlapTagger::produce(), GsfTrackProducerBase::putInEvt(), SiStripMonitorTrack::RecHitInfo(), SiStripBadModuleConfigurableFakeESSource::selectDetectors(), HITrackClusterRemover::sensorThickness(), siStripClusterTools::sensorThicknessInverse(), SiStripFolderOrganizer::setLayerFolder(), StripCPEfromTrackAngle::StripCPEfromTrackAngle(), LA_Filler_Fitter::subdetLabel(), and APVGain::thickness().

UNKNOWN

constexpr auto SiStripDetId::UNKNOWN = SiStripSubdetector::UNKNOWN

static

Definition at line 37 of file SiStripDetId.h.

Referenced by moduleGeometry().