TotemRPDetId Class Reference

Detector ID class for TOTEM Si strip detectors. More...

#include <TotemRPDetId.h>

Inheritance diagram for TotemRPDetId:

Public Member Functions
uint32_t	chip () const
void	chipName (std::string &name, NameFlag flag=nFull) const
bool	isStripsCoordinateUDirection () const
bool	isStripsCoordinateVDirection () const
uint32_t	plane () const
uint32_t	planeDecimalId () const
TotemRPDetId	planeId () const
void	planeName (std::string &name, NameFlag flag=nFull) const
uint32_t	rpDecimalId () const
void	setChip (uint32_t chip)
void	setPlane (uint32_t det)
	TotemRPDetId (uint32_t id)
	TotemRPDetId (const CTPPSDetId &id)
	TotemRPDetId (uint32_t Arm, uint32_t Station, uint32_t RomanPot=0, uint32_t Plane=0, uint32_t Chip=0)
	Construct from hierarchy indeces. 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 Attributes
static const uint32_t	lowMaskChip = 0x1FFF
static const uint32_t	lowMaskPlane = 0x7FFF
static const uint32_t	maskChip = 0x3
static const uint32_t	maskPlane = 0xF
static const uint32_t	maxChip = 3
static const uint32_t	maxPlane = 9
static const uint32_t	startChipBit = 13
static const uint32_t	startPlaneBit = 15
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

Static Private Attributes
static const std::string	chipNames [] = {"1", "2", "3", "4"}
static const std::string	planeNames [] = {"01", "02", "03", "04", "05", "06", "07", "08", "09", "10"}

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 }
	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 Si strip detectors.

Beyond the bit assignment in CTPPSDetId, this is the additional structure: Bits [15:18] => plane number from 0 (most near) to 9 (most far) Bits [13:14] => chip (VFAT) number Bits [0:12] => not assigned

Definition at line 30 of file TotemRPDetId.h.

Constructor & Destructor Documentation

TotemRPDetId::TotemRPDetId ( uint32_t  id )

explicit

Construct from a raw id. It is required that the Detector part of id is Totem and the SubDet part is RP, otherwise an exception is thrown.

Definition at line 28 of file TotemRPDetId.cc.

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

Referenced by planeId().

                                      : CTPPSDetId(id) {
  bool inputOK = (det() == DetId::VeryForward && subdetId() == sdTrackingStrip);

  if (!inputOK) {
    throw cms::Exception("InvalidDetId") << "TotemRPDetId ctor:"
                                         << " det: " << det() << " subdet: " << subdetId()
                                         << " is not a valid TotemRP id.";
  }
}

TotemRPDetId::TotemRPDetId ( const CTPPSDetId &  id )

inline

Definition at line 36 of file TotemRPDetId.h.

: CTPPSDetId(id) {}

TotemRPDetId::TotemRPDetId	(	uint32_t	Arm,
		uint32_t	Station,
		uint32_t	RomanPot = 0,
		uint32_t	Plane = 0,
		uint32_t	Chip = 0
	)

Construct from hierarchy indeces.

Definition at line 40 of file TotemRPDetId.cc.

References Exception, DetId::id_, CTPPSDetId::maskArm, maskChip, maskPlane, CTPPSDetId::maskRP, CTPPSDetId::maskStation, CTPPSDetId::maxArm, maxChip, maxPlane, CTPPSDetId::maxRP, CTPPSDetId::maxStation, convertSQLiteXML::ok, CTPPSDetId::startArmBit, startChipBit, startPlaneBit, CTPPSDetId::startRPBit, and CTPPSDetId::startStationBit.

    : CTPPSDetId(sdTrackingStrip, Arm, Station, RomanPot) {
  if (Arm > maxArm || Station > maxStation || RomanPot > maxRP || Plane > maxPlane || Chip > maxChip) {
    throw cms::Exception("InvalidDetId") << "TotemRPDetId ctor:"
                                         << " Invalid parameters:"
                                         << " arm=" << Arm << " station=" << Station << " rp=" << RomanPot
                                         << " plane=" << Plane << " chip=" << Chip << 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_ |= ((Chip & maskChip) << startChipBit);
}

Member Function Documentation

uint32_t TotemRPDetId::chip ( ) const

inline

Definition at line 53 of file TotemRPDetId.h.

References DetId::id_, maskChip, and startChipBit.

Referenced by chipName(), and RawToDigiConverter::run().

{ return ((id_ >> startChipBit) & maskChip); }

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

inline

Definition at line 97 of file TotemRPDetId.h.

References chip(), chipNames, CTPPSDetId::nFull, CTPPSDetId::nPath, CTPPSDetId::nShort, and planeName().

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

    name += chipNames[chip()];
  }

bool TotemRPDetId::isStripsCoordinateUDirection ( ) const

inline

Definition at line 66 of file TotemRPDetId.h.

References plane().

Referenced by TotemRPDQMSource::analyze(), and isStripsCoordinateVDirection().

{ return plane() % 2; }

bool TotemRPDetId::isStripsCoordinateVDirection ( ) const

inline

Definition at line 68 of file TotemRPDetId.h.

References isStripsCoordinateUDirection().

{ return !isStripsCoordinateUDirection(); }

uint32_t TotemRPDetId::plane ( ) const

inline

Definition at line 46 of file TotemRPDetId.h.

References DetId::id_, maskPlane, and startPlaneBit.

Referenced by TotemRPDQMSource::analyze(), AlignmentTask::buildGeometry(), CTPPSGeometryInfo::formatDetId(), isStripsCoordinateUDirection(), TotemRPDQMHarvester::MakePlaneEfficiencyHistograms(), planeDecimalId(), planeName(), printId(), TotemRPUVPatternFinder::produce(), LocalTrackFitter::removeInsufficientPots(), and CTPPSRPAlignmentCorrectionsMethods::writeXMLBlock().

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

uint32_t TotemRPDetId::planeDecimalId ( ) const

inline

Definition at line 75 of file TotemRPDetId.h.

References plane(), and rpDecimalId().

{ return plane() + rpDecimalId() * 10; }

TotemRPDetId TotemRPDetId::planeId ( ) const

inline

Definition at line 62 of file TotemRPDetId.h.

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

Referenced by RawToDigiConverter::run().

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

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

inline

Definition at line 79 of file TotemRPDetId.h.

References CTPPSDetId::nFull, CTPPSDetId::nPath, CTPPSDetId::nShort, plane(), planeNames, and CTPPSDetId::rpName().

Referenced by chipName(), TotemRPDQMHarvester::MakePlaneEfficiencyHistograms(), and TotemRPDQMSource::PlanePlots::PlanePlots().

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

    name += planeNames[plane()];
  }

uint32_t TotemRPDetId::rpDecimalId ( ) const

inline

Definition at line 73 of file TotemRPDetId.h.

References CTPPSDetId::arm(), CTPPSDetId::rp(), and CTPPSDetId::station().

Referenced by planeDecimalId().

{ return rp() + station() * 10 + arm() * 100; }

void TotemRPDetId::setChip ( uint32_t  chip )

inline

Definition at line 55 of file TotemRPDetId.h.

References DetId::id_, maskChip, and startChipBit.

                              {
    id_ &= ~(maskChip << startChipBit);
    id_ |= ((chip & maskChip) << startChipBit);
  }

void TotemRPDetId::setPlane ( uint32_t  det )

inline

Definition at line 48 of file TotemRPDetId.h.

References DetId::id_, maskPlane, and startPlaneBit.

Referenced by TotemRPDQMSource::analyze(), and TotemTimingDQMSource::analyze().

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

Member Data Documentation

const string TotemRPDetId::chipNames = {"1", "2", "3", "4"}

staticprivate

Definition at line 117 of file TotemRPDetId.h.

Referenced by chipName().

const uint32_t TotemRPDetId::lowMaskChip = 0x1FFF

static

Definition at line 42 of file TotemRPDetId.h.

const uint32_t TotemRPDetId::lowMaskPlane = 0x7FFF

static

Definition at line 41 of file TotemRPDetId.h.

Referenced by planeId().

const uint32_t TotemRPDetId::maskChip = 0x3

static

Definition at line 42 of file TotemRPDetId.h.

Referenced by chip(), setChip(), and TotemRPDetId().

const uint32_t TotemRPDetId::maskPlane = 0xF

static

Definition at line 41 of file TotemRPDetId.h.

Referenced by plane(), RPDisplacementGenerator::rawToDecId(), setPlane(), and TotemRPDetId().

const uint32_t TotemRPDetId::maxChip = 3

static

Definition at line 42 of file TotemRPDetId.h.

Referenced by TotemRPDetId().

const uint32_t TotemRPDetId::maxPlane = 9

static

Definition at line 41 of file TotemRPDetId.h.

Referenced by TotemRPDetId().

const string TotemRPDetId::planeNames = {"01", "02", "03", "04", "05", "06", "07", "08", "09", "10"}

staticprivate

Definition at line 116 of file TotemRPDetId.h.

Referenced by planeName().

const uint32_t TotemRPDetId::startChipBit = 13

static

Definition at line 42 of file TotemRPDetId.h.

Referenced by chip(), setChip(), and TotemRPDetId().

const uint32_t TotemRPDetId::startPlaneBit = 15

static

Definition at line 41 of file TotemRPDetId.h.

Referenced by plane(), RPDisplacementGenerator::rawToDecId(), setPlane(), and TotemRPDetId().