xAOD::CMMRoI_v1 Class Reference

Description of CMMRoI_v1. More...

#include <CMMRoI_v1.h>

Inheritance diagram for xAOD::CMMRoI_v1:

Collaboration diagram for xAOD::CMMRoI_v1:

Public Member Functions
	CMMRoI_v1 ()
uint32_t	jetEtRoiWord () const
	get jetEtRoiWord
void	setJetEtRoiWord (uint32_t)
	set jetEtRoiWord
uint32_t	energyRoiWord0 () const
	get energyRoiWord0
void	setEnergyRoiWord0 (uint32_t)
	set energyRoiWord0
uint32_t	energyRoiWord1 () const
	get energyRoiWord1
void	setEnergyRoiWord1 (uint32_t)
	set energyRoiWord1
uint32_t	energyRoiWord2 () const
	get energyRoiWord2
void	setEnergyRoiWord2 (uint32_t)
	set energyRoiWord2
bool	setRoiWord (uint32_t roiWord)
	Set RoI word with ID check Internally works out the type of roiWord.
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).
int	parity (uint32_t roiWord) const
	Return Energy parity error (0/1).
int	overflow (uint32_t roiWord) const
	Return Energy overflow flag (0/1).

Static Private Attributes
static const int	s_jetEtWordIdVal = 0x5
static const int	s_wordIdVal0 = 0x4
static const int	s_wordIdVal1 = 0x6
static const 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

Description of CMMRoI_v1.

Author

John Morris john..nosp@m.morr.nosp@m.is@ce.nosp@m.rn.c.nosp@m.h

Revision

631127

Date

2014-11-26 10:54:48 +0100 (Wed, 26 Nov 2014)

Definition at line 27 of file CMMRoI_v1.h.

Constructor & Destructor Documentation

CMMRoI_v1()

xAOD::CMMRoI_v1::CMMRoI_v1

(

)

Definition at line 18 of file CMMRoI_v1.cxx.

                       :
    SG::AuxElement()
  {        
  }  

Member Function Documentation

energyRoiWord0()

uint32_t xAOD::CMMRoI_v1::energyRoiWord0

(

)

const

get energyRoiWord0

energyRoiWord1()

uint32_t xAOD::CMMRoI_v1::energyRoiWord1

(

)

const

get energyRoiWord1

energyRoiWord2()

uint32_t xAOD::CMMRoI_v1::energyRoiWord2

(

)

const

get energyRoiWord2

et()

int xAOD::CMMRoI_v1::et

(

)

const

Return Et.

Definition at line 81 of file CMMRoI_v1.cxx.

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

etError()

int xAOD::CMMRoI_v1::etError

(

)

const

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

Definition at line 123 of file CMMRoI_v1.cxx.

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

ex()

int xAOD::CMMRoI_v1::ex

(

)

const

Return Ex.

Definition at line 69 of file CMMRoI_v1.cxx.

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

exError()

int xAOD::CMMRoI_v1::exError

(

)

const

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

Definition at line 111 of file CMMRoI_v1.cxx.

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

ey()

int xAOD::CMMRoI_v1::ey

(

)

const

Return Ey.

Definition at line 75 of file CMMRoI_v1.cxx.

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

eyError()

int xAOD::CMMRoI_v1::eyError

(

)

const

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

Definition at line 117 of file CMMRoI_v1.cxx.

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

jetEtError()

int xAOD::CMMRoI_v1::jetEtError

(

)

const

Return Jet-ET error flag (bit 1 Parity).

Definition at line 87 of file CMMRoI_v1.cxx.

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

jetEtHits()

int xAOD::CMMRoI_v1::jetEtHits

(

)

const

Return Jet-ET hits.

Definition at line 45 of file CMMRoI_v1.cxx.

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

jetEtRoiWord()

uint32_t xAOD::CMMRoI_v1::jetEtRoiWord

(

)

const

get jetEtRoiWord

missingEtError()

int xAOD::CMMRoI_v1::missingEtError

(

)

const

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

Definition at line 99 of file CMMRoI_v1.cxx.

  {
    return parity(energyRoiWord2()) << 1;
  }

missingEtHits()

int xAOD::CMMRoI_v1::missingEtHits

(

)

const

Return Missing-ET hits.

Definition at line 57 of file CMMRoI_v1.cxx.

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

missingEtSigError()

int xAOD::CMMRoI_v1::missingEtSigError

(

)

const

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

Definition at line 105 of file CMMRoI_v1.cxx.

  {
    return parity(energyRoiWord0()) << 1;  
  }

missingEtSigHits()

int xAOD::CMMRoI_v1::missingEtSigHits

(

)

const

Return Missing-ET-Sig hits.

Definition at line 63 of file CMMRoI_v1.cxx.

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

overflow()

int xAOD::CMMRoI_v1::overflow

(

uint32_t

roiWord

)

const

Return Energy overflow flag (0/1).

Definition at line 135 of file CMMRoI_v1.cxx.

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

parity()

int xAOD::CMMRoI_v1::parity

(

uint32_t

roiWord

)

const

Return Energy parity error (0/1).

Definition at line 129 of file CMMRoI_v1.cxx.

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

setEnergyRoiWord0()

void xAOD::CMMRoI_v1::setEnergyRoiWord0

(

uint32_t

)

set energyRoiWord0

setEnergyRoiWord1()

void xAOD::CMMRoI_v1::setEnergyRoiWord1

(

uint32_t

)

set energyRoiWord1

setEnergyRoiWord2()

void xAOD::CMMRoI_v1::setEnergyRoiWord2

(

uint32_t

)

set energyRoiWord2

setJetEtRoiWord()

void xAOD::CMMRoI_v1::setJetEtRoiWord

(

uint32_t

)

set jetEtRoiWord

setRoiWord()

bool xAOD::CMMRoI_v1::setRoiWord

(

uint32_t

roiWord

)

Set RoI word with ID check Internally works out the type of roiWord.

Set RoI word with ID check.

Definition at line 29 of file CMMRoI_v1.cxx.

  {
    bool valid(true);
    int wordId = (roiWord >> s_jetEtWordIdBit) & s_jetEtWordIdMask;
    if (wordId == s_jetEtWordIdVal) setJetEtRoiWord( roiWord );
      else {
        wordId = (roiWord >> s_wordIdBit) & s_wordIdMask;
        if      (wordId == s_wordIdVal0) setEnergyRoiWord0( roiWord );
        else if (wordId == s_wordIdVal1) setEnergyRoiWord1( roiWord );
        else if (wordId == s_wordIdVal2) setEnergyRoiWord2( roiWord );
        else valid = false;
      }
    return valid;    
  }

sumEtError()

int xAOD::CMMRoI_v1::sumEtError

(

)

const

Return Sum-ET error flag (bit 1 Parity).

Definition at line 93 of file CMMRoI_v1.cxx.

  {
    return parity(energyRoiWord1()) << 1;  
  }

sumEtHits()

int xAOD::CMMRoI_v1::sumEtHits

(

)

const

Return Sum-ET hits.

Definition at line 51 of file CMMRoI_v1.cxx.

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

Member Data Documentation

s_energyBit

const int xAOD::CMMRoI_v1::s_energyBit = 0

staticprivate

Definition at line 102 of file CMMRoI_v1.h.

s_energyMask

const int xAOD::CMMRoI_v1::s_energyMask = 0x7fff

staticprivate

Definition at line 113 of file CMMRoI_v1.h.

s_jetEtHitsBit

const int xAOD::CMMRoI_v1::s_jetEtHitsBit = 0

staticprivate

Definition at line 98 of file CMMRoI_v1.h.

s_jetEtHitsMask

const int xAOD::CMMRoI_v1::s_jetEtHitsMask = 0xf

staticprivate

Definition at line 109 of file CMMRoI_v1.h.

s_jetEtParityBit

const int xAOD::CMMRoI_v1::s_jetEtParityBit = 28

staticprivate

Definition at line 103 of file CMMRoI_v1.h.

s_jetEtWordIdBit

const int xAOD::CMMRoI_v1::s_jetEtWordIdBit = 29

staticprivate

Definition at line 96 of file CMMRoI_v1.h.

s_jetEtWordIdMask

const int xAOD::CMMRoI_v1::s_jetEtWordIdMask = 0x7

staticprivate

Definition at line 107 of file CMMRoI_v1.h.

s_jetEtWordIdVal

const int xAOD::CMMRoI_v1::s_jetEtWordIdVal = 0x5

staticprivate

Definition at line 91 of file CMMRoI_v1.h.

s_missingEtHitsBit

const int xAOD::CMMRoI_v1::s_missingEtHitsBit = 16

staticprivate

Definition at line 100 of file CMMRoI_v1.h.

s_missingEtHitsMask

const int xAOD::CMMRoI_v1::s_missingEtHitsMask = 0xff

staticprivate

Definition at line 111 of file CMMRoI_v1.h.

s_missingEtSigHitsBit

const int xAOD::CMMRoI_v1::s_missingEtSigHitsBit = 16

staticprivate

Definition at line 101 of file CMMRoI_v1.h.

s_missingEtSigHitsMask

const int xAOD::CMMRoI_v1::s_missingEtSigHitsMask = 0xff

staticprivate

Definition at line 112 of file CMMRoI_v1.h.

s_overflowBit

const int xAOD::CMMRoI_v1::s_overflowBit = 15

staticprivate

Definition at line 105 of file CMMRoI_v1.h.

s_parityBit

const int xAOD::CMMRoI_v1::s_parityBit = 27

staticprivate

Definition at line 104 of file CMMRoI_v1.h.

s_sumEtHitsBit

const int xAOD::CMMRoI_v1::s_sumEtHitsBit = 16

staticprivate

Definition at line 99 of file CMMRoI_v1.h.

s_sumEtHitsMask

const int xAOD::CMMRoI_v1::s_sumEtHitsMask = 0xff

staticprivate

Definition at line 110 of file CMMRoI_v1.h.

s_wordIdBit

const int xAOD::CMMRoI_v1::s_wordIdBit = 28

staticprivate

Definition at line 97 of file CMMRoI_v1.h.

s_wordIdMask

const int xAOD::CMMRoI_v1::s_wordIdMask = 0xf

staticprivate

Definition at line 108 of file CMMRoI_v1.h.

s_wordIdVal0

const int xAOD::CMMRoI_v1::s_wordIdVal0 = 0x4

staticprivate

Definition at line 92 of file CMMRoI_v1.h.

s_wordIdVal1

const int xAOD::CMMRoI_v1::s_wordIdVal1 = 0x6

staticprivate

Definition at line 93 of file CMMRoI_v1.h.

s_wordIdVal2

const int xAOD::CMMRoI_v1::s_wordIdVal2 = 0x5

staticprivate

Definition at line 94 of file CMMRoI_v1.h.

---

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

• CMMRoI_v1.h
• CMMRoI_v1.cxx