Skip to content

[L1T] PR containing simulation and emulation related to jet mass reconstruction (Phase-2) #47792

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 11 commits into from
May 8, 2025
Merged

[L1T] PR containing simulation and emulation related to jet mass reconstruction (Phase-2) #47792

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
ccc2b30
Contains all jet mass emulator commits and rebase to 151X
lrobertshaw May 29, 2024
f224be0
code format patch
lrobertshaw Apr 4, 2025
baba4d2
added previously removed phase-1 jets back in
lrobertshaw Apr 4, 2025
9db1d48
removed non-default file path
lrobertshaw Apr 4, 2025
e2787da
Added a new HW encoding for new packed type
lrobertshaw Apr 8, 2025
4903a04
code checks and format
lrobertshaw Apr 8, 2025
02ab393
actioned PR comments regarding formatting, not addressed B tagging ha…
lrobertshaw Apr 28, 2025
ba2114a
code formats and code checks
lrobertshaw Apr 28, 2025
41f28b0
Merge branch 'master' into CMSSW_15_1_X
lrobertshaw May 6, 2025
7e21c79
code formats and code checks changes
lrobertshaw May 6, 2025
9daabf3
reverting checksum value for ClassVersion 7
lrobertshaw May 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion DataFormats/L1TParticleFlow/interface/PFJet.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ namespace l1t {
typedef std::vector<edm::Ptr<l1t::PFCandidate>> Constituents;

PFJet() {}
PFJet(float pt, float eta, float phi, float mass = 0, int hwpt = 0, int hweta = 0, int hwphi = 0)
PFJet(float pt, float eta, float phi, float mass, int hwpt = 0, int hweta = 0, int hwphi = 0)
: L1Candidate(PolarLorentzVector(pt, eta, phi, mass), hwpt, hweta, hwphi, /*hwQuality=*/0), rawPt_(pt) {}

PFJet(const LorentzVector& p4, int hwpt = 0, int hweta = 0, int hwphi = 0)
Expand Down
2 changes: 2 additions & 0 deletions DataFormats/L1TParticleFlow/interface/datatypes.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
namespace l1ct {

typedef ap_ufixed<14, 12, AP_TRN, AP_SAT> pt_t;
typedef ap_ufixed<17, 15, AP_TRN, AP_SAT> mass2_t; // can store up to 256 GeV with 0.5 GeV precision
typedef ap_ufixed<10, 8, AP_TRN, AP_SAT> pt10_t;
typedef ap_fixed<16, 14, AP_TRN, AP_SAT> dpt_t;
typedef ap_ufixed<28, 24, AP_TRN, AP_SAT> pt2_t;
Expand Down Expand Up @@ -177,6 +178,7 @@ namespace l1ct {
inline float floatHoe(hoe_t hoe) { return hoe.to_float(); };
inline float floatIDScore(id_score_t score) { return score.to_float(); };
inline float floatBtagScore(b_tag_score_t b_tag_score) { return b_tag_score.to_float(); }
inline float floatMass(mass2_t mass) { return mass.to_float(); }

inline pt_t makePt(int pt) { return ap_ufixed<16, 14>(pt) >> 2; }
inline dpt_t makeDPt(int dpt) { return ap_fixed<18, 16>(dpt) >> 2; }
Expand Down
87 changes: 87 additions & 0 deletions DataFormats/L1TParticleFlow/interface/gt_datatypes.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@ namespace l1gt {
// While bitwise identical to the l1ct::z0_t value, we store z0 in mm to profit of ap_fixed goodies
typedef ap_fixed<10, 9, AP_RND_CONV, AP_SAT> z0_t; // NOTE: mm instead of cm!!!
typedef ap_ufixed<10, 1, AP_RND, AP_SAT> b_tag_score_t;
typedef ap_ufixed<10, 1, AP_RND, AP_SAT> n_prong_score_t;
typedef ap_ufixed<17, 15, AP_RND_CONV, AP_SAT> mass2_t;
typedef ap_uint<1> valid_t;

// E/gamma fields
Expand All @@ -48,6 +50,7 @@ namespace l1gt {
inline float floatEta(eta_t eta) { return eta.to_float() * ETAPHI_LSB; }
inline float floatPhi(phi_t phi) { return phi.to_float() * ETAPHI_LSB; }
inline float floatZ0(z0_t z0) { return z0.to_float() * Z0_UNITS; }
inline float floatMassSq(mass2_t massSq) { return massSq.to_float(); }
} // namespace Scales

struct ThreeVector {
Expand Down Expand Up @@ -139,8 +142,90 @@ namespace l1gt {
return unpack_ap(bits);
}

inline static Jet unpack(const std::array<long long unsigned int, 2> &src) {
// unpack from two 64b ints
ap_uint<BITWIDTH> bits;
bits(63, 0) = src[0];
bits(127, 64) = src[1];
return unpack_ap(bits);
}

}; // struct Jet

struct WideJet {
valid_t valid;
ThreeVector v3;
z0_t z0;
n_prong_score_t hwNProngScore;
mass2_t hwMassSq;

inline bool operator==(const WideJet &other) const {
return valid == other.valid && z0 == other.z0 && hwNProngScore == other.hwNProngScore &&
hwMassSq == other.hwMassSq && v3 == other.v3;
}

static const int BITWIDTH = 128;
inline ap_uint<BITWIDTH> pack_ap() const {
ap_uint<BITWIDTH> ret = 0;
unsigned int start = 0;
pack_into_bits(ret, start, valid);
pack_into_bits(ret, start, v3.pack());
pack_into_bits(ret, start, z0);
pack_into_bits(ret, start, hwNProngScore);
start = 64; // Start second word
pack_into_bits(ret, start, hwMassSq);
return ret;
}

inline std::array<uint64_t, 2> pack() const {
std::array<uint64_t, 2> packed;
ap_uint<BITWIDTH> bits = this->pack_ap();
packed[0] = bits(63, 0);
packed[1] = bits(127, 64);
return packed;
}

inline static WideJet unpack_ap(const ap_uint<BITWIDTH> &src) {
WideJet ret;
ret.initFromBits(src);
return ret;
}

inline void initFromBits(const ap_uint<BITWIDTH> &src) {
unsigned int start = 0;
unpack_from_bits(src, start, valid);
unpack_from_bits(src, start, v3.pt);
unpack_from_bits(src, start, v3.phi);
unpack_from_bits(src, start, v3.eta);
unpack_from_bits(src, start, z0);
unpack_from_bits(src, start, hwNProngScore);
start = 64; // Start second word
unpack_from_bits(src, start, hwMassSq);
}

inline static WideJet unpack(const std::array<uint64_t, 2> &src) {
ap_uint<BITWIDTH> bits;
bits(63, 0) = src[0];
bits(127, 64) = src[1];
return unpack_ap(bits);
}

inline static WideJet unpack(long long unsigned int &src) {
// unpack from single 64b int
ap_uint<BITWIDTH> bits = src;
return unpack_ap(bits);
}

inline static WideJet unpack(const std::array<long long unsigned int, 2> &src) {
// unpack from two 64b ints
ap_uint<BITWIDTH> bits;
bits(63, 0) = src[0];
bits(127, 64) = src[1];
return unpack_ap(bits);
}

}; // struct WideJet

struct Sum {
valid_t valid;
pt_t vector_pt;
Expand Down Expand Up @@ -382,6 +467,8 @@ namespace l1ct {
return x * Scales::ETAPHI_CTtoGT_SCALE;
}

inline l1gt::mass2_t CTtoGT_massSq(mass2_t x) { return (l1gt::mass2_t)x; }

} // namespace l1ct

#endif
44 changes: 35 additions & 9 deletions DataFormats/L1TParticleFlow/interface/jets.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,11 @@ namespace l1ct {
glbeta_t hwEta;
glbphi_t hwPhi;
z0_t hwZ0;
b_tag_score_t hwBtagScore;
// b_tag_score_t hwBtagScore;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we really remove the btag score now from the jets? If so then you can remove the commented out lines here and throughout

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The existing b tag scores stored here are not actually used in CMSSW (perhaps they are not stored at all in this struct in CMSSW), so could in principle be removed, however they are used by the HLS in the firmware implementation (so perhaps we should keep them uncommented). A few other upcoming PRs may also touch this struct.

@thesps can you comment on how to proceed?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@EmyrClement - sorry I had forgotten about your question to @thesps. This comment suggests that it should be removed, which is now what is done in the master branch.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree that b_tag_score_t can be removed +1 it has been superseded in the now merged #47798

mass2_t hwMassSq;

inline bool operator==(const Jet &other) const {
return hwPt == other.hwPt && hwEta == other.hwEta && hwPhi == other.hwPhi;
return hwPt == other.hwPt && hwEta == other.hwEta && hwPhi == other.hwPhi && hwMassSq == other.hwMassSq;
}

inline bool operator>(const Jet &other) const { return hwPt > other.hwPt; }
Expand All @@ -28,7 +29,8 @@ namespace l1ct {
hwEta = 0;
hwPhi = 0;
hwZ0 = 0;
hwBtagScore = 0;
// hwBtagScore = 0;
hwMassSq = 0;
}

int intPt() const { return Scales::intPt(hwPt); }
Expand All @@ -37,25 +39,28 @@ namespace l1ct {
float floatPt() const { return Scales::floatPt(hwPt); }
float floatEta() const { return Scales::floatEta(hwEta); }
float floatPhi() const { return Scales::floatPhi(hwPhi); }
float floatBtagScore() const { return Scales::floatBtagScore(hwBtagScore); }
float floatZ0() const { return Scales::floatZ0(hwZ0); }
// float floatBtagScore() const { return Scales::floatBtagScore(hwBtagScore); }
float floatMass() const { return Scales::floatMass(hwMassSq); }

static const int BITWIDTH = pt_t::width + glbeta_t::width + glbphi_t::width + z0_t::width + b_tag_score_t::width;
// static const int BITWIDTH = pt_t::width + glbeta_t::width + glbphi_t::width + z0_t::width + b_tag_score_t::width + mass2_t::width;
static const int BITWIDTH = pt_t::width + glbeta_t::width + glbphi_t::width + z0_t::width + mass2_t::width;
inline ap_uint<BITWIDTH> pack_ap() const {
ap_uint<BITWIDTH> ret;
unsigned int start = 0;
pack_into_bits(ret, start, hwPt);
pack_into_bits(ret, start, hwEta);
pack_into_bits(ret, start, hwPhi);
pack_into_bits(ret, start, hwZ0);
pack_into_bits(ret, start, hwBtagScore);
// pack_into_bits(ret, start, hwBtagScore);
pack_into_bits(ret, start, hwMassSq);
return ret;
}

inline std::array<uint64_t, 2> pack() const {
std::array<uint64_t, 2> packed = {{0, 0}};
ap_uint<BITWIDTH> bits = this->pack_ap();
packed[0] = bits;
packed[0] = bits(63, 0);
//packed[1] = bits[slice]; // for when there are more than 64 bits in the word
return packed;
}
Expand All @@ -72,7 +77,8 @@ namespace l1ct {
unpack_from_bits(src, start, hwEta);
unpack_from_bits(src, start, hwPhi);
unpack_from_bits(src, start, hwZ0);
unpack_from_bits(src, start, hwBtagScore);
// unpack_from_bits(src, start, hwBtagScore);
unpack_from_bits(src, start, hwMassSq);
}

inline static Jet unpack(const std::array<uint64_t, 2> &src) {
Expand All @@ -87,14 +93,34 @@ namespace l1ct {
return unpack_ap(bits);
}

inline static Jet unpack(const std::array<long long unsigned int, 2> &src) {
// unpack from two 64b ints
ap_uint<BITWIDTH> bits;
bits(63, 0) = src[0];
// bits(127, 64) = src[1];
return unpack_ap(bits);
}

l1gt::Jet toGT() const {
l1gt::Jet j;
j.valid = hwPt != 0;
j.v3.pt = CTtoGT_pt(hwPt);
j.v3.phi = CTtoGT_phi(hwPhi);
j.v3.eta = CTtoGT_eta(hwEta);
j.z0(l1ct::z0_t::width - 1, 0) = hwZ0(l1ct::z0_t::width - 1, 0);
j.hwBtagScore = hwBtagScore;
j.hwBtagScore = 0;
return j;
}

l1gt::WideJet toGTWide() const {
l1gt::WideJet j;
j.valid = hwPt != 0;
j.v3.pt = CTtoGT_pt(hwPt);
j.v3.phi = CTtoGT_phi(hwPhi);
j.v3.eta = CTtoGT_eta(hwEta);
j.z0(l1ct::z0_t::width - 1, 0) = hwZ0(l1ct::z0_t::width - 1, 0);
j.hwNProngScore = 0;
j.hwMassSq = CTtoGT_massSq(hwMassSq);
return j;
}
};
Expand Down
1 change: 1 addition & 0 deletions L1Trigger/Configuration/python/SimL1Emulator_cff.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -251,6 +251,7 @@
# PF MET
# ########################################################################
from L1Trigger.Phase2L1ParticleFlow.l1pfJetMet_cff import *
_phase2_siml1emulator.add(L1TPFJetsTask)
_phase2_siml1emulator.add(L1TPFJetsEmulationTask)

from L1Trigger.Phase2L1ParticleFlow.l1tMETPFProducer_cfi import *
Expand Down
31 changes: 28 additions & 3 deletions L1Trigger/Phase2L1ParticleFlow/interface/jetmet/L1SeedConePFJetEmulator.h
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
#ifndef L1Trigger_Phase2L1ParticleFlow_L1SeedConePFJetEmulator_h
#define L1Trigger_Phase2L1ParticleFlow_L1SeedConePFJetEmulator_h

#define NCONSTITSFW 32

#include "DataFormats/L1TParticleFlow/interface/layer1_emulator.h"
#include "DataFormats/L1TParticleFlow/interface/jets.h"

Expand All @@ -21,6 +23,18 @@ class L1SCJetEmu {
typedef ap_int<13> detaphi_t; // Type for deta & dphi
typedef ap_fixed<18, 23> detaphi2_t; // Type for deta^2 & dphi^2
typedef ap_fixed<22, 22> pt_etaphi_t; // Type for product of pt with deta & dphi

typedef ap_ufixed<13, 1, AP_RND, AP_SAT>
eventrig_t; // stores values between 0 and 2, - 0 bit for sign, - 1 bit for integer, leaves 12 for frac
typedef ap_fixed<13, 1, AP_RND, AP_SAT>
oddtrig_t; // stores values between -1 and 1, 13 - 1 bit for sign, - 0 bits for integer, leaves 12 for frac

// typedef l1ct::mass_t mass_t; // stores values up to ~1 TeV, 18 bits - 0 for sign, - 10 for integer, 14 total bits improves performance
typedef l1ct::mass2_t mass2_t;

typedef ap_ufixed<20, 12, AP_TRN, AP_SAT> ppt_t; // stores values between -1 and 1
typedef ap_fixed<22, 14, AP_TRN, AP_SAT> npt_t; // stores values between -1 and 1 JUST REDUCED BY 2

typedef l1ct::PuppiObjEmu Particle;

class Jet : public l1ct::Jet {
Expand All @@ -43,6 +57,7 @@ class L1SCJetEmu {
typedef ap_ufixed<18, -2> inv_pt_t;
static constexpr int N_table_inv_pt = 1024;
inv_pt_t inv_pt_table_[N_table_inv_pt];
static constexpr int hwEtaPhi_steps = 185; // corresponds to eta/phi range of 0 to 0.8

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

Expand Down Expand Up @@ -142,10 +157,20 @@ class L1SCJetEmu {
return out;
}

template <typename lut_T, int N>
static std::array<lut_T, N> init_trig_lut(lut_T (*func)(float)) {
std::array<lut_T, N> lut;
for (int hwEtaPhi = 0; hwEtaPhi < N; hwEtaPhi++) {
lut[hwEtaPhi] = func(hwEtaPhi * l1ct::Scales::ETAPHI_LSB);
}
return lut;
}

static detaphi_t deltaPhi(Particle a, Particle b);
bool inCone(Particle seed, Particle part) const;
Jet makeJet_HW(const std::vector<Particle>& parts) const;

std::vector<Particle> sortConstituents(const std::vector<Particle>& parts, const Particle seed) const;
mass2_t jetMass_HW(const std::vector<Particle>& parts) const;
Jet makeJet_HW(const std::vector<Particle>& parts, const Particle seed) const;
}; // class L1SCJetEmu

#endif
#endif
Loading