HcalTrigTowerDetId Class Reference

#include <HcalTrigTowerDetId.h>

Inheritance diagram for HcalTrigTowerDetId:

Public Member Functions
int	depth () const
	get the depth (zero for LHC Run 1, may be nonzero for later runs) More...
	HcalTrigTowerDetId ()
	HcalTrigTowerDetId (uint32_t rawid)
	HcalTrigTowerDetId (int ieta, int iphi)
	Constructor from signed ieta, iphi. More...
	HcalTrigTowerDetId (int ieta, int iphi, int depth)
	Constructor from signed ieta, iphi, depth. More...
	HcalTrigTowerDetId (int ieta, int iphi, int depth, int version)
	Constructor from signed ieta, iphi, depth, version. More...
	HcalTrigTowerDetId (const DetId &id)
int	ieta () const
	get the tower ieta More...
int	ietaAbs () const
	get the absolute value of the tower ieta More...
int	iphi () const
	get the tower iphi More...
HcalTrigTowerDetId &	operator= (const DetId &id)
void	setVersion (int version)
HcalSubdetector	subdet () const
	get the subdetector More...
int	version () const
	get the version code for the trigger tower More...
int	zside () const
	get the z-side of the tower (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 Attributes
static const int	kHcalDepthMask = 0x7
static const int	kHcalDepthOffset = 14
static const int	kHcalEtaMask = 0x3F
static const int	kHcalEtaOffset = 7
static const int	kHcalPhiMask = 0x7F
static const int	kHcalVersMask = 0x7
static const int	kHcalVersOffset = 17
static const int	kHcalZsideMask = 0x2000
static const HcalTrigTowerDetId	Undefined
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 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

Cell id for an Calo Trigger tower

Author

J. Mans - Minnesota

Definition at line 14 of file HcalTrigTowerDetId.h.

Constructor & Destructor Documentation

HcalTrigTowerDetId::HcalTrigTowerDetId

(

)

Constructor of a null id

Definition at line 7 of file HcalTrigTowerDetId.cc.

{}

HcalTrigTowerDetId::HcalTrigTowerDetId

(

uint32_t

rawid

)

Constructor from a raw value

Definition at line 9 of file HcalTrigTowerDetId.cc.

: DetId(rawid) {}

HcalTrigTowerDetId::HcalTrigTowerDetId	(	int	ieta,
		int	iphi
	)

Constructor from signed ieta, iphi.

Definition at line 11 of file HcalTrigTowerDetId.cc.

References DetId::id_, kHcalEtaOffset, kHcalPhiMask, and kHcalZsideMask.

                                                         : DetId(Hcal, HcalTriggerTower) {
  id_ |=
      ((ieta > 0) ? (kHcalZsideMask | (ieta << kHcalEtaOffset)) : ((-ieta) << kHcalEtaOffset)) | (iphi & kHcalPhiMask);
  // Default to depth = 0 & version = 0
}

HcalTrigTowerDetId::HcalTrigTowerDetId	(	int	ieta,
		int	iphi,
		int	depth
	)

Constructor from signed ieta, iphi, depth.

Definition at line 17 of file HcalTrigTowerDetId.cc.

References DetId::id_, kHcalDepthMask, kHcalDepthOffset, kHcalEtaOffset, kHcalPhiMask, kHcalVersMask, kHcalVersOffset, kHcalZsideMask, and version().

                                                                    : DetId(Hcal, HcalTriggerTower) {
  const int ones = depth % 10;
  const int tens = (depth - ones) / 10;
  // version convension   0 : default for 3x2 TP; 1, 2, 3 : for future & currently version = 1 is for 1x1 TP
  // Note that in this conversion, depth can take values from 0 to 9 for different purpose
  // -> so depth should be = ones!
  id_ |= ((ones & kHcalDepthMask) << kHcalDepthOffset) |
         ((ieta > 0) ? (kHcalZsideMask | (ieta << kHcalEtaOffset)) : ((-ieta) << kHcalEtaOffset)) |
         (iphi & kHcalPhiMask);

  const int version = tens;
  if (version > 9) {  // do NOT envision to have versions over 9...
    edm::LogError("HcalTrigTowerDetId") << "in its ctor using depth, version larger than 9 (too many of it!)?"
                                        << std::endl;
  }

  id_ |= ((version & kHcalVersMask) << kHcalVersOffset);
}

HcalTrigTowerDetId::HcalTrigTowerDetId	(	int	ieta,
		int	iphi,
		int	depth,
		int	version
	)

Constructor from signed ieta, iphi, depth, version.

Definition at line 36 of file HcalTrigTowerDetId.cc.

References DetId::id_, kHcalDepthMask, kHcalDepthOffset, kHcalEtaOffset, kHcalPhiMask, kHcalVersMask, kHcalVersOffset, and kHcalZsideMask.

                                                                                 : DetId(Hcal, HcalTriggerTower) {
  id_ |= ((depth & kHcalDepthMask) << kHcalDepthOffset) |
         ((ieta > 0) ? (kHcalZsideMask | (ieta << kHcalEtaOffset)) : ((-ieta) << kHcalEtaOffset)) |
         (iphi & kHcalPhiMask);
  id_ |= ((version & kHcalVersMask) << kHcalVersOffset);
}

HcalTrigTowerDetId::HcalTrigTowerDetId

(

const DetId &

id

)

Constructor from a generic cell id

Definition at line 43 of file HcalTrigTowerDetId.cc.

References TauDecayModes::dec, DetId::det(), Exception, DetId::Hcal, HcalTriggerTower, DetId::id_, DetId::null(), DetId::rawId(), and DetId::subdetId().

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

Member Function Documentation

int HcalTrigTowerDetId::depth ( ) const

inline

get the depth (zero for LHC Run 1, may be nonzero for later runs)

Definition at line 58 of file HcalTrigTowerDetId.h.

References DetId::id_, kHcalDepthMask, and kHcalDepthOffset.

Referenced by hcaldqm::quantity::getValue_TTdepth(), hcaldqm::hashfunctions::hash_TChannel(), hcaldqm::hashfunctions::hash_TTdepth(), HcalText2DetIdConverter::init(), and hcaldqm::hashfunctions::name_TTdepth().

{ return (id_ >> kHcalDepthOffset) & kHcalDepthMask; }

int HcalTrigTowerDetId::ieta ( ) const

inline

get the tower ieta

Definition at line 54 of file HcalTrigTowerDetId.h.

References ietaAbs(), and zside().

Referenced by HcalTrigTowerGeometry::detIds(), hcaldqm::quantity::getLabels_TTSubdetPM(), hcaldqm::quantity::getValue_TTieta(), hcaldqm::quantity::getValue_TTieta2x3(), hcaldqm::quantity::getValue_TTSubdetPM(), hcaldqm::hashfunctions::hash_TChannel(), hcaldqm::hashfunctions::hash_TTSubdetPM(), hcaldqm::hashfunctions::hash_TTSubdetPMiphi(), HcalText2DetIdConverter::init(), hcaldqm::hashfunctions::name_TTSubdetPM(), and HTLogicalMapEntry::printLMapLine().

{ return zside() * ietaAbs(); }

int HcalTrigTowerDetId::ietaAbs ( ) const

inline

get the absolute value of the tower ieta

Definition at line 52 of file HcalTrigTowerDetId.h.

References DetId::id_, kHcalEtaMask, and kHcalEtaOffset.

Referenced by TPTask::_process(), HcalTopology::detId2denseIdHT(), hcaldqm::TPRunSummary::endJob(), hcaldqm::quantity::getLabels_TTSubdetPM(), hcaldqm::quantity::getValue_TTSubdet(), hcaldqm::quantity::getValue_TTSubdetPM(), hcaldqm::hashfunctions::hash_TTSubdet(), hcaldqm::hashfunctions::hash_TTSubdetFW(), hcaldqm::hashfunctions::hash_TTSubdetPM(), hcaldqm::hashfunctions::hash_TTSubdetPMiphi(), ieta(), hcaldqm::hashfunctions::name_TTSubdet(), hcaldqm::hashfunctions::name_TTSubdetFW(), and hcaldqm::hashfunctions::name_TTSubdetPM().

{ return (id_ >> kHcalEtaOffset) & kHcalEtaMask; }

int HcalTrigTowerDetId::iphi ( ) const

inline

get the tower iphi

Definition at line 56 of file HcalTrigTowerDetId.h.

References DetId::id_, and kHcalPhiMask.

Referenced by HcalTopology::detId2denseIdHT(), HcalTrigTowerGeometry::detIds(), hcaldqm::quantity::getValue_TTiphi(), hcaldqm::hashfunctions::hash_TChannel(), hcaldqm::hashfunctions::hash_TTSubdetPMiphi(), HcalText2DetIdConverter::init(), hcaldqm::hashfunctions::name_TTSubdetPMiphi(), and HTLogicalMapEntry::printLMapLine().

{ return id_ & kHcalPhiMask; }

HcalTrigTowerDetId & HcalTrigTowerDetId::operator=

(

const DetId &

id

)

Assignment from a generic cell id

Definition at line 53 of file HcalTrigTowerDetId.cc.

References TauDecayModes::dec, DetId::det(), Exception, DetId::Hcal, HcalTriggerTower, DetId::id_, DetId::null(), DetId::rawId(), and DetId::subdetId().

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

void HcalTrigTowerDetId::setVersion

(

int

version

)

Definition at line 51 of file HcalTrigTowerDetId.cc.

References DetId::id_, kHcalVersMask, and kHcalVersOffset.

{ id_ |= ((version & kHcalVersMask) << kHcalVersOffset); }

HcalSubdetector HcalTrigTowerDetId::subdet ( ) const

inline

get the subdetector

Definition at line 48 of file HcalTrigTowerDetId.h.

References DetId::subdetId().

{ return (HcalSubdetector)(subdetId()); }

int HcalTrigTowerDetId::version ( ) const

inline

get the version code for the trigger tower

Definition at line 60 of file HcalTrigTowerDetId.h.

References DetId::id_, kHcalVersMask, and kHcalVersOffset.

Referenced by TPTask::_process(), HcalTriggerPrimitiveAlgo::addSignal(), validation.Sample::datasetpattern(), HcalTopology::detId2denseIdHT(), HcalTrigTowerGeometry::detIds(), hcaldqm::TPRunSummary::endJob(), validation.Sample::filename(), HcalTrigTowerDetId(), and HcalText2DetIdConverter::init().

{ return (id_ >> kHcalVersOffset) & kHcalVersMask; }

int HcalTrigTowerDetId::zside ( ) const

inline

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

Definition at line 50 of file HcalTrigTowerDetId.h.

References DetId::id_, and kHcalZsideMask.

Referenced by HcalTopology::detId2denseIdHT(), HcalTrigTowerGeometry::detIds(), and ieta().

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

Member Data Documentation

const int HcalTrigTowerDetId::kHcalDepthMask = 0x7

static

Definition at line 21 of file HcalTrigTowerDetId.h.

Referenced by depth(), and HcalTrigTowerDetId().

const int HcalTrigTowerDetId::kHcalDepthOffset = 14

static

Definition at line 20 of file HcalTrigTowerDetId.h.

Referenced by depth(), and HcalTrigTowerDetId().

const int HcalTrigTowerDetId::kHcalEtaMask = 0x3F

static

Definition at line 18 of file HcalTrigTowerDetId.h.

Referenced by ietaAbs().

const int HcalTrigTowerDetId::kHcalEtaOffset = 7

static

Definition at line 17 of file HcalTrigTowerDetId.h.

Referenced by HcalTrigTowerDetId(), and ietaAbs().

const int HcalTrigTowerDetId::kHcalPhiMask = 0x7F

static

Definition at line 16 of file HcalTrigTowerDetId.h.

Referenced by HcalTrigTowerDetId(), and iphi().

const int HcalTrigTowerDetId::kHcalVersMask = 0x7

static

Definition at line 23 of file HcalTrigTowerDetId.h.

Referenced by HcalTrigTowerDetId(), setVersion(), and version().

const int HcalTrigTowerDetId::kHcalVersOffset = 17

static

Definition at line 22 of file HcalTrigTowerDetId.h.

Referenced by HcalTrigTowerDetId(), setVersion(), and version().

const int HcalTrigTowerDetId::kHcalZsideMask = 0x2000

static

Definition at line 19 of file HcalTrigTowerDetId.h.

Referenced by HcalTrigTowerDetId(), and zside().

const HcalTrigTowerDetId HcalTrigTowerDetId::Undefined

static

Definition at line 62 of file HcalTrigTowerDetId.h.

Referenced by HcalText2DetIdConverter::init(), HcalUnpacker::unpackUTCA(), and HcalUnpacker::unpackVME().