LUT for conversion of Ht components x and y to magnitude and angle. More...

#include <L1GctHtMissLut.h>

Inheritance diagram for L1GctHtMissLut:

Public Types
enum	numberOfBits { kHxOrHyMissComponentNBits = 8, kHtMissMagnitudeNBits = 7, kHtMissAngleNBits = 5 }

Public Member Functions
const double	componentLsb () const

const L1CaloEtScale *	etScale () const
	Return the Lut functions and parameters. More...

std::vector< unsigned >	getThresholdsGct () const

std::vector< double >	getThresholdsGeV () const
	Get thresholds. More...

	L1GctHtMissLut ()
	Default constructor. More...

	L1GctHtMissLut (const L1CaloEtScale *const scale, const double lsb)
	Constructor for use with emulator. More...

	L1GctHtMissLut (const L1GctHtMissLut &lut)
	Copy constructor. More...

L1GctHtMissLut	operator= (const L1GctHtMissLut &lut)
	Overload = operator. More...

void	setEtScale (const L1CaloEtScale *const fn)
	Set the functions. More...

void	setExEyLsb (const double lsb)

	~L1GctHtMissLut () override
	Destructor. More...

Public Member Functions inherited from L1GctLut< 16, 12 >
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 int	NAddress = 2 * L1GctHtMissLut::kHxOrHyMissComponentNBits

static const int	NData = L1GctHtMissLut::kHtMissMagnitudeNBits + L1GctHtMissLut::kHtMissAngleNBits

Static Public Attributes inherited from L1GctLut< 16, 12 >
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< 16, 12 >
bool	equalityCheck (const L1GctLut< KAddressBits, KDataBits > &c) const

	L1GctLut ()

Private Attributes
double	m_componentLsb

const L1CaloEtScale *	m_etScale

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

Additional Inherited Members
Protected Attributes inherited from L1GctLut< 16, 12 >
bool	m_setupOk

bool	m_verbose

Detailed Description

LUT for conversion of Ht components x and y to magnitude and angle.

Author: Greg Heath

Date: September 2008

Definition at line 20 of file L1GctHtMissLut.h.

Member Enumeration Documentation

◆ numberOfBits

enum L1GctHtMissLut::numberOfBits

Enumerator
kHxOrHyMissComponentNBits
kHtMissMagnitudeNBits
kHtMissAngleNBits

Definition at line 24 of file L1GctHtMissLut.h.

24 { kHxOrHyMissComponentNBits = 8, kHtMissMagnitudeNBits = 7, kHtMissAngleNBits = 5 };

Constructor & Destructor Documentation

◆ L1GctHtMissLut() [1/3]

L1GctHtMissLut::L1GctHtMissLut	(	const L1CaloEtScale *const	scale,
		const double	lsb
	)

Constructor for use with emulator.

Definition at line 11 of file L1GctHtMissLut.cc.

     : L1GctLut<NAddress, NData>(), m_etScale(scale), m_componentLsb(lsb) {
   if (scale != nullptr)
     m_setupOk = true;
 }

References L1GctLut< 16, 12 >::m_setupOk, and L1EGammaCrystalsEmulatorProducer_cfi::scale.

◆ L1GctHtMissLut() [2/3]

L1GctHtMissLut::L1GctHtMissLut ( )

Default constructor.

Definition at line 17 of file L1GctHtMissLut.cc.

17 : L1GctLut<NAddress, NData>(), m_etScale(nullptr), m_componentLsb(1.0) {}

◆ L1GctHtMissLut() [3/3]

L1GctHtMissLut::L1GctHtMissLut ( const L1GctHtMissLut & lut )

Copy constructor.

Definition at line 19 of file L1GctHtMissLut.cc.

     : L1GctLut<NAddress, NData>(), m_etScale(lut.etScale()), m_componentLsb(lut.componentLsb()) {
   if (m_etScale != nullptr)
     m_setupOk = true;
 }

References m_etScale, and L1GctLut< 16, 12 >::m_setupOk.

◆ ~L1GctHtMissLut()

L1GctHtMissLut::~L1GctHtMissLut ( )

override

Destructor.

Definition at line 25 of file L1GctHtMissLut.cc.

25 {}

Member Function Documentation

◆ componentLsb()

const double L1GctHtMissLut::componentLsb ( ) const

inline

Definition at line 55 of file L1GctHtMissLut.h.

55 { return m_componentLsb; }

References m_componentLsb.

Referenced by L1GctMet::componentLsb().

◆ etScale()

const L1CaloEtScale* L1GctHtMissLut::etScale ( ) const

inline

Return the Lut functions and parameters.

Definition at line 54 of file L1GctHtMissLut.h.

54 { return m_etScale; }

References m_etScale.

Referenced by L1GctMet::etScale().

◆ getThresholdsGct()

std::vector< unsigned > L1GctHtMissLut::getThresholdsGct ( ) const

Definition at line 70 of file L1GctHtMissLut.cc.

                                                            {
   std::vector<unsigned> result;
   std::vector<double> thresholdsGeV = m_etScale->getThresholds();
   for (std::vector<double>::const_iterator thr = thresholdsGeV.begin(); thr != thresholdsGeV.end(); thr++) {
     result.push_back(static_cast<unsigned>((*thr) / (m_componentLsb)));
   }
   return result;
 }

References L1CaloEtScale::getThresholds(), m_componentLsb, m_etScale, and mps_fire::result.

◆ getThresholdsGeV()

std::vector< double > L1GctHtMissLut::getThresholdsGeV ( ) const

Get thresholds.

Definition at line 68 of file L1GctHtMissLut.cc.

68 { return m_etScale->getThresholds(); }

References L1CaloEtScale::getThresholds(), and m_etScale.

◆ operator=()

L1GctHtMissLut L1GctHtMissLut::operator= ( const L1GctHtMissLut & lut )

Overload = operator.

Definition at line 79 of file L1GctHtMissLut.cc.

                                                                   {
   const L1GctHtMissLut& temp(lut);
   return temp;
 }

References groupFilesInBlocks::temp.

◆ setEtScale()

void L1GctHtMissLut::setEtScale ( const L1CaloEtScale *const fn )

inline

Set the functions.

Definition at line 45 of file L1GctHtMissLut.h.

                                                  {
     m_etScale = fn;
     if (fn != nullptr) {
       m_setupOk = true;
     }
   }

References personalPlayback::fn, m_etScale, and L1GctLut< 16, 12 >::m_setupOk.

Referenced by L1GctMet::setEtScale().

◆ setExEyLsb()

void L1GctHtMissLut::setExEyLsb ( const double lsb )

inline

Definition at line 51 of file L1GctHtMissLut.h.

51 { m_componentLsb = lsb; }

References hgcalVFEProducer_cfi::lsb, and m_componentLsb.

Referenced by L1GctMet::setEtComponentLsb().

◆ value()

uint16_t L1GctHtMissLut::value ( const uint16_t lutAddress ) const

overrideprotectedvirtual

Implements L1GctLut< 16, 12 >.

Definition at line 27 of file L1GctHtMissLut.cc.

                                                               {
   uint16_t result = 0;
  
   if (lutAddress != 0) {
     static const int maxComponent = 1 << kHxOrHyMissComponentNBits;
     static const int componentMask = maxComponent - 1;
  
     static const int magnitudeMask = (1 << kHtMissMagnitudeNBits) - 1;
     static const int angleMask = (1 << kHtMissAngleNBits) - 1;
  
     // Extract the bits corresponding to hx and hy components
     int hxCompGct = static_cast<int>(lutAddress >> kHxOrHyMissComponentNBits) & componentMask;
     int hyCompGct = static_cast<int>(lutAddress) & componentMask;
  
     // These are twos-complement integers - if the MSB is set, the value is negative
     if (hxCompGct >= maxComponent / 2)
       hxCompGct -= maxComponent;
     if (hyCompGct >= maxComponent / 2)
       hyCompGct -= maxComponent;
  
     // Convert to GeV. Add 0.5 to each component to compensate for truncation errors.
     double hxCompGeV = m_componentLsb * (static_cast<double>(hxCompGct) + 0.5);
     double hyCompGeV = m_componentLsb * (static_cast<double>(hyCompGct) + 0.5);
  
     // Convert to magnitude and angle
     double htMissMag = sqrt(hxCompGeV * hxCompGeV + hyCompGeV * hyCompGeV);
     double htMissAng = atan2(hyCompGeV, hxCompGeV);
     if (htMissAng < 0.0)
       htMissAng += 2.0 * M_PI;
  
     // Convert back to integer
     int htMissMagBits = static_cast<int>(m_etScale->rank(htMissMag)) & magnitudeMask;
     int htMissAngBits = static_cast<int>(htMissAng * 9.0 / M_PI) & angleMask;
  
     // Form the lut output
     result = (htMissMagBits << kHtMissAngleNBits) | htMissAngBits;
   }
  
   return result;
 }

References kHtMissAngleNBits, kHtMissMagnitudeNBits, kHxOrHyMissComponentNBits, m_componentLsb, m_etScale, M_PI, L1CaloEtScale::rank(), mps_fire::result, and mathSSE::sqrt().

Referenced by average.Average::average().

Friends And Related Function Documentation

◆ operator<<

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

friend

Overload << operator.

Definition at line 84 of file L1GctHtMissLut.cc.

                                                                   {
   os << "===L1GctHtMissLut===" << std::endl;
   std::vector<double> thresholds = lut.m_etScale->getThresholds();
   std::vector<double>::const_iterator thr = thresholds.begin();
   os << "Thresholds are: " << *(thr++);
   for (; thr != thresholds.end(); thr++) {
     os << ", " << *thr;
   }
   os << std::endl;
   os << "Max values for input to et scale " << lut.m_etScale->linScaleMax() << " and for output "
      << lut.m_etScale->rankScaleMax() << std::endl;
   os << "LSB used for conversion is " << lut.m_componentLsb << " GeV" << std::endl;
   os << "\n===Lookup table contents===\n" << std::endl;
   const L1GctLut<L1GctHtMissLut::NAddress, L1GctHtMissLut::NData>* temp = &lut;
   os << *temp;
   return os;
 }

Member Data Documentation

◆ m_componentLsb

double L1GctHtMissLut::m_componentLsb

private

Definition at line 67 of file L1GctHtMissLut.h.

Referenced by componentLsb(), getThresholdsGct(), operator<<(), setExEyLsb(), and value().

◆ m_etScale

const L1CaloEtScale* L1GctHtMissLut::m_etScale

private

Definition at line 65 of file L1GctHtMissLut.h.

Referenced by etScale(), getThresholdsGct(), getThresholdsGeV(), L1GctHtMissLut(), operator<<(), setEtScale(), and value().

◆ NAddress

const int L1GctHtMissLut::NAddress = 2 * L1GctHtMissLut::kHxOrHyMissComponentNBits

static

Definition at line 27 of file L1GctHtMissLut.h.

◆ NData

const int L1GctHtMissLut::NData = L1GctHtMissLut::kHtMissMagnitudeNBits + L1GctHtMissLut::kHtMissAngleNBits

static

Definition at line 27 of file L1GctHtMissLut.h.

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ numberOfBits

Constructor & Destructor Documentation

◆ L1GctHtMissLut() [1/3]

◆ L1GctHtMissLut() [2/3]

◆ L1GctHtMissLut() [3/3]

◆ ~L1GctHtMissLut()

Member Function Documentation

◆ componentLsb()

◆ etScale()

◆ getThresholdsGct()

◆ getThresholdsGeV()

◆ operator=()

◆ setEtScale()

◆ setExEyLsb()

◆ value()

Friends And Related Function Documentation

◆ operator<<

Member Data Documentation

◆ m_componentLsb

◆ m_etScale

◆ NAddress

◆ NData