l1tp2::DigitizedClusterGT Class Reference

#include <DigitizedClusterGT.h>

Public Member Functions
ap_uint< 64 >	data () const
	DigitizedClusterGT ()
	DigitizedClusterGT (ap_uint< 64 > data)
	DigitizedClusterGT (ap_uint< 1 > isValid, ap_uint< 16 > pt, ap_int< 13 > phi, ap_int< 14 > eta, bool fullyDigitizedInputs)
	DigitizedClusterGT (bool isValid, float pt_f, float phi_f, float eta_f)
ap_int< 14 >	eta () const
float	etaLSB () const
ap_uint< 1 >	isValid () const
bool	passNullBitsCheck (void) const
ap_int< 13 >	phi () const
float	phiLSB () const
ap_uint< 16 >	pt () const
float	ptFloat () const
float	ptLSB () const
float	realEta () const
float	realPhi () const
const int	unusedBitsStart () const

Private Member Functions
ap_int< 14 >	digitizeEta (float eta_f)
ap_uint< 1 >	digitizeIsValid (bool isValid)
ap_int< 13 >	digitizePhi (float phi_f)
ap_uint< 16 >	digitizePt (float pt_f)

Private Attributes
ap_uint< 64 >	clusterData
float	LSB_ETA = (M_PI / std::pow(2, n_bits_eta_pi))
float	LSB_PHI = (M_PI / std::pow(2, n_bits_phi_pi))

Static Private Attributes
static constexpr float	LSB_PT = 0.03125
static constexpr unsigned int	n_bits_eta_pi = 12
static constexpr unsigned int	n_bits_phi_pi = 12
static constexpr unsigned int	n_bits_pt = 16
static constexpr unsigned int	n_bits_unused_start = 44

Detailed Description

Definition at line 9 of file DigitizedClusterGT.h.

Constructor & Destructor Documentation

DigitizedClusterGT() [1/4]

l1tp2::DigitizedClusterGT::DigitizedClusterGT ( )

inline

Definition at line 49 of file DigitizedClusterGT.h.

References clusterData.

{ clusterData = 0x0; }

DigitizedClusterGT() [2/4]

l1tp2::DigitizedClusterGT::DigitizedClusterGT ( ap_uint< 64 >  data )

inline

Definition at line 51 of file DigitizedClusterGT.h.

References clusterData, and data().

{ clusterData = data; }

DigitizedClusterGT() [3/4]

l1tp2::DigitizedClusterGT::DigitizedClusterGT ( ap_uint< 1 >  isValid, ap_uint< 16 >  pt, ap_int< 13 >  phi, ap_int< 14 >  eta, bool  fullyDigitizedInputs  )

inline

Definition at line 54 of file DigitizedClusterGT.h.

References clusterData, eta(), isValid(), phi(), pt(), and funct::void.

                                                                                                                      {
      (void)fullyDigitizedInputs;
      clusterData =
          ((ap_uint<64>)isValid) | (((ap_uint<64>)pt) << 1) | (((ap_uint<64>)phi) << 17) | (((ap_uint<64>)eta) << 30);
    }

DigitizedClusterGT() [4/4]

l1tp2::DigitizedClusterGT::DigitizedClusterGT ( bool  isValid, float  pt_f, float  phi_f, float  eta_f  )

inline

Definition at line 61 of file DigitizedClusterGT.h.

References clusterData, digitizeEta(), digitizeIsValid(), digitizePhi(), digitizePt(), and isValid().

                                                                           {
      // N.b.: For eta/phi, after shifting the bits to the correct place and casting to ap_uint<64>,
      // we have an additional bit mask
      // e.g. 0x3FFE0000 for phi. This mask is all zero's except for 1 in the phi bits (bits 17 through 29):
      // bit mask = 0x3FFE0000 = 0b111111111111100000000000000000
      // Applying the "and" of this bitmask, avoids bogus 1's in the case where phi is negative

      clusterData = ((ap_uint<64>)digitizeIsValid(isValid)) | ((ap_uint<64>)digitizePt(pt_f) << 1) |
                    (((ap_uint<64>)digitizePhi(phi_f) << 17) &
                     0x3FFE0000) |  // 0x3FFE0000 is all zero's except the phi bits (bits 17 through 29)
                    (((ap_uint<64>)digitizeEta(eta_f) << 30) &
                     0xFFFC0000000);  // 0xFFFC0000000 is all zero's except the eta bits (bits 30 through 32)
    }

Member Function Documentation

data()

ap_uint<64> l1tp2::DigitizedClusterGT::data ( ) const

inline

Definition at line 75 of file DigitizedClusterGT.h.

References clusterData.

Referenced by DigitizedClusterGT(), and passNullBitsCheck().

{ return clusterData; }

digitizeEta()

ap_int<14> l1tp2::DigitizedClusterGT::digitizeEta ( float  eta_f )

inlineprivate

Definition at line 43 of file DigitizedClusterGT.h.

References LSB_ETA.

Referenced by DigitizedClusterGT().

                                        {
      ap_int<14> eta_digitized = (eta_f / LSB_ETA);
      return eta_digitized;
    }

digitizeIsValid()

ap_uint<1> l1tp2::DigitizedClusterGT::digitizeIsValid ( bool  isValid )

inlineprivate

Definition at line 25 of file DigitizedClusterGT.h.

References isValid().

Referenced by DigitizedClusterGT().

{ return (ap_uint<1>)isValid; }

digitizePhi()

ap_int<13> l1tp2::DigitizedClusterGT::digitizePhi ( float  phi_f )

inlineprivate

Definition at line 37 of file DigitizedClusterGT.h.

References LSB_PHI.

Referenced by DigitizedClusterGT().

                                        {
      ap_int<13> phi_digitized = (phi_f / LSB_PHI);
      return phi_digitized;
    }

digitizePt()

ap_uint<16> l1tp2::DigitizedClusterGT::digitizePt ( float  pt_f )

inlineprivate

Definition at line 27 of file DigitizedClusterGT.h.

References LSB_PT, n_bits_pt, and conifer::pow().

Referenced by DigitizedClusterGT().

                                       {
      float maxPt_f = (std::pow(2, n_bits_pt) - 1) * LSB_PT;
      // If pT exceeds the maximum, saturate the value
      if (pt_f >= maxPt_f) {
        return (ap_uint<16>)0xFFFF;
      }
      return (ap_uint<16>)(pt_f / LSB_PT);
    }

eta()

ap_int<14> l1tp2::DigitizedClusterGT::eta ( ) const

inline

Definition at line 84 of file DigitizedClusterGT.h.

References clusterData.

Referenced by Particle.Particle::__str__(), DigitizedClusterGT(), Jet.Jet::jetID(), Jet.Jet::puJetId(), and realEta().

{ return ((clusterData >> 30) & 0x3FFF); }  // (fourteen 1's) = 0x3FFF

etaLSB()

float l1tp2::DigitizedClusterGT::etaLSB ( ) const

inline

Definition at line 80 of file DigitizedClusterGT.h.

References LSB_ETA.

Referenced by realEta().

{ return LSB_ETA; }

isValid()

ap_uint<1> l1tp2::DigitizedClusterGT::isValid ( void  ) const

inline

Definition at line 81 of file DigitizedClusterGT.h.

References clusterData.

Referenced by ntupleDataFormat._Object::_checkIsValid(), DigitizedClusterGT(), digitizeIsValid(), and core.AutoHandle.AutoHandle::ReallyLoad().

{ return (clusterData & 0x1); }

passNullBitsCheck()

bool l1tp2::DigitizedClusterGT::passNullBitsCheck ( void  ) const

inline

Definition at line 96 of file DigitizedClusterGT.h.

References data(), and unusedBitsStart().

{ return ((data() >> unusedBitsStart()) == 0x0); }

phi()

ap_int<13> l1tp2::DigitizedClusterGT::phi ( ) const

inline

Definition at line 83 of file DigitizedClusterGT.h.

References clusterData.

Referenced by Particle.Particle::__str__(), DigitizedClusterGT(), ntupleDataFormat.Track::phiPull(), and realPhi().

{ return ((clusterData >> 17) & 0x1FFF); }  // (thirteen 1's)= 0x1FFF

phiLSB()

float l1tp2::DigitizedClusterGT::phiLSB ( ) const

inline

Definition at line 79 of file DigitizedClusterGT.h.

References LSB_PHI.

Referenced by realPhi().

{ return LSB_PHI; }

pt()

ap_uint<16> l1tp2::DigitizedClusterGT::pt ( ) const

inline

Definition at line 82 of file DigitizedClusterGT.h.

References clusterData.

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

{ return ((clusterData >> 1) & 0xFFFF); }   // 16 1's = 0xFFFF

ptFloat()

float l1tp2::DigitizedClusterGT::ptFloat ( ) const

inline

Definition at line 86 of file DigitizedClusterGT.h.

References pt(), and ptLSB().

{ return (pt() * ptLSB()); }

ptLSB()

float l1tp2::DigitizedClusterGT::ptLSB ( ) const

inline

Definition at line 78 of file DigitizedClusterGT.h.

References LSB_PT.

Referenced by ptFloat().

{ return LSB_PT; }

realEta()

float l1tp2::DigitizedClusterGT::realEta ( ) const

inline

Definition at line 90 of file DigitizedClusterGT.h.

References eta(), and etaLSB().

                          {  // convert from signed int to float
      return (eta() * etaLSB());
    }

realPhi()

float l1tp2::DigitizedClusterGT::realPhi ( ) const

inline

Definition at line 87 of file DigitizedClusterGT.h.

References phi(), and phiLSB().

                          {  // convert from signed int to float
      return (phi() * phiLSB());
    }

unusedBitsStart()

const int l1tp2::DigitizedClusterGT::unusedBitsStart ( ) const

inline

Definition at line 93 of file DigitizedClusterGT.h.

References n_bits_unused_start.

Referenced by passNullBitsCheck().

{ return n_bits_unused_start; }  // unused bits start at bit 44

Member Data Documentation

clusterData

ap_uint<64> l1tp2::DigitizedClusterGT::clusterData

private

Definition at line 12 of file DigitizedClusterGT.h.

Referenced by data(), DigitizedClusterGT(), eta(), isValid(), phi(), and pt().

LSB_ETA

float l1tp2::DigitizedClusterGT::LSB_ETA = (M_PI / std::pow(2, n_bits_eta_pi))

private

Definition at line 21 of file DigitizedClusterGT.h.

Referenced by digitizeEta(), and etaLSB().

LSB_PHI

float l1tp2::DigitizedClusterGT::LSB_PHI = (M_PI / std::pow(2, n_bits_phi_pi))

private

Definition at line 22 of file DigitizedClusterGT.h.

Referenced by digitizePhi(), and phiLSB().

LSB_PT

constexpr float l1tp2::DigitizedClusterGT::LSB_PT = 0.03125

staticprivate

Definition at line 15 of file DigitizedClusterGT.h.

Referenced by digitizePt(), and ptLSB().

n_bits_eta_pi

constexpr unsigned int l1tp2::DigitizedClusterGT::n_bits_eta_pi = 12

staticprivate

Definition at line 16 of file DigitizedClusterGT.h.

n_bits_phi_pi

constexpr unsigned int l1tp2::DigitizedClusterGT::n_bits_phi_pi = 12

staticprivate

Definition at line 17 of file DigitizedClusterGT.h.

n_bits_pt

constexpr unsigned int l1tp2::DigitizedClusterGT::n_bits_pt = 16

staticprivate

Definition at line 18 of file DigitizedClusterGT.h.

Referenced by digitizePt().

n_bits_unused_start

constexpr unsigned int l1tp2::DigitizedClusterGT::n_bits_unused_start = 44

staticprivate

Definition at line 19 of file DigitizedClusterGT.h.

Referenced by unusedBitsStart().