Skip to content

Commit 9f80045

Browse files
Small documentation update for parent_jets
1 parent 65101ba commit 9f80045

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

docs/src/index.md

+9-1
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ sorted_jets = sort!(inclusive_jets(cs::ClusterSequence; ptmin=5.0),
8888
by=JetReconstruction.energy, rev=true)
8989
```
9090

91-
## Jet Constituents
91+
## Jet Constituents and Jet Parents
9292

9393
There are two ways to retrieve jet constituents. The first way is just to
9494
retrieve the *indexes* of the constituent jets. These indexes refer to the
@@ -107,6 +107,14 @@ reconstruction is required (to avoid circular dependencies and improve memory
107107
management reconstructed jets do not contain a link back to their cluster
108108
sequence).
109109

110+
To retrieve a jet's parents:
111+
112+
- [`parent_jets`](@ref)
113+
114+
This will return a tuple of the target jet's parents, or `nothing` when one or
115+
both parents are missing (the only case when a jet has one parent is when it
116+
undergoes a *beam merge* step).
117+
110118
## References
111119

112120
Although it has been developed further since the CHEP2023 conference, the CHEP

0 commit comments

Comments
 (0)