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

#include <SystemEnergy.h>

Collaboration diagram for LVL1::SystemEnergy:

Public Member Functions
	SystemEnergy (const DataVector< CrateEnergy > crates, const TrigConf::L1Menu l1Menu)
	SystemEnergy (unsigned int et, unsigned int exTC, unsigned int eyTC, unsigned int overflowT, unsigned int overflowX, unsigned int overflowY, unsigned int restricted, const TrigConf::L1Menu *l1Menu)
	~SystemEnergy ()=default
int	et () const
	return global 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
unsigned int	etMissHits () const
	Trigger Results.
unsigned int	etSumHits () const
	return EtSum hits
unsigned int	metSigHits () const
	return MEtSig hits
unsigned int	roiWord0 () const
	RoI words.
unsigned int	roiWord1 () const
	return RoI word 1 (Ey value & overflow, EtSum hits)
unsigned int	roiWord2 () const
	return RoI word 2 (Et value & overflow, EtMiss hits)

Private Member Functions
void	etMissTrigger ()
	Test Ex, Ey sums against ETmiss thresholds Regrettably not as simple as it sounds if we emulate hardware!
void	etSumTrigger ()
	Test Et sum against ETsum thresholds.
void	metSigTrigger ()
	Test MEt Significance against METSig thresholds.
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
const TrigConf::L1Menu *	m_L1Menu
int	m_systemEx
int	m_systemEy
int	m_systemEt
unsigned int	m_overflowX
unsigned int	m_overflowY
unsigned int	m_overflowT
unsigned int	m_restricted
unsigned int	m_etMissHits
unsigned int	m_etSumHits
unsigned int	m_metSigHits
uint32_t	m_etMissQ
bool	m_debug

Static Private Attributes
static const unsigned int	m_sumBits =15
static const int	m_maxEtSumThr =0x3fff
static const int	m_etSumOverflow =0x7fff

Detailed Description

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

Definition at line 30 of file SystemEnergy.h.

Constructor & Destructor Documentation

◆ SystemEnergy() [1/2]

LVL1::SystemEnergy::SystemEnergy	(	const DataVector< CrateEnergy > *	crates,
		const TrigConf::L1Menu *	l1Menu )

Get Ex, Ey, ET sums from crates and form global sums
Propagate overflows and test for new ones

Check for EtSum overflow

Having completed sums, we can now compare with thresholds

Definition at line 21 of file SystemEnergy.cxx.

                                                                                              : m_L1Menu(l1Menu),
                                                                                                                    m_systemEx(0),
                                                                                                                    m_systemEy(0),
                                                                                                                    m_systemEt(0),
                                                                                                                    m_overflowX(0),
                                                                                                                    m_overflowY(0),
                                                                                                                    m_overflowT(0),
                                                                                                                    m_restricted(0),
                                                                                                                    m_etMissHits(0),
                                                                                                                    m_etSumHits(0),
                                                                                                                    m_metSigHits(0),
                                                                                                                    m_debug(false)
{
 
  int xyMax = 1 << (m_sumBits - 1);
 
  for (const CrateEnergy* cr : *crates)
  {
    if (cr->crate() == 0)
    {
      m_systemEx += cr->ex();
      m_systemEy += cr->ey();
      m_systemEt += cr->et();
    }
    else if (cr->crate() == 1)
    {
      m_systemEx -= cr->ex();
      m_systemEy += cr->ey();
      m_systemEt += cr->et();
    }
    
    m_overflowX = m_overflowX | (cr->ex() == -xyMax);
    m_overflowY = m_overflowY | (cr->ey() == -xyMax);
    m_overflowT = m_overflowT | (cr->et() == m_maxEtSumThr);
 
    if (cr->restricted())
      m_restricted = 1;
  }
  if (m_overflowT != 0) {
    m_systemEt = m_etSumOverflow;
  }
    
 
 
  if ((abs(m_systemEx) >= xyMax) || m_overflowX)
  {
    m_overflowX = 1;
    m_systemEx = -xyMax;
  }
 
  if ((abs(m_systemEy) >= xyMax) || m_overflowY)
  {
    m_overflowY = 1;
    m_systemEy = -xyMax;
  }
 
  if (m_debug)
  {
    std::cout << "SystemEnergy results: " << std::endl
              << "   Et " << m_systemEt << " overflow " << m_overflowT << std::endl
              << "   Ex " << m_systemEx << " overflow " << m_overflowX << std::endl
              << "   Ey " << m_systemEy << " overflow " << m_overflowY << std::endl;
  }
  etMissTrigger();
  etSumTrigger();
  metSigTrigger();
}

◆ SystemEnergy() [2/2]

LVL1::SystemEnergy::SystemEnergy	(	unsigned int	et,
		unsigned int	exTC,
		unsigned int	eyTC,
		unsigned int	overflowT,
		unsigned int	overflowX,
		unsigned int	overflowY,
		unsigned int	restricted,
		const TrigConf::L1Menu *	l1Menu )

Having completed sums, we can now compare with thresholds

Definition at line 96 of file SystemEnergy.cxx.

                                                         : m_L1Menu(l1Menu),
                                                                             m_systemEx(0),
                                                                             m_systemEy(0),
                                                                             m_systemEt(et),
                                                                             m_overflowX(overflowX),
                                                                             m_overflowY(overflowY),
                                                                             m_overflowT(overflowT),
                                                                             m_restricted(restricted),
                                                                             m_etMissHits(0),
                                                                             m_etSumHits(0),
                                                                             m_metSigHits(0),
                                                                             m_debug(false)
{
 
  m_systemEx = decodeTC(exTC);
  m_systemEy = decodeTC(eyTC);
 
  int xyMax = 1 << (m_sumBits - 1);
 
  m_overflowT = m_systemEt == m_etSumOverflow;
  m_overflowX = m_systemEx == -xyMax;
  m_overflowY = m_systemEy == -xyMax;
 
  if (m_debug)
  {
    std::cout << "SystemEnergy results: " << std::endl
              << "   Et " << m_systemEt << " overflow " << m_overflowT << std::endl
              << "   Ex " << m_systemEx << " overflow " << m_overflowX << std::endl
              << "   Ey " << m_systemEy << " overflow " << m_overflowY << std::endl;
  }
  etMissTrigger();
  etSumTrigger();
  metSigTrigger();
}

◆ ~SystemEnergy()

LVL1::SystemEnergy::~SystemEnergy ( )

default

Member Function Documentation

◆ decodeTC()

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

private

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

Definition at line 430 of file SystemEnergy.cxx.

{
 
  int mask = (1 << m_sumBits) - 1;
  int value = input & mask;
 
  if ((value >> (m_sumBits - 1)))
  {
    int complement = ~value;
    value = -((complement + 1) & mask);
  }
 
  return value;
}

◆ encodeTC()

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

private

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

Definition at line 412 of file SystemEnergy.cxx.

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

◆ et()

int LVL1::SystemEnergy::et ( ) const

return global et, ex, ey sums

return crate Et

Definition at line 138 of file SystemEnergy.cxx.

{
  return m_systemEt;
}

◆ etMissHits()

unsigned int LVL1::SystemEnergy::etMissHits ( ) const

Trigger Results.

return EtMiss hits

Definition at line 186 of file SystemEnergy.cxx.

{
  return m_etMissHits;
}

◆ etMissTrigger()

void LVL1::SystemEnergy::etMissTrigger ( )

private

Test Ex, Ey sums against ETmiss thresholds
Regrettably not as simple as it sounds if we emulate hardware!

See CMM specificiation from L1Calo web pages for details

Start cleanly

Calculate MET^2

Ex or Ey overflow automatically fires all thresholds

Otherwise see which thresholds were passed

Definition at line 257 of file SystemEnergy.cxx.

{
  m_etMissHits = 0;
  m_etMissQ = m_systemEx * m_systemEx + m_systemEy * m_systemEy;
  if ((m_overflowX != 0) || (m_overflowY != 0))
  {
    m_etMissHits = (1 << TrigT1CaloDefs::numOfMissingEtThresholds) - 1;
    return;
  }
 
  // Get thresholds
  std::vector<std::shared_ptr<TrigConf::L1Threshold>> allThresholds = m_L1Menu->thresholds();
 
  // get Threshold values and test
 
  for ( const auto& thresh : allThresholds ) {
    if ( thresh->type() == L1DataDef::typeAsString(L1DataDef::XE) ) {
      auto thresh_Calo = static_cast<const TrigConf::L1Threshold_Calo*>(thresh.get());
      unsigned int thresholdValue = thresh_Calo->thrValueCounts();
      uint32_t tvQ = thresholdValue * thresholdValue;
      int threshNumber = thresh->mapping();
      if (m_restricted == 0 && threshNumber < 8)
      {
        if (m_etMissQ > tvQ)
          m_etMissHits = m_etMissHits | (1 << threshNumber);
      }
      else if (m_restricted != 0 && threshNumber >= 8)
      {
        if (m_etMissQ > tvQ)
          m_etMissHits = m_etMissHits | (1 << (threshNumber - 8));
      }
    }
  }
 
  return;
}

◆ etOverflow()

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

return Et overflow bit

Definition at line 156 of file SystemEnergy.cxx.

{
  return m_overflowT & 0x1;
}

◆ etSumHits()

unsigned int LVL1::SystemEnergy::etSumHits ( ) const

return EtSum hits

Definition at line 192 of file SystemEnergy.cxx.

{
  return m_etSumHits;
}

◆ etSumTrigger()

void LVL1::SystemEnergy::etSumTrigger ( )

private

Test Et sum against ETsum thresholds.

Definition at line 302 of file SystemEnergy.cxx.

{
  // Start cleanly
  m_etSumHits = 0;
 
  // Overflow of any sort automatically fires all thresholds
  if (m_overflowT != 0 || m_systemEt > m_maxEtSumThr)
  {
    m_etSumHits = (1 << TrigT1CaloDefs::numOfSumEtThresholds) - 1;
    return;
  }
 
  // Get thresholds
  std::vector<std::shared_ptr<TrigConf::L1Threshold>> allThresholds = m_L1Menu->thresholds();
 
  // get Threshold values and test
  // Since eta-dependent values are being used to disable TE in regions, must find lowest value for each threshold
  for ( const auto& thresh : allThresholds ) {
    if ( thresh->type() == L1DataDef::typeAsString(L1DataDef::TE) ) {
      int threshNumber = thresh->mapping();
      int thresholdValue = m_maxEtSumThr;
      auto thresh_Calo = static_cast<const TrigConf::L1Threshold_Calo*>(thresh.get());
      auto tvcs = thresh_Calo->thrValuesCounts();
      if (tvcs.size() == 0) {
        tvcs.addRangeValue(thresh_Calo->thrValueCounts(),-49, 49, 1, true);
      }
      for (const auto& tVC : tvcs) {
        if (static_cast<int>(tVC.value()) < thresholdValue) {
          thresholdValue = tVC.value();
        }
      }
 
      if (m_restricted == 0 && threshNumber < 8)
      {
        if (static_cast<int>(m_systemEt) > thresholdValue)
          m_etSumHits = m_etSumHits | (1 << threshNumber);
      }
      else if (m_restricted != 0 && threshNumber >= 8)
      {
        if (static_cast<int>(m_systemEt) > thresholdValue)
          m_etSumHits = m_etSumHits | (1 << (threshNumber - 8));
      }
    }
  }
 
  return;
}

◆ ex()

int LVL1::SystemEnergy::ex ( ) const

return crate Ex

Definition at line 144 of file SystemEnergy.cxx.

{
  return m_systemEx;
}

◆ exOverflow()

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

Overflow bits.

return Ex overflow bit

Definition at line 162 of file SystemEnergy.cxx.

{
  return m_overflowX & 0x1;
}

◆ exTC()

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

15 bit twos-complement format

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

Definition at line 174 of file SystemEnergy.cxx.

{
  return encodeTC(m_systemEx);
}

◆ ey()

int LVL1::SystemEnergy::ey ( ) const

return crate Ey

Definition at line 150 of file SystemEnergy.cxx.

{
  return m_systemEy;
}

◆ eyOverflow()

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

return Ey overflow bit

Definition at line 168 of file SystemEnergy.cxx.

{
  return m_overflowY & 0x1;
}

◆ eyTC()

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

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

Definition at line 180 of file SystemEnergy.cxx.

{
  return encodeTC(m_systemEy);
}

◆ metSigHits()

unsigned int LVL1::SystemEnergy::metSigHits ( ) const

return MEtSig hits

Definition at line 198 of file SystemEnergy.cxx.

{
  return m_metSigHits;
}

◆ metSigTrigger()

void LVL1::SystemEnergy::metSigTrigger ( )

private

Test MEt Significance against METSig thresholds.

Start cleanly

No restricted eta MET significance trigger

Obtain parameters from configuration service

Start with overflow and range checks

Perform threshold tests. Emulate firmware logic for this, so don't explicitly calculate XS Prepare factors we wil re-use for each threshold. Scale bQ to hardware precision

get Threshold values and test aQTiQ has to be scaled to hardware precision after product formed

Definition at line 351 of file SystemEnergy.cxx.

{
  m_metSigHits = 0;
  if (m_restricted != 0)
    return;
  auto& params = m_L1Menu->thrExtraInfo().XS();
  unsigned int Scale = params.xsSigmaScale();
  unsigned int Offset = params.xsSigmaOffset();
  unsigned int XEmin = params.xeMin();
  unsigned int XEmax = params.xeMax();
  int sqrtTEmin = params.teSqrtMin();
  int sqrtTEmax = params.teSqrtMax();
  if ((m_overflowX > 0) || (m_overflowY > 0) || (m_etMissQ > XEmax * XEmax))
  {
    m_metSigHits = (1 << TrigT1CaloDefs::numOfMEtSigThresholds) - 1;
    return;
  }
  else if ((m_etMissQ < XEmin * XEmin) || (m_systemEt < sqrtTEmin * sqrtTEmin) || (m_systemEt > sqrtTEmax * sqrtTEmax))
  {
    return;
  }
  unsigned long aQ = Scale * Scale;
  unsigned int bQ = ceil(Offset * Offset * 1.e-6);
  unsigned long fourbQTE = 4 * bQ * m_systemEt;
 
  // Get thresholds
  std::vector<std::shared_ptr<TrigConf::L1Threshold>> allThresholds = m_L1Menu->thresholds();
  for ( const auto& thresh : allThresholds ) {
    if ( thresh->type() == L1DataDef::typeAsString(L1DataDef::XS) ) {
 
      int threshNumber = thresh->mapping();
      auto thresh_Calo = static_cast<const TrigConf::L1Threshold_Calo*>(thresh.get());
      unsigned int Ti = thresh_Calo->thrValueCounts();
      unsigned long aQTiQ = (0.5 + double(aQ * 1.e-8) * Ti * Ti);
 
      long left = aQTiQ * aQTiQ * fourbQTE;
      long right = aQTiQ * (m_systemEt + bQ) - m_etMissQ;
 
      if (right < 0 || left > right * right)
        m_metSigHits = m_metSigHits | (1 << threshNumber);
    }
  }
 
  return;
}

◆ roiWord0()

unsigned int LVL1::SystemEnergy::roiWord0 ( ) const

RoI words.

return RoI word 0 (Ex value & overflow)

Definition at line 204 of file SystemEnergy.cxx.

{
  // Start by setting up header
  unsigned int word = TrigT1CaloDefs::energyRoIType << 30;
  word += TrigT1CaloDefs::energyRoI0 << 28;
  // set full/restricted eta range flag
  word += (m_restricted & 1) << 26;
  // add MET Significance hits
  word += metSigHits() << 16;
  // add Ex overflow bit
  word += exOverflow() << 15;
  // add Ex value (twos-complement)
  word += exTC();
  return word;
}

◆ roiWord1()

unsigned int LVL1::SystemEnergy::roiWord1 ( ) const

return RoI word 1 (Ey value & overflow, EtSum hits)

Definition at line 221 of file SystemEnergy.cxx.

{
  // Start by setting up header
  unsigned int word = TrigT1CaloDefs::energyRoIType << 30;
  word += TrigT1CaloDefs::energyRoI1 << 28;
  // set full/restricted eta range flag
  word += (m_restricted & 1) << 26;
  // add EtSum hits
  word += etSumHits() << 16;
  // add Ey overflow bit
  word += eyOverflow() << 15;
  // add Ey value (twos-complement)
  word += eyTC();
  return word;
}

◆ roiWord2()

unsigned int LVL1::SystemEnergy::roiWord2 ( ) const

return RoI word 2 (Et value & overflow, EtMiss hits)

Definition at line 238 of file SystemEnergy.cxx.

{
  // Start by setting up header
  unsigned int word = TrigT1CaloDefs::energyRoIType << 30;
  word += TrigT1CaloDefs::energyRoI2 << 28;
  // set full/restricted eta range flag
  word += (m_restricted & 1) << 26;
  // add EtMiss hits
  word += etMissHits() << 16;
  // add Et overflow bit
  word += etOverflow() << 15;
  // add Et value (unsigned)
  word += et();
  return word;
}

Member Data Documentation

◆ m_debug

bool LVL1::SystemEnergy::m_debug

private

Definition at line 78 of file SystemEnergy.h.

◆ m_etMissHits

unsigned int LVL1::SystemEnergy::m_etMissHits

private

Definition at line 71 of file SystemEnergy.h.

◆ m_etMissQ

uint32_t LVL1::SystemEnergy::m_etMissQ

private

Definition at line 74 of file SystemEnergy.h.

◆ m_etSumHits

unsigned int LVL1::SystemEnergy::m_etSumHits

private

Definition at line 72 of file SystemEnergy.h.

◆ m_etSumOverflow

const int LVL1::SystemEnergy::m_etSumOverflow =0x7fff

staticprivate

Definition at line 77 of file SystemEnergy.h.

◆ m_L1Menu

const TrigConf::L1Menu* LVL1::SystemEnergy::m_L1Menu

private

Definition at line 62 of file SystemEnergy.h.

◆ m_maxEtSumThr

const int LVL1::SystemEnergy::m_maxEtSumThr =0x3fff

staticprivate

Definition at line 76 of file SystemEnergy.h.

◆ m_metSigHits

unsigned int LVL1::SystemEnergy::m_metSigHits

private

Definition at line 73 of file SystemEnergy.h.

◆ m_overflowT

unsigned int LVL1::SystemEnergy::m_overflowT

private

Definition at line 69 of file SystemEnergy.h.

◆ m_overflowX

unsigned int LVL1::SystemEnergy::m_overflowX

private

Definition at line 67 of file SystemEnergy.h.

◆ m_overflowY

unsigned int LVL1::SystemEnergy::m_overflowY

private

Definition at line 68 of file SystemEnergy.h.

◆ m_restricted

unsigned int LVL1::SystemEnergy::m_restricted

private

Definition at line 70 of file SystemEnergy.h.

◆ m_sumBits

const unsigned int LVL1::SystemEnergy::m_sumBits =15

staticprivate

Definition at line 75 of file SystemEnergy.h.

◆ m_systemEt

int LVL1::SystemEnergy::m_systemEt

private

Definition at line 66 of file SystemEnergy.h.

◆ m_systemEx

int LVL1::SystemEnergy::m_systemEx

private

Definition at line 64 of file SystemEnergy.h.

◆ m_systemEy

int LVL1::SystemEnergy::m_systemEy

private

Definition at line 65 of file SystemEnergy.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

◆ SystemEnergy() [1/2]

◆ SystemEnergy() [2/2]

◆ ~SystemEnergy()

Member Function Documentation

◆ decodeTC()

◆ encodeTC()

◆ et()

◆ etMissHits()

◆ etMissTrigger()

◆ etOverflow()

◆ etSumHits()

◆ etSumTrigger()

◆ ex()

◆ exOverflow()

◆ exTC()

◆ ey()

◆ eyOverflow()

◆ eyTC()

◆ metSigHits()

◆ metSigTrigger()

◆ roiWord0()

◆ roiWord1()

◆ roiWord2()

Member Data Documentation

◆ m_debug

◆ m_etMissHits

◆ m_etMissQ

◆ m_etSumHits

◆ m_etSumOverflow

◆ m_L1Menu

◆ m_maxEtSumThr

◆ m_metSigHits

◆ m_overflowT

◆ m_overflowX

◆ m_overflowY

◆ m_restricted

◆ m_sumBits

◆ m_systemEt

◆ m_systemEx

◆ m_systemEy