CTPPSDetId Class Reference

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 (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	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 32 of file CTPPSDetId.h.

Member Enumeration Documentation

enum CTPPSDetId::NameFlag

type of name returned by *Name functions

Enumerator
nShort
nFull
nPath

Definition at line 83 of file CTPPSDetId.h.

{ nShort, nFull, nPath };

enum CTPPSDetId::SubDetector

CTPPS sub-detectors.

Enumerator
sdTrackingStrip
sdTrackingPixel
sdTimingDiamond
sdTimingFastSilicon

Definition at line 35 of file CTPPSDetId.h.

{ sdTrackingStrip = 3, sdTrackingPixel = 4, sdTimingDiamond = 5, sdTimingFastSilicon = 6 };

Constructor & Destructor Documentation

CTPPSDetId::CTPPSDetId ( uint32_t  id )

explicit

Construct from a raw id.

Definition at line 35 of file CTPPSDetId.cc.

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

Referenced by armId(), rpId(), and stationId().

                                  : 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.";
  }
}

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

Construct from hierarchy indeces.

Definition at line 47 of file CTPPSDetId.cc.

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

    : 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);
}

Member Function Documentation

uint32_t CTPPSDetId::arm ( ) const

inline

Definition at line 51 of file CTPPSDetId.h.

References DetId::id_, maskArm, and startArmBit.

Referenced by CTPPSOpticsPlotter::analyze(), CTPPSAcceptancePlotter::analyze(), CTPPSDirectProtonSimulationValidator::analyze(), CTPPSProtonReconstructionValidator::analyze(), CTPPSPixelDQMSource::analyze(), CTPPSTrackDistributionPlotter::analyze(), CTPPSProtonReconstructionPlotter::analyze(), CTPPSProtonReconstructionSimulationValidator::analyze(), CTPPSProtonReconstructionEfficiencyEstimatorMC::analyze(), CTPPSProtonReconstructionEfficiencyEstimatorData::analyze(), CTPPSDiamondDQMSource::analyze(), CTPPSCommonDQMSource::analyzeTracks(), armName(), PPSModifySingularModes::beginRun(), DiamondSampicDQMSource::bookHistograms(), DiamondSampicCalibrationDQMSource::bookHistograms(), AlignmentTask::buildEqualMeanUMeanVRotZConstraints(), AlignmentTask::buildGeometry(), AlignmentTask::buildOneRotZPerPotConstraints(), AlignmentTask::buildStandardConstraints(), CTPPSDiamondDQMSource::dqmBeginRun(), factorRPFromSensorCorrections(), JanAlignmentAlgorithm::feed(), RPixPlaneCombinatoryTracking::findTracks(), PPSFastLocalSimulation::GenerateTrack(), DiamondSampicDQMSource::globalEndLuminosityBlock(), TotemTimingDQMSource::globalEndLuminosityBlock(), CTPPSDiamondDQMSource::globalEndLuminosityBlock(), PPSDirectSimulationData::loadEffeciencyHistogramsPerPlane(), printId(), PPSAlignmentWorker::SectorData::process(), StraightTrackAlignment::processEvent(), CTPPSDirectProtonSimulation::processProton(), CTPPSModifiedOpticalFunctionsESSource::produce(), ProtonProducer::produce(), RPixPlaneCombinatoryTracking::produceAllHitCombination(), ProtonReconstructionAlgorithm::reconstructFromSingleRP(), TotemRPDetId::rpDecimalId(), OpticalFunctionsTransport::transportProton(), CTPPSProtonReconstructionEfficiencyEstimatorData::ArmData::UpdateOptics(), and CTPPSRPAlignmentCorrectionsMethods::writeXMLBlock().

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

CTPPSDetId CTPPSDetId::armId ( ) const

inline

Definition at line 74 of file CTPPSDetId.h.

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

Referenced by DiamondSampicDQMSource::bookHistograms(), CTPPSDiamondDQMSource::bookHistograms(), CTPPSGeometry::build(), and DiamondSampicDQMSource::globalEndLuminosityBlock().

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

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

inline

Definition at line 92 of file CTPPSDetId.h.

References arm(), armNames, nFull, nPath, nShort, and subDetectorName().

Referenced by CTPPSCommonDQMSource::ArmPlots::ArmPlots(), CTPPSPixelDQMSource::bookHistograms(), DiamondSampicDQMSource::SectorPlots::SectorPlots(), CTPPSDiamondDQMSource::SectorPlots::SectorPlots(), and stationName().

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

    name += armNames[arm()];
  }

uint32_t CTPPSDetId::rp ( ) const

inline

Definition at line 65 of file CTPPSDetId.h.

References DetId::id_, maskRP, and startRPBit.

Referenced by CTPPSOpticsPlotter::analyze(), CTPPSPixelDQMSource::analyze(), CTPPSProtonReconstructionEfficiencyEstimatorMC::analyze(), CTPPSCommonDQMSource::analyzeTracks(), PPSModifySingularModes::beginRun(), DiamondSampicDQMSource::bookHistograms(), DiamondSampicCalibrationDQMSource::bookHistograms(), AlignmentTask::buildEqualMeanUMeanVRotZConstraints(), AlignmentTask::buildGeometry(), AlignmentTask::buildOneRotZPerPotConstraints(), AlignmentTask::buildStandardConstraints(), factorRPFromSensorCorrections(), JanAlignmentAlgorithm::feed(), PPSFastLocalSimulation::GenerateTrack(), TotemTimingDQMSource::globalEndLuminosityBlock(), DiamondSampicDQMSource::globalEndLuminosityBlock(), CTPPSDiamondDQMSource::globalEndLuminosityBlock(), PPSDirectSimulationData::loadEffeciencyHistogramsPerPlane(), printId(), StraightTrackAlignment::processEvent(), CTPPSDirectProtonSimulation::processProton(), CTPPSModifiedOpticalFunctionsESSource::produce(), RPixPlaneCombinatoryTracking::produceAllHitCombination(), TotemRPDetId::rpDecimalId(), rpName(), OpticalFunctionsTransport::transportProton(), CTPPSProtonReconstructionEfficiencyEstimatorData::ArmData::UpdateOptics(), and CTPPSRPAlignmentCorrectionsMethods::writeXMLBlock().

{ return ((id_ >> startRPBit) & maskRP); }

CTPPSDetId CTPPSDetId::rpId ( ) const

inline

Definition at line 78 of file CTPPSDetId.h.

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

Referenced by ElasticPlotDQMSource::analyze(), TotemRPDQMSource::analyze(), CTPPSProtonReconstructionEfficiencyEstimatorMC::analyze(), CTPPSDiamondDQMSource::analyze(), CTPPSPixelDQMSource::bookHistograms(), CTPPSDiamondDQMSource::bookHistograms(), CTPPSGeometry::build(), AlignmentTask::buildEqualMeanUMeanVRotZConstraints(), AlignmentTask::buildOneRotZPerPotConstraints(), AlignmentTask::buildStandardConstraints(), CTPPSDiamondDQMSource::checkEventNumber(), DiamondSampicDQMSource::dqmBeginRun(), DiamondSampicCalibrationDQMSource::dqmBeginRun(), factorRPFromSensorCorrections(), RPixRoadFinder::findPattern(), StraightTrackAlignment::finish(), TotemRPDQMHarvester::MakePlaneEfficiencyHistograms(), TotemRPUVPatternFinder::produce(), CTPPSPixelLocalTrackProducer::produce(), CTPPSProtonProducer::produce(), LocalTrackFitter::removeInsufficientPots(), and CTPPSRPAlignmentCorrectionsMethods::writeXMLBlock().

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

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

inline

Definition at line 128 of file CTPPSDetId.h.

References nFull, nPath, nShort, rp(), rpNames, and stationName().

Referenced by CTPPSCommonDQMSource::ArmPlots::ArmPlots(), ElasticPlotDQMSource::DiagonalPlots::DiagonalPlots(), TotemRPDQMHarvester::MakeHitNumberRatios(), TotemRPDQMHarvester::MakePlaneEfficiencyHistograms(), CTPPSDiamondDetId::planeName(), TotemTimingDetId::planeName(), TotemRPDetId::planeName(), TotemRPDQMSource::PotPlots::PotPlots(), ElasticPlotDQMSource::PotPlots::PotPlots(), DiamondSampicCalibrationDQMSource::PotPlots::PotPlots(), DiamondSampicDQMSource::PotPlots::PotPlots(), TotemTimingDQMSource::PotPlots::PotPlots(), and CTPPSDiamondDQMSource::PotPlots::PotPlots().

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

    name += rpNames[rp()];
  }

void CTPPSDetId::setArm ( uint32_t  arm )

inline

Definition at line 53 of file CTPPSDetId.h.

References DetId::id_, maskArm, and startArmBit.

                            {
    id_ &= ~(maskArm << startArmBit);
    id_ |= ((arm & maskArm) << startArmBit);
  }

void CTPPSDetId::setRP ( uint32_t  rp )

inline

Definition at line 67 of file CTPPSDetId.h.

References DetId::id_, maskRP, and startRPBit.

Referenced by CTPPSPixelDQMSource::bookHistograms().

                          {
    id_ &= ~(maskRP << startRPBit);
    id_ |= ((rp & maskRP) << startRPBit);
  }

void CTPPSDetId::setStation ( uint32_t  station )

inline

Definition at line 60 of file CTPPSDetId.h.

References DetId::id_, maskStation, and startStationBit.

Referenced by CTPPSPixelDQMSource::bookHistograms().

                                    {
    id_ &= ~(maskStation << startStationBit);
    id_ |= ((station & maskStation) << startStationBit);
  }

uint32_t CTPPSDetId::station ( ) const

inline

Definition at line 58 of file CTPPSDetId.h.

References DetId::id_, maskStation, and startStationBit.

Referenced by CTPPSOpticsPlotter::analyze(), CTPPSPixelDQMSource::analyze(), CTPPSProtonReconstructionEfficiencyEstimatorMC::analyze(), PPSTimingCalibrationPCLHarvester::beginRun(), PPSModifySingularModes::beginRun(), PPSTimingCalibrationPCLWorker::bookHistograms(), DiamondSampicDQMSource::bookHistograms(), DiamondSampicCalibrationDQMSource::bookHistograms(), AlignmentTask::buildEqualMeanUMeanVRotZConstraints(), AlignmentTask::buildGeometry(), AlignmentTask::buildOneRotZPerPotConstraints(), AlignmentTask::buildStandardConstraints(), factorRPFromSensorCorrections(), JanAlignmentAlgorithm::feed(), RPixPlaneCombinatoryTracking::findTracks(), PPSFastLocalSimulation::GenerateTrack(), geometryXMLparser.DTAlignable::index(), geometryXMLparser.CSCAlignable::index(), PPSDirectSimulationData::loadEffeciencyHistogramsPerPlane(), printId(), StraightTrackAlignment::processEvent(), CTPPSDirectProtonSimulation::processProton(), CTPPSModifiedOpticalFunctionsESSource::produce(), RPixPlaneCombinatoryTracking::produceAllHitCombination(), TotemRPDetId::rpDecimalId(), stationName(), OpticalFunctionsTransport::transportProton(), CTPPSProtonReconstructionEfficiencyEstimatorData::ArmData::UpdateOptics(), and CTPPSRPAlignmentCorrectionsMethods::writeXMLBlock().

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

CTPPSDetId CTPPSDetId::stationId ( ) const

inline

Definition at line 76 of file CTPPSDetId.h.

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

Referenced by CTPPSPixelDQMSource::bookHistograms(), and CTPPSGeometry::build().

{ return CTPPSDetId(rawId() & (~lowMaskStation)); }

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

inline

Definition at line 110 of file CTPPSDetId.h.

References armName(), nFull, nPath, nShort, station(), and stationNames.

Referenced by CTPPSCommonDQMSource::ArmPlots::ArmPlots(), and rpName().

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

    name += stationNames[station()];
  }

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

inline

Definition at line 85 of file CTPPSDetId.h.

References nPath, subDetectorNames, subDetectorPaths, and DetId::subdetId().

Referenced by armName().

                                                                            {
    if (flag == nPath)
      name = subDetectorPaths[subdetId()];
    else
      name = subDetectorNames[subdetId()];
  }

Member Data Documentation

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

staticprivate

Definition at line 149 of file CTPPSDetId.h.

Referenced by armName().

const uint32_t CTPPSDetId::lowMaskArm = 0xFFFFFF

static

Definition at line 45 of file CTPPSDetId.h.

Referenced by armId().

const uint32_t CTPPSDetId::lowMaskRP = 0x7FFFF

static

Definition at line 47 of file CTPPSDetId.h.

Referenced by rpId().

const uint32_t CTPPSDetId::lowMaskStation = 0x3FFFFF

static

Definition at line 46 of file CTPPSDetId.h.

Referenced by stationId().

const uint32_t CTPPSDetId::maskArm = 0x1

static

Definition at line 45 of file CTPPSDetId.h.

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

const uint32_t CTPPSDetId::maskRP = 0x7

static

Definition at line 47 of file CTPPSDetId.h.

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

const uint32_t CTPPSDetId::maskStation = 0x3

static

Definition at line 46 of file CTPPSDetId.h.

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

const uint32_t CTPPSDetId::maxArm = 1

static

Definition at line 45 of file CTPPSDetId.h.

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

const uint32_t CTPPSDetId::maxRP = 6

static

Definition at line 47 of file CTPPSDetId.h.

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

const uint32_t CTPPSDetId::maxStation = 2

static

Definition at line 46 of file CTPPSDetId.h.

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

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

staticprivate

Definition at line 151 of file CTPPSDetId.h.

Referenced by rpName().

const uint32_t CTPPSDetId::startArmBit = 24

static

Definition at line 45 of file CTPPSDetId.h.

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

const uint32_t CTPPSDetId::startRPBit = 19

static

Definition at line 47 of file CTPPSDetId.h.

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

const uint32_t CTPPSDetId::startStationBit = 22

static

Definition at line 46 of file CTPPSDetId.h.

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

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

staticprivate

Definition at line 150 of file CTPPSDetId.h.

Referenced by stationName().

const string CTPPSDetId::subDetectorNames

staticprivate

Initial value:

= {
    "", "", "", "ctpps_tr_strip", "ctpps_tr_pixel", "ctpps_ti_diamond", "ctpps_ti_fastsilicon"}

Definition at line 147 of file CTPPSDetId.h.

Referenced by subDetectorName().

const string CTPPSDetId::subDetectorPaths

staticprivate

Initial value:

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

Definition at line 148 of file CTPPSDetId.h.

Referenced by subDetectorName().