Detector ID class for CTPPS Timing Diamond detectors. Bits [19:31] : Assigend in CTPPSDetId Calss Bits [17:18] : 2 bits for diamond plane 0,1,2,3 Bits [12:16] : 5 bits for Diamond channel numbers 1,2,3,..16 Bits [0:11] : unspecified yet. More...

#include <CTPPSDiamondDetId.h>

Inheritance diagram for CTPPSDiamondDetId:

Public Member Functions
uint32_t	channel () const

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

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

	CTPPSDiamondDetId (const CTPPSDetId &id)

	CTPPSDiamondDetId (uint32_t Arm, uint32_t Station, uint32_t RomanPot=0, uint32_t Plane=0, uint32_t Channel=0)
	Construct from hierarchy indeces. More...

uint32_t	plane () const

CTPPSDiamondDetId	planeId () const

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

void	setChannel (uint32_t channel)

void	setPlane (uint32_t channel)

Public Member Functions inherited from CTPPSDetId
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 (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 bool	check (unsigned int raw)
	returns true if the raw ID is a PPS-timing one More...

Static Public Attributes
static const uint32_t	lowMaskChannel = 0xFFF

static const uint32_t	lowMaskPlane = 0x1FFFF

static const uint32_t	maskChannel = 0x1F

static const uint32_t	maskPlane = 0x3

static const uint32_t	maxChannel = 31

static const uint32_t	maxPlane = 3

static const uint32_t	startDetBit = 12

static const uint32_t	startPlaneBit = 17

Static Public Attributes inherited from CTPPSDetId
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

Additional Inherited Members
Public Types inherited from CTPPSDetId
enum	NameFlag { nShort, nFull, nPath }
	type of name returned by *Name functions More...

enum	SubDetector { sdTrackingStrip = 3, sdTrackingPixel = 4, sdTimingDiamond = 5, sdTimingFastSilicon = 6, sdTotemT2 = 7 }
	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 }

Protected Attributes inherited from DetId
uint32_t	id_

Detailed Description

Detector ID class for CTPPS Timing Diamond detectors. Bits [19:31] : Assigend in CTPPSDetId Calss Bits [17:18] : 2 bits for diamond plane 0,1,2,3 Bits [12:16] : 5 bits for Diamond channel numbers 1,2,3,..16 Bits [0:11] : unspecified yet.

Definition at line 25 of file CTPPSDiamondDetId.h.

Constructor & Destructor Documentation

◆ CTPPSDiamondDetId() [1/3]

CTPPSDiamondDetId::CTPPSDiamondDetId ( uint32_t id )

explicit

Construct from a raw id.

Definition at line 21 of file CTPPSDiamondDetId.cc.

References channel(), check(), Exception, and DetId::subdetId().

Referenced by planeId().

                                                 : CTPPSDetId(id) {
   if (!check(id)) {
     throw cms::Exception("InvalidDetId") << "CTPPSDiamondDetId ctor:"
                                          << " channel: " << channel() << " subdet: " << subdetId()
                                          << " is not a valid CTPPS Timing Diamond id";
   }
 }

◆ CTPPSDiamondDetId() [2/3]

CTPPSDiamondDetId::CTPPSDiamondDetId ( const CTPPSDetId & id )

inline

Definition at line 30 of file CTPPSDiamondDetId.h.

30 : CTPPSDetId(id) {}

CTPPSDetId::CTPPSDetId

CTPPSDetId(uint32_t id)

Construct from a raw id.

Definition: CTPPSDetId.cc:41

◆ CTPPSDiamondDetId() [3/3]

CTPPSDiamondDetId::CTPPSDiamondDetId	(	uint32_t	Arm,
		uint32_t	Station,
		uint32_t	RomanPot = `0`,
		uint32_t	Plane = `0`,
		uint32_t	Channel = `0`
	)

Construct from hierarchy indeces.

Definition at line 31 of file CTPPSDiamondDetId.cc.

References Exception, DetId::id_, CTPPSDetId::maskArm, maskChannel, maskPlane, CTPPSDetId::maskRP, CTPPSDetId::maskStation, CTPPSDetId::maxArm, maxChannel, maxPlane, CTPPSDetId::maxRP, CTPPSDetId::maxStation, convertSQLiteXML::ok, CTPPSDetId::startArmBit, startDetBit, startPlaneBit, CTPPSDetId::startRPBit, and CTPPSDetId::startStationBit.

     : CTPPSDetId(sdTimingDiamond, Arm, Station, RomanPot) {
   if (Arm > maxArm || Station > maxStation || RomanPot > maxRP || Plane > maxPlane || Channel > maxChannel) {
     throw cms::Exception("InvalidDetId") << "CTPPSDiamondDetId ctor:"
                                          << " Invalid parameters:"
                                          << " arm=" << Arm << " station=" << Station << " rp=" << RomanPot
                                          << " plane=" << Plane << " detector=" << Channel << std::endl;
   }
 
   uint32_t ok = 0xfe000000;
   id_ &= ok;
 
   id_ |= ((Arm & maskArm) << startArmBit);
   id_ |= ((Station & maskStation) << startStationBit);
   id_ |= ((RomanPot & maskRP) << startRPBit);
   id_ |= ((Plane & maskPlane) << startPlaneBit);
   id_ |= ((Channel & maskChannel) << startDetBit);
 }

Member Function Documentation

◆ channel()

uint32_t CTPPSDiamondDetId::channel ( ) const

inline

Definition at line 52 of file CTPPSDiamondDetId.h.

References DetId::id_, maskChannel, and startDetBit.

Referenced by channelName(), CTPPSDiamondDetId(), CTPPSGeometryInfo::formatDetId(), PPSFastLocalSimulation::GenerateTrack(), DiamondSampicDQMSource::globalEndLuminosityBlock(), CTPPSDiamondDQMSource::globalEndLuminosityBlock(), setChannel(), and setPlane().

52 { return ((id_ >> startDetBit) & maskChannel); }

CTPPSDiamondDetId::maskChannel

static const uint32_t maskChannel

Definition: CTPPSDiamondDetId.h:36

DetId::id_

uint32_t id_

Definition: DetId.h:69

CTPPSDiamondDetId::startDetBit

static const uint32_t startDetBit

Definition: CTPPSDiamondDetId.h:36

◆ channelName()

void CTPPSDiamondDetId::channelName	(	std::string &	name,
		NameFlag	flag = `nFull`
	)		const

inline

Definition at line 83 of file CTPPSDiamondDetId.h.

References channel(), RemoveAddSevLevel::flag, mergeVDriftHistosByStation::name, CTPPSDetId::nFull, CTPPSDetId::nPath, CTPPSDetId::nShort, planeName(), and to_string().

Referenced by DiamondSampicCalibrationDQMSource::ChannelPlots::ChannelPlots(), DiamondSampicDQMSource::ChannelPlots::ChannelPlots(), and CTPPSDiamondDQMSource::ChannelPlots::ChannelPlots().

                                                                         {
     switch (flag) {
       case nShort:
         name = "";
         break;
       case nFull:
         planeName(name, flag);
         name += "_";
         break;
       case nPath:
         planeName(name, flag);
         name += "/channel ";
         break;
     }
 
     name += std::to_string(channel());
   }

◆ check()

static bool CTPPSDiamondDetId::check ( unsigned int raw )

inlinestatic

returns true if the raw ID is a PPS-timing one

Definition at line 39 of file CTPPSDiamondDetId.h.

References DetId::kDetOffset, DetId::kSubdetOffset, CTPPSDetId::sdTimingDiamond, and DetId::VeryForward.

Referenced by PPSTimingCalibrationPCLHarvester::beginRun(), PPSDiamondSampicTimingCalibrationPCLHarvester::beginRun(), PPSTimingCalibrationPCLWorker::bookHistograms(), PPSDiamondSampicTimingCalibrationPCLWorker::bookHistograms(), DiamondSampicDQMSource::bookHistograms(), DiamondSampicCalibrationDQMSource::bookHistograms(), CTPPSDiamondDQMSource::bookHistograms(), CTPPSDiamondDetId(), DiamondSampicDQMSource::dqmBeginRun(), DiamondSampicCalibrationDQMSource::dqmBeginRun(), and CTPPSDiamondDQMSource::dqmBeginRun().

                                       {
     return (((raw >> DetId::kDetOffset) & 0xF) == DetId::VeryForward &&
             ((raw >> DetId::kSubdetOffset) & 0x7) == sdTimingDiamond);
   }

◆ plane()

uint32_t CTPPSDiamondDetId::plane ( ) const

inline

Definition at line 45 of file CTPPSDiamondDetId.h.

References DetId::id_, maskPlane, and startPlaneBit.

Referenced by CTPPSGeometryInfo::formatDetId(), DiamondSampicDQMSource::globalEndLuminosityBlock(), CTPPSDiamondDQMSource::globalEndLuminosityBlock(), planeName(), printId(), and CTPPSRPAlignmentCorrectionsMethods::writeXMLBlock().

45 { return ((id_ >> startPlaneBit) & maskPlane); }

CTPPSDiamondDetId::startPlaneBit

static const uint32_t startPlaneBit

Definition: CTPPSDiamondDetId.h:35

DetId::id_

uint32_t id_

Definition: DetId.h:69

CTPPSDiamondDetId::maskPlane

static const uint32_t maskPlane

Definition: CTPPSDiamondDetId.h:35

◆ planeId()

CTPPSDiamondDetId CTPPSDiamondDetId::planeId ( ) const

inline

Definition at line 61 of file CTPPSDiamondDetId.h.

References CTPPSDiamondDetId(), lowMaskPlane, and DetId::rawId().

Referenced by CTPPSDiamondDQMSource::bookHistograms().

61 { return CTPPSDiamondDetId(rawId() & (~lowMaskPlane)); }

CTPPSDiamondDetId::CTPPSDiamondDetId

CTPPSDiamondDetId(uint32_t id)

Construct from a raw id.

Definition: CTPPSDiamondDetId.cc:21

DetId::rawId

constexpr uint32_t rawId() const

get the raw id

Definition: DetId.h:57

CTPPSDiamondDetId::lowMaskPlane

static const uint32_t lowMaskPlane

Definition: CTPPSDiamondDetId.h:35

◆ planeName()

void CTPPSDiamondDetId::planeName	(	std::string &	name,
		NameFlag	flag = `nFull`
	)		const

inline

Definition at line 65 of file CTPPSDiamondDetId.h.

References RemoveAddSevLevel::flag, mergeVDriftHistosByStation::name, CTPPSDetId::nFull, CTPPSDetId::nPath, CTPPSDetId::nShort, plane(), CTPPSDetId::rpName(), and to_string().

Referenced by channelName(), DiamondSampicCalibrationDQMSource::PlanePlots::PlanePlots(), DiamondSampicDQMSource::PlanePlots::PlanePlots(), and CTPPSDiamondDQMSource::PlanePlots::PlanePlots().

                                                                       {
     switch (flag) {
       case nShort:
         name = "";
         break;
       case nFull:
         rpName(name, flag);
         name += "_";
         break;
       case nPath:
         rpName(name, flag);
         name += "/plane ";
         break;
     }
 
     name += std::to_string(plane());
   }

◆ setChannel()

void CTPPSDiamondDetId::setChannel ( uint32_t channel )

inline

Definition at line 54 of file CTPPSDiamondDetId.h.

References channel(), DetId::id_, maskChannel, and startDetBit.

Referenced by DiamondSampicDQMSource::analyze(), and DiamondSampicCalibrationDQMSource::analyze().

                                     {
     id_ &= ~(maskChannel << startDetBit);
     id_ |= ((channel & maskChannel) << startDetBit);
   }

◆ setPlane()

void CTPPSDiamondDetId::setPlane ( uint32_t channel )

inline

Definition at line 47 of file CTPPSDiamondDetId.h.

References channel(), DetId::id_, maskPlane, and startPlaneBit.

Referenced by DiamondSampicDQMSource::analyze(), and DiamondSampicCalibrationDQMSource::analyze().

                                   {
     id_ &= ~(maskPlane << startPlaneBit);
     id_ |= ((channel & maskPlane) << startPlaneBit);
   }

Member Data Documentation

◆ lowMaskChannel

const uint32_t CTPPSDiamondDetId::lowMaskChannel = 0xFFF

static

Definition at line 36 of file CTPPSDiamondDetId.h.

◆ lowMaskPlane

const uint32_t CTPPSDiamondDetId::lowMaskPlane = 0x1FFFF

static

Definition at line 35 of file CTPPSDiamondDetId.h.

Referenced by planeId().

◆ maskChannel

const uint32_t CTPPSDiamondDetId::maskChannel = 0x1F

static

Definition at line 36 of file CTPPSDiamondDetId.h.

Referenced by channel(), CTPPSDiamondDetId(), and setChannel().

◆ maskPlane

const uint32_t CTPPSDiamondDetId::maskPlane = 0x3

static

Definition at line 35 of file CTPPSDiamondDetId.h.

Referenced by CTPPSDiamondDetId(), plane(), and setPlane().

◆ maxChannel

const uint32_t CTPPSDiamondDetId::maxChannel = 31

static

Definition at line 36 of file CTPPSDiamondDetId.h.

Referenced by CTPPSDiamondDetId().

◆ maxPlane

const uint32_t CTPPSDiamondDetId::maxPlane = 3

static

Definition at line 35 of file CTPPSDiamondDetId.h.

Referenced by CTPPSDiamondDetId().

◆ startDetBit

const uint32_t CTPPSDiamondDetId::startDetBit = 12

static

Definition at line 36 of file CTPPSDiamondDetId.h.

Referenced by channel(), CTPPSDiamondDetId(), and setChannel().

◆ startPlaneBit

const uint32_t CTPPSDiamondDetId::startPlaneBit = 17

static

Definition at line 35 of file CTPPSDiamondDetId.h.

Referenced by CTPPSDiamondDetId(), plane(), and setPlane().

Public Member Functions

Static Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CTPPSDiamondDetId() [1/3]

◆ CTPPSDiamondDetId() [2/3]

◆ CTPPSDiamondDetId() [3/3]

Member Function Documentation

◆ channel()

◆ channelName()

◆ check()

◆ plane()

◆ planeId()

◆ planeName()

◆ setChannel()

◆ setPlane()

Member Data Documentation

◆ lowMaskChannel

◆ lowMaskPlane

◆ maskChannel

◆ maskPlane

◆ maxChannel

◆ maxPlane

◆ startDetBit

◆ startPlaneBit