Deploy to GitHub pages

UCATLAS · Nov 12, 2024 · c9451a3 · c9451a3
commit c9451a3
Show file tree

Hide file tree

Showing 1,202 changed files with 302,568 additions and 0 deletions.
diff --git a/.buildinfo b/.buildinfo
@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 3a0aa59c7ed8b37b6bf049672ee6dcf2
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/.nojekyll b/.nojekyll
diff --git a/API.html b/API.html
@@ -0,0 +1,319 @@
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+  <meta charset="utf-8">
+
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+  <title>API Reference &mdash; xAODAnaHelpers c38ee56 documentation</title>
+
+
+
+
+
+
+
+
+  <script type="text/javascript" src="_static/js/modernizr.min.js"></script>
+
+
+      <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
+        <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
+        <script src="_static/jquery.js"></script>
+        <script src="_static/underscore.js"></script>
+        <script src="_static/doctools.js"></script>
+        <script src="_static/collapsible-lists/js/CollapsibleLists.compressed.js"></script>
+        <script src="_static/collapsible-lists/js/apply-collapsible-lists.js"></script>
+
+    <script type="text/javascript" src="_static/js/theme.js"></script>
+
+
+
+
+  <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
+  <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
+  <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
+  <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
+  <link rel="stylesheet" href="_static/collapsible-lists/css/tree_view.css" type="text/css" />
+    <link rel="index" title="Index" href="genindex.html" />
+    <link rel="search" title="Search" href="search.html" />
+    <link rel="next" title="Getting Objects" href="Getters.html" />
+    <link rel="prev" title="xAH FAQ" href="FAQs.html" /> 
+</head>
+
+<body class="wy-body-for-nav">
+
+
+  <div class="wy-grid-for-nav">
+
+    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+      <div class="wy-side-scroll">
+        <div class="wy-side-nav-search" >
+
+
+
+            <a href="index.html" class="icon icon-home"> xAODAnaHelpers
+
+
+
+          </a>
+
+
+
+
+              <div class="version">
+                c38ee56
+              </div>
+
+
+
+
+<div role="search">
+  <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
+    <input type="text" name="q" placeholder="Search docs" />
+    <input type="hidden" name="check_keywords" value="yes" />
+    <input type="hidden" name="area" value="default" />
+  </form>
+</div>
+
+
+        </div>
+
+        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+
+
+
+              <ul class="current">
+<li class="toctree-l1"><a class="reference internal" href="Intro.html">Introduction</a></li>
+<li class="toctree-l1"><a class="reference internal" href="Installing.html">Installing</a></li>
+<li class="toctree-l1"><a class="reference internal" href="UsingUs.html">xAH_run.py</a></li>
+<li class="toctree-l1"><a class="reference internal" href="Algorithms.html">Algorithms</a></li>
+<li class="toctree-l1"><a class="reference internal" href="Development.html">Development</a></li>
+<li class="toctree-l1"><a class="reference internal" href="Community.html">Community</a></li>
+<li class="toctree-l1"><a class="reference internal" href="FAQs.html">xAH FAQ</a></li>
+<li class="toctree-l1 current"><a class="current reference internal" href="#">API Reference</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="Getters.html">Getting Objects</a></li>
+<li class="toctree-l2"><a class="reference internal" href="Calibrators.html">Calibrating Objects</a></li>
+<li class="toctree-l2"><a class="reference internal" href="Correctors.html">Efficiency Correcting</a></li>
+<li class="toctree-l2"><a class="reference internal" href="Selectors.html">Selecting Objects</a></li>
+<li class="toctree-l2"><a class="reference internal" href="Histograms.html">Histograms</a></li>
+<li class="toctree-l2"><a class="reference internal" href="ToolsUsed.html">Tools Used</a></li>
+<li class="toctree-l2"><a class="reference internal" href="Outputs.html">Producing Outputs</a></li>
+<li class="toctree-l2"><a class="reference internal" href="Utilities.html">Utilities</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="api/library_root.html">Doxygen API</a></li>
+</ul>
+
+
+
+        </div>
+      </div>
+    </nav>
+
+    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+      <nav class="wy-nav-top" aria-label="top navigation">
+
+          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+          <a href="index.html">xAODAnaHelpers</a>
+
+      </nav>
+
+
+      <div class="wy-nav-content">
+
+        <div class="rst-content">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<div role="navigation" aria-label="breadcrumbs navigation">
+
+  <ul class="wy-breadcrumbs">
+
+      <li><a href="index.html">Docs</a> &raquo;</li>
+
+      <li>API Reference</li>
+
+
+      <li class="wy-breadcrumbs-aside">
+
+
+            <a href="_sources/API.rst.txt" rel="nofollow"> View page source</a>
+
+
+      </li>
+
+  </ul>
+
+
+  <hr/>
+</div>
+          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+           <div itemprop="articleBody">
+
+  <div class="section" id="api-reference">
+<h1>API Reference<a class="headerlink" href="#api-reference" title="Permalink to this headline">¶</a></h1>
+<div class="toctree-wrapper compound">
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="Getters.html">Getting Objects</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="HLTJetGetter.html">HLT Jet Getter</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="Calibrators.html">Calibrating Objects</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="ElectronCalibrator.html"><span class="math notranslate nohighlight">\(e\)</span></a></li>
+<li class="toctree-l2"><a class="reference internal" href="JetCalibrator.html"><span class="math notranslate nohighlight">\(j\)</span></a></li>
+<li class="toctree-l2"><a class="reference internal" href="MuonCalibrator.html"><span class="math notranslate nohighlight">\(\mu\)</span></a></li>
+<li class="toctree-l2"><a class="reference internal" href="TauCalibrator.html"><span class="math notranslate nohighlight">\(\tau\)</span></a></li>
+<li class="toctree-l2"><a class="reference internal" href="PhotonCalibrator.html"><span class="math notranslate nohighlight">\(\gamma\)</span></a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="Correctors.html">Efficiency Correcting</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="BJetEfficiencyCorrector.html"><em>b</em>-jet</a></li>
+<li class="toctree-l2"><a class="reference internal" href="ElectronEfficiencyCorrector.html"><span class="math notranslate nohighlight">\(e\)</span></a></li>
+<li class="toctree-l2"><a class="reference internal" href="MuonEfficiencyCorrector.html"><span class="math notranslate nohighlight">\(\mu\)</span></a></li>
+<li class="toctree-l2"><a class="reference internal" href="TauEfficiencyCorrector.html"><span class="math notranslate nohighlight">\(\tau\)</span></a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="Selectors.html">Selecting Objects</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="BasicEventSelection.html">Event</a></li>
+<li class="toctree-l2"><a class="reference internal" href="OverlapRemover.html">Overlap Removal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="ElectronSelector.html"><span class="math notranslate nohighlight">\(e\)</span></a></li>
+<li class="toctree-l2"><a class="reference internal" href="JetSelector.html"><span class="math notranslate nohighlight">\(j\)</span></a></li>
+<li class="toctree-l2"><a class="reference internal" href="MuonSelector.html"><span class="math notranslate nohighlight">\(\mu\)</span></a></li>
+<li class="toctree-l2"><a class="reference internal" href="PhotonSelector.html"><span class="math notranslate nohighlight">\(\gamma\)</span></a></li>
+<li class="toctree-l2"><a class="reference internal" href="TauSelector.html"><span class="math notranslate nohighlight">\(\tau\)</span></a></li>
+<li class="toctree-l2"><a class="reference internal" href="TrackSelector.html">Tracks</a></li>
+<li class="toctree-l2"><a class="reference internal" href="TruthSelector.html">Truth</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="Histograms.html">Histograms</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="Histograms.html#histogrammanager">HistogramManager</a></li>
+<li class="toctree-l2"><a class="reference internal" href="Histograms.html#classes">Classes</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="ClusterHists.html">ClusterHists</a></li>
+<li class="toctree-l3"><a class="reference internal" href="JetHists.html">JetHists</a></li>
+<li class="toctree-l3"><a class="reference internal" href="MetHists.html">MetHists</a></li>
+<li class="toctree-l3"><a class="reference internal" href="MuonHists.html">MuonHists</a></li>
+<li class="toctree-l3"><a class="reference internal" href="TrackHists.html">TrackHists</a></li>
+<li class="toctree-l3"><a class="reference internal" href="VtxHists.html">VtxHists</a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="Histograms.html#algorithms">Algorithms</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="ClusterHistsAlgo.html">ClusterHistsAlgo</a></li>
+<li class="toctree-l3"><a class="reference internal" href="JetHistsAlgo.html">JetHistsAlgo</a></li>
+<li class="toctree-l3"><a class="reference internal" href="MetHistsAlgo.html">MetHistsAlgo</a></li>
+<li class="toctree-l3"><a class="reference internal" href="MuonHistsAlgo.html">MuonHistsAlgo</a></li>
+<li class="toctree-l3"><a class="reference internal" href="TrackHistsAlgo.html">TrackHistsAlgo</a></li>
+</ul>
+</li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="ToolsUsed.html">Tools Used</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="ToolsUsed.html#event-level">Event Level</a></li>
+<li class="toctree-l2"><a class="reference internal" href="ToolsUsed.html#e-and-gamma"><span class="math notranslate nohighlight">\(e\)</span> and <span class="math notranslate nohighlight">\(\gamma\)</span></a></li>
+<li class="toctree-l2"><a class="reference internal" href="ToolsUsed.html#mu"><span class="math notranslate nohighlight">\(\mu\)</span></a></li>
+<li class="toctree-l2"><a class="reference internal" href="ToolsUsed.html#j"><span class="math notranslate nohighlight">\(j\)</span></a></li>
+<li class="toctree-l2"><a class="reference internal" href="ToolsUsed.html#tau-jets"><span class="math notranslate nohighlight">\(\tau\)</span> jets</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="Outputs.html">Producing Outputs</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="Outputs.html#ttree-outputs">TTree Outputs</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="HelpTreeBase.html">Tree Maker Base Class</a></li>
+<li class="toctree-l3"><a class="reference internal" href="TreeAlgo.html">Tree Maker Algorithm</a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="Outputs.html#xaod-outputs">xAOD Outputs</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="MinixAOD.html">Mini-xAOD</a></li>
+</ul>
+</li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="Utilities.html">Utilities</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="DebugTool.html">Debug Tool</a></li>
+<li class="toctree-l2"><a class="reference internal" href="HelperClasses.html">Helper Classes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="HelperFunctions.html">Helper Functions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="METConstructor.html">MET Constructor</a></li>
+<li class="toctree-l2"><a class="reference internal" href="ParticlePIDManager.html">Particle PID Manager</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="ParticlePIDManager.html#electron-lh-pid-manager">Electron LH PID Manager</a></li>
+<li class="toctree-l3"><a class="reference internal" href="ParticlePIDManager.html#electron-cut-based-pid-manager">Electron Cut-Based PID Manager</a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="xAHAlgorithm.html">xAH::Algorithm</a></li>
+<li class="toctree-l2"><a class="reference internal" href="MessagePrinterAlgo.html">MessagePrinterAlgo</a></li>
+</ul>
+</li>
+</ul>
+</div>
+</div>
+
+
+           </div>
+
+          </div>
+          <footer>
+
+    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+        <a href="Getters.html" class="btn btn-neutral float-right" title="Getting Objects" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+        <a href="FAQs.html" class="btn btn-neutral float-left" title="xAH FAQ" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+    </div>
+
+
+  <hr/>
+
+  <div role="contentinfo">
+    <p>
+        &copy; Copyright 2015-2017, ATLAS Collaboration
+
+    </p>
+  </div>
+  Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. 
+
+</footer>
+
+        </div>
+      </div>
+
+    </section>
+
+  </div>
+
+
+
+  <script type="text/javascript">
+      jQuery(function () {
+          SphinxRtdTheme.Navigation.enable(true);
+      });
+  </script>
+
+
+
+
+
+
+</body>
+</html>