Jet elements are the inputs to the Jet, ETmiss and ETsum triggers. More...

#include <JetElement.h>

Collaboration diagram for LVL1::JetElement:

Public Member Functions
	JetElement ()=default
	Default constructor. More...

	JetElement (double phi, double eta, int emEnergy, int hadEnergy, unsigned int key, int emError, int hadError, int linkError)
	Single slice constructor (some simulation tasks, legacy really) More...

	JetElement (double phi, double eta, const std::vector< int > &emEnergy, const std::vector< int > &hadEnergy, unsigned int key, const std::vector< int > &emError, const std::vector< int > &hadError, const std::vector< int > &linkError, int peak)
	Multi-slice constructor, e.g. More...

void	addEnergy (int emEnergy, int hadEnergy)
	Add ET to triggered time slice. More...

void	addSlice (int slice, int emEnergy, int hadEnergy, int emError, int hadError, int linkError)
	add data for one timeslice. More...

double	eta () const
	Eta of centre of JetElement. More...

double	phi () const
	Phi of centre of JetElement. More...

int	emEnergy () const
	Return ET for peak slice. More...

int	hadEnergy () const
	returns had ET More...

int	energy () const
	returns jet element ET The LVL1 Calo trigger uses a 10 bit integer i.e. More...

int	emSliceEnergy (int slice) const
	return the ET values for a specified slice More...

int	hadSliceEnergy (int slice) const

int	sliceEnergy (int slice) const

unsigned int	key () const
	Error codes and utility information. More...

bool	isSaturated () const
	returns TRUE if the JetElement is saturated (i.e. More...

bool	isEmSaturated () const
	returns TRUE if the Em layer of the JetElement is saturated More...

bool	isHadSaturated () const
	returns TRUE if the Had layer of the JetElement is saturated More...

int	emError () const
	return Em error More...

int	hadError () const
	return Had error More...

int	linkError () const
	return link error More...

int	peak () const
	return triggered slice offset More...

const std::vector< int > &	emEnergyVec () const
	Return data for all slices. More...

const std::vector< int > &	hadEnergyVec () const
	return Had energy vector reference (all timeslices) More...

const std::vector< int > &	emErrorVec () const
	return Em error vector reference (all timeslices) More...

const std::vector< int > &	hadErrorVec () const
	return Had error vector reference (all timeslices) More...

const std::vector< int > &	linkErrorVec () const
	return link error vector reference (all timeslices) More...

Coordinate	coord () const
	return coord of JE More...

Private Attributes
double	m_phi {}
	Internal data. More...

double	m_eta {}

unsigned int	m_key {}

int	m_peak {}

std::vector< int >	m_emEnergy {0}

std::vector< int >	m_hadEnergy {0}

std::vector< int >	m_em_error {0}

std::vector< int >	m_had_error {0}

std::vector< int >	m_link_error {0}

Static Private Attributes
static const int	m_saturationThreshold = 1023

static const int	m_layerSaturationThreshold = 511

Detailed Description

Jet elements are the inputs to the Jet, ETmiss and ETsum triggers.

They are formed in two stages: 2x2 Trigger Towers (EM or Had) are summed in the PreProcessor The corresponding EM and Had towers are summed in the Jet/Energy Module In the simulation, both of these stages are performed in the TrigT1CaloSim::JetElementMaker algorithm.

As for most L1Calo outputs, the hardware can read out a variable number of slices of data. Hence JetElement stores its internal data in vectors, and can return an individal slice of data or the entire vector.

Definition at line 43 of file Trigger/TrigT1/TrigT1CaloEvent/TrigT1CaloEvent/JetElement.h.

Constructor & Destructor Documentation

◆ JetElement() [1/3]

LVL1::JetElement::JetElement ( )

default

Default constructor.

◆ JetElement() [2/3]

LVL1::JetElement::JetElement	(	double	phi,
		double	eta,
		int	emEnergy,
		int	hadEnergy,
		unsigned int	key,
		int	emError,
		int	hadError,
		int	linkError
	)

Single slice constructor (some simulation tasks, legacy really)

constructs a jet element with one timeslice

Definition at line 31 of file JetElement.cxx.

 {
 }
  
 JetElement::JetElement(double phi, double eta,
                        const std::vector<int>& emEnergy,
                    const std::vector<int>& hadEnergy,

◆ JetElement() [3/3]

LVL1::JetElement::JetElement	(	double	phi,
		double	eta,
		const std::vector< int > &	emEnergy,
		const std::vector< int > &	hadEnergy,
		unsigned int	key,
		const std::vector< int > &	emError,
		const std::vector< int > &	hadError,
		const std::vector< int > &	linkError,
		int	peak
	)

Multi-slice constructor, e.g.

constructs a jet element with multiple timeslices

for bytestream decoding

Definition at line 47 of file JetElement.cxx.

                                                          :
   m_phi(phi),
   m_eta(eta),
   m_key(key),
   m_peak(peak),
   m_emEnergy(emEnergy),
   m_hadEnergy(hadEnergy),
   m_em_error(emError),
   m_had_error(hadError),
   m_link_error(linkError)
 {
 }
  
  
 double JetElement::eta() const{
     return m_eta;

Member Function Documentation

◆ addEnergy()

void LVL1::JetElement::addEnergy	(	int	emEnergy,
		int	hadEnergy
	)

Add ET to triggered time slice.

this will add energy to the JE.

It's really intended for JetElementMaker to use when creating JEs.

Definition at line 149 of file JetElement.cxx.

156 {

157 m_emEnergy[slice] =

◆ addSlice()

void LVL1::JetElement::addSlice	(	int	slice,
		int	emEnergy,
		int	hadEnergy,
		int	emError,
		int	hadError,
		int	linkError
	)

add data for one timeslice.

Used by bytestream converter.

Definition at line 160 of file JetElement.cxx.

                                                          : m_layerSaturationThreshold);
   m_em_error[slice]   = emError;
   m_had_error[slice]  = hadError;
   m_link_error[slice] = linkError;
   return;
 }
  
 unsigned int JetElement::key() const{
   return m_key;

◆ coord()

Coordinate LVL1::JetElement::coord ( ) const

return coord of JE

Definition at line 256 of file JetElement.cxx.

◆ emEnergy()

int LVL1::JetElement::emEnergy ( ) const

Return ET for peak slice.

returns em ET

Definition at line 78 of file JetElement.cxx.

                                {
   if (m_hadEnergy[m_peak] < m_layerSaturationThreshold) {
     return m_hadEnergy[m_peak];

◆ emEnergyVec()

const std::vector< int > & LVL1::JetElement::emEnergyVec ( ) const

Return data for all slices.

return Em energy vector reference (all timeslices)

Definition at line 231 of file JetElement.cxx.

                                                     {
   return m_hadEnergy;
 }

◆ emError()

int LVL1::JetElement::emError ( ) const

return Em error

Definition at line 211 of file JetElement.cxx.

                               {
   return m_had_error[m_peak];
 }

◆ emErrorVec()

const std::vector< int > & LVL1::JetElement::emErrorVec ( ) const

return Em error vector reference (all timeslices)

Definition at line 241 of file JetElement.cxx.

                                                    {
   return m_had_error;
 }

◆ emSliceEnergy()

int LVL1::JetElement::emSliceEnergy ( int slice ) const

return the ET values for a specified slice

return ET for specified slice

Definition at line 112 of file JetElement.cxx.

          {
       return m_layerSaturationThreshold;
     }
   }
   else return 0;
 }
  
 int JetElement::hadSliceEnergy(int slice) const{
   if (slice >=0 && slice < (int)m_hadEnergy.size()) {
     if (m_hadEnergy[slice] < m_layerSaturationThreshold) {
       return m_hadEnergy[slice];

◆ energy()

int LVL1::JetElement::energy ( ) const

returns jet element ET
The LVL1 Calo trigger uses a 10 bit integer i.e.

0-1023 GeV JetElements are treated as saturated if any of tower, layer or element ET exceed their dynamic range

Definition at line 101 of file JetElement.cxx.

        {
     return m_emEnergy[m_peak] + m_hadEnergy[m_peak];
   }
 }
  
 int JetElement::emSliceEnergy(int slice) const{
   if (slice >=0 && slice < (int)m_emEnergy.size()) {
     if (m_emEnergy[slice] < m_layerSaturationThreshold) {

◆ eta()

double LVL1::JetElement::eta ( ) const

Eta of centre of JetElement.

returns eta coord

Definition at line 68 of file JetElement.cxx.

                             {
     return m_phi;
 }

◆ hadEnergy()

int LVL1::JetElement::hadEnergy ( ) const

returns had ET

Definition at line 88 of file JetElement.cxx.

◆ hadEnergyVec()

const std::vector< int > & LVL1::JetElement::hadEnergyVec ( ) const

return Had energy vector reference (all timeslices)

Definition at line 236 of file JetElement.cxx.

                                                   {
   return m_em_error;
 }

◆ hadError()

int LVL1::JetElement::hadError ( ) const

return Had error

Definition at line 216 of file JetElement.cxx.

                                {
   return m_link_error[m_peak];
 }

◆ hadErrorVec()

const std::vector< int > & LVL1::JetElement::hadErrorVec ( ) const

return Had error vector reference (all timeslices)

Definition at line 246 of file JetElement.cxx.

                                                     {
   return m_link_error;
 }

◆ hadSliceEnergy()

int LVL1::JetElement::hadSliceEnergy ( int slice ) const

Definition at line 124 of file JetElement.cxx.

          {
       return m_layerSaturationThreshold;
     }
   }
   else return 0;
 }
  
 int JetElement::sliceEnergy(int slice) const{
   if ( (emSliceEnergy(slice)  >= m_layerSaturationThreshold) ||
        (hadSliceEnergy(slice) >= m_layerSaturationThreshold) ||
        (emSliceEnergy(slice) + hadSliceEnergy(slice) >= m_saturationThreshold) ){

◆ isEmSaturated()

bool LVL1::JetElement::isEmSaturated ( ) const

returns TRUE if the Em layer of the JetElement is saturated

Definition at line 193 of file JetElement.cxx.

                                      {
   if ( m_hadEnergy[m_peak] >= m_layerSaturationThreshold ){
     return true;

◆ isHadSaturated()

bool LVL1::JetElement::isHadSaturated ( ) const

returns TRUE if the Had layer of the JetElement is saturated

Definition at line 202 of file JetElement.cxx.

                              {
   return m_em_error[m_peak];
 }

◆ isSaturated()

bool LVL1::JetElement::isSaturated ( ) const

returns TRUE if the JetElement is saturated (i.e.

either the energy of the JetElement itself or that of one of its components exceeds its dynamic range) and FALSE otherwise.

Definition at line 181 of file JetElement.cxx.

        {
     return false;
   }
 }
  
  
 bool JetElement::isEmSaturated() const{
   if ( m_emEnergy[m_peak] >= m_layerSaturationThreshold ){

◆ key()

unsigned int LVL1::JetElement::key ( ) const

Error codes and utility information.

returns JE key - that is the key the JE had when it was created.

Added for bug-testing.

Definition at line 174 of file JetElement.cxx.

176 {

◆ linkError()

int LVL1::JetElement::linkError ( ) const

return link error

Definition at line 221 of file JetElement.cxx.

                           {
   return m_peak;
 }

◆ linkErrorVec()

const std::vector< int > & LVL1::JetElement::linkErrorVec ( ) const

return link error vector reference (all timeslices)

Definition at line 251 of file JetElement.cxx.

                                   {
   return Coordinate(m_phi,m_eta);
 }

◆ peak()

int LVL1::JetElement::peak ( ) const

return triggered slice offset

Definition at line 226 of file JetElement.cxx.

                                                    {
   return m_emEnergy;
 }

◆ phi()

double LVL1::JetElement::phi ( ) const

Phi of centre of JetElement.

returns phi coord of tower

Definition at line 73 of file JetElement.cxx.

                               {
   if (m_emEnergy[m_peak] < m_layerSaturationThreshold) {
     return m_emEnergy[m_peak];

◆ sliceEnergy()

int LVL1::JetElement::sliceEnergy ( int slice ) const

Definition at line 136 of file JetElement.cxx.

       {
     return emSliceEnergy(slice) + hadSliceEnergy(slice);
   }
 }
  
 void JetElement::addEnergy(int emEnergy, int hadEnergy){
   m_emEnergy[m_peak]  += emEnergy;

Member Data Documentation

◆ m_em_error

std::vector<int> LVL1::JetElement::m_em_error {0}

private

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

◆ m_emEnergy

std::vector<int> LVL1::JetElement::m_emEnergy {0}

private

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

◆ m_eta

double LVL1::JetElement::m_eta {}

private

Definition at line 103 of file Trigger/TrigT1/TrigT1CaloEvent/TrigT1CaloEvent/JetElement.h.

◆ m_had_error

std::vector<int> LVL1::JetElement::m_had_error {0}

private

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

◆ m_hadEnergy

std::vector<int> LVL1::JetElement::m_hadEnergy {0}

private

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

◆ m_key

unsigned int LVL1::JetElement::m_key {}

private

Definition at line 104 of file Trigger/TrigT1/TrigT1CaloEvent/TrigT1CaloEvent/JetElement.h.

◆ m_layerSaturationThreshold

const int LVL1::JetElement::m_layerSaturationThreshold = 511

staticprivate

Definition at line 113 of file Trigger/TrigT1/TrigT1CaloEvent/TrigT1CaloEvent/JetElement.h.

◆ m_link_error

std::vector<int> LVL1::JetElement::m_link_error {0}

private

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

◆ m_peak

int LVL1::JetElement::m_peak {}

private

Definition at line 105 of file Trigger/TrigT1/TrigT1CaloEvent/TrigT1CaloEvent/JetElement.h.

◆ m_phi

double LVL1::JetElement::m_phi {}

private

Internal data.

Definition at line 102 of file Trigger/TrigT1/TrigT1CaloEvent/TrigT1CaloEvent/JetElement.h.

◆ m_saturationThreshold

const int LVL1::JetElement::m_saturationThreshold = 1023

staticprivate

Definition at line 112 of file Trigger/TrigT1/TrigT1CaloEvent/TrigT1CaloEvent/JetElement.h.

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

Public Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ JetElement() [1/3]

◆ JetElement() [2/3]

◆ JetElement() [3/3]

Member Function Documentation

◆ addEnergy()

◆ addSlice()

◆ coord()

◆ emEnergy()

◆ emEnergyVec()

◆ emError()

◆ emErrorVec()

◆ emSliceEnergy()

◆ energy()

◆ eta()

◆ hadEnergy()

◆ hadEnergyVec()

◆ hadError()

◆ hadErrorVec()

◆ hadSliceEnergy()

◆ isEmSaturated()

◆ isHadSaturated()

◆ isSaturated()

◆ key()

◆ linkError()

◆ linkErrorVec()

◆ peak()

◆ phi()

◆ sliceEnergy()

Member Data Documentation

◆ m_em_error

◆ m_emEnergy

◆ m_eta

◆ m_had_error

◆ m_hadEnergy

◆ m_key

◆ m_layerSaturationThreshold

◆ m_link_error

◆ m_peak

◆ m_phi

◆ m_saturationThreshold