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 ()
	HGCalDetId (uint32_t rawid)
	HGCalDetId (ForwardSubdetector subdet, int zp, int lay, int mod, int subsec, 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	sector () const
	get the sector # More...
int	subsector () const
	get the degree subsector More...
int	zside () const
	get the z-side of the cell (1/-1) More...
Public Member Functions inherited from DetId
Detector	det () const
	get the detector field from this detid More...
	DetId ()
	Create an empty or null id (also for persistence) More...
	DetId (uint32_t id)
	Create an id from a raw number. More...
	DetId (Detector det, int subdet)
	Create an id, filling the detector and subdetector fields as specified. More...
bool	null () const
	is this a null id ? More...
	operator uint32_t () const
bool	operator!= (DetId id) const
	inequality More...
uint32_t	operator() () const
bool	operator< (DetId id) const
	comparison More...
bool	operator== (DetId id) const
	equality More...
uint32_t	rawId () const
	get the raw id More...
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 mod, int subsec, int cell)

Static Public Attributes
static const int	kHGCalCellMask = 0xFFFF
static const int	kHGCalCellOffset = 0
static const int	kHGCalLayerMask = 0x7F
static const int	kHGCalLayerOffset = 24
static const int	kHGCalSectorMask = 0x7F
static const int	kHGCalSectorOffset = 16
static const int	kHGCalSubSectorMask = 0x1
static const int	kHGCalSubSectorOffset = 23
static const int	kHGCalZsideMask = 0x1
static const int	kHGCalZsideOffset = 31
Static Public Attributes inherited from DetId
static const int	kDetOffset = 28
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 }
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	mod,
		int	subsec,
		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, kHGCalSectorMask, kHGCalSectorOffset, kHGCalSubSectorMask, kHGCalSubSectorOffset, kHGCalZsideMask, and kHGCalZsideOffset.

                                                                                                : DetId(Forward,subdet) {  

  if (cell > kHGCalCellMask || sec>kHGCalSectorMask || 
      subsec > kHGCalSubSectorMask || lay>kHGCalLayerMask ) {
#ifdef DebugLog
    std::cout << "[HGCalDetId] request for new id for layer=" << lay
          << " @ zp=" << zp 
          << " sector=" << sec 
          << " subsec=" << subsec 
          << " cell=" << cell 
          << " for subdet=" << subdet 
          << " has one or more fields out of bounds and will be reset" 
          << std::endl;
#endif
    cell=0;  sec=0;  subsec=0; lay=0;
  }
  uint32_t rawid=0;
  rawid |= ((cell   & kHGCalCellMask)        << kHGCalCellOffset);
  rawid |= ((sec    & kHGCalSectorMask)      << kHGCalSectorOffset);
  if (subsec<0) subsec=0;
  rawid |= ((subsec & kHGCalSubSectorMask)   << kHGCalSubSectorOffset);
  rawid |= ((lay    & kHGCalLayerMask)       << kHGCalLayerOffset);
  if (zp>0) rawid |= ((zp & kHGCalZsideMask) << kHGCalZsideOffset);
  id_ = rawid;
}

HGCalDetId::HGCalDetId

(

const DetId &

id

)

Constructor from a generic cell id

Definition at line 38 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 35 of file HGCalDetId.h.

References DetId::id_, and kHGCalCellMask.

{ return id_&kHGCalCellMask; }

bool HGCalDetId::isForward ( ) const

inline

Definition at line 51 of file HGCalDetId.h.

{ return true; }

bool HGCalDetId::isHGCal ( ) const

inline

consistency check : no bits left => no overhead

Definition at line 50 of file HGCalDetId.h.

{ return true; }

bool HGCalDetId::isValid ( ForwardSubdetector  subdet, int  zp, int  lay, int  mod, int  subsec, int  cell  )

static

Definition at line 47 of file HGCalDetId.cc.

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

Referenced by core.AutoHandle.AutoHandle::ReallyLoad().

                                            {
  bool ok = ((subdet == HGCEE || subdet == HGCHEF || subdet == HGCHEB) &&
         (cell >= 0 && cell <= kHGCalCellMask) && 
         (mod >= 1 && mod <= kHGCalSectorMask) &&
         (subsec == 0 || subsec == 1) && 
         (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 <= 0xffff) 
          << " Module " << mod << ":" << (mod >= 1 && mod <= 0x7f) 
          << " SubSector " << subsec << ":" << (subsec == 0 || subsec == 1)
          << " Layer " << lay << ":" << (lay >= 0 && lay <= 0x7f) 
          << " zp " << zp << ":" << (zp == -1 || zp == 1) << std::endl;
#endif
  return ok;
}

int HGCalDetId::layer ( ) const

inline

get the layer #

Definition at line 44 of file HGCalDetId.h.

References DetId::id_, kHGCalLayerMask, and kHGCalLayerOffset.

Referenced by geometryXMLparser.DTAlignable::index(), and geometryXMLparser.CSCAlignable::index().

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

HGCalDetId & HGCalDetId::operator=

(

const DetId &

id

)

Assignment from a generic cell id

Definition at line 42 of file HGCalDetId.cc.

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

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

int HGCalDetId::sector ( ) const

inline

get the sector #

Definition at line 38 of file HGCalDetId.h.

References DetId::id_, kHGCalSectorMask, and kHGCalSectorOffset.

Referenced by geometryXMLparser.DTAlignable::index().

{ return (id_>>kHGCalSectorOffset)&kHGCalSectorMask; }

int HGCalDetId::subsector ( ) const

inline

get the degree subsector

Definition at line 41 of file HGCalDetId.h.

References DetId::id_, kHGCalSubSectorMask, and kHGCalSubSectorOffset.

{ return ( (id_>>kHGCalSubSectorOffset)&kHGCalSubSectorMask ? 1 : -1); }

int HGCalDetId::zside ( ) const

inline

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

Definition at line 47 of file HGCalDetId.h.

References DetId::id_, kHGCalZsideMask, and kHGCalZsideOffset.

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

Member Data Documentation

const int HGCalDetId::kHGCalCellMask = 0xFFFF

static

Definition at line 13 of file HGCalDetId.h.

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

const int HGCalDetId::kHGCalCellOffset = 0

static

Definition at line 12 of file HGCalDetId.h.

Referenced by HGCalDetId().

const int HGCalDetId::kHGCalLayerMask = 0x7F

static

Definition at line 19 of file HGCalDetId.h.

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

const int HGCalDetId::kHGCalLayerOffset = 24

static

Definition at line 18 of file HGCalDetId.h.

Referenced by HGCalDetId(), and layer().

const int HGCalDetId::kHGCalSectorMask = 0x7F

static

Definition at line 15 of file HGCalDetId.h.

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

const int HGCalDetId::kHGCalSectorOffset = 16

static

Definition at line 14 of file HGCalDetId.h.

Referenced by HGCalDetId(), and sector().

const int HGCalDetId::kHGCalSubSectorMask = 0x1

static

Definition at line 17 of file HGCalDetId.h.

Referenced by HGCalDetId(), and subsector().

const int HGCalDetId::kHGCalSubSectorOffset = 23

static

Definition at line 16 of file HGCalDetId.h.

Referenced by HGCalDetId(), and subsector().

const int HGCalDetId::kHGCalZsideMask = 0x1

static

Definition at line 21 of file HGCalDetId.h.

Referenced by HGCalDetId(), and zside().

const int HGCalDetId::kHGCalZsideOffset = 31

static

Definition at line 20 of file HGCalDetId.h.

Referenced by HGCalDetId(), and zside().