L1SCJetEmu Class Reference

#include <L1SeedConePFJetEmulator.h>

Classes
class	Jet
class	OpPuppiObjMax

Public Types
typedef ap_fixed< 18, 23 >	detaphi2_t
typedef ap_int< 13 >	detaphi_t
typedef l1ct::glbeta_t	etaphi_t
typedef l1ct::PuppiObjEmu	Particle
typedef ap_fixed< 22, 22 >	pt_etaphi_t
typedef l1ct::pt_t	pt_t

Public Member Functions
std::vector< Jet >	emulateEvent (std::vector< Particle > &parts) const
	L1SCJetEmu (bool debug, float coneSize, unsigned nJets)

Private Types
typedef ap_ufixed< 18, -2 >	inv_pt_t

Private Member Functions
bool	inCone (Particle seed, Particle part) const
Jet	makeJet_HW (const std::vector< Particle > &parts) const

Static Private Member Functions
static constexpr int	ceillog2 (int x)
static detaphi_t	deltaPhi (Particle a, Particle b)
static constexpr int	floorlog2 (int x)
template<class data_T , int N>
static unsigned	idx_from_real_val (data_T x)
template<class data_T , class table_T , int N>
static void	init_invert_table (table_T table_out[N])
template<class in_t , class table_t , int N>
static table_t	invert_with_shift (const in_t in, const table_t inv_table[N], bool debug=false)
template<int B>
static constexpr int	pow (int x)
static constexpr int	pow2 (int x)
template<class data_T , int N>
static float	real_val_from_idx (unsigned i)
template<class T , class Op >
static T	reduce (std::vector< T > x, Op op)

Private Attributes
float	coneSize_
bool	debug_
inv_pt_t	inv_pt_table_ [N_table_inv_pt]
unsigned	nJets_
detaphi2_t	rCone2_

Static Private Attributes
static constexpr int	N_table_inv_pt = 1024
static constexpr OpPuppiObjMax	op_max {}

Detailed Description

Definition at line 14 of file L1SeedConePFJetEmulator.h.

Member Typedef Documentation

detaphi2_t

typedef ap_fixed<18, 23> L1SCJetEmu::detaphi2_t

Definition at line 22 of file L1SeedConePFJetEmulator.h.

detaphi_t

typedef ap_int<13> L1SCJetEmu::detaphi_t

Definition at line 21 of file L1SeedConePFJetEmulator.h.

etaphi_t

typedef l1ct::glbeta_t L1SCJetEmu::etaphi_t

Definition at line 20 of file L1SeedConePFJetEmulator.h.

inv_pt_t

typedef ap_ufixed<18, -2> L1SCJetEmu::inv_pt_t

private

Definition at line 43 of file L1SeedConePFJetEmulator.h.

Particle

typedef l1ct::PuppiObjEmu L1SCJetEmu::Particle

Definition at line 24 of file L1SeedConePFJetEmulator.h.

pt_etaphi_t

typedef ap_fixed<22, 22> L1SCJetEmu::pt_etaphi_t

Definition at line 23 of file L1SeedConePFJetEmulator.h.

pt_t

typedef l1ct::pt_t L1SCJetEmu::pt_t

Definition at line 19 of file L1SeedConePFJetEmulator.h.

Constructor & Destructor Documentation

L1SCJetEmu()

L1SCJetEmu::L1SCJetEmu	(	bool	debug,
		float	coneSize,
		unsigned	nJets
	)

Definition at line 3 of file L1SeedConePFJetEmulator.cc.

References inv_pt_table_.

    : debug_(debug),
      coneSize_(coneSize),
      nJets_(nJets),
      rCone2_(coneSize * coneSize / l1ct::Scales::ETAPHI_LSB / l1ct::Scales::ETAPHI_LSB) {
  init_invert_table<pt_t, inv_pt_t, N_table_inv_pt>(inv_pt_table_);
}

Member Function Documentation

ceillog2()

static constexpr int L1SCJetEmu::ceillog2 ( int  x )

inlinestaticprivate

Definition at line 47 of file L1SeedConePFJetEmulator.h.

References ceillog2(), and x.

Referenced by ceillog2(), idx_from_real_val(), and real_val_from_idx().

{ return (x <= 2) ? 1 : 1 + ceillog2((x + 1) / 2); }

deltaPhi()

L1SCJetEmu::detaphi_t L1SCJetEmu::deltaPhi ( L1SCJetEmu::Particle  a, L1SCJetEmu::Particle  b  )

staticprivate

Definition at line 11 of file L1SeedConePFJetEmulator.cc.

References a, b, l1ct::Scales::INTPHI_PI, and l1ct::Scales::INTPHI_TWOPI.

Referenced by inCone(), and makeJet_HW().

                                                                                   {
  detaphi_t dphi = detaphi_t(a.hwPhi) - detaphi_t(b.hwPhi);
  // phi wrap
  detaphi_t dphi0 =
      dphi > detaphi_t(l1ct::Scales::INTPHI_PI) ? detaphi_t(l1ct::Scales::INTPHI_TWOPI - dphi) : detaphi_t(dphi);
  detaphi_t dphi1 =
      dphi < detaphi_t(-l1ct::Scales::INTPHI_PI) ? detaphi_t(l1ct::Scales::INTPHI_TWOPI + dphi) : detaphi_t(dphi);
  detaphi_t dphiw = dphi > detaphi_t(0) ? dphi0 : dphi1;
  return dphiw;
}

emulateEvent()

std::vector< L1SCJetEmu::Jet > L1SCJetEmu::emulateEvent

(

std::vector< Particle > &

parts

)

const

Definition at line 92 of file L1SeedConePFJetEmulator.cc.

References dbgCout(), debug_, inCone(), PDWG_EXODelayedJetMET_cff::jets, makeJet_HW(), nJets_, op_max, reduce(), fileCollector::seed, HcalDetIdTransform::transform(), and edmIntegrityCheck::work.

Referenced by L1SeedConePFJetProducer::processEvent_HW().

                                                                                  {
  // The fixed point algorithm emulation
  std::vector<Particle> work;
  work.resize(parts.size());
  std::transform(parts.begin(), parts.end(), work.begin(), [](const Particle& part) { return part; });

  std::vector<Jet> jets;
  jets.reserve(nJets_);
  while (!work.empty() && jets.size() < nJets_) {
    // Take the highest pt candidate as a seed
    // Use the firmware reduce function to find the same seed as the firmware
    // in case there are multiple seeds with the same pT
    Particle seed = reduce(work, op_max);

    // Get the particles within a coneSize_ of the seed
    std::vector<Particle> particlesInCone;
    std::copy_if(work.begin(), work.end(), std::back_inserter(particlesInCone), [&](const Particle& part) {
      return inCone(seed, part);
    });
    if (debug_) {
      dbgCout() << "Seed: " << seed.hwPt << ", " << seed.hwEta << ", " << seed.hwPhi << std::endl;
      std::for_each(particlesInCone.begin(), particlesInCone.end(), [&](Particle& part) {
        dbgCout() << "  Part: " << part.hwPt << ", " << part.hwEta << ", " << part.hwPhi << std::endl;
        inCone(seed, part);
      });
    }
    jets.push_back(makeJet_HW(particlesInCone));
    // remove the clustered particles
    work.erase(std::remove_if(work.begin(), work.end(), [&](const Particle& part) { return inCone(seed, part); }),
               work.end());
  }
  return jets;
}

floorlog2()

static constexpr int L1SCJetEmu::floorlog2 ( int  x )

inlinestaticprivate

Definition at line 49 of file L1SeedConePFJetEmulator.h.

References floorlog2(), and x.

Referenced by floorlog2(), and reduce().

{ return (x < 2) ? 0 : 1 + floorlog2(x / 2); }

idx_from_real_val()

template<class data_T , int N>

static unsigned L1SCJetEmu::idx_from_real_val ( data_T  x )

inlinestaticprivate

Definition at line 102 of file L1SeedConePFJetEmulator.h.

References ceillog2(), N, x, and y.

                                                     {
    // Slice the top N bits to get an index into the table
    static constexpr int NB = ceillog2(N);  // number of address bits for table
    // Slice the top-1 NB bits of the value
    // the MSB of '1' is implicit, so only slice below that
    ap_uint<NB> y = x(x.width - 2, x.width - NB - 1);
    return (unsigned)y(NB - 1, 0);
  }

inCone()

bool L1SCJetEmu::inCone ( L1SCJetEmu::Particle  seed, L1SCJetEmu::Particle  part  ) const

private

Definition at line 22 of file L1SeedConePFJetEmulator.cc.

References dbgCout(), debug_, deltaPhi(), diffTwoXMLs::r2, rCone2_, runTheMatrix::ret, and fileCollector::seed.

Referenced by emulateEvent().

                                                                              {
  // scale the particle eta, phi to hardware units
  detaphi_t deta = detaphi_t(seed.hwEta) - detaphi_t(part.hwEta);
  detaphi_t dphi = deltaPhi(seed, part);
  bool ret = deta * deta + dphi * dphi < rCone2_;
  //bool ret = r2 < cone2;
  if (debug_) {
    detaphi2_t r2 = detaphi2_t(deta) * detaphi2_t(deta) + detaphi2_t(dphi) * detaphi2_t(dphi);
    dbgCout() << "  part eta, seed eta: " << part.hwEta << ", " << seed.hwEta << std::endl;
    dbgCout() << "  part phi, seed phi: " << part.hwPhi << ", " << seed.hwPhi << std::endl;
    dbgCout() << "  pt, deta, dphi, r2, cone2, lt: " << part.hwPt << ", " << deta << ", " << dphi << ", "
              << deta * deta + dphi * dphi << ", " << rCone2_ << ", " << ret << std::endl;
  }
  return ret;
}

init_invert_table()

template<class data_T , class table_T , int N>

static void L1SCJetEmu::init_invert_table ( table_T  table_out[N] )

inlinestaticprivate

Definition at line 112 of file L1SeedConePFJetEmulator.h.

References mps_fire::i, N, and x.

                                                      {
    // The template data_T is the data type used to address the table
    for (unsigned i = 0; i < N; i++) {
      float x = real_val_from_idx<data_T, N>(i);
      table_T inv_x = 1 / x;
      table_out[i] = inv_x;
    }
  }

invert_with_shift()

template<class in_t , class table_t , int N>

static table_t L1SCJetEmu::invert_with_shift ( const in_t  in, const table_t  inv_table[N], bool  debug = false  )

inlinestaticprivate

Definition at line 122 of file L1SeedConePFJetEmulator.h.

References b, dbgCout(), debug, nano_mu_digi_cff::float, heavyIonCSV_trainingSettings::idx, recoMuon::in, and MillePedeFileConverter_cfg::out.

                                                                                                  {
    // find the first '1' in the denominator
    int msb = 0;
    for (int b = 0; b < in.width; b++) {
      if (in[b])
        msb = b;
    }
    // shift up the denominator such that the left-most bit (msb) is '1'
    in_t in_shifted = in << (in.width - msb - 1);
    // lookup the inverse of the shifted input
    int idx = idx_from_real_val<in_t, N>(in_shifted);
    table_t inv_in = inv_table[idx];
    // shift the output back
    table_t out = inv_in << (in.width - msb - 1);
    if (debug) {
      dbgCout() << "           x " << in << ", msb = " << msb << ", shift = " << (in.width - msb) << ", idx = " << idx
                << std::endl;
      dbgCout() << "     pre 1 / " << in_shifted << " = " << inv_in << "(" << 1 / (float)in_shifted << ")" << std::endl;
      dbgCout() << "    post 1 / " << in << " = " << out << "(" << 1 / (float)in << ")" << std::endl;
    }
    return out;
  }

makeJet_HW()

L1SCJetEmu::Jet L1SCJetEmu::makeJet_HW ( const std::vector< Particle > &  parts ) const

private

Definition at line 38 of file L1SeedConePFJetEmulator.cc.

References a, b, dbgCout(), debug_, deltaPhi(), PVValHelper::eta, inv_pt_table_, metsig::jet, op_max, phi, DiDispStaMuonMonitor_cfi::pt, reduce(), fileCollector::seed, HcalDetIdTransform::transform(), and x.

Referenced by emulateEvent().

                                                                           {
  // Seed Cone Jet algorithm with ap_fixed types and hardware emulation
  Particle seed = reduce(parts, op_max);

  // Event with saturation, order of terms doesn't matter since they're all positive
  auto sumpt = [](pt_t(a), const Particle& b) { return a + b.hwPt; };

  // Sum the pt
  pt_t pt = std::accumulate(parts.begin(), parts.end(), pt_t(0), sumpt);
  inv_pt_t inv_pt = invert_with_shift<pt_t, inv_pt_t, N_table_inv_pt>(pt, inv_pt_table_, false);

  // pt weighted d eta
  std::vector<pt_etaphi_t> pt_deta;
  pt_deta.resize(parts.size());
  std::transform(parts.begin(), parts.end(), pt_deta.begin(), [&seed](const Particle& part) {
    // In the firmware we calculate the per-particle pt-weighted deta
    return pt_etaphi_t(part.hwPt * detaphi_t(part.hwEta - seed.hwEta));
  });
  // Accumulate the pt-weighted etas. Init to 0, include seed in accumulation
  pt_etaphi_t sum_pt_eta = std::accumulate(pt_deta.begin(), pt_deta.end(), pt_etaphi_t(0));
  etaphi_t eta = seed.hwEta + etaphi_t(sum_pt_eta * inv_pt);

  // pt weighted d phi
  std::vector<pt_etaphi_t> pt_dphi;
  pt_dphi.resize(parts.size());
  std::transform(parts.begin(), parts.end(), pt_dphi.begin(), [&seed](const Particle& part) {
    // In the firmware we calculate the per-particle pt-weighted dphi
    return pt_etaphi_t(part.hwPt * deltaPhi(part, seed));
  });
  // Accumulate the pt-weighted phis. Init to 0, include seed in accumulation
  pt_etaphi_t sum_pt_phi = std::accumulate(pt_dphi.begin(), pt_dphi.end(), pt_etaphi_t(0));
  etaphi_t phi = seed.hwPhi + etaphi_t(sum_pt_phi * inv_pt);

  Jet jet;
  jet.hwPt = pt;
  jet.hwEta = eta;
  jet.hwPhi = phi;
  jet.constituents = parts;

  if (debug_) {
    std::for_each(pt_dphi.begin(), pt_dphi.end(), [](pt_etaphi_t& x) { dbgCout() << "pt_dphi: " << x << std::endl; });
    std::for_each(pt_deta.begin(), pt_deta.end(), [](pt_etaphi_t& x) { dbgCout() << "pt_deta: " << x << std::endl; });
    dbgCout() << " sum_pt_eta: " << sum_pt_eta << ", 1/pt: " << inv_pt
              << ", sum_pt_eta * 1/pt: " << etaphi_t(sum_pt_eta * inv_pt) << std::endl;
    dbgCout() << " sum_pt_phi: " << sum_pt_phi << ", 1/pt: " << inv_pt
              << ", sum_pt_phi * 1/pt: " << etaphi_t(sum_pt_phi * inv_pt) << std::endl;
    dbgCout() << " uncorr eta: " << seed.hwEta << ", phi: " << seed.hwPhi << std::endl;
    dbgCout() << "   corr eta: " << eta << ", phi: " << phi << std::endl;
    dbgCout() << "         pt: " << pt << std::endl;
  }

  return jet;
}

pow()

template<int B>

static constexpr int L1SCJetEmu::pow ( int  x )

inlinestaticprivate

Definition at line 52 of file L1SeedConePFJetEmulator.h.

References B, and x.

                                  {
    return x == 0 ? 1 : B * pow<B>(x - 1);
  }

pow2()

static constexpr int L1SCJetEmu::pow2 ( int  x )

inlinestaticprivate

Definition at line 56 of file L1SeedConePFJetEmulator.h.

References x.

Referenced by reduce().

{ return pow<2>(x); }

real_val_from_idx()

template<class data_T , int N>

static float L1SCJetEmu::real_val_from_idx ( unsigned  i )

inlinestaticprivate

Definition at line 90 of file L1SeedConePFJetEmulator.h.

References ceillog2(), mps_fire::i, N, and x.

                                                    {
    // Treat the index as the top N bits
    static constexpr int NB = ceillog2(N);  // number of address bits for table
    data_T x(0);
    // The MSB of 1 is implicit in the table
    x[x.width - 1] = 1;
    // So we can use the next NB bits for real data
    x(x.width - 2, x.width - NB - 1) = i;
    return (float)x;
  }

reduce()

template<class T , class Op >

static T L1SCJetEmu::reduce ( std::vector< T >  x, Op  op  )

inlinestaticprivate

Definition at line 67 of file L1SeedConePFJetEmulator.h.

References floorlog2(), N, pow2(), and x.

Referenced by emulateEvent(), and makeJet_HW().

                                         {
    int N = x.size();
    int leftN = pow2(floorlog2(N - 1)) > 0 ? pow2(floorlog2(N - 1)) : 0;
    //static constexpr int rightN = N - leftN > 0 ? N - leftN : 0;
    if (N == 1) {
      return x.at(0);
    } else if (N == 2) {
      return op(x.at(0), x.at(1));
    } else {
      std::vector<T> left(x.begin(), x.begin() + leftN);
      std::vector<T> right(x.begin() + leftN, x.end());
      return op(reduce<T, Op>(left, op), reduce<T, Op>(right, op));
    }
  }

Member Data Documentation

coneSize_

float L1SCJetEmu::coneSize_

private

Definition at line 38 of file L1SeedConePFJetEmulator.h.

debug_

bool L1SCJetEmu::debug_

private

Definition at line 37 of file L1SeedConePFJetEmulator.h.

Referenced by emulateEvent(), inCone(), and makeJet_HW().

inv_pt_table_

inv_pt_t L1SCJetEmu::inv_pt_table_[N_table_inv_pt]

private

Definition at line 45 of file L1SeedConePFJetEmulator.h.

Referenced by L1SCJetEmu(), and makeJet_HW().

N_table_inv_pt

constexpr int L1SCJetEmu::N_table_inv_pt = 1024

staticprivate

Definition at line 44 of file L1SeedConePFJetEmulator.h.

nJets_

unsigned L1SCJetEmu::nJets_

private

Definition at line 39 of file L1SeedConePFJetEmulator.h.

Referenced by emulateEvent().

op_max

constexpr OpPuppiObjMax L1SCJetEmu::op_max {}

staticprivate

Definition at line 87 of file L1SeedConePFJetEmulator.h.

Referenced by emulateEvent(), and makeJet_HW().

rCone2_

detaphi2_t L1SCJetEmu::rCone2_

private

Definition at line 40 of file L1SeedConePFJetEmulator.h.

Referenced by inCone().