CrateEnergy class declaration Simulates behaviour of the Crate-CMM System CMM logic is done in EnergyTrigger. More...

#include <CrateEnergy.h>

Collaboration diagram for LVL1::CrateEnergy:

Public Member Functions
	CrateEnergy (unsigned int crate, const DataVector< ModuleEnergy > *modules, uint32_t maskXE=0xff, uint32_t maskTE=0xff, bool restricted=false)
	CrateEnergy (unsigned int crate, const DataVector< EnergyCMXData > *modules, uint32_t maskXE=0xff, uint32_t maskTE=0xff, bool restricted=false)
	CrateEnergy (unsigned int crate, unsigned int et, unsigned int exTC, unsigned int eyTC, unsigned int overflowT, unsigned int overflowX, unsigned int overflowY, bool restricted=false)
	~CrateEnergy ()
unsigned int	crate () const
	return crate number
int	et () const
	return et, ex, ey sums
int	ex () const
	return crate Ex
int	ey () const
	return crate Ey
unsigned int	exTC () const
	15 bit twos-complement format
unsigned int	eyTC () const
	return crate Ey in 15-bit twos-complement format (hardware format)
unsigned int	exOverflow () const
	Overflow bits.
unsigned int	eyOverflow () const
	return Ey overflow bit
unsigned int	etOverflow () const
	return Et overflow bit
bool	restricted () const
	Full or restricted eta range?

Private Member Functions
unsigned int	encodeTC (int input) const
	encode int as 15-bit twos-complement format (hardware Ex/Ey format)
int	decodeTC (unsigned int input) const
	decode 15-bit twos-complement format (hardware Ex/Ey format) as int

Private Attributes
unsigned int	m_crate
unsigned int	m_crateEt
int	m_crateEx
int	m_crateEy
unsigned int	m_overflowT
unsigned int	m_overflowX
unsigned int	m_overflowY
bool	m_restricted
bool	m_debug

Static Private Attributes
static const unsigned int	m_sumBitsTC =15
static const unsigned int	m_sumBits =14
static const unsigned int	m_jemEtSaturation = 0x3fff

Detailed Description

CrateEnergy class declaration Simulates behaviour of the Crate-CMM System CMM logic is done in EnergyTrigger.

Definition at line 30 of file CrateEnergy.h.

Constructor & Destructor Documentation

◆ CrateEnergy() [1/3]

LVL1::CrateEnergy::CrateEnergy	(	unsigned int	crate,
		const DataVector< ModuleEnergy > *	modules,
		uint32_t	maskXE = 0xff,
		uint32_t	maskTE = 0xff,
		bool	restricted = false )

Check crate in range

Added for restricted eta triggers in Run 2

Summing within a crate proceeds as follows:
unsigned 14 bit Ex, Ey, Et sums are formed for each half crate
these sums (= opposite quadrants) are added (Et) or subtracted (Ex, Ey)
to give the crate totals
overflows are propagated using separate bits

Sum ET from modules belonging to this crate in two halves

Check for overflows then truncate quadrant sums

Form crate sums

For total ET we must check for further overflows

Definition at line 18 of file CrateEnergy.cxx.

                                                                                                                                   :
  m_crate(crate),
  m_crateEt(0),
  m_crateEx(0),
  m_crateEy(0),
  m_overflowT(0),
  m_overflowX(0),
  m_overflowY(0),
  m_restricted(restricted),
  m_debug(false)
  {
  if (m_crate > 1) return;
  if ((maskXE&0xff) != 0xff || (maskTE&0xff) != 0xff) m_restricted = true;
  
  unsigned int eT[2] = {0,0};
  unsigned int eX[2] = {0,0};
  unsigned int eY[2] = {0,0};
  for ( const ModuleEnergy* jem : *JEMs ) {
    int moduleInQuad = jem->module() % 8;
    if (jem->crate() == m_crate) {
      int quad = ( jem->module() < 8 ? 0 : 1 );
      if ((maskTE>>moduleInQuad)&1) {
        eT[quad] += jem->et();
        if ( jem->et() >= m_jemEtSaturation ) m_overflowT = 1;
      }
      if ((maskXE>>moduleInQuad)&1) {
        eX[quad] += jem->ex();
        eY[quad] += jem->ey();
        if ( jem->ex() >= m_jemEtSaturation ) m_overflowX = 1;
        if ( jem->ey() >= m_jemEtSaturation ) m_overflowY = 1;
      } 
    }  // Right crate?
  }   // Loop over JEMs
  
  const unsigned int mask = (1U << m_sumBits) - 1U;
  const int overflowValue = -static_cast<int>(mask + 1U);
  m_crateEt = eT[0] + eT[1];
  if (m_crateEt >= mask){
    m_overflowT = 1;
    m_crateEt = mask;
  }
 
 
  if (!m_overflowX) {
    m_crateEx = static_cast<int>(eX[0]) - static_cast<int>(eX[1]);
  } else {
    m_crateEx = overflowValue;
  }
 
  if (!m_overflowY) {
    m_crateEy = static_cast<int>(eY[0]) - static_cast<int>(eY[1]);
  } else {
    m_crateEy = overflowValue;
  }
  
 
  if (m_debug) {
    std::cout << "CrateEnergy: crate " << m_crate << " results " 
              << "\n   Et "  << m_crateEt << " overflow " << m_overflowT 
              << "\n   Ex "  << m_crateEx << " overflow " << m_overflowX 
              << "\n   Ey "  << m_crateEy << " overflow " << m_overflowY << std::endl;
              
  }
  
}

◆ CrateEnergy() [2/3]

LVL1::CrateEnergy::CrateEnergy	(	unsigned int	crate,
		const DataVector< EnergyCMXData > *	modules,
		uint32_t	maskXE = 0xff,
		uint32_t	maskTE = 0xff,
		bool	restricted = false )

Check crate in range

Added for restricted eta triggers in Run 2

Summing within a crate proceeds as follows:
unsigned 14 bit Ex, Ey, Et sums are formed for each half crate
these sums (= opposite quadrants) are added (Et) or subtracted (Ex, Ey)
to give the crate totals
overflows are propagated using separate bits

Sum ET from modules belonging to this crate in two halves

Check for overflows then truncate quadrant sums

Form crate sums

For total ET we must check for further overflows

Definition at line 97 of file CrateEnergy.cxx.

                                                                                                                                    :
  m_crate(crate),
  m_crateEt(0),
  m_crateEx(0),
  m_crateEy(0),
  m_overflowT(0),
  m_overflowX(0),
  m_overflowY(0),
  m_restricted(restricted),
  m_debug(false)
  {
  if (m_crate > 1) return;
  if ((maskXE&0xff) != 0xff || (maskTE&0xff) != 0xff) m_restricted = true;
  
  unsigned int eT[2] = {0,0};
  unsigned int eX[2] = {0,0};
  unsigned int eY[2] = {0,0};
  for ( const EnergyCMXData* jem : *JEMs ) {
    int moduleInQuad = jem->module() % 8;
    if ((unsigned int)jem->crate() == m_crate) {
      int quad = ( jem->module() < 8 ? 0 : 1 );
 
      if ((maskTE>>moduleInQuad)&1) {
        eT[quad] += jem->Et();
        if ( jem->Et() >= m_jemEtSaturation ) m_overflowT = 1;
      }
      if ((maskXE>>moduleInQuad)&1) {
        eX[quad] += jem->Ex();
        eY[quad] += jem->Ey();
        if ( jem->Ex() >= m_jemEtSaturation ) m_overflowX = 1;
        if ( jem->Ey() >= m_jemEtSaturation ) m_overflowY = 1;
      } 
    }
  }
  
  unsigned int mask = (1<<m_sumBits) - 1;
 
  m_crateEt = eT[0] + eT[1];
  if (m_crateEt >= mask){
    m_overflowT = 1;
    m_crateEt = mask;
  }
 
  if (!m_overflowX){
    m_crateEx = eX[0] - eX[1];
  } else{
    if (std::in_range<int>(-(mask + 1))) m_crateEx = -(mask + 1);
    else throw std::out_of_range("m_crateEx set value is out of integer range");
  }
  if (!m_overflowY){
    m_crateEy = eY[0] - eY[1];
  }else{
    if (std::in_range<int>(-(mask + 1))) m_crateEy = -(mask + 1);
    else throw std::out_of_range("m_crateEy set value is out of integer range");
  }
 
  if (m_debug) {
    std::cout << "CrateEnergy: crate " << m_crate << " results " 
              << "\n   Et "  << m_crateEt << " overflow " << m_overflowT 
              << "\n   Ex "  << m_crateEx << " overflow " << m_overflowX 
              << "\n   Ey "  << m_crateEy << " overflow " << m_overflowY << std::endl;
              
  }
  
}

◆ CrateEnergy() [3/3]

LVL1::CrateEnergy::CrateEnergy	(	unsigned int	crate,
		unsigned int	et,
		unsigned int	exTC,
		unsigned int	eyTC,
		unsigned int	overflowT,
		unsigned int	overflowX,
		unsigned int	overflowY,
		bool	restricted = false )

Check crate in range

Definition at line 177 of file CrateEnergy.cxx.

                                                  :
  m_crate(crate),
  m_crateEt(0),
  m_crateEx(0),
  m_crateEy(0),
  m_overflowT(0),
  m_overflowX(0),
  m_overflowY(0),
  m_restricted(restricted),
  m_debug(false)
{
  if (m_crate > 1) return;
  m_crateEt = et;
  m_crateEx = decodeTC(exTC);
  m_crateEy = decodeTC(eyTC);
  m_overflowT = overflowT;
  m_overflowX = overflowX;
  m_overflowY = overflowY;
 
  if (m_debug) {
    std::cout << "CrateEnergy: crate " << m_crate << " results " 
              << "\n   Et "  << m_crateEt << " overflow " << m_overflowT 
              << "\n   Ex "  << m_crateEx << " overflow " << m_overflowX 
              << "\n   Ey "  << m_crateEy << " overflow " << m_overflowY << std::endl;
              
  }
}

◆ ~CrateEnergy()

LVL1::CrateEnergy::~CrateEnergy ( )

Definition at line 209 of file CrateEnergy.cxx.

209 {

210}

Member Function Documentation

◆ crate()

unsigned int LVL1::CrateEnergy::crate ( ) const

return crate number

Definition at line 213 of file CrateEnergy.cxx.

                                      {
  return m_crate;
}

◆ decodeTC()

int LVL1::CrateEnergy::decodeTC ( unsigned int input ) const

private

decode 15-bit twos-complement format (hardware Ex/Ey format) as int

Definition at line 278 of file CrateEnergy.cxx.

                                                  {
 
  int mask = (1<<m_sumBitsTC) - 1;
  int value = input&mask;
 
  if ((value >> (m_sumBitsTC - 1))) {
    value += (~0U) << m_sumBitsTC;
  }
 
  return value;
}

◆ encodeTC()

unsigned int LVL1::CrateEnergy::encodeTC ( int input ) const

private

encode int as 15-bit twos-complement format (hardware Ex/Ey format)

Definition at line 263 of file CrateEnergy.cxx.

                                                  {
  unsigned int value;
 
  if (input > 0) {
    value = input;
  }
  else {
    value = (1<<m_sumBitsTC) + input;
  }
 
  int mask = (1<<m_sumBitsTC) - 1;
  return value&mask ;
}

◆ et()

int LVL1::CrateEnergy::et ( ) const

return et, ex, ey sums

return crate Et

Definition at line 218 of file CrateEnergy.cxx.

                          {
  return m_crateEt;
}

◆ etOverflow()

unsigned int LVL1::CrateEnergy::etOverflow ( ) const

return Et overflow bit

Definition at line 233 of file CrateEnergy.cxx.

                                           {
  return m_overflowT;
}

◆ ex()

int LVL1::CrateEnergy::ex ( ) const

return crate Ex

Definition at line 223 of file CrateEnergy.cxx.

                          {
  return m_crateEx;
}

◆ exOverflow()

unsigned int LVL1::CrateEnergy::exOverflow ( ) const

Overflow bits.

return Ex overflow bit

Definition at line 238 of file CrateEnergy.cxx.

                                           {
  return m_overflowX;
}

◆ exTC()

unsigned int LVL1::CrateEnergy::exTC ( ) const

15 bit twos-complement format

return crate Ex in 15-bit twos-complement format (hardware format)

Definition at line 253 of file CrateEnergy.cxx.

                                     {
  return encodeTC(m_crateEx);
}

◆ ey()

int LVL1::CrateEnergy::ey ( ) const

return crate Ey

Definition at line 228 of file CrateEnergy.cxx.

                          {
  return m_crateEy;
}

◆ eyOverflow()

unsigned int LVL1::CrateEnergy::eyOverflow ( ) const

return Ey overflow bit

Definition at line 243 of file CrateEnergy.cxx.

                                           {
  return m_overflowY;
}

◆ eyTC()

unsigned int LVL1::CrateEnergy::eyTC ( ) const

return crate Ey in 15-bit twos-complement format (hardware format)

Definition at line 258 of file CrateEnergy.cxx.

                                     {
  return encodeTC(m_crateEy);
}

◆ restricted()

bool LVL1::CrateEnergy::restricted ( ) const

Full or restricted eta range?

Full or Restricted eta range.

Definition at line 248 of file CrateEnergy.cxx.

                                   {
  return m_restricted;
}

Member Data Documentation

◆ m_crate

unsigned int LVL1::CrateEnergy::m_crate

private

Definition at line 56 of file CrateEnergy.h.

◆ m_crateEt

unsigned int LVL1::CrateEnergy::m_crateEt

private

Definition at line 57 of file CrateEnergy.h.

◆ m_crateEx

int LVL1::CrateEnergy::m_crateEx

private

Definition at line 58 of file CrateEnergy.h.

◆ m_crateEy

int LVL1::CrateEnergy::m_crateEy

private

Definition at line 59 of file CrateEnergy.h.

◆ m_debug

bool LVL1::CrateEnergy::m_debug

private

Definition at line 64 of file CrateEnergy.h.

◆ m_jemEtSaturation

const unsigned int LVL1::CrateEnergy::m_jemEtSaturation = 0x3fff

staticprivate

Definition at line 67 of file CrateEnergy.h.

◆ m_overflowT

unsigned int LVL1::CrateEnergy::m_overflowT

private

Definition at line 60 of file CrateEnergy.h.

◆ m_overflowX

unsigned int LVL1::CrateEnergy::m_overflowX

private

Definition at line 61 of file CrateEnergy.h.

◆ m_overflowY

unsigned int LVL1::CrateEnergy::m_overflowY

private

Definition at line 62 of file CrateEnergy.h.

◆ m_restricted

bool LVL1::CrateEnergy::m_restricted

private

Definition at line 63 of file CrateEnergy.h.

◆ m_sumBits

const unsigned int LVL1::CrateEnergy::m_sumBits =14

staticprivate

Definition at line 66 of file CrateEnergy.h.

◆ m_sumBitsTC

const unsigned int LVL1::CrateEnergy::m_sumBitsTC =15

staticprivate

Definition at line 65 of file CrateEnergy.h.

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

Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ CrateEnergy() [1/3]

◆ CrateEnergy() [2/3]

◆ CrateEnergy() [3/3]

◆ ~CrateEnergy()

Member Function Documentation

◆ crate()

◆ decodeTC()

◆ encodeTC()

◆ et()

◆ etOverflow()

◆ ex()

◆ exOverflow()

◆ exTC()

◆ ey()

◆ eyOverflow()

◆ eyTC()

◆ restricted()

Member Data Documentation

◆ m_crate

◆ m_crateEt

◆ m_crateEx

◆ m_crateEy

◆ m_debug

◆ m_jemEtSaturation

◆ m_overflowT

◆ m_overflowX

◆ m_overflowY

◆ m_restricted

◆ m_sumBits

◆ m_sumBitsTC