l1t::TkJetWord Class Reference

#include <TkJetWord.h>

Public Types
typedef ap_uint< kDispFlagSize >	dispflag_t
typedef ap_int< kGlbEtaSize >	glbeta_t
typedef ap_int< kGlbPhiSize >	glbphi_t
typedef ap_uint< kNtSize >	nt_t
typedef ap_uint< kXtSize >	nx_t
typedef ap_ufixed< kPtSize, kPtMagSize, AP_TRN, AP_SAT >	pt_t
enum	TkJetBitLocations {   kPtLSB = 0, kPtMSB = kPtLSB + TkJetBitWidths::kPtSize - 1, kGlbPhiLSB = kPtMSB + 1, kGlbPhiMSB = kGlbPhiLSB + TkJetBitWidths::kGlbPhiSize - 1,   kGlbEtaLSB = kGlbPhiMSB + 1, kGlbEtaMSB = kGlbEtaLSB + TkJetBitWidths::kGlbEtaSize - 1, kZ0LSB = kGlbEtaMSB + 1, kZ0MSB = kZ0LSB + TkJetBitWidths::kZ0Size - 1,   kNtLSB = kZ0MSB + 1, kNtMSB = kNtLSB + TkJetBitWidths::kNtSize - 1, kXtLSB = kNtMSB + 1, kXtMSB = kXtLSB + TkJetBitWidths::kXtSize - 1,   kDispFlagLSB = kXtMSB + 1, kDispFlagMSB = kDispFlagLSB + TkJetBitWidths::kDispFlagSize - 1, kUnassignedLSB = kDispFlagMSB + 1, kUnassignedMSB = kUnassignedLSB + TkJetBitWidths::kUnassignedSize - 1 }
enum	TkJetBitWidths {   kPtSize = 16, kPtMagSize = 11, kGlbEtaSize = 14, kGlbPhiSize = 13,   kZ0Size = 10, kNtSize = 5, kXtSize = 4, kDispFlagSize = 1,   kUnassignedSize = 65, kTkJetWordSize }
typedef ap_uint< TkJetBitWidths::kUnassignedSize >	tkjetunassigned_t
typedef std::bitset< TkJetBitWidths::kTkJetWordSize >	tkjetword_bs_t
typedef ap_uint< TkJetBitWidths::kTkJetWordSize >	tkjetword_t
typedef ap_int< kZ0Size >	z0_t

Public Member Functions
int	dispflag () const
unsigned int	dispFlagBits () const
dispflag_t	dispFlagWord () const
float	glbeta () const
unsigned int	glbEtaBits () const
glbeta_t	glbEtaWord () const
float	glbphi () const
unsigned int	glbPhiBits () const
glbphi_t	glbPhiWord () const
int	nt () const
unsigned int	ntBits () const
nt_t	ntWord () const
TkJetWord &	operator= (const TkJetWord &word)
float	pt () const
unsigned int	ptBits () const
pt_t	ptWord () const
void	setTkJetWord (pt_t pt, glbeta_t eta, glbphi_t phi, z0_t z0, nt_t nt, nx_t nx, dispflag_t dispflag, tkjetunassigned_t unassigned)
	TkJetWord ()
	TkJetWord (pt_t pt, glbeta_t eta, glbphi_t phi, z0_t z0, nt_t nt, nx_t nx, dispflag_t dispflag, tkjetunassigned_t unassigned)
	TkJetWord (const TkJetWord &word)
tkjetword_t	tkJetWord () const
unsigned int	unassigned () const
unsigned int	unassignedBits () const
tkjetunassigned_t	unassignedWord () const
int	xt () const
unsigned int	xtBits () const
nx_t	xtWord () const
float	z0 () const
unsigned int	z0Bits () const
z0_t	z0Word () const
	~TkJetWord ()

Static Public Attributes
static constexpr double	MAX_ETA = 8.
static constexpr double	MAX_Z0 = 30.

Private Member Functions
double	unpackSignedValue (unsigned int bits, unsigned int nBits, double lsb) const

Private Attributes
tkjetword_bs_t	tkJetWord_

Detailed Description

Definition at line 19 of file TkJetWord.h.

Member Typedef Documentation

dispflag_t

typedef ap_uint<kDispFlagSize> l1t::TkJetWord::dispflag_t

Definition at line 64 of file TkJetWord.h.

glbeta_t

typedef ap_int<kGlbEtaSize> l1t::TkJetWord::glbeta_t

Definition at line 59 of file TkJetWord.h.

glbphi_t

typedef ap_int<kGlbPhiSize> l1t::TkJetWord::glbphi_t

Definition at line 60 of file TkJetWord.h.

nt_t

typedef ap_uint<kNtSize> l1t::TkJetWord::nt_t

Definition at line 62 of file TkJetWord.h.

nx_t

typedef ap_uint<kXtSize> l1t::TkJetWord::nx_t

Definition at line 63 of file TkJetWord.h.

pt_t

typedef ap_ufixed<kPtSize, kPtMagSize, AP_TRN, AP_SAT> l1t::TkJetWord::pt_t

Definition at line 58 of file TkJetWord.h.

tkjetunassigned_t

typedef ap_uint<TkJetBitWidths::kUnassignedSize> l1t::TkJetWord::tkjetunassigned_t

Definition at line 65 of file TkJetWord.h.

tkjetword_bs_t

typedef std::bitset<TkJetBitWidths::kTkJetWordSize> l1t::TkJetWord::tkjetword_bs_t

Definition at line 66 of file TkJetWord.h.

tkjetword_t

typedef ap_uint<TkJetBitWidths::kTkJetWordSize> l1t::TkJetWord::tkjetword_t

Definition at line 67 of file TkJetWord.h.

z0_t

typedef ap_int<kZ0Size> l1t::TkJetWord::z0_t

Definition at line 61 of file TkJetWord.h.

Member Enumeration Documentation

TkJetBitLocations

enum l1t::TkJetWord::TkJetBitLocations

Enumerator
kPtLSB
kPtMSB
kGlbPhiLSB
kGlbPhiMSB
kGlbEtaLSB
kGlbEtaMSB
kZ0LSB
kZ0MSB
kNtLSB
kNtMSB
kXtLSB
kXtMSB
kDispFlagLSB
kDispFlagMSB
kUnassignedLSB
kUnassignedMSB

Definition at line 39 of file TkJetWord.h.

                           {
      kPtLSB = 0,
      kPtMSB = kPtLSB + TkJetBitWidths::kPtSize - 1,
      kGlbPhiLSB = kPtMSB + 1,
      kGlbPhiMSB = kGlbPhiLSB + TkJetBitWidths::kGlbPhiSize - 1,
      kGlbEtaLSB = kGlbPhiMSB + 1,
      kGlbEtaMSB = kGlbEtaLSB + TkJetBitWidths::kGlbEtaSize - 1,
      kZ0LSB = kGlbEtaMSB + 1,
      kZ0MSB = kZ0LSB + TkJetBitWidths::kZ0Size - 1,
      kNtLSB = kZ0MSB + 1,
      kNtMSB = kNtLSB + TkJetBitWidths::kNtSize - 1,
      kXtLSB = kNtMSB + 1,
      kXtMSB = kXtLSB + TkJetBitWidths::kXtSize - 1,
      kDispFlagLSB = kXtMSB + 1,
      kDispFlagMSB = kDispFlagLSB + TkJetBitWidths::kDispFlagSize - 1,
      kUnassignedLSB = kDispFlagMSB + 1,
      kUnassignedMSB = kUnassignedLSB + TkJetBitWidths::kUnassignedSize - 1,
    };

TkJetBitWidths

enum l1t::TkJetWord::TkJetBitWidths

Enumerator
kPtSize
kPtMagSize
kGlbEtaSize
kGlbPhiSize
kZ0Size
kNtSize
kXtSize
kDispFlagSize
kUnassignedSize
kTkJetWordSize

Definition at line 25 of file TkJetWord.h.

                        {
      kPtSize = 16,
      kPtMagSize = 11,
      kGlbEtaSize = 14,
      kGlbPhiSize = 13,
      kZ0Size = 10,
      kNtSize = 5,
      kXtSize = 4,
      kDispFlagSize = 1,
      kUnassignedSize = 65,
      kTkJetWordSize =
          kPtSize + kGlbEtaSize + kGlbPhiSize + kZ0Size + kNtSize + kXtSize + kDispFlagSize + kUnassignedSize,
    };

Constructor & Destructor Documentation

TkJetWord() [1/3]

l1t::TkJetWord::TkJetWord ( )

inline

Definition at line 71 of file TkJetWord.h.

{}

TkJetWord() [2/3]

l1t::TkJetWord::TkJetWord	(	pt_t	pt,
		glbeta_t	eta,
		glbphi_t	phi,
		z0_t	z0,
		nt_t	nt,
		nx_t	nx,
		dispflag_t	dispflag,
		tkjetunassigned_t	unassigned
	)

Definition at line 7 of file TkJetWord.cc.

References dispflag(), PVValHelper::eta, nt(), pt(), setTkJetWord(), unassigned(), and z0().

                                                     {
    setTkJetWord(pt, eta, phi, z0, nt, nx, dispflag, unassigned);
  }

~TkJetWord()

l1t::TkJetWord::~TkJetWord ( )

inline

Definition at line 81 of file TkJetWord.h.

{}

TkJetWord() [3/3]

l1t::TkJetWord::TkJetWord ( const TkJetWord &  word )

inline

Definition at line 84 of file TkJetWord.h.

References tkJetWord_.

{ tkJetWord_ = word.tkJetWord_; }

Member Function Documentation

dispflag()

int l1t::TkJetWord::dispflag ( ) const

inline

Definition at line 162 of file TkJetWord.h.

References dispFlagWord().

Referenced by TkJetWord().

{ return (ap_ufixed<kDispFlagSize + 2, kDispFlagSize>(dispFlagWord())).to_int(); }

dispFlagBits()

unsigned int l1t::TkJetWord::dispFlagBits ( ) const

inline

Definition at line 143 of file TkJetWord.h.

References dispFlagWord().

{ return dispFlagWord().to_uint(); }

dispFlagWord()

dispflag_t l1t::TkJetWord::dispFlagWord ( ) const

inline

Definition at line 124 of file TkJetWord.h.

References runTheMatrix::ret, and tkJetWord().

Referenced by dispflag(), and dispFlagBits().

                                    {
      dispflag_t ret;
      ret.V = tkJetWord()(TkJetBitLocations::kDispFlagMSB, TkJetBitLocations::kDispFlagLSB);
      return ret;
    }

glbeta()

float l1t::TkJetWord::glbeta ( ) const

inline

Definition at line 149 of file TkJetWord.h.

References glbEtaWord(), MAX_ETA, and unpackSignedValue().

                         {
      return unpackSignedValue(
          glbEtaWord(), TkJetBitWidths::kGlbEtaSize, (MAX_ETA) / (1 << TkJetBitWidths::kGlbEtaSize));
    }

glbEtaBits()

unsigned int l1t::TkJetWord::glbEtaBits ( ) const

inline

Definition at line 138 of file TkJetWord.h.

References glbEtaWord().

{ return glbEtaWord().to_uint(); }

glbEtaWord()

glbeta_t l1t::TkJetWord::glbEtaWord ( ) const

inline

Definition at line 99 of file TkJetWord.h.

References runTheMatrix::ret, and tkJetWord().

Referenced by glbeta(), and glbEtaBits().

                                {
      glbeta_t ret;
      ret.V = tkJetWord()(TkJetBitLocations::kGlbEtaMSB, TkJetBitLocations::kGlbEtaLSB);
      return ret;
    }

glbphi()

float l1t::TkJetWord::glbphi ( ) const

inline

Definition at line 153 of file TkJetWord.h.

References funct::abs(), glbPhiWord(), M_PI, and unpackSignedValue().

                         {
      return unpackSignedValue(
          glbPhiWord(), TkJetBitWidths::kGlbPhiSize, (2. * std::abs(M_PI)) / (1 << TkJetBitWidths::kGlbPhiSize));
    }

glbPhiBits()

unsigned int l1t::TkJetWord::glbPhiBits ( ) const

inline

Definition at line 139 of file TkJetWord.h.

References glbPhiWord().

{ return glbPhiWord().to_uint(); }

glbPhiWord()

glbphi_t l1t::TkJetWord::glbPhiWord ( ) const

inline

Definition at line 104 of file TkJetWord.h.

References runTheMatrix::ret, and tkJetWord().

Referenced by glbphi(), and glbPhiBits().

                                {
      glbphi_t ret;
      ret.V = tkJetWord()(TkJetBitLocations::kGlbPhiMSB, TkJetBitLocations::kGlbPhiLSB);
      return ret;
    }

nt()

int l1t::TkJetWord::nt ( ) const

inline

Definition at line 160 of file TkJetWord.h.

References ntWord().

Referenced by setTkJetWord(), and TkJetWord().

{ return (ap_ufixed<kNtSize + 2, kNtSize>(ntWord())).to_int(); }

ntBits()

unsigned int l1t::TkJetWord::ntBits ( ) const

inline

Definition at line 141 of file TkJetWord.h.

References ntWord().

{ return ntWord().to_uint(); }

ntWord()

nt_t l1t::TkJetWord::ntWord ( ) const

inline

Definition at line 114 of file TkJetWord.h.

References runTheMatrix::ret, and tkJetWord().

Referenced by nt(), and ntBits().

                        {
      nt_t ret;
      ret.V = tkJetWord()(TkJetBitLocations::kNtMSB, TkJetBitLocations::kNtLSB);
      return ret;
    }

operator=()

TkJetWord& l1t::TkJetWord::operator= ( const TkJetWord &  word )

inline

Definition at line 87 of file TkJetWord.h.

References tkJetWord_.

                                                {
      tkJetWord_ = word.tkJetWord_;
      return *this;
    }

pt()

float l1t::TkJetWord::pt ( ) const

inline

Definition at line 148 of file TkJetWord.h.

References ptWord().

Referenced by Particle.Particle::__str__(), DiObject.DiMuon::__str__(), Photon.Photon::calScaledIsoValueExp(), Photon.Photon::calScaledIsoValueLin(), Photon.Photon::calScaledIsoValueQuadr(), Electron.Electron::mvaIDLoose(), Electron.Electron::mvaIDRun2(), Electron.Electron::mvaIDTight(), Electron.Electron::ptErr(), ntupleDataFormat.Track::ptPull(), Lepton.Lepton::relIso(), Lepton.Lepton::relIsoFromEA(), Lepton.Lepton::relIsoR(), Jet.Jet::setCorrP4(), setTkJetWord(), and TkJetWord().

{ return ptWord().to_float(); }

ptBits()

unsigned int l1t::TkJetWord::ptBits ( ) const

inline

Definition at line 137 of file TkJetWord.h.

References ptWord().

{ return ptWord().to_uint(); }

ptWord()

pt_t l1t::TkJetWord::ptWord ( ) const

inline

Definition at line 94 of file TkJetWord.h.

References runTheMatrix::ret, and tkJetWord().

Referenced by pt(), and ptBits().

                        {
      pt_t ret;
      ret.V = tkJetWord()(TkJetBitLocations::kPtMSB, TkJetBitLocations::kPtLSB);
      return ret;
    }

setTkJetWord()

void l1t::TkJetWord::setTkJetWord	(	pt_t	pt,
		glbeta_t	eta,
		glbphi_t	phi,
		z0_t	z0,
		nt_t	nt,
		nx_t	nx,
		dispflag_t	dispflag,
		tkjetunassigned_t	unassigned
	)

Definition at line 18 of file TkJetWord.cc.

References b, PVValHelper::eta, l1tmhtemu::kUnassignedSize, nt(), hltrates_dqm_sourceclient-live_cfg::offset, pt(), tkJetWord_, unassigned(), and z0().

Referenced by TkJetWord().

                                                             {
    // pack the TkJet word
    unsigned int offset = 0;
    for (unsigned int b = offset; b < (offset + TkJetBitWidths::kPtSize); b++) {
      tkJetWord_.set(b, pt[b - offset]);
    }
    offset += TkJetBitWidths::kPtSize;
    for (unsigned int b = offset; b < (offset + TkJetBitWidths::kGlbPhiSize); b++) {
      tkJetWord_.set(b, phi[b - offset]);
    }
    offset += TkJetBitWidths::kGlbPhiSize;
    for (unsigned int b = offset; b < (offset + TkJetBitWidths::kGlbEtaSize); b++) {
      tkJetWord_.set(b, eta[b - offset]);
    }
    offset += TkJetBitWidths::kGlbEtaSize;
    for (unsigned int b = offset; b < (offset + TkJetBitWidths::kZ0Size); b++) {
      tkJetWord_.set(b, z0[b - offset]);
    }
    offset += TkJetBitWidths::kZ0Size;
    for (unsigned int b = offset; b < (offset + TkJetBitWidths::kNtSize); b++) {
      tkJetWord_.set(b, nt[b - offset]);
    }
    offset += TkJetBitWidths::kNtSize;
    for (unsigned int b = offset; b < (offset + TkJetBitWidths::kXtSize); b++) {
      tkJetWord_.set(b, nx[b - offset]);
    }
    offset += TkJetBitWidths::kXtSize;
    for (unsigned int b = offset; b < (offset + TkJetBitWidths::kDispFlagSize); b++) {
      tkJetWord_.set(b, nx[b - offset]);
    }
    offset += TkJetBitWidths::kDispFlagSize;
    for (unsigned int b = offset; b < (offset + TkJetBitWidths::kUnassignedSize); b++) {
      tkJetWord_.set(b, unassigned[b - offset]);
    }
  }

tkJetWord()

tkjetword_t l1t::TkJetWord::tkJetWord ( ) const

inline

Definition at line 133 of file TkJetWord.h.

References tkJetWord_.

Referenced by dispFlagWord(), glbEtaWord(), glbPhiWord(), ntWord(), ptWord(), unassignedWord(), xtWord(), and z0Word().

{ return tkjetword_t(tkJetWord_.to_string().c_str(), 2); }

unassigned()

unsigned int l1t::TkJetWord::unassigned ( ) const

inline

Definition at line 163 of file TkJetWord.h.

References unassignedWord().

Referenced by setTkJetWord(), and TkJetWord().

{ return unassignedWord().to_uint(); }

unassignedBits()

unsigned int l1t::TkJetWord::unassignedBits ( ) const

inline

Definition at line 144 of file TkJetWord.h.

References unassignedWord().

{ return unassignedWord().to_uint(); }

unassignedWord()

tkjetunassigned_t l1t::TkJetWord::unassignedWord ( ) const

inline

Definition at line 130 of file TkJetWord.h.

References l1tmhtemu::kUnassignedLSB, l1tmhtemu::kUnassignedMSB, and tkJetWord().

Referenced by unassigned(), and unassignedBits().

                                             {
      return tkJetWord()(TkJetBitLocations::kUnassignedMSB, TkJetBitLocations::kUnassignedLSB);
    }

unpackSignedValue()

double l1t::TkJetWord::unpackSignedValue ( unsigned int  bits, unsigned int  nBits, double  lsb  ) const

inlineprivate

Definition at line 177 of file TkJetWord.h.

References gpuClustering::pixelStatus::bits, and l1tHGCalVFEProducer_cfi::lsb.

Referenced by glbeta(), glbphi(), and z0().

                                                                                      {
      int isign = 1;
      unsigned int digitized_maximum = (1 << nBits) - 1;
      if (bits & (1 << (nBits - 1))) {  // check the sign
        isign = -1;
        bits = (1 << (nBits + 1)) - bits;  // if negative, flip everything for two's complement encoding
      }
      return (double(bits & digitized_maximum) + 0.5) * lsb * isign;
    }

xt()

int l1t::TkJetWord::xt ( ) const

inline

Definition at line 161 of file TkJetWord.h.

References xtWord().

{ return (ap_ufixed<kXtSize + 2, kXtSize>(xtWord())).to_int(); }

xtBits()

unsigned int l1t::TkJetWord::xtBits ( ) const

inline

Definition at line 142 of file TkJetWord.h.

References xtWord().

{ return xtWord().to_uint(); }

xtWord()

nx_t l1t::TkJetWord::xtWord ( ) const

inline

Definition at line 119 of file TkJetWord.h.

References runTheMatrix::ret, and tkJetWord().

Referenced by xt(), and xtBits().

                        {
      nx_t ret;
      ret.V = tkJetWord()(TkJetBitLocations::kXtMSB, TkJetBitLocations::kXtLSB);
      return ret;
    }

z0()

float l1t::TkJetWord::z0 ( ) const

inline

Definition at line 157 of file TkJetWord.h.

References MAX_Z0, unpackSignedValue(), and z0Word().

Referenced by setTkJetWord(), and TkJetWord().

                     {
      return unpackSignedValue(z0Word(), TkJetBitWidths::kZ0Size, MAX_Z0 / (1 << TkJetBitWidths::kZ0Size));
    }

z0Bits()

unsigned int l1t::TkJetWord::z0Bits ( ) const

inline

Definition at line 140 of file TkJetWord.h.

References z0Word().

{ return z0Word().to_uint(); }

z0Word()

z0_t l1t::TkJetWord::z0Word ( ) const

inline

Definition at line 109 of file TkJetWord.h.

References runTheMatrix::ret, and tkJetWord().

Referenced by z0(), and z0Bits().

                        {
      z0_t ret;
      ret.V = tkJetWord()(TkJetBitLocations::kZ0MSB, TkJetBitLocations::kZ0LSB);
      return ret;
    }

Member Data Documentation

MAX_ETA

constexpr double l1t::TkJetWord::MAX_ETA = 8.

static

Definition at line 23 of file TkJetWord.h.

Referenced by glbeta().

MAX_Z0

constexpr double l1t::TkJetWord::MAX_Z0 = 30.

static

Definition at line 22 of file TkJetWord.h.

Referenced by z0().

tkJetWord_

tkjetword_bs_t l1t::TkJetWord::tkJetWord_

private

Definition at line 188 of file TkJetWord.h.

Referenced by operator=(), setTkJetWord(), TkJetWord(), and tkJetWord().