TotemT2DetId Class Reference

Detector ID class for Totem T2 detectors. Bits [19:31] : Base CTPPSDetId class attributes Bits [16:18] : 3 bits for T2 plane [0-7] Bits [14:15] : 2 bits for T2 tile numbers [0-3] Bits [0:13] : unspecified yet. More...

#include <TotemT2DetId.h>

Inheritance diagram for TotemT2DetId:

Public Member Functions
uint32_t	channel () const
void	channelName (std::string &name, NameFlag flag=nFull) const
uint32_t	plane () const
TotemT2DetId	planeId () const
void	planeName (std::string &name, NameFlag flag=nFull) const
void	setChannel (uint32_t channel)
void	setPlane (uint32_t channel)
	TotemT2DetId (uint32_t id)
	Construct from a raw id. More...
	TotemT2DetId (const CTPPSDetId &id)
	TotemT2DetId (uint32_t arm, uint32_t plane, uint32_t channel=0)
	Construct from hierarchy indices. More...
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 constexpr uint32_t	lowMaskChannel = 0x1fff
static constexpr uint32_t	lowMaskPlane = 0xffff
static constexpr uint32_t	maskChannel = 0x3
static constexpr uint32_t	maskPlane = 0x7
static constexpr uint32_t	maxChannel = 3
static constexpr uint32_t	maxPlane = 7
static constexpr uint32_t	startChannelBit = 14
static constexpr uint32_t	startPlaneBit = 16
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 Totem T2 detectors. Bits [19:31] : Base CTPPSDetId class attributes Bits [16:18] : 3 bits for T2 plane [0-7] Bits [14:15] : 2 bits for T2 tile numbers [0-3] Bits [0:13] : unspecified yet.

Definition at line 25 of file TotemT2DetId.h.

Constructor & Destructor Documentation

TotemT2DetId() [1/3]

TotemT2DetId::TotemT2DetId ( uint32_t  id )

explicit

Construct from a raw id.

Definition at line 14 of file TotemT2DetId.cc.

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

Referenced by planeId().

                                      : CTPPSDetId(id) {
  if (!check(id))
    throw cms::Exception("InvalidDetId") << "TotemT2DetId ctor:"
                                         << " channel: " << channel() << " subdet: " << subdetId()
                                         << " is not a valid Totem nT2 id";
}

TotemT2DetId() [2/3]

TotemT2DetId::TotemT2DetId ( const CTPPSDetId &  id )

inline

Definition at line 29 of file TotemT2DetId.h.

: CTPPSDetId(id) {}

TotemT2DetId() [3/3]

TotemT2DetId::TotemT2DetId	(	uint32_t	arm,
		uint32_t	plane,
		uint32_t	channel = 0
	)

Construct from hierarchy indices.

Definition at line 23 of file TotemT2DetId.cc.

References CTPPSDetId::arm(), channel(), Exception, DetId::id_, CTPPSDetId::maskArm, maskChannel, maskPlane, CTPPSDetId::maxArm, maxChannel, maxPlane, convertSQLiteXML::ok, plane(), CTPPSDetId::startArmBit, startChannelBit, and startPlaneBit.

                                                                         : CTPPSDetId(sdTotemT2, arm, 0, 0) {
  if (arm > maxArm || plane > maxPlane || channel > maxChannel)
    throw cms::Exception("InvalidDetId") << "TotemT2DetId ctor:"
                                         << " Invalid parameters:"
                                         << " arm=" << arm << " plane=" << plane << " detector=" << channel;

  uint32_t ok = 0xfe000000;
  id_ &= ok;

  id_ |= ((arm & maskArm) << startArmBit);
  id_ |= ((plane & maskPlane) << startPlaneBit);
  id_ |= ((channel & maskChannel) << startChannelBit);
}

Member Function Documentation

channel()

uint32_t TotemT2DetId::channel ( ) const

inline

Definition at line 51 of file TotemT2DetId.h.

References DetId::id_, maskChannel, and startChannelBit.

Referenced by TotemT2DQMSource::areChannelsTriggered(), channelName(), TotemT2Segmentation::computeBins(), TotemT2DQMSource::fillTriggerBitset(), setChannel(), setPlane(), and TotemT2DetId().

{ return ((id_ >> startChannelBit) & maskChannel); }

channelName()

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

Definition at line 58 of file TotemT2DetId.cc.

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

Referenced by TotemT2DQMSource::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 TotemT2DetId::check ( unsigned int  raw )

inlinestatic

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

Definition at line 38 of file TotemT2DetId.h.

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

Referenced by TotemT2DetId().

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

plane()

uint32_t TotemT2DetId::plane ( ) const

inline

Definition at line 44 of file TotemT2DetId.h.

References DetId::id_, maskPlane, and startPlaneBit.

Referenced by TotemT2DQMSource::areChannelsTriggered(), TotemT2Segmentation::computeBins(), TotemT2DQMSource::fillActivePlanes(), TotemT2DQMSource::fillTriggerBitset(), planeName(), and TotemT2DetId().

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

planeId()

TotemT2DetId TotemT2DetId::planeId ( ) const

inline

Definition at line 60 of file TotemT2DetId.h.

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

Referenced by TotemT2DQMSource::bookHistograms(), and TotemT2DQMSource::fillFlags().

{ return TotemT2DetId(rawId() & (~lowMaskPlane)); }

planeName()

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

Definition at line 39 of file TotemT2DetId.cc.

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

Referenced by channelName(), and TotemT2DQMSource::PlanePlots::PlanePlots().

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

setChannel()

void TotemT2DetId::setChannel ( uint32_t  channel )

inline

Definition at line 53 of file TotemT2DetId.h.

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

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

setPlane()

void TotemT2DetId::setPlane ( uint32_t  channel )

inline

Definition at line 46 of file TotemT2DetId.h.

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

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

Member Data Documentation

lowMaskChannel

constexpr uint32_t TotemT2DetId::lowMaskChannel = 0x1fff

static

Definition at line 35 of file TotemT2DetId.h.

lowMaskPlane

constexpr uint32_t TotemT2DetId::lowMaskPlane = 0xffff

static

Definition at line 34 of file TotemT2DetId.h.

Referenced by planeId().

maskChannel

constexpr uint32_t TotemT2DetId::maskChannel = 0x3

static

Definition at line 35 of file TotemT2DetId.h.

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

maskPlane

constexpr uint32_t TotemT2DetId::maskPlane = 0x7

static

Definition at line 34 of file TotemT2DetId.h.

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

maxChannel

constexpr uint32_t TotemT2DetId::maxChannel = 3

static

Definition at line 35 of file TotemT2DetId.h.

Referenced by TotemT2DQMSource::analyze(), TotemT2DQMSource::bookHistograms(), TotemT2DetId(), and TotemT2Segmentation::TotemT2Segmentation().

maxPlane

constexpr uint32_t TotemT2DetId::maxPlane = 7

static

Definition at line 34 of file TotemT2DetId.h.

Referenced by TotemT2DQMSource::areChannelsTriggered(), TotemT2DQMSource::bookHistograms(), TotemT2DetId(), and TotemT2Segmentation::TotemT2Segmentation().

startChannelBit

constexpr uint32_t TotemT2DetId::startChannelBit = 14

static

Definition at line 35 of file TotemT2DetId.h.

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

startPlaneBit

constexpr uint32_t TotemT2DetId::startPlaneBit = 16

static

Definition at line 34 of file TotemT2DetId.h.

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