Base class for CTPPS detector IDs. More...

#include <CTPPSDetId.h>

Inheritance diagram for CTPPSDetId:

Public Types
enum	NameFlag { nShort, nFull, nPath }
	type of name returned by *Name functions More...

enum	SubDetector { sdTrackingStrip = 3, sdTrackingPixel = 4, sdTimingDiamond = 5, sdTimingFastSilicon = 6 }
	CTPPS sub-detectors. More...

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	arm () const

CTPPSDetId	armId () const

void	armName (std::string &name, NameFlag flag=nFull) const

	CTPPSDetId (uint32_t id)
	Construct from a raw id. More...

	CTPPSDetId (uint32_t SubDet, uint32_t Arm, uint32_t Station, uint32_t RomanPot=0)
	Construct from hierarchy indeces. More...

uint32_t	rp () const

CTPPSDetId	rpId () const

void	rpName (std::string &name, NameFlag flag=nFull) const

void	setArm (uint32_t arm)

void	setRP (uint32_t rp)

void	setStation (uint32_t station)

uint32_t	station () const

CTPPSDetId	stationId () const

void	stationName (std::string &name, NameFlag flag=nFull) const

void	subDetectorName (std::string &name, NameFlag flag=nFull) 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 (Detector det, int subdet)
	Create an id, filling the detector and subdetector fields as specified. More...

constexpr	DetId (uint32_t id)
	Create an id from a raw number. 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 uint32_t	lowMaskArm = 0xFFFFFF

static const uint32_t	lowMaskRP = 0x7FFFF

static const uint32_t	lowMaskStation = 0x3FFFFF

static const uint32_t	maskArm = 0x1

static const uint32_t	maskRP = 0x7

static const uint32_t	maskStation = 0x3

static const uint32_t	maxArm = 1

static const uint32_t	maxRP = 6

static const uint32_t	maxStation = 2

static const uint32_t	startArmBit = 24

static const uint32_t	startRPBit = 19

static const uint32_t	startStationBit = 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

Static Private Attributes
static const std::string	armNames [] = {"45", "56"}

static const std::string	rpNames [] = {"nr_tp", "nr_bt", "nr_hr", "fr_hr", "fr_tp", "fr_bt", "cyl_hr"}

static const std::string	stationNames [] = {"210", "220cyl", "220"}

static const std::string	subDetectorNames []

static const std::string	subDetectorPaths []

Additional Inherited Members
Protected Attributes inherited from DetId
uint32_t	id_

Detailed Description

Base class for CTPPS detector IDs.

The bit structure is as follows: bits [24:24] => arm: 0 (sector 45), 1 (sector 56) bits [22:23] => station: 0 (210m), 1 (cylyndrical pots), 2 (220m) bits [19:21] => Roman Pot: 0 (near top), 1 (near bottom), 2 (near horizontal), 3 (far horizontal), 4 (far top), 5 (far bottom) bits [0:18] => available for derived classes

The ...Name() methods implement the official naming scheme based on EDMS 906715.

Definition at line 31 of file CTPPSDetId.h.

Member Enumeration Documentation

◆ NameFlag

enum CTPPSDetId::NameFlag

type of name returned by *Name functions

Enumerator
nShort
nFull
nPath

Definition at line 87 of file CTPPSDetId.h.

◆ SubDetector

enum CTPPSDetId::SubDetector

CTPPS sub-detectors.

Enumerator
sdTrackingStrip
sdTrackingPixel
sdTimingDiamond
sdTimingFastSilicon

Definition at line 39 of file CTPPSDetId.h.

51 { return ((id_ >> startArmBit) & maskArm); }

Constructor & Destructor Documentation

◆ CTPPSDetId() [1/2]

CTPPSDetId::CTPPSDetId ( uint32_t id )

explicit

Construct from a raw id.

Definition at line 34 of file CTPPSDetId.cc.

                                   : DetId(id) {
   bool inputOK = (det() == DetId::VeryForward);
  
   if (!inputOK) {
     throw cms::Exception("InvalidDetId") << "CTPPSDetId ctor:"
                                          << " det: " << det() << " subdet: " << subdetId()
                                          << " is not a valid CTPPS id.";
   }

References DetId::det(), Exception, DetId::subdetId(), and DetId::VeryForward.

Referenced by armId(), and setRP().

◆ CTPPSDetId() [2/2]

CTPPSDetId::CTPPSDetId	(	uint32_t	SubDet,
		uint32_t	Arm,
		uint32_t	Station,
		uint32_t	RomanPot = `0`
	)

Construct from hierarchy indeces.

Definition at line 46 of file CTPPSDetId.cc.

     : DetId(DetId::VeryForward, SubDet) {
   if (SubDet != sdTrackingStrip && SubDet != sdTrackingPixel && SubDet != sdTimingDiamond &&
       SubDet != sdTimingFastSilicon) {
     throw cms::Exception("InvalidDetId") << "CTPPSDetId ctor: invalid sub-detector " << SubDet << ".";
   }
  
   if (Arm > maxArm || Station > maxStation || RomanPot > maxRP) {
     throw cms::Exception("InvalidDetId") << "CTPPSDetId ctor:"
                                          << " Invalid parameters:"
                                          << " arm=" << Arm << " station=" << Station << " rp=" << RomanPot << std::endl;
   }
  
   uint32_t ok = 0xfe000000;
   id_ &= ok;
  
   id_ |= ((Arm & maskArm) << startArmBit);
   id_ |= ((Station & maskStation) << startStationBit);
   id_ |= ((RomanPot & maskRP) << startRPBit);

References Exception, DetId::id_, maskArm, maskRP, maskStation, maxArm, maxRP, maxStation, convertSQLiteXML::ok, sdTimingDiamond, sdTimingFastSilicon, sdTrackingPixel, sdTrackingStrip, startArmBit, startRPBit, startStationBit, and ntupleEnum::SubDet.

Member Function Documentation

◆ arm()

uint32_t CTPPSDetId::arm ( ) const

inline

Definition at line 55 of file CTPPSDetId.h.

58 { return ((id_ >> startStationBit) & maskStation); }

Referenced by CTPPSProtonReconstructionPlotter::analyze(), CTPPSPixelDQMSource::analyze(), CTPPSProtonReconstructionEfficiencyEstimatorData::analyze(), PPSModifySingularModes::beginRun(), AlignmentTask::buildGeometry(), AlignmentTask::buildStandardConstraints(), JanAlignmentAlgorithm::feed(), RPixPlaneCombinatoryTracking::findTracks(), PPSFastLocalSimulation::GenerateTrack(), TotemTimingDQMSource::globalEndLuminosityBlock(), CTPPSDiamondDQMSource::globalEndLuminosityBlock(), TotemRPDetId::isStripsCoordinateVDirection(), printId(), StraightTrackAlignment::processEvent(), CTPPSDirectProtonSimulation::processProton(), RPixPlaneCombinatoryTracking::produceAllHitCombination(), TotemTimingDetId::TotemTimingDetId(), and CTPPSRPAlignmentCorrectionsMethods::writeXMLBlock().

◆ armId()

CTPPSDetId CTPPSDetId::armId ( ) const

inline

Definition at line 78 of file CTPPSDetId.h.

78 { return CTPPSDetId(rawId() & (~lowMaskRP)); }

References CTPPSDetId(), lowMaskRP, and DetId::rawId().

Referenced by CTPPSGeometry::build().

◆ armName()

void CTPPSDetId::armName	(	std::string &	name,
		NameFlag	flag = `nFull`
	)		const

inline

Definition at line 96 of file CTPPSDetId.h.

                 :
         subDetectorName(name, flag);
         name += "_";
         break;
       case nPath:
         subDetectorName(name, flag);
         name += "/sector ";
         break;
     }
  
     name += armNames[arm()];
   }
  
   inline void stationName(std::string &name, NameFlag flag = nFull) const {
     switch (flag) {
       case nShort:

Referenced by CTPPSCommonDQMSource::ArmPlots::ArmPlots().

◆ rp()

uint32_t CTPPSDetId::rp ( ) const

inline

Definition at line 69 of file CTPPSDetId.h.

74 { return CTPPSDetId(rawId() & (~lowMaskArm)); }

Referenced by CTPPSPixelDQMSource::analyze(), PPSModifySingularModes::beginRun(), AlignmentTask::buildGeometry(), AlignmentTask::buildStandardConstraints(), JanAlignmentAlgorithm::feed(), PPSFastLocalSimulation::GenerateTrack(), TotemTimingDQMSource::globalEndLuminosityBlock(), CTPPSDiamondDQMSource::globalEndLuminosityBlock(), TotemRPDetId::isStripsCoordinateVDirection(), printId(), StraightTrackAlignment::processEvent(), RPixPlaneCombinatoryTracking::produceAllHitCombination(), and CTPPSRPAlignmentCorrectionsMethods::writeXMLBlock().

◆ rpId()

CTPPSDetId CTPPSDetId::rpId ( ) const

inline

Definition at line 82 of file CTPPSDetId.h.

83 { nShort, nFull, nPath };

Referenced by CTPPSGeometry::build(), AlignmentTask::buildEqualMeanUMeanVRotZConstraints(), AlignmentTask::buildOneRotZPerPotConstraints(), AlignmentTask::buildStandardConstraints(), factorRPFromSensorCorrections(), RPixRoadFinder::findPattern(), StraightTrackAlignment::finish(), TotemRPDQMHarvester::MakePlaneEfficiencyHistograms(), CTPPSPixelLocalTrackProducer::produce(), LocalTrackFitter::removeInsufficientPots(), and CTPPSRPAlignmentCorrectionsMethods::writeXMLBlock().

◆ rpName()

void CTPPSDetId::rpName	(	std::string &	name,
		NameFlag	flag = `nFull`
	)		const

inline

Definition at line 132 of file CTPPSDetId.h.

                 :
         stationName(name, flag);
         name += "_";
         break;
       case nPath:
         stationName(name, flag);
         name += "/";
         break;
     }
  
     name += rpNames[rp()];
   }
  
 private:
   static const std::string subDetectorNames[];
   static const std::string subDetectorPaths[];

Referenced by ElasticPlotDQMSource::DiagonalPlots::DiagonalPlots(), TotemRPDQMHarvester::MakeHitNumberRatios(), CTPPSDiamondDetId::planeName(), TotemTimingDetId::planeName(), TotemRPDQMSource::PotPlots::PotPlots(), ElasticPlotDQMSource::PotPlots::PotPlots(), TotemTimingDQMSource::PotPlots::PotPlots(), and CTPPSDiamondDQMSource::PotPlots::PotPlots().

◆ setArm()

void CTPPSDetId::setArm ( uint32_t arm )

inline

Definition at line 57 of file CTPPSDetId.h.

                            { return ((id_ >> startStationBit) & maskStation); }
  
   void setStation(uint32_t station) {

References DetId::id_, maskStation, and startStationBit.

◆ setRP()

void CTPPSDetId::setRP ( uint32_t rp )

inline

Definition at line 71 of file CTPPSDetId.h.

74 { return CTPPSDetId(rawId() & (~lowMaskArm)); }

References CTPPSDetId(), lowMaskArm, and DetId::rawId().

◆ setStation()

void CTPPSDetId::setStation ( uint32_t station )

inline

Definition at line 64 of file CTPPSDetId.h.

                       { return ((id_ >> startRPBit) & maskRP); }
  
   void setRP(uint32_t rp) {

References DetId::id_, maskRP, and startRPBit.

◆ station()

uint32_t CTPPSDetId::station ( ) const

inline

◆ stationId()

CTPPSDetId CTPPSDetId::stationId ( ) const

inline

Definition at line 80 of file CTPPSDetId.h.

83 { nShort, nFull, nPath };

References nFull, nPath, and nShort.

Referenced by CTPPSGeometry::build().

◆ stationName()

void CTPPSDetId::stationName	(	std::string &	name,
		NameFlag	flag = `nFull`
	)		const

inline

Definition at line 114 of file CTPPSDetId.h.

                 :
         armName(name, flag);
         name += "_";
         break;
       case nPath:
         armName(name, flag);
         name += "/station ";
         break;
     }
  
     name += stationNames[station()];
   }
  
   inline void rpName(std::string &name, NameFlag flag = nFull) const {
     switch (flag) {
       case nShort:

◆ subDetectorName()

void CTPPSDetId::subDetectorName	(	std::string &	name,
		NameFlag	flag = `nFull`
	)		const

inline

Definition at line 89 of file CTPPSDetId.h.

                                                                     {
     switch (flag) {
       case nShort:

Member Data Documentation

◆ armNames

const string CTPPSDetId::armNames = {"45", "56"}

staticprivate

Definition at line 153 of file CTPPSDetId.h.

◆ lowMaskArm

const uint32_t CTPPSDetId::lowMaskArm = 0xFFFFFF

static

Definition at line 49 of file CTPPSDetId.h.

Referenced by setRP().

◆ lowMaskRP

const uint32_t CTPPSDetId::lowMaskRP = 0x7FFFF

static

Definition at line 51 of file CTPPSDetId.h.

Referenced by armId().

◆ lowMaskStation

const uint32_t CTPPSDetId::lowMaskStation = 0x3FFFFF

static

Definition at line 50 of file CTPPSDetId.h.

◆ maskArm

const uint32_t CTPPSDetId::maskArm = 0x1

static

Definition at line 49 of file CTPPSDetId.h.

Referenced by CTPPSDetId(), CTPPSDiamondDetId::CTPPSDiamondDetId(), CTPPSPixelDetId::init(), RPDisplacementGenerator::rawToDecId(), TotemRPDetId::TotemRPDetId(), and TotemTimingDetId::TotemTimingDetId().

◆ maskRP

const uint32_t CTPPSDetId::maskRP = 0x7

static

Definition at line 51 of file CTPPSDetId.h.

Referenced by CTPPSDetId(), CTPPSDiamondDetId::CTPPSDiamondDetId(), CTPPSPixelDetId::init(), RPDisplacementGenerator::rawToDecId(), setStation(), TotemRPDetId::TotemRPDetId(), and TotemTimingDetId::TotemTimingDetId().

◆ maskStation

const uint32_t CTPPSDetId::maskStation = 0x3

static

Definition at line 50 of file CTPPSDetId.h.

Referenced by CTPPSDetId(), CTPPSDiamondDetId::CTPPSDiamondDetId(), CTPPSPixelDetId::init(), RPDisplacementGenerator::rawToDecId(), setArm(), TotemRPDetId::TotemRPDetId(), and TotemTimingDetId::TotemTimingDetId().

◆ maxArm

const uint32_t CTPPSDetId::maxArm = 1

static

Definition at line 49 of file CTPPSDetId.h.

Referenced by CTPPSDetId(), CTPPSDiamondDetId::CTPPSDiamondDetId(), CTPPSPixelDetId::init(), TotemRPDetId::TotemRPDetId(), and TotemTimingDetId::TotemTimingDetId().

◆ maxRP

const uint32_t CTPPSDetId::maxRP = 6

static

Definition at line 51 of file CTPPSDetId.h.

Referenced by CTPPSDetId(), CTPPSDiamondDetId::CTPPSDiamondDetId(), CTPPSPixelDetId::init(), TotemRPDetId::TotemRPDetId(), and TotemTimingDetId::TotemTimingDetId().

◆ maxStation

const uint32_t CTPPSDetId::maxStation = 2

static

Definition at line 50 of file CTPPSDetId.h.

Referenced by CTPPSDetId(), CTPPSDiamondDetId::CTPPSDiamondDetId(), CTPPSPixelDetId::init(), TotemRPDetId::TotemRPDetId(), and TotemTimingDetId::TotemTimingDetId().

◆ rpNames

const string CTPPSDetId::rpNames = {"nr_tp", "nr_bt", "nr_hr", "fr_hr", "fr_tp", "fr_bt", "cyl_hr"}

staticprivate

Definition at line 155 of file CTPPSDetId.h.

◆ startArmBit

const uint32_t CTPPSDetId::startArmBit = 24

static

Definition at line 49 of file CTPPSDetId.h.

Referenced by CTPPSDetId(), CTPPSDiamondDetId::CTPPSDiamondDetId(), CTPPSPixelDetId::init(), RPDisplacementGenerator::rawToDecId(), TotemRPDetId::TotemRPDetId(), and TotemTimingDetId::TotemTimingDetId().

◆ startRPBit

const uint32_t CTPPSDetId::startRPBit = 19

static

Definition at line 51 of file CTPPSDetId.h.

Referenced by CTPPSDetId(), CTPPSDiamondDetId::CTPPSDiamondDetId(), CTPPSPixelDetId::init(), RPDisplacementGenerator::rawToDecId(), setStation(), TotemRPDetId::TotemRPDetId(), and TotemTimingDetId::TotemTimingDetId().

◆ startStationBit

const uint32_t CTPPSDetId::startStationBit = 22

static

Definition at line 50 of file CTPPSDetId.h.

Referenced by CTPPSDetId(), CTPPSDiamondDetId::CTPPSDiamondDetId(), CTPPSPixelDetId::init(), RPDisplacementGenerator::rawToDecId(), setArm(), TotemRPDetId::TotemRPDetId(), and TotemTimingDetId::TotemTimingDetId().

◆ stationNames

const string CTPPSDetId::stationNames = {"210", "220cyl", "220"}

staticprivate

Definition at line 154 of file CTPPSDetId.h.

◆ subDetectorNames

const string CTPPSDetId::subDetectorNames

staticprivate

Initial value:

= {

"", "", "", "ctpps_tr_strip", "ctpps_tr_pixel", "ctpps_ti_diamond", "ctpps_ti_fastsilicon"}

Definition at line 151 of file CTPPSDetId.h.

◆ subDetectorPaths

const string CTPPSDetId::subDetectorPaths

staticprivate

Initial value:

= {

"", "", "", "CTPPS/TrackingStrip", "CTPPS/TrackingPixel", "CTPPS/TimingDiamond", "CTPPS/TimingFastSilicon"}

Definition at line 152 of file CTPPSDetId.h.

Public Types

Public Member Functions

Static Public Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ NameFlag

◆ SubDetector

Constructor & Destructor Documentation

◆ CTPPSDetId() [1/2]

◆ CTPPSDetId() [2/2]

Member Function Documentation

◆ arm()

◆ armId()

◆ armName()

◆ rp()

◆ rpId()

◆ rpName()

◆ setArm()

◆ setRP()

◆ setStation()

◆ station()

◆ stationId()

◆ stationName()

◆ subDetectorName()

Member Data Documentation

◆ armNames

◆ lowMaskArm

◆ lowMaskRP

◆ lowMaskStation

◆ maskArm

◆ maskRP

◆ maskStation

◆ maxArm

◆ maxRP

◆ maxStation

◆ rpNames

◆ startArmBit

◆ startRPBit

◆ startStationBit

◆ stationNames

◆ subDetectorNames

◆ subDetectorPaths