L1GctJetEtCalibrationLut Class Reference

Jet Et calibration LUT. More...

#include <L1GctJetEtCalibrationLut.h>

Inheritance diagram for L1GctJetEtCalibrationLut:

Public Member Functions
unsigned	etaBin () const
const L1GctJetFinderParams *	getFunction () const
const L1CaloEtScale *	getOutputEtScale () const
	L1GctJetEtCalibrationLut ()
void	setEtaBin (const unsigned eta)
void	setFunction (const L1GctJetFinderParams *const lutfn)
void	setOutputEtScale (const L1CaloEtScale *const scale)
	~L1GctJetEtCalibrationLut () override
Public Member Functions inherited from L1GctLut< 11, 6 >
uint16_t	lutValue (const uint16_t lutAddress) const
	Access the look-up table contents for a given Address. More...
int	operator!= (const L1GctLut< KAddressBits, KDataBits > &rhsLut) const
	Inequality check between look-up tables. More...
int	operator== (const L1GctLut< KAddressBits, KDataBits > &rhsLut) const
	Equality check between look-up tables. More...
uint16_t	operator[] (const uint16_t lutAddress) const
	Access the look-up table contents for a given Address. More...
void	setTerse ()
bool	setupOk ()
void	setVerbose ()
	control output messages More...
virtual	~L1GctLut ()

Static Public Attributes
static const unsigned	JET_ENERGY_BITWIDTH = 10
	Input bitwidth of jet energy; must be 10 or more. More...
static const int	NAddress = 11
static const int	NData = 6
Static Public Attributes inherited from L1GctLut< 11, 6 >
static const uint16_t	MAX_ADDRESS_BITMASK
static const uint16_t	MAX_DATA_BITMASK

Protected Member Functions
uint16_t	value (const uint16_t lutAddress) const override
Protected Member Functions inherited from L1GctLut< 11, 6 >
bool	equalityCheck (const L1GctLut< KAddressBits, KDataBits > &c) const
	L1GctLut ()

Private Attributes
uint8_t	m_etaBin
const L1GctJetFinderParams *	m_lutFunction
const L1CaloEtScale *	m_outputEtScale

Friends
std::ostream &	operator<< (std::ostream &os, const L1GctJetEtCalibrationLut &lut)
	Overload << operator. More...

Additional Inherited Members
Protected Attributes inherited from L1GctLut< 11, 6 >
bool	m_setupOk
bool	m_verbose

Detailed Description

Jet Et calibration LUT.

Author

Robert Frazier & Greg Heath

Date

May 2006

Input is 10 bit Et and tau veto bit. Separate LUTs for different eta. Output is 6 bit rank (for jet sorting).

Modified March 2007 to remove the actual calculation to a separate class Modified October 2008 to have separate LUTs for each eta, as in the firmware

Definition at line 28 of file L1GctJetEtCalibrationLut.h.

Constructor & Destructor Documentation

L1GctJetEtCalibrationLut()

L1GctJetEtCalibrationLut::L1GctJetEtCalibrationLut

(

)

Definition at line 12 of file L1GctJetEtCalibrationLut.cc.

: L1GctLut<NAddress, NData>() {}

~L1GctJetEtCalibrationLut()

L1GctJetEtCalibrationLut::~L1GctJetEtCalibrationLut ( )

override

Definition at line 14 of file L1GctJetEtCalibrationLut.cc.

{}

Member Function Documentation

etaBin()

unsigned L1GctJetEtCalibrationLut::etaBin ( ) const

inline

Definition at line 45 of file L1GctJetEtCalibrationLut.h.

{ return static_cast<unsigned>(m_etaBin); }

References m_etaBin.

Referenced by operator<<(), and value().

getFunction()

const L1GctJetFinderParams* L1GctJetEtCalibrationLut::getFunction ( ) const

inline

Definition at line 43 of file L1GctJetEtCalibrationLut.h.

{ return m_lutFunction; }

References m_lutFunction.

Referenced by operator<<().

getOutputEtScale()

const L1CaloEtScale* L1GctJetEtCalibrationLut::getOutputEtScale ( ) const

inline

Definition at line 44 of file L1GctJetEtCalibrationLut.h.

{ return m_outputEtScale; }

References m_outputEtScale.

setEtaBin()

void L1GctJetEtCalibrationLut::setEtaBin

(

const unsigned

eta

)

Definition at line 23 of file L1GctJetEtCalibrationLut.cc.

                                                           {
  static const unsigned nEtaBits = 4;
  static const uint8_t etaMask = static_cast<uint8_t>((1 << nEtaBits) - 1);
  m_etaBin = static_cast<uint8_t>(eta) & etaMask;
}

References PVValHelper::eta, and m_etaBin.

setFunction()

void L1GctJetEtCalibrationLut::setFunction

(

const L1GctJetFinderParams *const

lutfn

)

Definition at line 16 of file L1GctJetEtCalibrationLut.cc.

                                                                                  {
  m_lutFunction = lutfn;
  m_setupOk = (lutfn != nullptr);
}

References m_lutFunction, and L1GctLut< 11, 6 >::m_setupOk.

setOutputEtScale()

void L1GctJetEtCalibrationLut::setOutputEtScale

(

const L1CaloEtScale *const

scale

)

Definition at line 21 of file L1GctJetEtCalibrationLut.cc.

{ m_outputEtScale = scale; }

References m_outputEtScale, and L1EGammaCrystalsEmulatorProducer_cfi::scale.

value()

uint16_t L1GctJetEtCalibrationLut::value ( const uint16_t  lutAddress ) const

overrideprotectedvirtual

Implements L1GctLut< 11, 6 >.

Definition at line 29 of file L1GctJetEtCalibrationLut.cc.

                                                                        {
  static const uint16_t maxEtMask = static_cast<uint16_t>((1 << JET_ENERGY_BITWIDTH) - 1);
  static const uint16_t tauBitMask = static_cast<uint16_t>(1 << (JET_ENERGY_BITWIDTH));
  static const uint16_t ovrFlowOut = 0x3f;
  uint16_t jetEt = lutAddress & maxEtMask;
  // Check for saturation
  if (jetEt == maxEtMask) {
    return ovrFlowOut;
  } else {
    double uncoEt = static_cast<double>(jetEt) * m_outputEtScale->linearLsb();
    bool tauVeto = ((lutAddress & tauBitMask) == 0);
 
    double corrEt = m_lutFunction->correctedEtGeV(uncoEt, etaBin(), tauVeto);
    return m_outputEtScale->rank(corrEt);
  }
}

References L1GctJetFinderParams::correctedEtGeV(), etaBin(), JET_ENERGY_BITWIDTH, L1CaloEtScale::linearLsb(), m_lutFunction, m_outputEtScale, and L1CaloEtScale::rank().

Referenced by average.Average::average().

Friends And Related Function Documentation

operator<<

std::ostream& operator<< ( std::ostream &  os, const L1GctJetEtCalibrationLut &  lut  )

friend

Overload << operator.

Definition at line 46 of file L1GctJetEtCalibrationLut.cc.

                                                                            {
  os << std::endl;
  os << "==================================================" << std::endl;
  os << "===Level-1 Trigger:  GCT Jet Et Calibration Lut===" << std::endl;
  os << "==================================================" << std::endl;
  os << "===Parameter settings for eta bin " << lut.etaBin() << "===" << std::endl;
  os << *lut.getFunction() << std::endl;
  os << "\n===Lookup table contents===\n" << std::endl;
  const L1GctLut<L1GctJetEtCalibrationLut::NAddress, L1GctJetEtCalibrationLut::NData>* temp = &lut;
  os << *temp;
  return os;
}

Member Data Documentation

JET_ENERGY_BITWIDTH

const unsigned L1GctJetEtCalibrationLut::JET_ENERGY_BITWIDTH = 10

static

Input bitwidth of jet energy; must be 10 or more.

Definition at line 32 of file L1GctJetEtCalibrationLut.h.

Referenced by L1GctJet::lutValue(), and value().

m_etaBin

uint8_t L1GctJetEtCalibrationLut::m_etaBin

private

Definition at line 57 of file L1GctJetEtCalibrationLut.h.

Referenced by etaBin(), and setEtaBin().

m_lutFunction

const L1GctJetFinderParams* L1GctJetEtCalibrationLut::m_lutFunction

private

Definition at line 54 of file L1GctJetEtCalibrationLut.h.

Referenced by getFunction(), setFunction(), and value().

m_outputEtScale

const L1CaloEtScale* L1GctJetEtCalibrationLut::m_outputEtScale

private

Definition at line 55 of file L1GctJetEtCalibrationLut.h.

Referenced by getOutputEtScale(), setOutputEtScale(), and value().

NAddress

const int L1GctJetEtCalibrationLut::NAddress = 11

static

Definition at line 30 of file L1GctJetEtCalibrationLut.h.

NData

const int L1GctJetEtCalibrationLut::NData = 6

static

Definition at line 31 of file L1GctJetEtCalibrationLut.h.