LVL1::CMXRoI Class Reference

CMX RoI data. More...

#include <CMXRoI.h>

Collaboration diagram for LVL1::CMXRoI:

Public Types
enum	SumType { NORMAL = 0 , MASKED = 1 }

Public Member Functions
	CMXRoI ()
	CMXRoI (uint32_t roiWord0, uint32_t roiWord1, uint32_t roiWord2, uint32_t roiWord3, uint32_t roiWord4, uint32_t roiWord5)
	CMXRoI (unsigned int ex, unsigned int ey, unsigned int et, int exError, int eyError, int etError, unsigned int sumEtHits, unsigned int missingEtHits, unsigned int missingEtSigHits, unsigned int exM, unsigned int eyM, unsigned int etM, int exErrorM, int eyErrorM, int etErrorM, unsigned int sumEtHitsM, unsigned int missingEtHitsM)
	~CMXRoI ()
unsigned int	ex (SumType type=NORMAL) const
	Return Ex.
unsigned int	ey (SumType type=NORMAL) const
	Return Ey.
unsigned int	et (SumType type=NORMAL) const
	Return Et.
int	exError (SumType type=NORMAL) const
	Return Ex error flags (bit 0 Overflow)
int	eyError (SumType type=NORMAL) const
	Return Ey error flags (bit 0 Overflow)
int	etError (SumType type=NORMAL) const
	Return Et error flags (bit 0 Overflow)
unsigned int	sumEtHits (SumType type=NORMAL) const
	Return Sum-ET hits.
unsigned int	missingEtHits (SumType type=NORMAL) const
	Return Missing-ET hits.
unsigned int	missingEtSigHits () const
	Return Missing-ET-Sig hits.
uint32_t	roiWord (int word) const
	Return packed Energy RoI word (0-5)
unsigned int	exWord (SumType type=NORMAL) const
	Return Ex RoI word.
unsigned int	eyWord (SumType type=NORMAL) const
	Return Ey RoI word.
unsigned int	etWord (SumType type=NORMAL) const
	Return ET RoI word.
bool	setRoiWord (uint32_t roiWord)
	Set RoI word with ID check.

Private Attributes
std::vector< uint32_t >	m_roiWords

Static Private Attributes
static const int	s_wordIdVal0 = 0x4
static const int	s_wordIdVal1 = 0x6
static const int	s_wordIdVal2 = 0x5
static const int	s_wordIdBit = 28
static const int	s_sumEtHitsBit = 16
static const int	s_missingEtHitsBit = 16
static const int	s_missingEtSigHitsBit = 16
static const int	s_energyBit = 0
static const int	s_overflowBit = 15
static const int	s_sumTypeBit = 26
static const int	s_wordIdMask = 0xf
static const int	s_sumEtHitsMask = 0xff
static const int	s_missingEtHitsMask = 0xff
static const int	s_missingEtSigHitsMask = 0xff
static const int	s_energyMask = 0x7fff
static const int	s_overflowMask = 0x1
static const int	s_sumTypeMask = 0x1
static const int	s_exOffset = 0
static const int	s_eyOffset = 2
static const int	s_etOffset = 4
static const int	s_maxRoiWords = 6

Detailed Description

CMX RoI data.

Contains six Energy RoI words. Used in analysis of RoI readout.

Author

Peter Faulkner

Definition at line 22 of file Trigger/TrigT1/TrigT1CaloEvent/TrigT1CaloEvent/CMXRoI.h.

Member Enumeration Documentation

SumType

enum LVL1::CMXRoI::SumType

Enumerator
NORMAL
MASKED

Definition at line 26 of file Trigger/TrigT1/TrigT1CaloEvent/TrigT1CaloEvent/CMXRoI.h.

{ NORMAL = 0, MASKED = 1 };

Constructor & Destructor Documentation

CMXRoI() [1/3]

LVL1::CMXRoI::CMXRoI

(

)

Definition at line 36 of file CMXRoI.cxx.

               : m_roiWords(s_maxRoiWords)
{
}

CMXRoI() [2/3]

LVL1::CMXRoI::CMXRoI	(	uint32_t	roiWord0,
		uint32_t	roiWord1,
		uint32_t	roiWord2,
		uint32_t	roiWord3,
		uint32_t	roiWord4,
		uint32_t	roiWord5 )

Definition at line 40 of file CMXRoI.cxx.

           : m_roiWords(s_maxRoiWords)
{
  m_roiWords[0] = roiWord0;
  m_roiWords[1] = roiWord1;
  m_roiWords[2] = roiWord2;
  m_roiWords[3] = roiWord3;
  m_roiWords[4] = roiWord4;
  m_roiWords[5] = roiWord5;
}

CMXRoI() [3/3]

LVL1::CMXRoI::CMXRoI	(	unsigned int	ex,
		unsigned int	ey,
		unsigned int	et,
		int	exError,
		int	eyError,
		int	etError,
		unsigned int	sumEtHits,
		unsigned int	missingEtHits,
		unsigned int	missingEtSigHits,
		unsigned int	exM,
		unsigned int	eyM,
		unsigned int	etM,
		int	exErrorM,
		int	eyErrorM,
		int	etErrorM,
		unsigned int	sumEtHitsM,
		unsigned int	missingEtHitsM )

Definition at line 52 of file CMXRoI.cxx.

           : m_roiWords(s_maxRoiWords)
{
  int type = NORMAL;
  int ix   = s_exOffset + type;
  m_roiWords[ix]  =  s_wordIdVal0                  << s_wordIdBit;
  m_roiWords[ix] |=  type                          << s_sumTypeBit;
  m_roiWords[ix] |= (ex & s_energyMask)            << s_energyBit;
  m_roiWords[ix] |= (exError & s_overflowMask)     << s_overflowBit;
  m_roiWords[ix] |= (missingEtSigHits & s_missingEtSigHitsMask)
                                                   << s_missingEtSigHitsBit;
  type = MASKED;
  ix   = s_exOffset + type;
  m_roiWords[ix]  =  s_wordIdVal0                  << s_wordIdBit;
  m_roiWords[ix] |=  type                          << s_sumTypeBit;
  m_roiWords[ix] |= (exM & s_energyMask)           << s_energyBit;
  m_roiWords[ix] |= (exErrorM & s_overflowMask)    << s_overflowBit;
 
  type = NORMAL;
  ix   = s_eyOffset + type;
  m_roiWords[ix]  =  s_wordIdVal1                  << s_wordIdBit;
  m_roiWords[ix] |=  type                          << s_sumTypeBit;
  m_roiWords[ix] |= (ey & s_energyMask)            << s_energyBit;
  m_roiWords[ix] |= (eyError & s_overflowMask)     << s_overflowBit;
  m_roiWords[ix] |= (missingEtHits & s_missingEtHitsMask)
                                                   << s_missingEtHitsBit;
  type = MASKED;
  ix   = s_eyOffset + type;
  m_roiWords[ix]  =  s_wordIdVal1                  << s_wordIdBit;
  m_roiWords[ix] |=  type                          << s_sumTypeBit;
  m_roiWords[ix] |= (eyM & s_energyMask)           << s_energyBit;
  m_roiWords[ix] |= (eyErrorM & s_overflowMask)    << s_overflowBit;
  m_roiWords[ix] |= (missingEtHitsM & s_missingEtHitsMask)
                                                   << s_missingEtHitsBit;
  type = NORMAL;
  ix   = s_etOffset + type;
  m_roiWords[ix]  =  s_wordIdVal2                  << s_wordIdBit;
  m_roiWords[ix] |=  type                          << s_sumTypeBit;
  m_roiWords[ix] |= (et & s_energyMask)            << s_energyBit;
  m_roiWords[ix] |= (etError & s_overflowMask)     << s_overflowBit;
  m_roiWords[ix] |= (sumEtHits & s_sumEtHitsMask)  << s_sumEtHitsBit;
 
  type = MASKED;
  ix   = s_etOffset + type;
  m_roiWords[ix]  =  s_wordIdVal2                  << s_wordIdBit;
  m_roiWords[ix] |=  type                          << s_sumTypeBit;
  m_roiWords[ix] |= (etM & s_energyMask)           << s_energyBit;
  m_roiWords[ix] |= (etErrorM & s_overflowMask)    << s_overflowBit;
  m_roiWords[ix] |= (sumEtHitsM & s_sumEtHitsMask) << s_sumEtHitsBit;
}

~CMXRoI()

LVL1::CMXRoI::~CMXRoI

(

)

Definition at line 109 of file CMXRoI.cxx.

{
}

Member Function Documentation

et()

unsigned int LVL1::CMXRoI::et ( SumType type = NORMAL ) const

inline

Return Et.

Definition at line 114 of file Trigger/TrigT1/TrigT1CaloEvent/TrigT1CaloEvent/CMXRoI.h.

{
  return (m_roiWords[s_etOffset+type] >> s_energyBit) & s_energyMask;
}

etError()

int LVL1::CMXRoI::etError ( SumType type = NORMAL ) const

inline

Return Et error flags (bit 0 Overflow)

Definition at line 129 of file Trigger/TrigT1/TrigT1CaloEvent/TrigT1CaloEvent/CMXRoI.h.

{
  return (m_roiWords[s_etOffset+type] >> s_overflowBit) & s_overflowMask;
}

etWord()

unsigned int LVL1::CMXRoI::etWord ( SumType type = NORMAL ) const

inline

Return ET RoI word.

Definition at line 164 of file Trigger/TrigT1/TrigT1CaloEvent/TrigT1CaloEvent/CMXRoI.h.

{
  return m_roiWords[s_etOffset+type];
}

ex()

unsigned int LVL1::CMXRoI::ex ( SumType type = NORMAL ) const

inline

Return Ex.

Definition at line 104 of file Trigger/TrigT1/TrigT1CaloEvent/TrigT1CaloEvent/CMXRoI.h.

{
  return (m_roiWords[s_exOffset+type] >> s_energyBit) & s_energyMask;
}

exError()

int LVL1::CMXRoI::exError ( SumType type = NORMAL ) const

inline

Return Ex error flags (bit 0 Overflow)

Definition at line 119 of file Trigger/TrigT1/TrigT1CaloEvent/TrigT1CaloEvent/CMXRoI.h.

{
  return (m_roiWords[s_exOffset+type] >> s_overflowBit) & s_overflowMask;
}

exWord()

unsigned int LVL1::CMXRoI::exWord ( SumType type = NORMAL ) const

inline

Return Ex RoI word.

Definition at line 154 of file Trigger/TrigT1/TrigT1CaloEvent/TrigT1CaloEvent/CMXRoI.h.

{
  return m_roiWords[s_exOffset+type];
}

ey()

unsigned int LVL1::CMXRoI::ey ( SumType type = NORMAL ) const

inline

Return Ey.

Definition at line 109 of file Trigger/TrigT1/TrigT1CaloEvent/TrigT1CaloEvent/CMXRoI.h.

{
  return (m_roiWords[s_eyOffset+type] >> s_energyBit) & s_energyMask;
}

eyError()

int LVL1::CMXRoI::eyError ( SumType type = NORMAL ) const

inline

Return Ey error flags (bit 0 Overflow)

Definition at line 124 of file Trigger/TrigT1/TrigT1CaloEvent/TrigT1CaloEvent/CMXRoI.h.

{
  return (m_roiWords[s_eyOffset+type] >> s_overflowBit) & s_overflowMask;
}

eyWord()

unsigned int LVL1::CMXRoI::eyWord ( SumType type = NORMAL ) const

inline

Return Ey RoI word.

Definition at line 159 of file Trigger/TrigT1/TrigT1CaloEvent/TrigT1CaloEvent/CMXRoI.h.

{
  return m_roiWords[s_eyOffset+type];
}

missingEtHits()

unsigned int LVL1::CMXRoI::missingEtHits ( SumType type = NORMAL ) const

inline

Return Missing-ET hits.

Definition at line 139 of file Trigger/TrigT1/TrigT1CaloEvent/TrigT1CaloEvent/CMXRoI.h.

{
  return (m_roiWords[s_eyOffset+type] >> s_missingEtHitsBit) & s_missingEtHitsMask;
}

missingEtSigHits()

unsigned int LVL1::CMXRoI::missingEtSigHits ( ) const

inline

Return Missing-ET-Sig hits.

Definition at line 144 of file Trigger/TrigT1/TrigT1CaloEvent/TrigT1CaloEvent/CMXRoI.h.

{
  return (m_roiWords[s_exOffset+NORMAL] >> s_missingEtSigHitsBit) & s_missingEtSigHitsMask;
}

roiWord()

uint32_t LVL1::CMXRoI::roiWord ( int word ) const

inline

Return packed Energy RoI word (0-5)

Definition at line 149 of file Trigger/TrigT1/TrigT1CaloEvent/TrigT1CaloEvent/CMXRoI.h.

{
  return (word < s_maxRoiWords) ? m_roiWords[word] : 0;
}

setRoiWord()

bool LVL1::CMXRoI::setRoiWord

(

uint32_t

roiWord

)

Set RoI word with ID check.

Definition at line 115 of file CMXRoI.cxx.

{
  bool valid = true;
  int wordId = (roiWord >> s_wordIdBit)  & s_wordIdMask;
  int type   = (roiWord >> s_sumTypeBit) & s_sumTypeMask;
  if      (wordId == s_wordIdVal0) m_roiWords[s_exOffset+type] = roiWord;
  else if (wordId == s_wordIdVal1) m_roiWords[s_eyOffset+type] = roiWord;
  else if (wordId == s_wordIdVal2) m_roiWords[s_etOffset+type] = roiWord;
  else valid = false;
  return valid;
}

sumEtHits()

unsigned int LVL1::CMXRoI::sumEtHits ( SumType type = NORMAL ) const

inline

Return Sum-ET hits.

Definition at line 134 of file Trigger/TrigT1/TrigT1CaloEvent/TrigT1CaloEvent/CMXRoI.h.

{
  return (m_roiWords[s_etOffset+type] >> s_sumEtHitsBit) & s_sumEtHitsMask;
}

Member Data Documentation

m_roiWords

std::vector<uint32_t> LVL1::CMXRoI::m_roiWords

private

Definition at line 100 of file Trigger/TrigT1/TrigT1CaloEvent/TrigT1CaloEvent/CMXRoI.h.

s_energyBit

const int LVL1::CMXRoI::s_energyBit = 0

staticprivate

Definition at line 82 of file Trigger/TrigT1/TrigT1CaloEvent/TrigT1CaloEvent/CMXRoI.h.

s_energyMask

const int LVL1::CMXRoI::s_energyMask = 0x7fff

staticprivate

Definition at line 90 of file Trigger/TrigT1/TrigT1CaloEvent/TrigT1CaloEvent/CMXRoI.h.

s_etOffset

const int LVL1::CMXRoI::s_etOffset = 4

staticprivate

Definition at line 96 of file Trigger/TrigT1/TrigT1CaloEvent/TrigT1CaloEvent/CMXRoI.h.

s_exOffset

const int LVL1::CMXRoI::s_exOffset = 0

staticprivate

Definition at line 94 of file Trigger/TrigT1/TrigT1CaloEvent/TrigT1CaloEvent/CMXRoI.h.

s_eyOffset

const int LVL1::CMXRoI::s_eyOffset = 2

staticprivate

Definition at line 95 of file Trigger/TrigT1/TrigT1CaloEvent/TrigT1CaloEvent/CMXRoI.h.

s_maxRoiWords

const int LVL1::CMXRoI::s_maxRoiWords = 6

staticprivate

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

s_missingEtHitsBit

const int LVL1::CMXRoI::s_missingEtHitsBit = 16

staticprivate

Definition at line 80 of file Trigger/TrigT1/TrigT1CaloEvent/TrigT1CaloEvent/CMXRoI.h.

s_missingEtHitsMask

const int LVL1::CMXRoI::s_missingEtHitsMask = 0xff

staticprivate

Definition at line 88 of file Trigger/TrigT1/TrigT1CaloEvent/TrigT1CaloEvent/CMXRoI.h.

s_missingEtSigHitsBit

const int LVL1::CMXRoI::s_missingEtSigHitsBit = 16

staticprivate

Definition at line 81 of file Trigger/TrigT1/TrigT1CaloEvent/TrigT1CaloEvent/CMXRoI.h.

s_missingEtSigHitsMask

const int LVL1::CMXRoI::s_missingEtSigHitsMask = 0xff

staticprivate

Definition at line 89 of file Trigger/TrigT1/TrigT1CaloEvent/TrigT1CaloEvent/CMXRoI.h.

s_overflowBit

const int LVL1::CMXRoI::s_overflowBit = 15

staticprivate

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

s_overflowMask

const int LVL1::CMXRoI::s_overflowMask = 0x1

staticprivate

Definition at line 91 of file Trigger/TrigT1/TrigT1CaloEvent/TrigT1CaloEvent/CMXRoI.h.

s_sumEtHitsBit

const int LVL1::CMXRoI::s_sumEtHitsBit = 16

staticprivate

Definition at line 79 of file Trigger/TrigT1/TrigT1CaloEvent/TrigT1CaloEvent/CMXRoI.h.

s_sumEtHitsMask

const int LVL1::CMXRoI::s_sumEtHitsMask = 0xff

staticprivate

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

s_sumTypeBit

const int LVL1::CMXRoI::s_sumTypeBit = 26

staticprivate

Definition at line 84 of file Trigger/TrigT1/TrigT1CaloEvent/TrigT1CaloEvent/CMXRoI.h.

s_sumTypeMask

const int LVL1::CMXRoI::s_sumTypeMask = 0x1

staticprivate

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

s_wordIdBit

const int LVL1::CMXRoI::s_wordIdBit = 28

staticprivate

Definition at line 78 of file Trigger/TrigT1/TrigT1CaloEvent/TrigT1CaloEvent/CMXRoI.h.

s_wordIdMask

const int LVL1::CMXRoI::s_wordIdMask = 0xf

staticprivate

Definition at line 86 of file Trigger/TrigT1/TrigT1CaloEvent/TrigT1CaloEvent/CMXRoI.h.

s_wordIdVal0

const int LVL1::CMXRoI::s_wordIdVal0 = 0x4

staticprivate

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

s_wordIdVal1

const int LVL1::CMXRoI::s_wordIdVal1 = 0x6

staticprivate

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

s_wordIdVal2

const int LVL1::CMXRoI::s_wordIdVal2 = 0x5

staticprivate

Definition at line 76 of file Trigger/TrigT1/TrigT1CaloEvent/TrigT1CaloEvent/CMXRoI.h.

---

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

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