HGCalDetId Class Reference

#include <HGCalDetId.h>

Inheritance diagram for HGCalDetId:

Public Member Functions
int	cell () const
	get the absolute value of the cell #'s in x and y More...
HGCalDetId	geometryCell () const
	HGCalDetId ()
	HGCalDetId (uint32_t rawid)
	HGCalDetId (ForwardSubdetector subdet, int zp, int lay, int wafertype, int wafer, int cell)
	HGCalDetId (const DetId &id)
bool	isForward () const
bool	isHGCal () const
	consistency check : no bits left => no overhead More...
int	layer () const
	get the layer # More...
HGCalDetId &	operator= (const DetId &id)
int	wafer () const
	get the wafer # More...
int	waferType () const
	get the wafer type 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 bool	isValid (ForwardSubdetector subdet, int zp, int lay, int wafertype, int wafer, int cell)

Static Public Attributes
static const int	kHGCalCellMask = 0xFF
static const int	kHGCalCellOffset = 0
static const int	kHGCalLayerMask = 0x1F
static const int	kHGCalLayerOffset = 19
static const int	kHGCalMaskCell = 0xFFFBFF00
static const int	kHGCalWaferMask = 0x3FF
static const int	kHGCalWaferOffset = 8
static const int	kHGCalWaferTypeMask = 0x1
static const int	kHGCalWaferTypeOffset = 18
static const int	kHGCalZsideMask = 0x1
static const int	kHGCalZsideOffset = 24
static const HGCalDetId	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

Definition at line 9 of file HGCalDetId.h.

Constructor & Destructor Documentation

HGCalDetId::HGCalDetId

(

)

Create a null cellid

Definition at line 6 of file HGCalDetId.cc.

                       : DetId() {
}

HGCalDetId::HGCalDetId

(

uint32_t

rawid

)

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

Definition at line 9 of file HGCalDetId.cc.

                                     : DetId(rawid) {
}

HGCalDetId::HGCalDetId	(	ForwardSubdetector	subdet,
		int	zp,
		int	lay,
		int	wafertype,
		int	wafer,
		int	cell
	)

Constructor from subdetector, zplus, layer, module, cell numbers

Definition at line 12 of file HGCalDetId.cc.

References gather_cfg::cout, DetId::id_, kHGCalCellMask, kHGCalCellOffset, kHGCalLayerMask, kHGCalLayerOffset, kHGCalWaferMask, kHGCalWaferOffset, kHGCalWaferTypeMask, kHGCalWaferTypeOffset, kHGCalZsideMask, and kHGCalZsideOffset.

                                                                                                     : DetId(Forward,subdet) {  

  if (wafertype < 0) wafertype = 0;
  if (cell>kHGCalCellMask || cell<0 || wafer>kHGCalWaferMask || wafer<0 || wafertype>kHGCalWaferTypeMask || lay>kHGCalLayerMask || lay<0) {
#ifdef DebugLog
    std::cout << "[HGCalDetId] request for new id for"
          << " layer=" << lay << ":" << kHGCalLayerMask
          << " @ zp=" << zp 
          << " wafer=" << wafer << ":" << kHGCalWaferMask
          << " waferType=" << wafertype << ":" << kHGCalWaferTypeMask
          << " cell=" << cell << ":" << kHGCalCellMask
          << " for subdet=" << subdet 
          << " has one or more fields out of bounds and will be reset" 
          << std::endl;
#endif
    zp = lay = wafertype = wafer = cell = 0;
  }
  id_ |= ((cell   & kHGCalCellMask)         << kHGCalCellOffset);
  id_ |= ((wafer  & kHGCalWaferMask)        << kHGCalWaferOffset);
  id_ |= ((wafertype & kHGCalWaferTypeMask) << kHGCalWaferTypeOffset);
  id_ |= ((lay    & kHGCalLayerMask)        << kHGCalLayerOffset);
  if (zp>0) id_ |= ((zp & kHGCalZsideMask)  << kHGCalZsideOffset);
}

HGCalDetId::HGCalDetId

(

const DetId &

id

)

Constructor from a generic cell id

Definition at line 36 of file HGCalDetId.cc.

References DetId::id_, and DetId::rawId().

                                       {
  id_ = gen.rawId();
}

Member Function Documentation

int HGCalDetId::cell ( ) const

inline

get the absolute value of the cell #'s in x and y

Definition at line 39 of file HGCalDetId.h.

References DetId::id_, and kHGCalCellMask.

Referenced by HGCalTBAnalyzer::analyzeRecHits(), hgcal::RecHitTools::getCell(), HGCalTriggerGeometryHexImp2::getCellsFromTriggerCell(), HGCalTriggerGeometryHexLayerBasedImp1::getCellsFromTriggerCell(), HGCalTriggerGeometryHexImp2::getNeighborsFromTriggerCell(), HGCalTriggerGeometryHexLayerBasedImp1::getNeighborsFromTriggerCell(), HGCalTriggerGeometryHexImp2::getTriggerCellFromCell(), HGCalTriggerGeometryHexLayerBasedImp1::getTriggerCellFromCell(), isForward(), and hgcal::RecHitTools::isHalfCell().

{ return id_&kHGCalCellMask; }

HGCalDetId HGCalDetId::geometryCell ( ) const

inline

Converter for a geometry cell id

Definition at line 36 of file HGCalDetId.h.

References DetId::id_, and kHGCalMaskCell.

Referenced by HGCalGeometry::getGeometry(), HGCalGeometry::indexFor(), HGCalGeometry::newCell(), and HGCalGeometry::present().

{return id_&kHGCalMaskCell;}

bool HGCalDetId::isForward ( ) const

inline

Definition at line 55 of file HGCalDetId.h.

References cell(), isValid(), and wafer().

{ return true; }

bool HGCalDetId::isHGCal ( ) const

inline

consistency check : no bits left => no overhead

Definition at line 54 of file HGCalDetId.h.

{ return true; }

bool HGCalDetId::isValid ( ForwardSubdetector  subdet, int  zp, int  lay, int  wafertype, int  wafer, int  cell  )

static

Definition at line 45 of file HGCalDetId.cc.

References gather_cfg::cout, HGCEE, HGCHEB, HGCHEF, kHGCalCellMask, kHGCalLayerMask, kHGCalWaferMask, kHGCalWaferTypeMask, and convertSQLiteXML::ok.

Referenced by ntupleDataFormat._Object::_checkIsValid(), isForward(), and core.AutoHandle.AutoHandle::ReallyLoad().

                                                                                                       {

  bool ok = ((subdet == HGCEE || subdet == HGCHEF || subdet == HGCHEB) &&
         (cell >= 0 && cell <= kHGCalCellMask) && 
         (wafer >= 0 && wafer <= kHGCalWaferMask) &&
         (wafertype <= kHGCalWaferTypeMask) && 
         (lay >= 0 && lay <= kHGCalLayerMask) &&
         (zp == -1 || zp == 1));
#ifdef DebugLog
  if (!ok) 
    std::cout << "HGCalDetId: subdet " << subdet << ":" 
          << (subdet == HGCEE || subdet == HGCHEF || subdet == HGCHEB) 
          << " Cell " << cell << ":" << (cell >= 0 && cell <= kHGCalCellMask) 
          << " Wafer " << wafer << ":" << (wafer >= 0 && wafer <= kHGCalWaferMask) 
          << " WaferType " << wafertype << ":" << (wafertype <= kHGCalWaferTypeMask)
          << " Layer " << lay << ":" << (lay >= 0 && lay <= kHGCalLayerMask) 
          << " zp " << zp << ":" << (zp == -1 || zp == 1) << std::endl;
#endif
  return ok;
}

int HGCalDetId::layer ( ) const

inline

get the layer #

Definition at line 48 of file HGCalDetId.h.

References DetId::id_, and kHGCalLayerMask.

Referenced by HGCalRecHitValidation::analyze(), HGCalDigiValidation::analyze(), HGCalTBAnalyzer::analyzeRecHits(), HGCalTriggerNtupleHGCTriggerCells::fill(), HGCalTriggerGeometryHexImp1::fillMaps(), HGCalTriggerGeometryHexImp2::getCellsFromModule(), HGCalTriggerGeometryHexImp2::getCellsFromTriggerCell(), HGCalTriggerGeometryHexLayerBasedImp1::getCellsFromTriggerCell(), hgcal::RecHitTools::getLayer(), HGCalTriggerGeometryHexImp2::getModuleFromCell(), HGCalTriggerGeometryHexImp2::getModuleFromTriggerCell(), HGCalTriggerGeometryHexLayerBasedImp1::getModuleFromTriggerCell(), HGCalTriggerGeometryHexImp2::getNeighborsFromTriggerCell(), HGCalTriggerGeometryHexLayerBasedImp1::getNeighborsFromTriggerCell(), HGCalTriggerGeometryHexImp2::getOrderedCellsFromModule(), HGCalTriggerGeometryHexImp2::getOrderedTriggerCellsFromModule(), HGCalTriggerGeometryHexLayerBasedImp1::getOrderedTriggerCellsFromModule(), hgcal::RecHitTools::getSiThickness(), HGCalGeometry::getSummary(), HGCalTriggerGeometryHexImp2::getTriggerCellFromCell(), HGCalTriggerGeometryHexLayerBasedImp1::getTriggerCellFromCell(), HGCalTriggerGeometryHexImp2::getTriggerCellsFromModule(), HGCalTriggerGeometryHexLayerBasedImp1::getTriggerCellsFromModule(), geometryXMLparser.DTAlignable::index(), geometryXMLparser.CSCAlignable::index(), HGCalTriggerTools::layer(), l1t::HGCalTriggerCell::layer(), l1t::HGCalClusterT< l1t::HGCalCluster >::layer(), HGCalTriggerGeometryHexLayerBasedImp1::layerWithOffset(), HGCalRecHitSimpleAlgo::makeRecHit(), HGCalTriggerGeometryHexImp2::triggerLayer(), and HGCalTriggerGeometryGenericMapping::triggerLayer().

{ return (id_>>kHGCalLayerOffset)&kHGCalLayerMask; }

HGCalDetId & HGCalDetId::operator=

(

const DetId &

id

)

Assignment from a generic cell id

Definition at line 40 of file HGCalDetId.cc.

References DetId::id_, and DetId::rawId().

                                                  {
  id_ = gen.rawId();
  return (*this);
}

int HGCalDetId::wafer ( ) const

inline

get the wafer #

Definition at line 42 of file HGCalDetId.h.

References DetId::id_, and kHGCalWaferMask.

Referenced by HGCalTriggerNtupleHGCPanels::fill(), HGCalTriggerNtupleHGCTriggerCells::fill(), HGCalTriggerGeometryHexImp1::fillMaps(), HGCalTriggerGeometryHexImp2::getCellsFromModule(), HGCalTriggerGeometryHexImp2::getCellsFromTriggerCell(), HGCalTriggerGeometryHexLayerBasedImp1::getCellsFromTriggerCell(), HGCalTriggerGeometryHexImp2::getModuleFromCell(), HGCalTriggerGeometryHexImp2::getModuleFromTriggerCell(), HGCalTriggerGeometryHexLayerBasedImp1::getModuleFromTriggerCell(), HGCalTriggerGeometryHexImp2::getNeighborsFromTriggerCell(), HGCalTriggerGeometryHexLayerBasedImp1::getNeighborsFromTriggerCell(), HGCalTriggerGeometryHexImp2::getOrderedCellsFromModule(), HGCalTriggerGeometryHexImp2::getOrderedTriggerCellsFromModule(), HGCalTriggerGeometryHexLayerBasedImp1::getOrderedTriggerCellsFromModule(), hgcal::RecHitTools::getSiThickness(), HGCalTriggerGeometryHexImp2::getTriggerCellFromCell(), HGCalTriggerGeometryHexLayerBasedImp1::getTriggerCellFromCell(), HGCalTriggerGeometryHexImp2::getTriggerCellsFromModule(), HGCalTriggerGeometryHexLayerBasedImp1::getTriggerCellsFromModule(), hgcal::RecHitTools::getWafer(), isForward(), and FullModuleSumAlgo< FECODEC, DATA >::run().

{ return (id_>>kHGCalWaferOffset)&kHGCalWaferMask; }

int HGCalDetId::waferType ( ) const

inline

get the wafer type

Definition at line 45 of file HGCalDetId.h.

References DetId::id_.

Referenced by HGCalTriggerGeometryHexImp1::fillMaps(), HGCalTriggerGeometryHexImp2::getCellsFromModule(), HGCalTriggerGeometryHexImp2::getCellsFromTriggerCell(), HGCalTriggerGeometryHexImp2::getModuleFromCell(), HGCalTriggerGeometryHexImp2::getModuleFromTriggerCell(), HGCalTriggerGeometryHexLayerBasedImp1::getModuleFromTriggerCell(), HGCalTriggerGeometryHexImp2::getNeighborsFromTriggerCell(), HGCalTriggerGeometryHexImp2::getOrderedCellsFromModule(), HGCalTriggerGeometryHexImp2::getOrderedTriggerCellsFromModule(), hgcal::RecHitTools::getRadiusToSide(), HGCalTriggerGeometryHexImp2::getTriggerCellFromCell(), HGCalTriggerGeometryHexImp2::getTriggerCellsFromModule(), and hgcal::RecHitTools::isHalfCell().

{ return ((id_>>kHGCalWaferTypeOffset)&kHGCalWaferTypeMask ? 1 : -1); }

int HGCalDetId::zside ( ) const

inline

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

Definition at line 51 of file HGCalDetId.h.

References DetId::id_.

Referenced by HGCalTriggerNtupleHGCPanels::fill(), HGCalTriggerGeometryHexImp1::fillMaps(), HGCalTriggerGeometryHexImp2::getCellsFromModule(), HGCalTriggerGeometryHexImp2::getCellsFromTriggerCell(), HGCalTriggerGeometryHexLayerBasedImp1::getCellsFromTriggerCell(), HGCalTriggerGeometryHexImp2::getModuleFromCell(), HGCalTriggerGeometryHexImp2::getModuleFromTriggerCell(), HGCalTriggerGeometryHexLayerBasedImp1::getModuleFromTriggerCell(), HGCalTriggerGeometryHexImp2::getNeighborsFromTriggerCell(), HGCalTriggerGeometryHexLayerBasedImp1::getNeighborsFromTriggerCell(), HGCalTriggerGeometryHexImp2::getOrderedCellsFromModule(), HGCalTriggerGeometryHexImp2::getOrderedTriggerCellsFromModule(), HGCalTriggerGeometryHexLayerBasedImp1::getOrderedTriggerCellsFromModule(), HGCalTriggerGeometryHexImp2::getTriggerCellFromCell(), HGCalTriggerGeometryHexLayerBasedImp1::getTriggerCellFromCell(), HGCalTriggerGeometryHexImp2::getTriggerCellsFromModule(), HGCalTriggerGeometryHexLayerBasedImp1::getTriggerCellsFromModule(), hgcal::RecHitTools::zside(), l1t::HGCalTriggerCell::zside(), and l1t::HGCalClusterT< l1t::HGCalCluster >::zside().

{ return ((id_>>kHGCalZsideOffset) & kHGCalZsideMask ? 1 : -1); }

Member Data Documentation

const int HGCalDetId::kHGCalCellMask = 0xFF

static

Definition at line 13 of file HGCalDetId.h.

Referenced by cell(), HGCalTriggerGeometryHexImp1::fillMaps(), HGCalTriggerGeometryHexImp2::getModuleFromCell(), HGCalTriggerGeometryHexImp2::getModuleFromTriggerCell(), HGCalTriggerGeometryHexLayerBasedImp1::getModuleFromTriggerCell(), HGCalDetId(), isValid(), HGCalTriggerGeometryHexLayerBasedImp1::packTriggerCell(), HGCalTriggerGeometryHexLayerBasedImp1::packWaferCellId(), and HGCalTriggerGeometryHexLayerBasedImp1::unpackWaferCellId().

const int HGCalDetId::kHGCalCellOffset = 0

static

Definition at line 12 of file HGCalDetId.h.

Referenced by HGCalDetId(), HGCalTriggerGeometryHexLayerBasedImp1::packTriggerCell(), and HGCalTriggerGeometryHexLayerBasedImp1::packWaferCellId().

const int HGCalDetId::kHGCalLayerMask = 0x1F

static

Definition at line 19 of file HGCalDetId.h.

Referenced by HGCalDetId(), isValid(), and layer().

const int HGCalDetId::kHGCalLayerOffset = 19

static

Definition at line 18 of file HGCalDetId.h.

Referenced by HGCalDetId().

const int HGCalDetId::kHGCalMaskCell = 0xFFFBFF00

static

Definition at line 22 of file HGCalDetId.h.

Referenced by geometryCell().

const int HGCalDetId::kHGCalWaferMask = 0x3FF

static

Definition at line 15 of file HGCalDetId.h.

Referenced by HGCalDetId(), isValid(), HGCalTriggerGeometryHexLayerBasedImp1::packTriggerCell(), HGCalTriggerGeometryHexLayerBasedImp1::packWaferCellId(), HGCalTriggerGeometryHexLayerBasedImp1::unpackWaferCellId(), and wafer().

const int HGCalDetId::kHGCalWaferOffset = 8

static

Definition at line 14 of file HGCalDetId.h.

Referenced by HGCalDetId(), HGCalTriggerGeometryHexLayerBasedImp1::packTriggerCell(), HGCalTriggerGeometryHexLayerBasedImp1::packWaferCellId(), and HGCalTriggerGeometryHexLayerBasedImp1::unpackWaferCellId().

const int HGCalDetId::kHGCalWaferTypeMask = 0x1

static

Definition at line 17 of file HGCalDetId.h.

Referenced by HGCalDetId(), and isValid().

const int HGCalDetId::kHGCalWaferTypeOffset = 18

static

Definition at line 16 of file HGCalDetId.h.

Referenced by HGCalDetId(), and HGCalTriggerGeometryHexLayerBasedImp1::packWaferCellId().

const int HGCalDetId::kHGCalZsideMask = 0x1

static

Definition at line 21 of file HGCalDetId.h.

Referenced by HGCalDetId().

const int HGCalDetId::kHGCalZsideOffset = 24

static

Definition at line 20 of file HGCalDetId.h.

Referenced by HGCalDetId().

const HGCalDetId HGCalDetId::Undefined

static

Definition at line 59 of file HGCalDetId.h.