HcalZDCDetId Class Reference

#include <HcalZDCDetId.h>

Inheritance diagram for HcalZDCDetId:

Public Types
enum	{ kSizeForDenseIndexing = kSizeForDenseIndexingRun1 }
enum	Section {   Unknown = 0, EM = 1, HAD = 2, LUM = 3,   RPD = 4 }
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
constexpr int32_t	channel () const
	get the channel More...
constexpr uint32_t	denseIndex () const
constexpr int32_t	depth () const
	get the depth (1 for EM, channel + 1 for HAD, 2 for RPD, not sure yet for LUM, leave as default) More...
constexpr	HcalZDCDetId ()
constexpr	HcalZDCDetId (uint32_t rawid)
constexpr	HcalZDCDetId (Section section, bool true_for_positive_eta, int32_t channel)
constexpr	HcalZDCDetId (const DetId &gen)
constexpr bool	operator!= (DetId gen) const
constexpr HcalZDCDetId &	operator= (const DetId &gen)
constexpr bool	operator== (DetId gen) const
constexpr Section	section () const
	get the section More...
constexpr int32_t	zside () const
	get the z-side of the cell (1/-1) More...
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 constexpr HcalZDCDetId	detIdFromDenseIndex (uint32_t di)
static constexpr uint32_t	newForm (const uint32_t &di)
static constexpr bool	newFormat (const uint32_t &di)
static constexpr bool	validDenseIndex (const uint32_t &di)
static constexpr bool	validDetId (Section se, int32_t dp)

Static Public Attributes
static constexpr int32_t	kDepEM = 5
static constexpr int32_t	kDepHAD = 4
static constexpr int32_t	kDepLUM = 2
static constexpr int32_t	kDepRPD = 16
static constexpr int32_t	kDepRun1 = (kDepEM + kDepHAD + kDepLUM)
static constexpr int32_t	kDepRun3 = kDepTot
static constexpr int32_t	kDepTot = (kDepRun1 + kDepRPD)
static constexpr int32_t	kSizeForDenseIndexingRun1 = 2 * kDepRun1
static constexpr int32_t	kSizeForDenseIndexingRun3 = 2 * kDepRun3
static constexpr uint32_t	kZDCChannelMask1 = 0xF
static constexpr uint32_t	kZDCChannelMask2 = 0x7F
static constexpr uint32_t	kZDCnewFormat = 0x100
static constexpr uint32_t	kZDCRPDMask = 0x80
static constexpr uint32_t	kZDCSectionMask = 0x3
static constexpr uint32_t	kZDCSectionOffset = 4
static constexpr uint32_t	kZDCZsideMask = 0x40
static constexpr int32_t	SubdetectorId = 2
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 Member Functions
static constexpr uint32_t	packHcalZDCDetId (const Section &se, const bool &zside, const int32_t &channel)
static constexpr void	unpackHcalZDCDetId (const uint32_t &id, Section &se, bool &zside, int32_t &channel)

Additional Inherited Members
Protected Attributes inherited from DetId
uint32_t	id_

Detailed Description

Contents of the HcalZDCDetId (Old): [7] Set for RPD [6] Z position (true for positive) [5:4] Section (EM/HAD/Lumi) [3:0] Channel Contents of the HcalZDCDetId (New): [8] Set to 1 for new format [7] Set for RPD [6] Z position (true for positive) [5:4] Section (EM/HAD/Lumi) [3:0] Chaneel for EM/HAD/Lumi [5:0] Channel for RPD

Definition at line 24 of file HcalZDCDetId.h.

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
kSizeForDenseIndexing

Definition at line 203 of file HcalZDCDetId.h.

{ kSizeForDenseIndexing = kSizeForDenseIndexingRun1 };

Section

enum HcalZDCDetId::Section

Enumerator
Unknown
EM
HAD
LUM
RPD

Definition at line 33 of file HcalZDCDetId.h.

{ Unknown = 0, EM = 1, HAD = 2, LUM = 3, RPD = 4 };

Constructor & Destructor Documentation

HcalZDCDetId() [1/4]

constexpr HcalZDCDetId::HcalZDCDetId ( )

inline

Create a null cellid

Definition at line 46 of file HcalZDCDetId.h.

Referenced by detIdFromDenseIndex().

: DetId() {}

HcalZDCDetId() [2/4]

constexpr HcalZDCDetId::HcalZDCDetId ( uint32_t  rawid )

inline

Create cellid from raw id (0=invalid tower id)

Definition at line 48 of file HcalZDCDetId.h.

: DetId(rawid) {}

HcalZDCDetId() [3/4]

constexpr HcalZDCDetId::HcalZDCDetId ( Section  section, bool  true_for_positive_eta, int32_t  channel  )

inline

Constructor from section, eta sign, and channel

Definition at line 50 of file HcalZDCDetId.h.

References channel(), DetId::id_, packHcalZDCDetId(), and section().

                                                                                       {
    id_ = packHcalZDCDetId(section, true_for_positive_eta, channel);
  }

HcalZDCDetId() [4/4]

constexpr HcalZDCDetId::HcalZDCDetId ( const DetId &  gen )

inline

Constructor from a generic cell id

Definition at line 54 of file HcalZDCDetId.h.

References DetId::Calo, TauDecayModes::dec, Exception, DetId::id_, newForm(), and SubdetectorId.

                                           {
    if (!gen.null() && (gen.det() != Calo || gen.subdetId() != SubdetectorId)) {
      throw cms::Exception("Invalid DetId")
          << "Cannot initialize ZDCDetId from " << std::hex << gen.rawId() << std::dec;
    }
    id_ = newForm(gen.rawId());
  }

Member Function Documentation

channel()

constexpr int32_t HcalZDCDetId::channel ( ) const

inline

get the channel

Definition at line 112 of file HcalZDCDetId.h.

References DetId::id_, kZDCChannelMask1, kZDCChannelMask2, newForm(), RPD, and section().

Referenced by ZDCDigiStudy::analyze(), ZdcTBAnalysis::analyze(), ZDCSimHitStudy::analyzeHits(), denseIndex(), depth(), HcaluLUTTPGCoder::getLUTId(), hcalTransformedId(), HcalZDCDetId(), HcalCondObjectContainerBase::indexFor(), HcalText2DetIdConverter::init(), ZdcTopology::longitudinal(), newForm(), packHcalZDCDetId(), ZDCLogicalMapEntry::printLMapLine(), HcalTrigTowerGeometry::towerIds_ZDC(), ZdcTopology::transverse(), unpackHcalZDCDetId(), and CaloGenericDetId::validDetId().

                                    {
    const int32_t se(section());
    uint32_t id = newForm(id_);
    if (se == RPD)
      return (1 + (id & kZDCChannelMask2));
    else
      return (id & kZDCChannelMask1);
  }

denseIndex()

constexpr uint32_t HcalZDCDetId::denseIndex ( ) const

inline

Definition at line 134 of file HcalZDCDetId.h.

References channel(), HAD, kDepEM, kDepHAD, kDepRPD, kDepRun1, LUM, RPD, section(), and zside().

Referenced by ZDCSimHitStudy::analyzeHits(), HcalCondObjectContainerBase::indexFor(), and ZdcGeometry::indexFor().

                                        {
    const int32_t se(section());
    uint32_t di =
        (channel() - 1 +
         (se == RPD ? 2 * kDepRun1 + (zside() < 0 ? 0 : kDepRPD)
                    : ((zside() < 0 ? 0 : kDepRun1) + (se == HAD ? kDepEM : (se == LUM ? kDepEM + kDepHAD : 0)))));
    return di;
  }

depth()

constexpr int32_t HcalZDCDetId::depth ( ) const

inline

get the depth (1 for EM, channel + 1 for HAD, 2 for RPD, not sure yet for LUM, leave as default)

Definition at line 100 of file HcalZDCDetId.h.

References channel(), EM, HAD, RPD, and section().

Referenced by ZdcTBAnalysis::analyze(), ZDCSimHitStudy::analyzeHits(), ZDCLogicalMapEntry::printLMapLine(), and HcalTrigTowerGeometry::towerIds_ZDC().

                                  {
    const int se(section());
    if (se == EM)
      return 1;
    else if (se == HAD)
      return (channel() + 2);
    else if (se == RPD)
      return 2;
    else
      return channel();
  }

detIdFromDenseIndex()

static constexpr HcalZDCDetId HcalZDCDetId::detIdFromDenseIndex ( uint32_t  di )

inlinestatic

Definition at line 145 of file HcalZDCDetId.h.

References Calorimetry_cff::dp, EM, HAD, HcalZDCDetId(), recoMuon::in, kDepEM, kDepHAD, kDepRPD, kDepRun1, kDepTot, LUM, RPD, Unknown, and validDenseIndex().

Referenced by CaloGenericDetId::CaloGenericDetId().

                                                                 {
    if (validDenseIndex(di)) {
      bool lz(false);
      uint32_t dp(0);
      Section se(Unknown);
      if (di >= 2 * kDepRun1) {
        lz = (di >= (kDepRun1 + kDepTot));
        se = RPD;
        dp = 1 + ((di - 2 * kDepRun1) % kDepRPD);
      } else {
        lz = (di >= kDepRun1);
        uint32_t in = (di % kDepRun1);
        se = (in < kDepEM ? EM : (in < kDepEM + kDepHAD ? HAD : LUM));
        dp = (se == EM ? in + 1 : (se == HAD ? in - kDepEM + 1 : in - kDepEM - kDepHAD + 1));
      }
      return HcalZDCDetId(se, lz, dp);
    } else {
      return HcalZDCDetId();
    }
  }

newForm()

static constexpr uint32_t HcalZDCDetId::newForm ( const uint32_t &  di )

inlinestatic

Definition at line 122 of file HcalZDCDetId.h.

References channel(), l1ctLayer2EG_cff::id, newFormat(), packHcalZDCDetId(), Unknown, unpackHcalZDCDetId(), and zside().

Referenced by channel(), HcalZDCDetId(), operator!=(), operator=(), operator==(), and section().

                                                        {
    uint32_t id(di);
    if (!newFormat(id)) {
      Section se(Unknown);
      bool zside(true);
      int32_t channel(0);
      unpackHcalZDCDetId(id, se, zside, channel);
      id = packHcalZDCDetId(se, zside, channel);
    }
    return id;
  }

newFormat()

static constexpr bool HcalZDCDetId::newFormat ( const uint32_t &  di )

inlinestatic

Definition at line 121 of file HcalZDCDetId.h.

References kZDCnewFormat.

Referenced by newForm().

{ return (di & kZDCnewFormat); }

operator!=()

constexpr bool HcalZDCDetId::operator!= ( DetId  gen ) const

inline

Definition at line 79 of file HcalZDCDetId.h.

References globals_cff::id1, globals_cff::id2, DetId::id_, and newForm().

                                             {
    if (gen.rawId() != id_) {
      return true;
    } else {
      uint32_t id1 = newForm(gen.rawId());
      uint32_t id2 = newForm(id_);
      return (id1 != id2);
    }
  }

operator=()

constexpr HcalZDCDetId& HcalZDCDetId::operator= ( const DetId &  gen )

inline

Assignment from a generic cell id

Definition at line 62 of file HcalZDCDetId.h.

References DetId::Calo, TauDecayModes::dec, Exception, DetId::id_, newForm(), and SubdetectorId.

                                                      {
    if (!gen.null() && (gen.det() != Calo || gen.subdetId() != SubdetectorId)) {
      throw cms::Exception("Invalid DetId") << "Cannot assign ZDCDetId from " << std::hex << gen.rawId() << std::dec;
    }
    id_ = newForm(gen.rawId());
    return *this;
  }

operator==()

constexpr bool HcalZDCDetId::operator== ( DetId  gen ) const

inline

Comparison operator

Definition at line 70 of file HcalZDCDetId.h.

References globals_cff::id1, globals_cff::id2, DetId::id_, and newForm().

                                             {
    if (gen.rawId() == id_) {
      return true;
    } else {
      uint32_t id1 = newForm(gen.rawId());
      uint32_t id2 = newForm(id_);
      return (id1 == id2);
    }
  }

packHcalZDCDetId()

static constexpr uint32_t HcalZDCDetId::packHcalZDCDetId ( const Section &  se, const bool &  zside, const int32_t &  channel  )

inlinestaticprivate

Definition at line 173 of file HcalZDCDetId.h.

References DetId::Calo, channel(), DetId::DetId(), l1ctLayer2EG_cff::id, kZDCChannelMask1, kZDCChannelMask2, kZDCnewFormat, kZDCRPDMask, kZDCSectionMask, kZDCSectionOffset, kZDCZsideMask, RPD, SubdetectorId, and zside().

Referenced by HcalZDCDetId(), and newForm().

                                                                                                           {
    uint32_t id = DetId(DetId::Calo, SubdetectorId);
    id |= kZDCnewFormat;
    if (se == RPD) {
      id |= kZDCRPDMask;
      id |= ((channel - 1) & kZDCChannelMask2);
    } else {
      id |= (se & kZDCSectionMask) << kZDCSectionOffset;
      id |= (channel & kZDCChannelMask1);
    }
    if (zside)
      id |= kZDCZsideMask;
    return id;
  }

section()

constexpr Section HcalZDCDetId::section ( ) const

inline

get the section

Definition at line 92 of file HcalZDCDetId.h.

References DetId::id_, kZDCRPDMask, kZDCSectionMask, kZDCSectionOffset, newForm(), and RPD.

Referenced by ZDCDigiStudy::analyze(), ZdcTBAnalysis::analyze(), ZDCSimHitStudy::analyzeHits(), channel(), denseIndex(), depth(), HcaluLUTTPGCoder::getLUTId(), hcalTransformedId(), HcalZDCDetId(), HcalCondObjectContainerBase::indexFor(), HcalText2DetIdConverter::init(), ZdcTopology::longitudinal(), VarParsing.VarParsing::parseArguments(), ZDCLogicalMapEntry::printLMapLine(), ZdcTopology::transverse(), HcaluLUTTPGCoder::update(), and CaloGenericDetId::validDetId().

                                    {
    uint32_t id = newForm(id_);
    if (id & kZDCRPDMask)
      return RPD;
    else
      return (Section)((id >> kZDCSectionOffset) & kZDCSectionMask);
  }

unpackHcalZDCDetId()

static constexpr void HcalZDCDetId::unpackHcalZDCDetId ( const uint32_t &  id, Section &  se, bool &  zside, int32_t &  channel  )

inlinestaticprivate

Definition at line 188 of file HcalZDCDetId.h.

References channel(), kZDCChannelMask1, kZDCChannelMask2, kZDCnewFormat, kZDCRPDMask, kZDCSectionMask, kZDCSectionOffset, kZDCZsideMask, RPD, and zside().

Referenced by newForm().

                                                                                                           {
    if (id & kZDCnewFormat) {
      se = (id & kZDCRPDMask) ? RPD : (Section)((id >> kZDCSectionOffset) & kZDCSectionMask);
      channel = (se == RPD) ? (1 + (id & kZDCChannelMask2)) : (id & kZDCChannelMask1);
      zside = (id & kZDCZsideMask);
    } else {
      se = (id & kZDCRPDMask) ? RPD : (Section)((id >> kZDCSectionOffset) & kZDCSectionMask);
      channel = (se == RPD) ? (1 + (id & kZDCChannelMask1)) : (id & kZDCChannelMask1);
      zside = (id & kZDCZsideMask);
    }
  }

validDenseIndex()

static constexpr bool HcalZDCDetId::validDenseIndex ( const uint32_t &  di )

inlinestatic

Definition at line 143 of file HcalZDCDetId.h.

References kSizeForDenseIndexing.

Referenced by detIdFromDenseIndex().

{ return (di < kSizeForDenseIndexing); }

validDetId()

static constexpr bool HcalZDCDetId::validDetId ( Section  se, int32_t  dp  )

inlinestatic

Definition at line 166 of file HcalZDCDetId.h.

References Calorimetry_cff::dp, EM, RemoveAddSevLevel::flag, HAD, kDepEM, kDepHAD, kDepLUM, kDepRPD, LUM, and RPD.

Referenced by CaloGenericDetId::validDetId().

                                                           {
    bool flag = (dp >= 1 && (((se == EM) && (dp <= kDepEM)) || ((se == HAD) && (dp <= kDepHAD)) ||
                             ((se == LUM) && (dp <= kDepLUM)) || ((se == RPD) && (dp <= kDepRPD))));
    return flag;
  }

zside()

constexpr int32_t HcalZDCDetId::zside ( ) const

inline

get the z-side of the cell (1/-1)

Definition at line 90 of file HcalZDCDetId.h.

References DetId::id_, and kZDCZsideMask.

Referenced by ZdcGeometry::alignmentTransformIndexLocal(), ZDCDigiStudy::analyze(), ZdcTBAnalysis::analyze(), ZDCSimHitStudy::analyzeHits(), denseIndex(), HcaluLUTTPGCoder::getLUTId(), hcalTransformedId(), HcalCondObjectContainerBase::indexFor(), HcalText2DetIdConverter::init(), ZdcTopology::longitudinal(), newForm(), packHcalZDCDetId(), ZDCLogicalMapEntry::printLMapLine(), reco::CentralityProducer::produce(), HcalTrigTowerGeometry::towerIds_ZDC(), ZdcTopology::transverse(), and unpackHcalZDCDetId().

{ return ((id_ & kZDCZsideMask) ? (1) : (-1)); }

Member Data Documentation

kDepEM

constexpr int32_t HcalZDCDetId::kDepEM = 5

static

Definition at line 37 of file HcalZDCDetId.h.

Referenced by denseIndex(), detIdFromDenseIndex(), ZdcTopology::ncells(), ZdcTopology::transverse(), validDetId(), and ZdcTopology::validRaw().

kDepHAD

constexpr int32_t HcalZDCDetId::kDepHAD = 4

static

Definition at line 38 of file HcalZDCDetId.h.

Referenced by denseIndex(), detIdFromDenseIndex(), ZdcTopology::longitudinal(), ZdcTopology::ncells(), validDetId(), and ZdcTopology::validRaw().

kDepLUM

constexpr int32_t HcalZDCDetId::kDepLUM = 2

static

Definition at line 39 of file HcalZDCDetId.h.

Referenced by ZdcTopology::longitudinal(), ZdcTopology::ncells(), validDetId(), and ZdcTopology::validRaw().

kDepRPD

constexpr int32_t HcalZDCDetId::kDepRPD = 16

static

Definition at line 40 of file HcalZDCDetId.h.

Referenced by denseIndex(), detIdFromDenseIndex(), ZdcTopology::longitudinal(), ZdcTopology::ncells(), validDetId(), and ZdcTopology::validRaw().

kDepRun1

constexpr int32_t HcalZDCDetId::kDepRun1 = (kDepEM + kDepHAD + kDepLUM)

static

Definition at line 41 of file HcalZDCDetId.h.

Referenced by denseIndex(), and detIdFromDenseIndex().

kDepRun3

constexpr int32_t HcalZDCDetId::kDepRun3 = kDepTot

static

Definition at line 43 of file HcalZDCDetId.h.

kDepTot

constexpr int32_t HcalZDCDetId::kDepTot = (kDepRun1 + kDepRPD)

static

Definition at line 42 of file HcalZDCDetId.h.

Referenced by detIdFromDenseIndex().

kSizeForDenseIndexingRun1

constexpr int32_t HcalZDCDetId::kSizeForDenseIndexingRun1 = 2 * kDepRun1

static

Definition at line 201 of file HcalZDCDetId.h.

Referenced by ZdcGeometry::getSummary().

kSizeForDenseIndexingRun3

constexpr int32_t HcalZDCDetId::kSizeForDenseIndexingRun3 = 2 * kDepRun3

static

Definition at line 202 of file HcalZDCDetId.h.

kZDCChannelMask1

constexpr uint32_t HcalZDCDetId::kZDCChannelMask1 = 0xF

static

Definition at line 26 of file HcalZDCDetId.h.

Referenced by channel(), packHcalZDCDetId(), and unpackHcalZDCDetId().

kZDCChannelMask2

constexpr uint32_t HcalZDCDetId::kZDCChannelMask2 = 0x7F

static

Definition at line 27 of file HcalZDCDetId.h.

Referenced by channel(), packHcalZDCDetId(), and unpackHcalZDCDetId().

kZDCnewFormat

constexpr uint32_t HcalZDCDetId::kZDCnewFormat = 0x100

static

Definition at line 32 of file HcalZDCDetId.h.

Referenced by newFormat(), packHcalZDCDetId(), and unpackHcalZDCDetId().

kZDCRPDMask

constexpr uint32_t HcalZDCDetId::kZDCRPDMask = 0x80

static

Definition at line 31 of file HcalZDCDetId.h.

Referenced by packHcalZDCDetId(), section(), and unpackHcalZDCDetId().

kZDCSectionMask

constexpr uint32_t HcalZDCDetId::kZDCSectionMask = 0x3

static

Definition at line 28 of file HcalZDCDetId.h.

Referenced by packHcalZDCDetId(), section(), and unpackHcalZDCDetId().

kZDCSectionOffset

constexpr uint32_t HcalZDCDetId::kZDCSectionOffset = 4

static

Definition at line 29 of file HcalZDCDetId.h.

Referenced by packHcalZDCDetId(), section(), and unpackHcalZDCDetId().

kZDCZsideMask

constexpr uint32_t HcalZDCDetId::kZDCZsideMask = 0x40

static

Definition at line 30 of file HcalZDCDetId.h.

Referenced by packHcalZDCDetId(), unpackHcalZDCDetId(), and zside().

SubdetectorId

constexpr int32_t HcalZDCDetId::SubdetectorId = 2

static

Definition at line 35 of file HcalZDCDetId.h.

Referenced by ZDCHitFilter::accepts(), HcalTriggerPrimitiveAlgo::addSignal(), HcalCondObjectContainer< HcalPedestalWidth >::addValues(), ValidateGeometry::analyze(), HcalTimeSlewSim::delay(), HcalPacker::findSamples(), HcalGenericDetId::genericSubdet(), HcalCondObjectContainer< HcalPedestalWidth >::getValues(), hcalEqualDetId(), HcalHitReconstructor::HcalHitReconstructor(), hcalTransformedId(), HcalZDCDetId(), HcalCondObjectContainerBase::indexFor(), HcalCondObjectContainer< HcalPedestalWidth >::initContainer(), CaloGenericDetId::isZDC(), ZdcHardcodeGeometryLoader::load(), operator<<(), operator=(), packHcalZDCDetId(), ZdcSimpleReconstructor::produce(), ZdcHitReconstructor::produce(), CaloGeometryBuilder::produceAligned(), HcalCondObjectContainerBase::sizeFor(), HcalCondObjectContainerBase::textForId(), ZdcUnpacker::unpack(), HcalUnpacker::unpackUTCA(), HcalUnpacker::unpackVME(), HcaluLUTTPGCoder::update(), HcalDigitizer::updateGeometry(), ZdcHitReconstructor::ZdcHitReconstructor(), and ZdcSimpleReconstructor::ZdcSimpleReconstructor().