LVL1::JEMRoI Class Reference

JEM RoI data. More...

#include <JEMRoI.h>

Collaboration diagram for LVL1::JEMRoI:

Public Member Functions
	JEMRoI ()
	JEMRoI (uint32_t roiWord)
	JEMRoI (int crate, int jem, int frame, int location, int forward, int hits, int error)
	~JEMRoI ()
int	crate () const
	Return crate number (0-1)
int	jem () const
	Return JEM number (0-15)
int	frame () const
	Return RoI frame number (0-7)
int	location () const
	Return location (RoI local coords) (0-3)
int	forward () const
	Return forward jet flag (0/1)
int	hits () const
	Return Jet hit map (8 bits Main or 4 bits Forward)
int	error () const
	Return error flags (bit 0 Saturation, bit 1 Parity)
uint32_t	roiWord () const
	Return packed RoI word.
bool	setRoiWord (uint32_t roiWord)
	Set RoI word with ID check.

Private Member Functions
int	parity () const
	Return parity error flag (0/1)
int	saturation () const
	Return saturation flag (0/1)

Private Attributes
uint32_t	m_roiWord
	RoI word.

Static Private Attributes
static const unsigned int	s_wordIdVal = 0x4
	RoI word ID.
static const int	s_wordIdBit = 29
static const int	s_crateBit = 28
static const int	s_jemBit = 24
static const int	s_frameBit = 21
static const int	s_locationBit = 19
static const int	s_forwardBit = 18
static const int	s_parityBit = 17
static const int	s_saturationBit = 16
static const int	s_forwardHitsBit = 8
static const int	s_mainHitsBit = 0
static const int	s_wordIdMask = 0x7
static const int	s_crateMask = 0x1
static const int	s_jemMask = 0xf
static const int	s_frameMask = 0x7
static const int	s_locationMask = 0x3
static const int	s_forwardMask = 0x1
static const int	s_parityMask = 0x1
static const int	s_saturationMask = 0x1
static const int	s_forwardHitsMask = 0xf
static const int	s_mainHitsMask = 0xff

Detailed Description

JEM RoI data.

Contains a Main Jet RoI word or a Forward Jet RoI word. Used in analysis of RoI readout.

Author

Peter Faulkner

Definition at line 19 of file Trigger/TrigT1/TrigT1CaloEvent/TrigT1CaloEvent/JEMRoI.h.

Constructor & Destructor Documentation

JEMRoI() [1/3]

LVL1::JEMRoI::JEMRoI

(

)

Definition at line 35 of file JEMRoI.cxx.

               : m_roiWord(0)
{
}

JEMRoI() [2/3]

LVL1::JEMRoI::JEMRoI

(

uint32_t

roiWord

)

Definition at line 39 of file JEMRoI.cxx.

                               : m_roiWord(roiWord)
{
}

JEMRoI() [3/3]

LVL1::JEMRoI::JEMRoI	(	int	crate,
		int	jem,
		int	frame,
		int	location,
		int	forward,
		int	hits,
		int	error )

Definition at line 43 of file JEMRoI.cxx.

{
  m_roiWord  =  s_wordIdVal                    << s_wordIdBit;
  m_roiWord |= (crate      & s_crateMask)      << s_crateBit;
  m_roiWord |= (jem        & s_jemMask)        << s_jemBit;
  m_roiWord |= (frame      & s_frameMask)      << s_frameBit;
  m_roiWord |= (location   & s_locationMask)   << s_locationBit;
  m_roiWord |= (forward    & s_forwardMask)    << s_forwardBit;
  m_roiWord |= ((error>>1) & s_parityMask)     << s_parityBit;
  m_roiWord |= (error      & s_saturationMask) << s_saturationBit;
  if (forward) m_roiWord |= (hits & s_forwardHitsMask) << s_forwardHitsBit;
  else         m_roiWord |= (hits & s_mainHitsMask)    << s_mainHitsBit;
}

~JEMRoI()

LVL1::JEMRoI::~JEMRoI

(

)

Definition at line 58 of file JEMRoI.cxx.

{
}

Member Function Documentation

crate()

int LVL1::JEMRoI::crate ( ) const

inline

Return crate number (0-1)

Definition at line 87 of file Trigger/TrigT1/TrigT1CaloEvent/TrigT1CaloEvent/JEMRoI.h.

{
  return (m_roiWord >> s_crateBit) & s_crateMask;
}

error()

int LVL1::JEMRoI::error ( ) const

inline

Return error flags (bit 0 Saturation, bit 1 Parity)

Definition at line 112 of file Trigger/TrigT1/TrigT1CaloEvent/TrigT1CaloEvent/JEMRoI.h.

{
  return (parity() << 1) | saturation();
}

forward()

int LVL1::JEMRoI::forward ( ) const

inline

Return forward jet flag (0/1)

Definition at line 107 of file Trigger/TrigT1/TrigT1CaloEvent/TrigT1CaloEvent/JEMRoI.h.

{
  return (m_roiWord >> s_forwardBit) & s_forwardMask;
}

frame()

int LVL1::JEMRoI::frame ( ) const

inline

Return RoI frame number (0-7)

Definition at line 97 of file Trigger/TrigT1/TrigT1CaloEvent/TrigT1CaloEvent/JEMRoI.h.

{
  return (m_roiWord >> s_frameBit) & s_frameMask;
}

hits()

int LVL1::JEMRoI::hits

(

)

const

Return Jet hit map (8 bits Main or 4 bits Forward)

Definition at line 64 of file JEMRoI.cxx.

{
  int hits = 0;
  if (forward()) hits = (m_roiWord >> s_forwardHitsBit) & s_forwardHitsMask;
  else           hits = (m_roiWord >> s_mainHitsBit)    & s_mainHitsMask;
  return hits;
}

jem()

int LVL1::JEMRoI::jem ( ) const

inline

Return JEM number (0-15)

Definition at line 92 of file Trigger/TrigT1/TrigT1CaloEvent/TrigT1CaloEvent/JEMRoI.h.

{
  return (m_roiWord >> s_jemBit) & s_jemMask;
}

location()

int LVL1::JEMRoI::location ( ) const

inline

Return location (RoI local coords) (0-3)

Definition at line 102 of file Trigger/TrigT1/TrigT1CaloEvent/TrigT1CaloEvent/JEMRoI.h.

{
  return (m_roiWord >> s_locationBit) & s_locationMask;
}

parity()

int LVL1::JEMRoI::parity ( ) const

inlineprivate

Return parity error flag (0/1)

Definition at line 122 of file Trigger/TrigT1/TrigT1CaloEvent/TrigT1CaloEvent/JEMRoI.h.

{
  return (m_roiWord >> s_parityBit) & s_parityMask;
}

roiWord()

uint32_t LVL1::JEMRoI::roiWord ( ) const

inline

Return packed RoI word.

Definition at line 117 of file Trigger/TrigT1/TrigT1CaloEvent/TrigT1CaloEvent/JEMRoI.h.

{
  return m_roiWord;
}

saturation()

int LVL1::JEMRoI::saturation ( ) const

inlineprivate

Return saturation flag (0/1)

Definition at line 127 of file Trigger/TrigT1/TrigT1CaloEvent/TrigT1CaloEvent/JEMRoI.h.

{
  return (m_roiWord >> s_saturationBit) & s_saturationMask;
}

setRoiWord()

bool LVL1::JEMRoI::setRoiWord

(

uint32_t

roiWord

)

Set RoI word with ID check.

Definition at line 74 of file JEMRoI.cxx.

{
  int wordId = (roiWord >> s_wordIdBit) & s_wordIdMask;
  bool valid = (wordId == s_wordIdVal);
  if (valid) m_roiWord = roiWord;
  return valid;
}

Member Data Documentation

m_roiWord

uint32_t LVL1::JEMRoI::m_roiWord

private

RoI word.

Definition at line 83 of file Trigger/TrigT1/TrigT1CaloEvent/TrigT1CaloEvent/JEMRoI.h.

s_crateBit

const int LVL1::JEMRoI::s_crateBit = 28

staticprivate

Definition at line 56 of file Trigger/TrigT1/TrigT1CaloEvent/TrigT1CaloEvent/JEMRoI.h.

s_crateMask

const int LVL1::JEMRoI::s_crateMask = 0x1

staticprivate

Definition at line 67 of file Trigger/TrigT1/TrigT1CaloEvent/TrigT1CaloEvent/JEMRoI.h.

s_forwardBit

const int LVL1::JEMRoI::s_forwardBit = 18

staticprivate

Definition at line 60 of file Trigger/TrigT1/TrigT1CaloEvent/TrigT1CaloEvent/JEMRoI.h.

s_forwardHitsBit

const int LVL1::JEMRoI::s_forwardHitsBit = 8

staticprivate

Definition at line 63 of file Trigger/TrigT1/TrigT1CaloEvent/TrigT1CaloEvent/JEMRoI.h.

s_forwardHitsMask

const int LVL1::JEMRoI::s_forwardHitsMask = 0xf

staticprivate

Definition at line 74 of file Trigger/TrigT1/TrigT1CaloEvent/TrigT1CaloEvent/JEMRoI.h.

s_forwardMask

const int LVL1::JEMRoI::s_forwardMask = 0x1

staticprivate

Definition at line 71 of file Trigger/TrigT1/TrigT1CaloEvent/TrigT1CaloEvent/JEMRoI.h.

s_frameBit

const int LVL1::JEMRoI::s_frameBit = 21

staticprivate

Definition at line 58 of file Trigger/TrigT1/TrigT1CaloEvent/TrigT1CaloEvent/JEMRoI.h.

s_frameMask

const int LVL1::JEMRoI::s_frameMask = 0x7

staticprivate

Definition at line 69 of file Trigger/TrigT1/TrigT1CaloEvent/TrigT1CaloEvent/JEMRoI.h.

s_jemBit

const int LVL1::JEMRoI::s_jemBit = 24

staticprivate

Definition at line 57 of file Trigger/TrigT1/TrigT1CaloEvent/TrigT1CaloEvent/JEMRoI.h.

s_jemMask

const int LVL1::JEMRoI::s_jemMask = 0xf

staticprivate

Definition at line 68 of file Trigger/TrigT1/TrigT1CaloEvent/TrigT1CaloEvent/JEMRoI.h.

s_locationBit

const int LVL1::JEMRoI::s_locationBit = 19

staticprivate

Definition at line 59 of file Trigger/TrigT1/TrigT1CaloEvent/TrigT1CaloEvent/JEMRoI.h.

s_locationMask

const int LVL1::JEMRoI::s_locationMask = 0x3

staticprivate

Definition at line 70 of file Trigger/TrigT1/TrigT1CaloEvent/TrigT1CaloEvent/JEMRoI.h.

s_mainHitsBit

const int LVL1::JEMRoI::s_mainHitsBit = 0

staticprivate

Definition at line 64 of file Trigger/TrigT1/TrigT1CaloEvent/TrigT1CaloEvent/JEMRoI.h.

s_mainHitsMask

const int LVL1::JEMRoI::s_mainHitsMask = 0xff

staticprivate

Definition at line 75 of file Trigger/TrigT1/TrigT1CaloEvent/TrigT1CaloEvent/JEMRoI.h.

s_parityBit

const int LVL1::JEMRoI::s_parityBit = 17

staticprivate

Definition at line 61 of file Trigger/TrigT1/TrigT1CaloEvent/TrigT1CaloEvent/JEMRoI.h.

s_parityMask

const int LVL1::JEMRoI::s_parityMask = 0x1

staticprivate

Definition at line 72 of file Trigger/TrigT1/TrigT1CaloEvent/TrigT1CaloEvent/JEMRoI.h.

s_saturationBit

const int LVL1::JEMRoI::s_saturationBit = 16

staticprivate

Definition at line 62 of file Trigger/TrigT1/TrigT1CaloEvent/TrigT1CaloEvent/JEMRoI.h.

s_saturationMask

const int LVL1::JEMRoI::s_saturationMask = 0x1

staticprivate

Definition at line 73 of file Trigger/TrigT1/TrigT1CaloEvent/TrigT1CaloEvent/JEMRoI.h.

s_wordIdBit

const int LVL1::JEMRoI::s_wordIdBit = 29

staticprivate

Definition at line 55 of file Trigger/TrigT1/TrigT1CaloEvent/TrigT1CaloEvent/JEMRoI.h.

s_wordIdMask

const int LVL1::JEMRoI::s_wordIdMask = 0x7

staticprivate

Definition at line 66 of file Trigger/TrigT1/TrigT1CaloEvent/TrigT1CaloEvent/JEMRoI.h.

s_wordIdVal

const unsigned int LVL1::JEMRoI::s_wordIdVal = 0x4

staticprivate

RoI word ID.

Definition at line 53 of file Trigger/TrigT1/TrigT1CaloEvent/TrigT1CaloEvent/JEMRoI.h.

---

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

• Trigger/TrigT1/TrigT1CaloEvent/TrigT1CaloEvent/JEMRoI.h
• JEMRoI.cxx