LVL1::CMMRoI Class Reference

CMM RoI data. More...

#include <CMMRoI.h>

Collaboration diagram for LVL1::CMMRoI:

Public Member Functions
	CMMRoI ()=default
	CMMRoI (uint32_t jetEtRoiWord, uint32_t energyRoiWord0, uint32_t energyRoiWord1, uint32_t energyRoiWord2)
	CMMRoI (int jetEtHits, int sumEtHits, int missingEtHits, int missingEtSigHits, int ex, int ey, int et, int jetEtError, int sumEtError, int missingEtError, int missingEtSigError, int exError, int eyError, int etError)
int	jetEtHits () const
	Return Jet-ET hits.
int	sumEtHits () const
	Return Sum-ET hits.
int	missingEtHits () const
	Return Missing-ET hits.
int	missingEtSigHits () const
	Return Missing-ET-Sig hits.
int	ex () const
	Return Ex.
int	ey () const
	Return Ey.
int	et () const
	Return Et.
int	jetEtError () const
	Return Jet-ET error flag (bit 1 Parity)
int	sumEtError () const
	Return Sum-ET error flag (bit 1 Parity)
int	missingEtError () const
	Return Missing-ET error flag (bit 1 Parity)
int	missingEtSigError () const
	Return Missing-ET-Sig error flag (bit 1 Parity)
int	exError () const
	Return Ex error flags (bit 0 Overflow, bit 1 Parity)
int	eyError () const
	Return Ey error flags (bit 0 Overflow, bit 1 Parity)
int	etError () const
	Return Et error flags (bit 0 Overflow, bit 1 Parity)
uint32_t	jetEtRoiWord () const
	Return packed Jet-Et RoI word.
uint32_t	energyRoiWord0 () const
	Return packed Energy RoI word 0.
uint32_t	energyRoiWord1 () const
	Return packed Energy RoI word 1.
uint32_t	energyRoiWord2 () const
	Return packed Energy RoI word 2.
bool	setRoiWord (uint32_t roiWord)
	Set RoI word with ID check.

Private Member Functions
int	parity (uint32_t roiWord) const
	Return Energy parity error (0/1)
int	overflow (uint32_t roiWord) const
	Return Energy overflow flag (0/1)

Private Attributes
uint32_t	m_jetEtRoiWord {}
uint32_t	m_energyRoiWord0 {}
uint32_t	m_energyRoiWord1 {}
uint32_t	m_energyRoiWord2 {}

Static Private Attributes
static const unsigned int	s_jetEtWordIdVal = 0x5
static const unsigned int	s_wordIdVal0 = 0x4
static const unsigned int	s_wordIdVal1 = 0x6
static const unsigned int	s_wordIdVal2 = 0x5
static const int	s_jetEtWordIdBit = 29
static const int	s_wordIdBit = 28
static const int	s_jetEtHitsBit = 0
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_jetEtParityBit = 28
static const int	s_parityBit = 27
static const int	s_overflowBit = 15
static const int	s_jetEtWordIdMask = 0x7
static const int	s_wordIdMask = 0xf
static const int	s_jetEtHitsMask = 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

Detailed Description

CMM RoI data.

Contains a Jet-ET RoI word and three Energy RoI words. Used in analysis of RoI readout.

Author

Peter Faulkner

Definition at line 21 of file Trigger/TrigT1/TrigT1CaloEvent/TrigT1CaloEvent/CMMRoI.h.

Constructor & Destructor Documentation

CMMRoI() [1/3]

LVL1::CMMRoI::CMMRoI ( )

default

CMMRoI() [2/3]

LVL1::CMMRoI::CMMRoI	(	uint32_t	jetEtRoiWord,
		uint32_t	energyRoiWord0,
		uint32_t	energyRoiWord1,
		uint32_t	energyRoiWord2 )

Definition at line 37 of file CMMRoI.cxx.

           : m_jetEtRoiWord(jetEtRoiWord),
             m_energyRoiWord0(energyRoiWord0),
             m_energyRoiWord1(energyRoiWord1),
         m_energyRoiWord2(energyRoiWord2)
{
}

CMMRoI() [3/3]

LVL1::CMMRoI::CMMRoI	(	int	jetEtHits,
		int	sumEtHits,
		int	missingEtHits,
		int	missingEtSigHits,
		int	ex,
		int	ey,
		int	et,
		int	jetEtError,
		int	sumEtError,
		int	missingEtError,
		int	missingEtSigError,
		int	exError,
		int	eyError,
		int	etError )

Definition at line 46 of file CMMRoI.cxx.

{
  m_jetEtRoiWord  =  s_jetEtWordIdVal                   << s_jetEtWordIdBit;
  m_jetEtRoiWord |= (jetEtHits       & s_jetEtHitsMask) << s_jetEtHitsBit;
  m_jetEtRoiWord |= ((jetEtError>>1) & 0x1)             << s_jetEtParityBit;
 
  m_energyRoiWord0  =  s_wordIdVal0                 << s_wordIdBit;
  m_energyRoiWord0 |= (ex & s_energyMask)           << s_energyBit;
  m_energyRoiWord0 |= (exError      & 0x1)          << s_overflowBit;
  m_energyRoiWord0 |= ((exError>>1) & 0x1)          << s_parityBit;
  m_energyRoiWord0 |= (missingEtSigHits & s_missingEtSigHitsMask)
                                                    << s_missingEtSigHitsBit;
  m_energyRoiWord0 |= ((missingEtSigError>>1) & 0x1)<< s_parityBit;
 
  m_energyRoiWord1  =  s_wordIdVal1                 << s_wordIdBit;
  m_energyRoiWord1 |= (ey & s_energyMask)           << s_energyBit;
  m_energyRoiWord1 |= (eyError      & 0x1)          << s_overflowBit;
  m_energyRoiWord1 |= ((eyError>>1) & 0x1)          << s_parityBit;
  m_energyRoiWord1 |= (sumEtHits & s_sumEtHitsMask) << s_sumEtHitsBit;
  m_energyRoiWord1 |= ((sumEtError>>1) & 0x1)       << s_parityBit;
 
  m_energyRoiWord2  =  s_wordIdVal2                 << s_wordIdBit;
  m_energyRoiWord2 |= (et & s_energyMask)           << s_energyBit;
  m_energyRoiWord2 |= (etError      & 0x1)          << s_overflowBit;
  m_energyRoiWord2 |= ((etError>>1) & 0x1)          << s_parityBit;
  m_energyRoiWord2 |= (missingEtHits & s_missingEtHitsMask)
                                                    << s_missingEtHitsBit;
  m_energyRoiWord2 |= ((missingEtError>>1) & 0x1)   << s_parityBit;
}

Member Function Documentation

energyRoiWord0()

uint32_t LVL1::CMMRoI::energyRoiWord0 ( ) const

inline

Return packed Energy RoI word 0.

Definition at line 189 of file Trigger/TrigT1/TrigT1CaloEvent/TrigT1CaloEvent/CMMRoI.h.

{
  return m_energyRoiWord0;
}

energyRoiWord1()

uint32_t LVL1::CMMRoI::energyRoiWord1 ( ) const

inline

Return packed Energy RoI word 1.

Definition at line 194 of file Trigger/TrigT1/TrigT1CaloEvent/TrigT1CaloEvent/CMMRoI.h.

{
  return m_energyRoiWord1;
}

energyRoiWord2()

uint32_t LVL1::CMMRoI::energyRoiWord2 ( ) const

inline

Return packed Energy RoI word 2.

Definition at line 199 of file Trigger/TrigT1/TrigT1CaloEvent/TrigT1CaloEvent/CMMRoI.h.

{
  return m_energyRoiWord2;
}

et()

int LVL1::CMMRoI::et ( ) const

inline

Return Et.

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

{
  return (m_energyRoiWord2 >> s_energyBit) & s_energyMask;
}

etError()

int LVL1::CMMRoI::etError ( ) const

inline

Return Et error flags (bit 0 Overflow, bit 1 Parity)

Definition at line 179 of file Trigger/TrigT1/TrigT1CaloEvent/TrigT1CaloEvent/CMMRoI.h.

{
  return (parity(m_energyRoiWord2) << 1) | overflow(m_energyRoiWord2);
}

ex()

int LVL1::CMMRoI::ex ( ) const

inline

Return Ex.

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

{
  return (m_energyRoiWord0 >> s_energyBit) & s_energyMask;
}

exError()

int LVL1::CMMRoI::exError ( ) const

inline

Return Ex error flags (bit 0 Overflow, bit 1 Parity)

Definition at line 169 of file Trigger/TrigT1/TrigT1CaloEvent/TrigT1CaloEvent/CMMRoI.h.

{
  return (parity(m_energyRoiWord0) << 1) | overflow(m_energyRoiWord0);
}

ey()

int LVL1::CMMRoI::ey ( ) const

inline

Return Ey.

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

{
  return (m_energyRoiWord1 >> s_energyBit) & s_energyMask;
}

eyError()

int LVL1::CMMRoI::eyError ( ) const

inline

Return Ey error flags (bit 0 Overflow, bit 1 Parity)

Definition at line 174 of file Trigger/TrigT1/TrigT1CaloEvent/TrigT1CaloEvent/CMMRoI.h.

{
  return (parity(m_energyRoiWord1) << 1) | overflow(m_energyRoiWord1);
}

jetEtError()

int LVL1::CMMRoI::jetEtError ( ) const

inline

Return Jet-ET error flag (bit 1 Parity)

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

{
  return ((m_jetEtRoiWord >> s_jetEtParityBit) & 0x1) << 1;
}

jetEtHits()

int LVL1::CMMRoI::jetEtHits ( ) const

inline

Return Jet-ET hits.

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

{
  return (m_jetEtRoiWord >> s_jetEtHitsBit) & s_jetEtHitsMask;
}

jetEtRoiWord()

uint32_t LVL1::CMMRoI::jetEtRoiWord ( ) const

inline

Return packed Jet-Et RoI word.

Definition at line 184 of file Trigger/TrigT1/TrigT1CaloEvent/TrigT1CaloEvent/CMMRoI.h.

{
  return m_jetEtRoiWord;
}

missingEtError()

int LVL1::CMMRoI::missingEtError ( ) const

inline

Return Missing-ET error flag (bit 1 Parity)

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

{
  return parity(m_energyRoiWord2) << 1;
}

missingEtHits()

int LVL1::CMMRoI::missingEtHits ( ) const

inline

Return Missing-ET hits.

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

{
  return (m_energyRoiWord2 >> s_missingEtHitsBit) & s_missingEtHitsMask;
}

missingEtSigError()

int LVL1::CMMRoI::missingEtSigError ( ) const

inline

Return Missing-ET-Sig error flag (bit 1 Parity)

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

{
  return parity(m_energyRoiWord0) << 1;
}

missingEtSigHits()

int LVL1::CMMRoI::missingEtSigHits ( ) const

inline

Return Missing-ET-Sig hits.

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

{
  return (m_energyRoiWord0 >> s_missingEtSigHitsBit) & s_missingEtSigHitsMask;
}

overflow()

int LVL1::CMMRoI::overflow ( uint32_t roiWord ) const

inlineprivate

Return Energy overflow flag (0/1)

Definition at line 209 of file Trigger/TrigT1/TrigT1CaloEvent/TrigT1CaloEvent/CMMRoI.h.

{
  return (roiWord >> s_overflowBit) & 0x1;
}

parity()

int LVL1::CMMRoI::parity ( uint32_t roiWord ) const

inlineprivate

Return Energy parity error (0/1)

Definition at line 204 of file Trigger/TrigT1/TrigT1CaloEvent/TrigT1CaloEvent/CMMRoI.h.

{
  return (roiWord >> s_parityBit) & 0x1;
}

setRoiWord()

bool LVL1::CMMRoI::setRoiWord

(

uint32_t

roiWord

)

Set RoI word with ID check.

Definition at line 82 of file CMMRoI.cxx.

{
  bool valid = true;
  int wordId = (roiWord >> s_jetEtWordIdBit) & s_jetEtWordIdMask;
  if (wordId == s_jetEtWordIdVal) m_jetEtRoiWord = roiWord;
  else {
    wordId = (roiWord >> s_wordIdBit) & s_wordIdMask;
    if      (wordId == s_wordIdVal0) m_energyRoiWord0 = roiWord;
    else if (wordId == s_wordIdVal1) m_energyRoiWord1 = roiWord;
    else if (wordId == s_wordIdVal2) m_energyRoiWord2 = roiWord;
    else valid = false;
  }
  return valid;
}

sumEtError()

int LVL1::CMMRoI::sumEtError ( ) const

inline

Return Sum-ET error flag (bit 1 Parity)

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

{
  return parity(m_energyRoiWord1) << 1;
}

sumEtHits()

int LVL1::CMMRoI::sumEtHits ( ) const

inline

Return Sum-ET hits.

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

{
  return (m_energyRoiWord1 >> s_sumEtHitsBit) & s_sumEtHitsMask;
}

Member Data Documentation

m_energyRoiWord0

uint32_t LVL1::CMMRoI::m_energyRoiWord0 {}

private

Definition at line 108 of file Trigger/TrigT1/TrigT1CaloEvent/TrigT1CaloEvent/CMMRoI.h.

{};

m_energyRoiWord1

uint32_t LVL1::CMMRoI::m_energyRoiWord1 {}

private

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

{};

m_energyRoiWord2

uint32_t LVL1::CMMRoI::m_energyRoiWord2 {}

private

Definition at line 110 of file Trigger/TrigT1/TrigT1CaloEvent/TrigT1CaloEvent/CMMRoI.h.

{};

m_jetEtRoiWord

uint32_t LVL1::CMMRoI::m_jetEtRoiWord {}

private

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

{};

s_energyBit

const int LVL1::CMMRoI::s_energyBit = 0

staticprivate

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

s_energyMask

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

staticprivate

Definition at line 99 of file Trigger/TrigT1/TrigT1CaloEvent/TrigT1CaloEvent/CMMRoI.h.

s_jetEtHitsBit

const int LVL1::CMMRoI::s_jetEtHitsBit = 0

staticprivate

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

s_jetEtHitsMask

const int LVL1::CMMRoI::s_jetEtHitsMask = 0xf

staticprivate

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

s_jetEtParityBit

const int LVL1::CMMRoI::s_jetEtParityBit = 28

staticprivate

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

s_jetEtWordIdBit

const int LVL1::CMMRoI::s_jetEtWordIdBit = 29

staticprivate

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

s_jetEtWordIdMask

const int LVL1::CMMRoI::s_jetEtWordIdMask = 0x7

staticprivate

Definition at line 93 of file Trigger/TrigT1/TrigT1CaloEvent/TrigT1CaloEvent/CMMRoI.h.

s_jetEtWordIdVal

const unsigned int LVL1::CMMRoI::s_jetEtWordIdVal = 0x5

staticprivate

Definition at line 77 of file Trigger/TrigT1/TrigT1CaloEvent/TrigT1CaloEvent/CMMRoI.h.

s_missingEtHitsBit

const int LVL1::CMMRoI::s_missingEtHitsBit = 16

staticprivate

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

s_missingEtHitsMask

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

staticprivate

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

s_missingEtSigHitsBit

const int LVL1::CMMRoI::s_missingEtSigHitsBit = 16

staticprivate

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

s_missingEtSigHitsMask

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

staticprivate

Definition at line 98 of file Trigger/TrigT1/TrigT1CaloEvent/TrigT1CaloEvent/CMMRoI.h.

s_overflowBit

const int LVL1::CMMRoI::s_overflowBit = 15

staticprivate

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

s_parityBit

const int LVL1::CMMRoI::s_parityBit = 27

staticprivate

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

s_sumEtHitsBit

const int LVL1::CMMRoI::s_sumEtHitsBit = 16

staticprivate

Definition at line 85 of file Trigger/TrigT1/TrigT1CaloEvent/TrigT1CaloEvent/CMMRoI.h.

s_sumEtHitsMask

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

staticprivate

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

s_wordIdBit

const int LVL1::CMMRoI::s_wordIdBit = 28

staticprivate

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

s_wordIdMask

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

staticprivate

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

s_wordIdVal0

const unsigned int LVL1::CMMRoI::s_wordIdVal0 = 0x4

staticprivate

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

s_wordIdVal1

const unsigned int LVL1::CMMRoI::s_wordIdVal1 = 0x6

staticprivate

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

s_wordIdVal2

const unsigned int LVL1::CMMRoI::s_wordIdVal2 = 0x5

staticprivate

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

---

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

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