Skip to content

[Phase-2 L1]: update readme for P2GT menu configs #47282

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
cmsbuild merged 3 commits into from
Feb 18, 2025
Merged

[Phase-2 L1]: update readme for P2GT menu configs #47282

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
80851f3
Update P2GT readme and add one for the Menu folder
artlbv Jan 24, 2025
e664dea
Use central menu in P2GT test script
artlbv Jan 24, 2025
b16e670
Expand P2GT menu readme
artlbv Jan 24, 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
25 changes: 25 additions & 0 deletions L1Trigger/Configuration/python/Phase2GTMenus/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# L1 Phase-2 Global Trigger (P2GT) menus

Menus for the P2GT emulator (and firmware) are stored in this folder.

See the Menu twiki page for a general overview: https://twiki.cern.ch/twiki/bin/viewauth/CMS/PhaseIIL1TriggerMenuTools

See the `README` in the P2GT package for details on how to write the menu configs:
[`L1Trigger/Phase2L1GT/README.md`](L1Trigger/Phase2L1GT/README.md)

Available menus:
* `step1_2023` –> first menu of 2023
* `step1_2024` -> the 2024 version
* `step1_2024_explicitSeeds` –> the 2024 version with explicit definitions of individual objects

These menus can be specified via the cmsDriver configuration as `-s L1P2GT:step1_2024`.

Note that the full menu expanded configuration can be inspected using `edmConfigDump` on a `cmsRun` config that executes the `L1P2GT` step:
1. Produce the config via
```
cmsDriver.py -s L1P2GT --conditions auto:phase2_realistic_T33 --filein file:file.root --no_exec --python_filename l1pgt_cfg.py
```
2. Dump the config via
```
edmConfigDump l1pgt_cfg.py > edm_l1pgt_cfg.py
```
85 changes: 84 additions & 1 deletion L1Trigger/Phase2L1GT/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Menu configuration manual

**NB! A general overview of the P2GT emulator menus is given in the `L1Trigger/Configuration/python/Phase2GTMenus/README.md`**

## Conditions

The basic building blocks of a Phase-2 Global Trigger menu are conditions. In order to start writing a menu one should first pull the standard definitions for the conditions into the configuration. These standard definitions contain the scale parameters (c.f. [l1tGTScales.py](python/l1tGTScales.py)) as well as the values for the $\cos$ and $\cosh$ LUT (computed in [l1tGTSingleInOutLUT.py](python/l1tGTSingleInOutLUT.py)).
Expand Down Expand Up @@ -89,6 +91,87 @@ process.TripleTkMuon533 = l1tGTTripleObjectCond.clone(
)
```

### Object presets to synchronise with the MenuTools

The L1 DPG Phase-2 Menu team is responsible for implementing, maintaining and validating the L1 menu.
See the twiki: https://twiki.cern.ch/twiki/bin/viewauth/CMS/PhaseIIL1TriggerMenuTools

In `L1Trigger/Phase2L1GT/python/l1tGTObject_constants.py` there are several functions to extract object cut properties defined by the menu team, which allow to simplify and synchronise the seed definitions between the P2GT emulator in CMSSW and the [MenuTools](https://github.com/cms-l1-dpg/Phase2-L1MenuTools).

There are these getter functions available to simplify the seed definitions:
* `get_object_etalowbounds(obj)` to get the min abs(eta) requirements to be set for `regionsAbsEtaLowerBounds`
* `get_object_thrs(thr, obj, id)` to set the thresholds using the online-offline scalings (per regions if available, otherwise a single value e.g. for sums). The `thr` argument is the offline threshold.
* `get_object_ids(obj, id)` to set the ID values (per regions if available) for
* `get_object_isos(obj, id)` to set the ID values (per regions if available)

The arguments are:
- `obj`: the trigger object name as from the P2GT producer, e.g. `GMTTkMuons`,
- `id`: the ID label e.g. `Loose` or `NoIso`.

The definitions of the object requirements are hardcoded in these files:
* IDs: `L1Trigger/Phase2L1GT/python/l1tGTObject_ids.py`
* Scalings: `L1Trigger/Phase2L1GT/python/l1tGTObject_scalings.py`

An example of translating the hard-coded values for `GMTTkMuon` is below:
```python
collection1 = cms.PSet(
tag = cms.InputTag("l1tGTProducer", "GMTTkMuons"),
regionsAbsEtaLowerBounds=cms.vdouble(0,0.83,1.24),
regionsMinPt=cms.vdouble(13,13,13)
qualityFlags = cms.uint32(0b0001)
...
)
```

Becomes:
```python
collection1 = cms.PSet(
tag = cms.InputTag("l1tGTProducer", "GMTTkMuons"),
regionsAbsEtaLowerBounds = get_object_etalowbounds("GMTTkMuons"),
regionsMinPt = get_object_thrs(15, "GMTTkMuons","VLoose"),
qualityFlags = get_object_ids("GMTTkMuons","VLoose"),
...
)
```

#### Simplification for common baseline objects

As there are only few baseline objects which are are used in many seeds, it might be simpler to define some baseline objects that could be re-used in many seeds, modifying/extending only with additional cuts.

E.g. in the b-physics seeds identical `Loose` `tkMuons` are used with only the pt thresholds varying.
Thus a baseline tkMuon can be defined as:
```python
l1tGTtkMuon = cms.PSet(
tag = cms.InputTag("l1tGTProducer", "GMTTkMuons"),
minEta = cms.double(-2.4),
maxEta = cms.double(2.4),
regionsAbsEtaLowerBounds = get_object_etalowbounds("GMTTkMuons"),
)
l1tGTtkMuonVLoose = l1tGTtkMuon.clone(
qualityFlags = get_object_ids("GMTTkMuons","VLoose"),
)
```
And then this can be used in seed definitions by only changing / adding what is needed, e.g.:
```python
FakeDiMuSeed = l1tGTDoubleObjectCond.clone(
collection1 = l1tGTtkMuon.clone(
minPt = cms.double(5), # overwrites minPt = 0 from template
),
collection2 = l1tGTtkMuonVLoose.clone(
minEta = cms.double(-1.5), # overwrites minEta = -2.4
maxEta = cms.double(1.5), # overwrites maxEta = 2.4
),
)
```
**NB!** Also new cuts can be added, however caution is needed to not mix per-region cuts such as `regionsMinPt` and the inclusive version `minPt`.

For single object conditions using pre-defined objects requires to first clone the condition and then extend it with the objects PSet as shown below:
```python
SingleTkMuon22 = l1tGTSingleObjectCond.clone(
l1tGTtkMuonVLoose.clone(),
)
```

### Single cuts

Possible cuts on single quantities are:
Expand Down Expand Up @@ -288,4 +371,4 @@ process.load('L1Trigger.Phase2L1GT.l1tGTBoardWriterVU13P_cff')
process.pBoardDataInputVU13P = cms.EndPath(process.BoardDataInputVU13P)
process.pBoardDataOutputObjectsVU13P = cms.EndPath(process.BoardDataOutputObjectsVU13P)
process.pAlgoBitBoardDataVU13P = cms.EndPath(process.AlgoBitBoardDataVU13P)
```
```
2 changes: 1 addition & 1 deletion L1Trigger/Phase2L1GT/test/test_GT.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@
process.load('L1Trigger.Configuration.GTemulator_cff')
process.GTemulation_step = cms.Path(process.GTemulator)

process.load('L1Trigger.Phase2L1GT.l1tGTMenu_cff')
process.load('L1Trigger.Configuration.Phase2GTMenus.SeedDefinitions.step1_2024.l1tGTMenu_cff')
from L1Trigger.Phase2L1GT.l1tGTAlgoBlockProducer_cff import collectAlgorithmPaths


Expand Down