BTLDetId Class Reference

Detector identifier class for the Barrel Timing Layer. The crystal count must start from 0, copy number must be scaled by 1 unit. More...

#include <BTLDetId.h>

Inheritance diagram for BTLDetId:

Public Types
enum	CrysLayout { CrysLayout::tile = 1, CrysLayout::bar = 2 }
Public Types inherited from MTDDetId
enum	MTDType { typeUNKNOWN =0, BTL =1, ETL =2 }
enum	SubDetector { subUNKNOWN =0, FastTime =1 }
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
	BTLDetId ()
	BTLDetId (const uint32_t &raw_id)
	BTLDetId (const DetId &det_id)
	BTLDetId (uint32_t zside, uint32_t rod, uint32_t module, uint32_t modtyp, uint32_t crystal)
int	crystal () const
BTLDetId	getUnhashedIndex (int hi, CrysLayout lay) const
int	hashedIndex (CrysLayout lay) const
int	ieta (CrysLayout lay) const
int	ietaAbs (CrysLayout lay) const
int	iphi (CrysLayout lay) const
int	modType () const
int	module () const
Public Member Functions inherited from MTDDetId
	MTDDetId ()
	MTDDetId (const uint32_t &raw_id)
	MTDDetId (const DetId &det_id)
	MTDDetId (Detector det, int subdet)
int	mtdRR () const
int	mtdSide () const
int	mtdSubDetector () const
SubDetector	subDetector () const
int	zside () const
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	validHashedIndex (uint32_t din)

Static Public Attributes
static constexpr int	HALF_ROD = 36
static constexpr uint32_t	kBTLCrystalMask = 0x3F
static constexpr uint32_t	kBTLCrystalOffset = 0
static constexpr uint32_t	kBTLmodTypeMask = 0x3
static constexpr uint32_t	kBTLmodTypeOffset = 8
static constexpr uint32_t	kBTLmoduleMask = 0x3F
static constexpr uint32_t	kBTLmoduleOffset = 10
static constexpr int	kCrystalsInEtaBar = 16
static constexpr int	kCrystalsInEtaTile = 4
static constexpr int	kCrystalsInPhiBar = 4
static constexpr int	kCrystalsInPhiTile = 16
static constexpr int	kCrystalsPerROD = kModulesPerROD*kCrystalsInPhiTile*kCrystalsInEtaTile
static constexpr int	kModulesPerROD = 54
	range constants, need two sets for the time being (one for tiles and one for bars) More...
static constexpr int	kSizeForDenseIndexing = MAX_HASH + 1
static constexpr int	kTypeBoundaries [4] = { 0, 18, 36, 54 }
static constexpr int	MAX_HASH = 2*MAX_IPHI_TILE*MAX_IETA_TILE-1
static constexpr int	MAX_IETA_BAR = kCrystalsInEtaBar*kModulesPerROD
static constexpr int	MAX_IETA_TILE = kCrystalsInEtaTile*kModulesPerROD
static constexpr int	MAX_IPHI_BAR = kCrystalsInPhiBar*HALF_ROD
static constexpr int	MAX_IPHI_TILE = kCrystalsInPhiTile*HALF_ROD
static constexpr int	MAX_ROD = 72
static constexpr int	MIN_HASH = 0
static constexpr int	MIN_IETA = 1
static constexpr int	MIN_IPHI = 1
static constexpr int	MIN_ROD = 1
Static Public Attributes inherited from MTDDetId
static const uint32_t	kMTDsubdMask = 0x3
static const uint32_t	kMTDsubdOffset = 23
static const uint32_t	kRodRingMask = 0x3F
static const uint32_t	kRodRingOffset = 16
static const uint32_t	kZsideMask = 0x1
static const uint32_t	kZsideOffset = 22
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
Protected Attributes inherited from DetId
uint32_t	id_

Detailed Description

Detector identifier class for the Barrel Timing Layer. The crystal count must start from 0, copy number must be scaled by 1 unit.

bit 15-10: module sequential number bit 9-8 : crystal type (1 - 3) bit 7-0 : crystal sequential number within a module ( 0 - 63 )

Definition at line 17 of file BTLDetId.h.

Member Enumeration Documentation

enum BTLDetId::CrysLayout

strong

Enumerator
tile
bar

Definition at line 49 of file BTLDetId.h.

{ tile = 1 , bar = 2 } ;

Constructor & Destructor Documentation

BTLDetId::BTLDetId ( )

inline

Construct a null id

Definition at line 54 of file BTLDetId.h.

References DetId::id_, MTDDetId::kMTDsubdMask, and MTDDetId::kMTDsubdOffset.

Referenced by getUnhashedIndex().

: MTDDetId( DetId::Forward, ForwardSubdetector::FastTime ) { id_ |= ( MTDType::BTL& kMTDsubdMask ) << kMTDsubdOffset ;}

BTLDetId::BTLDetId ( const uint32_t &  raw_id )

inline

Construct from a raw value

Definition at line 57 of file BTLDetId.h.

: MTDDetId( raw_id ) {;}

BTLDetId::BTLDetId ( const DetId &  det_id )

inline

Construct from generic DetId

Definition at line 60 of file BTLDetId.h.

: MTDDetId( det_id.rawId() ) {;}

BTLDetId::BTLDetId ( uint32_t  zside, uint32_t  rod, uint32_t  module, uint32_t  modtyp, uint32_t  crystal  )

inline

Construct and fill only the det and sub-det fields.

Definition at line 63 of file BTLDetId.h.

References DetId::id_, kBTLCrystalMask, kBTLmodTypeMask, MTDDetId::kMTDsubdMask, MTDDetId::kMTDsubdOffset, MTDDetId::kRodRingMask, MTDDetId::kRodRingOffset, MTDDetId::kZsideMask, and MTDDetId::kZsideOffset.

                              : MTDDetId( DetId::Forward, ForwardSubdetector::FastTime ) {
    id_ |= ( MTDType::BTL& kMTDsubdMask ) << kMTDsubdOffset |
      ( zside& kZsideMask ) << kZsideOffset |
      ( rod& kRodRingMask ) << kRodRingOffset |
      ( module& kBTLmoduleMask ) << kBTLmoduleOffset |
      ( modtyp& kBTLmodTypeMask ) << kBTLmodTypeOffset |
      ( (crystal-1)& kBTLCrystalMask ) << kBTLCrystalOffset ; 
  }

Member Function Documentation

int BTLDetId::crystal ( ) const

inline

Returns BTL crystal number.

Definition at line 85 of file BTLDetId.h.

References DetId::id_, ietaAbs(), and iphi().

Referenced by getUnhashedIndex(), ietaAbs(), and iphi().

{ return ((id_>>kBTLCrystalOffset)&kBTLCrystalMask) + 1; }

BTLDetId BTLDetId::getUnhashedIndex	(	int	hi,
		CrysLayout	lay
	)		const

get a DetId from a compact index for arrays

Definition at line 68 of file BTLDetId.cc.

References bar, BTLDetId(), crystal(), kCrystalsInEtaBar, kCrystalsInEtaTile, kCrystalsInPhiBar, kCrystalsInPhiTile, kTypeBoundaries, MAX_IETA_BAR, MAX_IETA_TILE, MAX_IPHI_BAR, MAX_IPHI_TILE, tile, and MTDDetId::zside().

Referenced by validHashedIndex().

                                                                  {
  int max_iphi =1 ,max_ieta = 1, nphi = 0, keta = 0, tmphi = hi + 1;
  switch ( lay ) {
    case CrysLayout::tile : {
      max_iphi = MAX_IPHI_TILE;
      max_ieta = MAX_IETA_TILE;
      nphi = kCrystalsInPhiTile;
      keta = kCrystalsInEtaTile;
      break ;
    }
    case CrysLayout::bar : {
      max_iphi = MAX_IPHI_BAR;
      max_ieta = MAX_IETA_BAR;
      nphi = kCrystalsInPhiBar;
      keta = kCrystalsInEtaBar;
      break ;
    }
    default: {
      break ;
    }
  }
  uint32_t zside = 0, rod = 0, module = 0, modtype = 1, crystal = 0;
  if ( tmphi > max_ieta*max_iphi ) { zside = 1; }
  int ip = (tmphi-1)%max_iphi+1;
  int ie = (tmphi-1)/max_iphi - max_ieta;
  ie = ( zside == 1 ? ie + 1 : -ie ) ; 
  rod = (ip-1)/nphi+1;
  module = (ie-1)/keta+1 ; 
  if ( module > kTypeBoundaries[1] ) { modtype = (module > kTypeBoundaries[2] ? 3 : 2 ) ;  }
  if ( modtype > 1 ) { module = module - kTypeBoundaries[modtype-1]; }
  crystal = ((ip-1)%nphi+1)+((ie-1)%keta)*nphi;
  return  BTLDetId( zside, rod, module, modtype, crystal);
}

int BTLDetId::hashedIndex

(

CrysLayout

lay

)

const

define a dense index of arrays from a DetId

Definition at line 46 of file BTLDetId.cc.

References bar, ietaAbs(), iphi(), MAX_IETA_BAR, MAX_IETA_TILE, MAX_IPHI_BAR, MAX_IPHI_TILE, tile, and MTDDetId::zside().

Referenced by ieta().

                                                { 
  int max_iphi = 1, max_ieta = 1;
  switch ( lay ) {
    case CrysLayout::tile : {
      max_iphi = MAX_IPHI_TILE;
      max_ieta = MAX_IETA_TILE;
      break ;
    }
    case CrysLayout::bar : {
      max_iphi = MAX_IPHI_BAR;
      max_ieta = MAX_IETA_BAR;
      break ;
    }
    default: {
      break ;
    }
  }
  return (max_ieta + ( zside() > 0 ? ietaAbs( lay ) - 1 : -ietaAbs( lay ) ) )*max_iphi+ iphi( lay ) - 1;
}

int BTLDetId::ieta ( CrysLayout  lay ) const

inline

Definition at line 93 of file BTLDetId.h.

References hashedIndex(), ietaAbs(), and MTDDetId::zside().

{ return zside()*ietaAbs( lay ); }

int BTLDetId::ietaAbs

(

CrysLayout

lay

)

const

Returns BTL ieta index for crystal according to type tile or bar

Definition at line 24 of file BTLDetId.cc.

References bar, crystal(), kCrystalsInEtaBar, kCrystalsInEtaTile, kCrystalsInPhiBar, kCrystalsInPhiTile, kTypeBoundaries, modType(), module(), and tile.

Referenced by crystal(), hashedIndex(), and ieta().

                                            {
  int kCrystalsInEta = 1, kCrystalsInPhi = 1;
  switch ( lay ) {
    case CrysLayout::tile : {
      kCrystalsInEta = kCrystalsInEtaTile;
      kCrystalsInPhi = kCrystalsInPhiTile;
      break ;
    }
    case CrysLayout::bar  : {
      kCrystalsInEta = kCrystalsInEtaBar ;
      kCrystalsInPhi = kCrystalsInPhiBar ;
      break ;
    }
    default: {
      break ;
    }
  }
  return kCrystalsInEta * ( module() -1 ) 
    + kCrystalsInEta * kTypeBoundaries[(modType() -1)] 
    + ( (crystal()-1)/kCrystalsInPhi + 1 ) ; 
}

int BTLDetId::iphi

(

CrysLayout

lay

)

const

Returns BTL iphi index for crystal according to type tile or bar

Definition at line 4 of file BTLDetId.cc.

References bar, crystal(), HALF_ROD, kCrystalsInPhiBar, kCrystalsInPhiTile, MTDDetId::mtdRR(), and tile.

Referenced by crystal(), and hashedIndex().

                                         {
  int kCrystalsInPhi = 1;
  switch ( lay ) {
    case CrysLayout::tile : {
      kCrystalsInPhi = kCrystalsInPhiTile ;
      break ;
    }
    case CrysLayout::bar  : {
      kCrystalsInPhi = kCrystalsInPhiBar ;
      break ;
    }
    default: {
      break ;
    }
  }
  return kCrystalsInPhi * ( ( mtdRR()%HALF_ROD > 0 ? mtdRR()%HALF_ROD : HALF_ROD ) -1 ) 
    + ( crystal()%kCrystalsInPhi > 0 ? crystal()%kCrystalsInPhi : kCrystalsInPhi ) ;
}

int BTLDetId::modType ( ) const

inline

Returns BTL crystal type number.

Definition at line 82 of file BTLDetId.h.

References DetId::id_, and kBTLmodTypeMask.

Referenced by ietaAbs().

{ return (id_>>kBTLmodTypeOffset)&kBTLmodTypeMask; }

int BTLDetId::module ( ) const

inline

Returns BTL module number.

Definition at line 79 of file BTLDetId.h.

References DetId::id_, and kBTLmoduleMask.

Referenced by ietaAbs().

{ return (id_>>kBTLmoduleOffset)&kBTLmoduleMask; }

static bool BTLDetId::validHashedIndex ( uint32_t  din )

inlinestatic

Definition at line 98 of file BTLDetId.h.

References getUnhashedIndex(), and operator<<().

{ return ( din < kSizeForDenseIndexing ) ; }

Member Data Documentation

constexpr int BTLDetId::HALF_ROD = 36

static

Definition at line 38 of file BTLDetId.h.

Referenced by BTLDetLayerGeometryBuilder::buildLayers(), and iphi().

constexpr uint32_t BTLDetId::kBTLCrystalMask = 0x3F

static

Definition at line 26 of file BTLDetId.h.

Referenced by BTLDetId().

constexpr uint32_t BTLDetId::kBTLCrystalOffset = 0

static

Definition at line 25 of file BTLDetId.h.

constexpr uint32_t BTLDetId::kBTLmodTypeMask = 0x3

static

Definition at line 24 of file BTLDetId.h.

Referenced by BTLDetId(), and modType().

constexpr uint32_t BTLDetId::kBTLmodTypeOffset = 8

static

Definition at line 23 of file BTLDetId.h.

constexpr uint32_t BTLDetId::kBTLmoduleMask = 0x3F

static

Definition at line 22 of file BTLDetId.h.

Referenced by module().

constexpr uint32_t BTLDetId::kBTLmoduleOffset = 10

static

Definition at line 21 of file BTLDetId.h.

constexpr int BTLDetId::kCrystalsInEtaBar = 16

static

Definition at line 34 of file BTLDetId.h.

Referenced by getUnhashedIndex(), and ietaAbs().

constexpr int BTLDetId::kCrystalsInEtaTile = 4

static

Definition at line 32 of file BTLDetId.h.

Referenced by getUnhashedIndex(), and ietaAbs().

constexpr int BTLDetId::kCrystalsInPhiBar = 4

static

Definition at line 33 of file BTLDetId.h.

Referenced by getUnhashedIndex(), ietaAbs(), and iphi().

constexpr int BTLDetId::kCrystalsInPhiTile = 16

static

Definition at line 31 of file BTLDetId.h.

Referenced by getUnhashedIndex(), ietaAbs(), and iphi().

constexpr int BTLDetId::kCrystalsPerROD = kModulesPerROD*kCrystalsInPhiTile*kCrystalsInEtaTile

static

Definition at line 35 of file BTLDetId.h.

constexpr int BTLDetId::kModulesPerROD = 54

static

range constants, need two sets for the time being (one for tiles and one for bars)

Definition at line 29 of file BTLDetId.h.

Referenced by BTLDetLayerGeometryBuilder::buildLayers().

constexpr int BTLDetId::kSizeForDenseIndexing = MAX_HASH + 1

static

Definition at line 47 of file BTLDetId.h.

constexpr int BTLDetId::kTypeBoundaries[4] = { 0, 18, 36, 54 }

static

Definition at line 30 of file BTLDetId.h.

Referenced by getUnhashedIndex(), and ietaAbs().

constexpr int BTLDetId::MAX_HASH = 2*MAX_IPHI_TILE*MAX_IETA_TILE-1

static

Definition at line 46 of file BTLDetId.h.

constexpr int BTLDetId::MAX_IETA_BAR = kCrystalsInEtaBar*kModulesPerROD

static

Definition at line 43 of file BTLDetId.h.

Referenced by getUnhashedIndex(), and hashedIndex().

constexpr int BTLDetId::MAX_IETA_TILE = kCrystalsInEtaTile*kModulesPerROD

static

Definition at line 41 of file BTLDetId.h.

Referenced by getUnhashedIndex(), and hashedIndex().

constexpr int BTLDetId::MAX_IPHI_BAR = kCrystalsInPhiBar*HALF_ROD

static

Definition at line 44 of file BTLDetId.h.

Referenced by getUnhashedIndex(), and hashedIndex().

constexpr int BTLDetId::MAX_IPHI_TILE = kCrystalsInPhiTile*HALF_ROD

static

Definition at line 42 of file BTLDetId.h.

Referenced by getUnhashedIndex(), and hashedIndex().

constexpr int BTLDetId::MAX_ROD = 72

static

Definition at line 37 of file BTLDetId.h.

constexpr int BTLDetId::MIN_HASH = 0

static

Definition at line 45 of file BTLDetId.h.

constexpr int BTLDetId::MIN_IETA = 1

static

Definition at line 39 of file BTLDetId.h.

constexpr int BTLDetId::MIN_IPHI = 1

static

Definition at line 40 of file BTLDetId.h.

constexpr int BTLDetId::MIN_ROD = 1

static

Definition at line 36 of file BTLDetId.h.

Referenced by BTLDetLayerGeometryBuilder::buildLayers().