CPM RoI data. More...

#include <CPMRoI.h>

Collaboration diagram for LVL1::CPMRoI:

Public Member Functions
	CPMRoI ()

	CPMRoI (uint32_t roiWord)

	CPMRoI (int crate, int cpm, int chip, int location, int hits, int error)

	~CPMRoI ()

int	crate () const
	Return crate number (0-1) More...

int	cpm () const
	Return CPM number (1-14) More...

int	chip () const
	Return CP chip number (0-7) More...

int	location () const
	Return location (RoI local coords) (0-7) More...

int	hits () const
	Return hit thresholds map. More...

int	error () const
	Return error flags (bit 0 Saturation, bit 1 Parity) More...

uint32_t	roiWord () const
	Return packed RoI word. More...

bool	setRoiWord (uint32_t roiWord)
	Set RoI word with ID check. More...

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

int	saturation () const
	Return saturation flag (0/1) More...

Private Attributes
uint32_t	m_roiWord
	RoI word. More...

Static Private Attributes
static const int	s_wordIdVal = 0x0
	RoI word ID. More...

static const int	s_wordIdBit = 30

static const int	s_crateBit = 28

static const int	s_cpmBit = 24

static const int	s_chipBit = 21

static const int	s_locationBit = 18

static const int	s_parityBit = 17

static const int	s_saturationBit = 16

static const int	s_hitsBit = 0

static const int	s_wordIdMask = 0x3

static const int	s_crateMask = 0x3

static const int	s_cpmMask = 0xf

static const int	s_chipMask = 0x7

static const int	s_locationMask = 0x7

static const int	s_parityMask = 0x1

static const int	s_saturationMask = 0x1

static const int	s_hitsMask = 0xffff

Detailed Description

CPM RoI data.

Contains a Cluster Processor Module RoI word. Used in analysis of RoI readout.

Author: Peter Faulkner

Definition at line 20 of file Trigger/TrigT1/TrigT1CaloEvent/TrigT1CaloEvent/CPMRoI.h.

Constructor & Destructor Documentation

◆ CPMRoI() [1/3]

LVL1::CPMRoI::CPMRoI ( )

Definition at line 31 of file CPMRoI.cxx.

                : m_roiWord(0)
 {
 }

◆ CPMRoI() [2/3]

LVL1::CPMRoI::CPMRoI ( uint32_t roiWord )

Definition at line 35 of file CPMRoI.cxx.

                                : m_roiWord(roiWord)
 {
 }

◆ CPMRoI() [3/3]

LVL1::CPMRoI::CPMRoI	(	int	crate,
		int	cpm,
		int	chip,
		int	location,
		int	hits,
		int	error
	)

Definition at line 39 of file CPMRoI.cxx.

 {
   m_roiWord  =  s_wordIdVal                    << s_wordIdBit;
   m_roiWord |= (crate      & s_crateMask)      << s_crateBit;
   m_roiWord |= (cpm        & s_cpmMask)        << s_cpmBit;
   m_roiWord |= (chip       & s_chipMask)       << s_chipBit;
   m_roiWord |= (location   & s_locationMask)   << s_locationBit;
   m_roiWord |= ((error>>1) & s_parityMask)     << s_parityBit;
   m_roiWord |= (error      & s_saturationMask) << s_saturationBit;
   m_roiWord |= (hits       & s_hitsMask)       << s_hitsBit;
 }

◆ ~CPMRoI()

LVL1::CPMRoI::~CPMRoI ( )

Definition at line 51 of file CPMRoI.cxx.

52 {

53 }

Member Function Documentation

◆ chip()

int LVL1::CPMRoI::chip ( ) const

inline

Return CP chip number (0-7)

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

 {
   return (m_roiWord >> s_chipBit) & s_chipMask;
 }

◆ cpm()

int LVL1::CPMRoI::cpm ( ) const

inline

Return CPM number (1-14)

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

 {
   return (m_roiWord >> s_cpmBit) & s_cpmMask;
 }

◆ crate()

int LVL1::CPMRoI::crate ( ) const

inline

Return crate number (0-1)

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

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

◆ error()

int LVL1::CPMRoI::error ( ) const

inline

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

Definition at line 106 of file Trigger/TrigT1/TrigT1CaloEvent/TrigT1CaloEvent/CPMRoI.h.

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

◆ hits()

int LVL1::CPMRoI::hits ( ) const

inline

Return hit thresholds map.

Definition at line 101 of file Trigger/TrigT1/TrigT1CaloEvent/TrigT1CaloEvent/CPMRoI.h.

 {
   return (m_roiWord >> s_hitsBit) & s_hitsMask;
 }

◆ location()

int LVL1::CPMRoI::location ( ) const

inline

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

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

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

◆ parity()

int LVL1::CPMRoI::parity ( ) const

inlineprivate

Return parity error flag (0/1)

Definition at line 116 of file Trigger/TrigT1/TrigT1CaloEvent/TrigT1CaloEvent/CPMRoI.h.

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

◆ roiWord()

uint32_t LVL1::CPMRoI::roiWord ( ) const

inline

Return packed RoI word.

Definition at line 111 of file Trigger/TrigT1/TrigT1CaloEvent/TrigT1CaloEvent/CPMRoI.h.

 {
   return m_roiWord;
 }

◆ saturation()

int LVL1::CPMRoI::saturation ( ) const

inlineprivate

Return saturation flag (0/1)

Definition at line 121 of file Trigger/TrigT1/TrigT1CaloEvent/TrigT1CaloEvent/CPMRoI.h.

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

◆ setRoiWord()

bool LVL1::CPMRoI::setRoiWord ( uint32_t roiWord )

Set RoI word with ID check.

Definition at line 57 of file CPMRoI.cxx.

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