-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Documenter.jl
committed
Nov 22, 2024
1 parent
357b5b5
commit a329d29
Showing
27 changed files
with
1,527 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| {"documenter":{"julia_version":"1.11.1","generation_timestamp":"2024-11-22T15:48:50","documenter_version":"1.8.0"}} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| <!DOCTYPE html> | ||
| <html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>EDM4hep · JetReconstruction.jl</title><meta name="title" content="EDM4hep · JetReconstruction.jl"/><meta property="og:title" content="EDM4hep · JetReconstruction.jl"/><meta property="twitter:title" content="EDM4hep · JetReconstruction.jl"/><meta name="description" content="Documentation for JetReconstruction.jl."/><meta property="og:description" content="Documentation for JetReconstruction.jl."/><meta property="twitter:description" content="Documentation for JetReconstruction.jl."/><script data-outdated-warner src="../assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL=".."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../assets/documenter.js"></script><script src="../search_index.js"></script><script src="../siteinfo.js"></script><script src="../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-mocha.css" data-theme-name="catppuccin-mocha"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-macchiato.css" data-theme-name="catppuccin-macchiato"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-frappe.css" data-theme-name="catppuccin-frappe"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-latte.css" data-theme-name="catppuccin-latte"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><a class="docs-logo" href="../"><img src="../assets/logo.svg" alt="JetReconstruction.jl logo"/></a><div class="docs-package-name"><span class="docs-autofit"><a href="../">JetReconstruction.jl</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li><a class="tocitem" href="../">Home</a></li><li><a class="tocitem" href="../examples/">Examples</a></li><li class="is-active"><a class="tocitem" href>EDM4hep</a><ul class="internal"><li><a class="tocitem" href="#Examples"><span>Examples</span></a></li><li><a class="tocitem" href="#Function-Index"><span>Function Index</span></a></li><li><a class="tocitem" href="#EDM4hep-Interfaces"><span>EDM4hep Interfaces</span></a></li></ul></li><li><a class="tocitem" href="../visualisation/">Visualisation</a></li><li><a class="tocitem" href="../particles/">Particle Inputs</a></li><li><a class="tocitem" href="../strategy/">Reconstruction Strategies</a></li><li><span class="tocitem">Reference Docs</span><ul><li><a class="tocitem" href="../lib/public/">Public API</a></li><li><a class="tocitem" href="../lib/internal/">Internal API</a></li></ul></li><li><span class="tocitem">Extras</span><ul><li><a class="tocitem" href="../extras/serialisation/">Serialisation</a></li></ul></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>EDM4hep</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>EDM4hep</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/JuliaHEP/JetReconstruction.jl" title="View the repository on GitHub"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">GitHub</span></a><a class="docs-navbar-link" href="https://github.com/JuliaHEP/JetReconstruction.jl/blob/main/docs/src/EDM4hep.md" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="EDM4hep-Inputs"><a class="docs-heading-anchor" href="#EDM4hep-Inputs">EDM4hep Inputs</a><a id="EDM4hep-Inputs-1"></a><a class="docs-heading-anchor-permalink" href="#EDM4hep-Inputs" title="Permalink"></a></h1><p>Extension functionality to read EDM4hep ReconstructedParticles, using the <a href="https://github.com/peremato/EDM4hep.jl">EDM4hep.jl</a> package.</p><h2 id="Examples"><a class="docs-heading-anchor" href="#Examples">Examples</a><a id="Examples-1"></a><a class="docs-heading-anchor-permalink" href="#Examples" title="Permalink"></a></h2><p>EDM4hep <code>ReconstructedParticles</code> can be used as direct input into jet reconstruction.</p><p>A number of working examples are maintained in the <a href="https://github.com/JuliaHEP/JetReconstruction.jl/tree/main/examples/EDM4hep">EDM4hep examples directory</a> of the package's <code>examples</code>.</p><p>Here is a snippet that shows the main steps:</p><pre><code class="language-julia hljs">using EDM4hep | ||
| using EDM4hep.RootIO | ||
| using JetReconstruction | ||
|
|
||
| # Change this to something that works on your system | ||
| input_file = joinpath("directory", "EDM4hep.root") | ||
| reader = RootIO.Reader(input_file) | ||
| events = RootIO.get(reader, "events") | ||
|
|
||
| evt = events[1] | ||
|
|
||
| recps = RootIO.get(reader, evt, "ReconstructedParticles") | ||
|
|
||
| cs = jet_reconstruct(recps; algorithm = JetAlgorithm.Durham)</code></pre><h2 id="Function-Index"><a class="docs-heading-anchor" href="#Function-Index">Function Index</a><a id="Function-Index-1"></a><a class="docs-heading-anchor-permalink" href="#Function-Index" title="Permalink"></a></h2><ul><li><a href="#JetReconstruction.energy-Tuple{ReconstructedParticle}"><code>JetReconstruction.energy</code></a></li><li><a href="#JetReconstruction.px-Tuple{ReconstructedParticle}"><code>JetReconstruction.px</code></a></li><li><a href="#JetReconstruction.py-Tuple{ReconstructedParticle}"><code>JetReconstruction.py</code></a></li><li><a href="#JetReconstruction.pz-Tuple{ReconstructedParticle}"><code>JetReconstruction.pz</code></a></li></ul><h2 id="EDM4hep-Interfaces"><a class="docs-heading-anchor" href="#EDM4hep-Interfaces">EDM4hep Interfaces</a><a id="EDM4hep-Interfaces-1"></a><a class="docs-heading-anchor-permalink" href="#EDM4hep-Interfaces" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="JetReconstruction.energy-Tuple{ReconstructedParticle}" href="#JetReconstruction.energy-Tuple{ReconstructedParticle}"><code>JetReconstruction.energy</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">JetReconstruction.energy(recoparticle::ReconstructedParticle)</code></pre><p>Return the energy component of a ReconstructedParticle's four vector.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaHEP/JetReconstruction.jl/blob/38a623d1ac005620ef1c111279366659efb5ae56/ext/EDM4hepJets.jl#L29-L33">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="JetReconstruction.px-Tuple{ReconstructedParticle}" href="#JetReconstruction.px-Tuple{ReconstructedParticle}"><code>JetReconstruction.px</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">JetReconstruction.px(recoparticle::ReconstructedParticle)</code></pre><p>Return the x component of the momentum of a ReconstructedParticle.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaHEP/JetReconstruction.jl/blob/38a623d1ac005620ef1c111279366659efb5ae56/ext/EDM4hepJets.jl#L8-L12">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="JetReconstruction.py-Tuple{ReconstructedParticle}" href="#JetReconstruction.py-Tuple{ReconstructedParticle}"><code>JetReconstruction.py</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">JetReconstruction.py(recoparticle::ReconstructedParticle)</code></pre><p>Return the y component of the momentum of a ReconstructedParticle.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaHEP/JetReconstruction.jl/blob/38a623d1ac005620ef1c111279366659efb5ae56/ext/EDM4hepJets.jl#L15-L19">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="JetReconstruction.pz-Tuple{ReconstructedParticle}" href="#JetReconstruction.pz-Tuple{ReconstructedParticle}"><code>JetReconstruction.pz</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">JetReconstruction.pz(recoparticle::ReconstructedParticle)</code></pre><p>Return the z component of the momentum of a ReconstructedParticle.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaHEP/JetReconstruction.jl/blob/38a623d1ac005620ef1c111279366659efb5ae56/ext/EDM4hepJets.jl#L22-L26">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../examples/">« Examples</a><a class="docs-footer-nextpage" href="../visualisation/">Visualisation »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.8.0 on <span class="colophon-date" title="Friday 22 November 2024 15:48">Friday 22 November 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> |
Oops, something went wrong.