HcalZDCDetId Class Reference

#include <HcalZDCDetId.h>

Inheritance diagram for HcalZDCDetId:

Public Types
enum	{ kSizeForDenseIndexing = 2 * kDepRun1 }
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
int	channel () const
	get the channel More...
uint32_t	denseIndex () const
int	depth () const
	get the depth (1 for EM, channel + 1 for HAD, 2 for RPD, not sure yet for LUM, leave as default) More...
	HcalZDCDetId ()
	HcalZDCDetId (uint32_t rawid)
	HcalZDCDetId (Section section, bool true_for_positive_eta, int channel)
	HcalZDCDetId (const DetId &id)
HcalZDCDetId &	operator= (const DetId &id)
Section	section () const
	get the section More...
int	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 HcalZDCDetId	detIdFromDenseIndex (uint32_t di)
static bool	validDenseIndex (uint32_t di)
static bool	validDetId (Section se, int dp)

Static Public Attributes
static const int	kZDCChannelMask = 0xF
static const int	kZDCRPDMask = 0x80
static const int	kZDCSectionMask = 0x3
static const int	kZDCSectionOffset = 4
static const int	kZDCZsideMask = 0x40
static const int	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

Private Types
enum	{   kDepEM = 5, kDepHAD = 4, kDepLUM = 2, kDepRPD = 16,   kDepRun1 = kDepEM + kDepHAD + kDepLUM, kDepTot = kDepRun1 + kDepRPD }

Additional Inherited Members
Protected Attributes inherited from DetId
uint32_t	id_

Detailed Description

Contents of the HcalZDCDetId : [7] Set for RPD [6] Z position (true for positive) [5:4] Section (EM/HAD/Lumi) [3:0] Channel

Definition at line 16 of file HcalZDCDetId.h.

Member Enumeration Documentation

anonymous enum

anonymous enum

private

Enumerator
kDepEM
kDepHAD
kDepLUM
kDepRPD
kDepRun1
kDepTot

Definition at line 56 of file HcalZDCDetId.h.

       {
    kDepEM = 5,
    kDepHAD = 4,
    kDepLUM = 2,
    kDepRPD = 16,
    kDepRun1 = kDepEM + kDepHAD + kDepLUM,
    kDepTot = kDepRun1 + kDepRPD
  };

anonymous enum

anonymous enum

Enumerator
kSizeForDenseIndexing

Definition at line 66 of file HcalZDCDetId.h.

{ kSizeForDenseIndexing = 2 * kDepRun1 };

Section

enum HcalZDCDetId::Section

Enumerator
Unknown
EM
HAD
LUM
RPD

Definition at line 23 of file HcalZDCDetId.h.

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

Constructor & Destructor Documentation

HcalZDCDetId() [1/4]

HcalZDCDetId::HcalZDCDetId

(

)

Create a null cellid

Definition at line 11 of file HcalZDCDetId.cc.

Referenced by detIdFromDenseIndex().

: DetId() {}

HcalZDCDetId() [2/4]

HcalZDCDetId::HcalZDCDetId

(

uint32_t

rawid

)

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

Definition at line 13 of file HcalZDCDetId.cc.

: DetId(rawid) {}

HcalZDCDetId() [3/4]

HcalZDCDetId::HcalZDCDetId	(	Section	section,
		bool	true_for_positive_eta,
		int	channel
	)

Constructor from section, eta sign, and channel

Definition at line 15 of file HcalZDCDetId.cc.

References channel(), DetId::id_, kZDCChannelMask, kZDCRPDMask, kZDCSectionMask, kZDCSectionOffset, kZDCZsideMask, RPD, section(), and Unknown.

    : DetId(DetId::Calo, SubdetectorId) {
  if (section == RPD) {
    id_ |= (Unknown & kZDCSectionMask) << kZDCSectionOffset;
    id_ |= kZDCRPDMask;
    id_ |= ((channel - 1) & kZDCChannelMask);
  } else {
    id_ |= (section & kZDCSectionMask) << kZDCSectionOffset;
    id_ |= (channel & kZDCChannelMask);
  }
  if (true_for_positive_eta)
    id_ |= kZDCZsideMask;
}

HcalZDCDetId() [4/4]

HcalZDCDetId::HcalZDCDetId

(

const DetId &

id

)

Constructor from a generic cell id

Definition at line 29 of file HcalZDCDetId.cc.

References DetId::Calo, TauDecayModes::dec, Exception, DetId::id_, 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_ = gen.rawId();
}

Member Function Documentation

channel()

int HcalZDCDetId::channel

(

)

const

get the channel

Definition at line 63 of file HcalZDCDetId.cc.

References DetId::id_, kZDCChannelMask, RPD, and section().

Referenced by ZDCDigiStudy::analyze(), ZdcTBAnalysis::analyze(), denseIndex(), depth(), hcalTransformedId(), HcalZDCDetId(), HcalCondObjectContainerBase::indexFor(), HcalText2DetIdConverter::init(), ZdcTopology::longitudinal(), ZDCLogicalMapEntry::printLMapLine(), L1TZDCProducer::produce(), ZdcTopology::transverse(), and CaloGenericDetId::validDetId().

                                {
  const int se(section());
  if (se == RPD)
    return (1 + (id_ & kZDCChannelMask));
  else
    return (id_ & kZDCChannelMask);
}

denseIndex()

uint32_t HcalZDCDetId::denseIndex

(

)

const

Definition at line 71 of file HcalZDCDetId.cc.

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

Referenced by HcalCondObjectContainerBase::indexFor().

                                        {
  const int 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()

int HcalZDCDetId::depth

(

)

const

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

Definition at line 51 of file HcalZDCDetId.cc.

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

Referenced by ZdcTBAnalysis::analyze(), and ZDCLogicalMapEntry::printLMapLine().

                              {
  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()

HcalZDCDetId HcalZDCDetId::detIdFromDenseIndex ( uint32_t  di )

static

Definition at line 80 of file HcalZDCDetId.cc.

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 = (EM == se ? in + 1 : (HAD == se ? in - kDepEM + 1 : in - kDepEM - kDepHAD + 1));
    }
    return HcalZDCDetId(se, lz, dp);
  } else {
    return HcalZDCDetId();
  }
}

operator=()

HcalZDCDetId & HcalZDCDetId::operator=

(

const DetId &

id

)

Assignment from a generic cell id

Definition at line 36 of file HcalZDCDetId.cc.

References DetId::Calo, TauDecayModes::dec, Exception, DetId::id_, 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_ = gen.rawId();
  return *this;
}

section()

HcalZDCDetId::Section HcalZDCDetId::section

(

)

const

get the section

Definition at line 44 of file HcalZDCDetId.cc.

References DetId::id_, kZDCRPDMask, kZDCSectionMask, kZDCSectionOffset, and RPD.

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

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

validDenseIndex()

static bool HcalZDCDetId::validDenseIndex ( uint32_t  di )

inlinestatic

Definition at line 49 of file HcalZDCDetId.h.

References kSizeForDenseIndexing.

Referenced by detIdFromDenseIndex().

{ return (di < kSizeForDenseIndexing); }

validDetId()

bool HcalZDCDetId::validDetId ( Section  se, int  dp  )

static

Definition at line 101 of file HcalZDCDetId.cc.

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()

int HcalZDCDetId::zside ( ) const

inline

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

Definition at line 39 of file HcalZDCDetId.h.

References DetId::id_, and kZDCZsideMask.

Referenced by ZdcGeometry::alignmentTransformIndexLocal(), ZDCDigiStudy::analyze(), ZdcTBAnalysis::analyze(), denseIndex(), hcalTransformedId(), HcalCondObjectContainerBase::indexFor(), HcalText2DetIdConverter::init(), ZdcTopology::longitudinal(), ZDCLogicalMapEntry::printLMapLine(), reco::CentralityProducer::produce(), L1TZDCProducer::produce(), and ZdcTopology::transverse().

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

Member Data Documentation

kZDCChannelMask

const int HcalZDCDetId::kZDCChannelMask = 0xF

static

Definition at line 18 of file HcalZDCDetId.h.

Referenced by channel(), and HcalZDCDetId().

kZDCRPDMask

const int HcalZDCDetId::kZDCRPDMask = 0x80

static

Definition at line 22 of file HcalZDCDetId.h.

Referenced by HcalZDCDetId(), and section().

kZDCSectionMask

const int HcalZDCDetId::kZDCSectionMask = 0x3

static

Definition at line 19 of file HcalZDCDetId.h.

Referenced by HcalZDCDetId(), and section().

kZDCSectionOffset

const int HcalZDCDetId::kZDCSectionOffset = 4

static

Definition at line 20 of file HcalZDCDetId.h.

Referenced by HcalZDCDetId(), and section().

kZDCZsideMask

const int HcalZDCDetId::kZDCZsideMask = 0x40

static

Definition at line 21 of file HcalZDCDetId.h.

Referenced by HcalZDCDetId(), and zside().

SubdetectorId

const int HcalZDCDetId::SubdetectorId = 2

static

Definition at line 25 of file HcalZDCDetId.h.

Referenced by ZDCHitFilter::accepts(), 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=(), ZdcSimpleReconstructor::produce(), ZdcHitReconstructor::produce(), CaloGeometryBuilder::produceAligned(), HcalCondObjectContainerBase::sizeFor(), HcalCondObjectContainerBase::textForId(), ZdcUnpacker::unpack(), HcalUnpacker::unpackUTCA(), HcalUnpacker::unpackVME(), HcalDigitizer::updateGeometry(), ZdcHitReconstructor::ZdcHitReconstructor(), and ZdcSimpleReconstructor::ZdcSimpleReconstructor().