InDetDD::SiReadoutCellId Class Reference

#include <SiReadoutCellId.h>

Inheritance diagram for InDetDD::SiReadoutCellId:

Collaboration diagram for InDetDD::SiReadoutCellId:

Public Member Functions
	SiReadoutCellId ()
	SiReadoutCellId (int strip)
	SiReadoutCellId (int phiIndex, int etaIndex)
int	etaIndex () const
	Get eta index. More...
int	phiIndex () const
	Get phi index. Equivalent to strip(). More...
int	strip () const
	Get strip number. Equivalent to phiIndex(). More...
bool	isValid () const
	Test if its in a valid state. More...
bool	operator== (const SiCellId &other) const
	Test equality. More...
bool	operator!= (const SiCellId &other) const
	Test inequality. More...
bool	operator< (const SiCellId &other) const
	Operator for sorting. More...
unsigned int	word () const

Private Types
enum	MaskAndShiftConstants {   PHI_MASK = 0x0000ffff, PHI_NEG = 0x00008000, ETA_MASK = 0x00007fff, ETA_SHIFT = 16,   ETA_NEG = 0x40000000, VALID = 0x80000000 }

Private Attributes
unsigned int	m_word

Detailed Description

Identifier for the strip or pixel readout cell.

SiReadoutCellId behaves identically to its base class. Its only introduced to provide some type safety and distiguish between diodes (base class) and readout cells (this class). This is since more than one diode can be connected to a readout cell.

The following conversion is legal

 SiReadoutCellId -> SiCellId   OK   

However the oppoisite is not allowed

 SiCellId -> SiReadoutCellId   NOT ALLOWED

since a SiCellId might not have direct readout out (eg for an edge strip or ganged pixel).

Author

Grant Gorfine

Definition at line 42 of file SiReadoutCellId.h.

Member Enumeration Documentation

MaskAndShiftConstants

enum InDetDD::SiCellId::MaskAndShiftConstants

privateinherited

Enumerator
PHI_MASK
PHI_NEG
ETA_MASK
ETA_SHIFT
ETA_NEG
VALID

Definition at line 76 of file SiCellId.h.

                             {
    PHI_MASK  = 0x0000ffff,
    PHI_NEG   = 0x00008000, //  (PHI_MASK >> 1 + 1)
    ETA_MASK  = 0x00007fff,
    ETA_SHIFT = 16,
    ETA_NEG   = 0x40000000, // ((ETA_MASK >> 1 + 1) << ETA_SHIFT) 
    VALID     = 0x80000000
  };

Constructor & Destructor Documentation

SiReadoutCellId() [1/3]

InDetDD::SiReadoutCellId::SiReadoutCellId ( )

inline

Definition at line 62 of file SiReadoutCellId.h.

  : SiCellId() 
{}

SiReadoutCellId() [2/3]

InDetDD::SiReadoutCellId::SiReadoutCellId ( int  strip )

inline

Definition at line 70 of file SiReadoutCellId.h.

  : SiCellId(strip)
{}

SiReadoutCellId() [3/3]

InDetDD::SiReadoutCellId::SiReadoutCellId ( int  phiIndex, int  etaIndex  )

inline

Definition at line 66 of file SiReadoutCellId.h.

  : SiCellId(phiIndex, etaIndex)
{}

Member Function Documentation

etaIndex()

int InDetDD::SiCellId::etaIndex ( ) const

inlineinherited

Get eta index.

Definition at line 114 of file SiCellId.h.

{
  if (m_word & ETA_NEG) { // Negative index
    return ((m_word >> ETA_SHIFT) & ETA_MASK) - ETA_MASK - 1;
  } 
  return (m_word >> ETA_SHIFT) & ETA_MASK;
}

isValid()

bool InDetDD::SiCellId::isValid ( ) const

inlineinherited

Test if its in a valid state.

Definition at line 136 of file SiCellId.h.

{
  return !(m_word & VALID);
}

operator!=()

bool InDetDD::SiCellId::operator!= ( const SiCellId &  other ) const

inlineinherited

Test inequality.

Definition at line 146 of file SiCellId.h.

{
  return (m_word != other.m_word);
} 

operator<()

bool InDetDD::SiCellId::operator< ( const SiCellId &  other ) const

inlineinherited

Operator for sorting.

Definition at line 151 of file SiCellId.h.

{
  return (m_word < other.m_word);
} 

operator==()

bool InDetDD::SiCellId::operator== ( const SiCellId &  other ) const

inlineinherited

Test equality.

Definition at line 141 of file SiCellId.h.

{
  return (m_word == other.m_word);
} 

phiIndex()

int InDetDD::SiCellId::phiIndex ( ) const

inlineinherited

Get phi index. Equivalent to strip().

Definition at line 122 of file SiCellId.h.

{
  if (m_word & PHI_NEG) { // Negative index
    return (m_word & PHI_MASK) - PHI_MASK - 1;
  } 
  return (m_word & PHI_MASK);
 
}

strip()

int InDetDD::SiCellId::strip ( ) const

inlineinherited

Get strip number. Equivalent to phiIndex().

Definition at line 131 of file SiCellId.h.

{
  return phiIndex();
}

word()

unsigned int InDetDD::SiCellId::word ( ) const

inlineinherited

Definition at line 67 of file SiCellId.h.

{ return m_word; } 

Member Data Documentation

m_word

unsigned int InDetDD::SiCellId::m_word

privateinherited

Definition at line 70 of file SiCellId.h.

---

The documentation for this class was generated from the following file:

• SiReadoutCellId.h