deploy: f739ae4

icecube · Aug 12, 2024 · eb0a1e9 · eb0a1e9
1 parent 6ff9fc2
commit eb0a1e9
Show file tree

Hide file tree

Showing 10 changed files with 421 additions and 3 deletions.
diff --git a/_modules/index.html b/_modules/index.html
@@ -96,6 +96,7 @@ <h1>All modules for which code is available</h1>
 <li><a href="pisa/scripts/test_flux_weights.html">pisa.scripts.test_flux_weights</a></li>
 <li><a href="pisa/stages/absorption/earth_absorption.html">pisa.stages.absorption.earth_absorption</a></li>
 <li><a href="pisa/stages/aeff/aeff.html">pisa.stages.aeff.aeff</a></li>
+<li><a href="pisa/stages/aeff/param.html">pisa.stages.aeff.param</a></li>
 <li><a href="pisa/stages/aeff/weight.html">pisa.stages.aeff.weight</a></li>
 <li><a href="pisa/stages/aeff/weight_hnl.html">pisa.stages.aeff.weight_hnl</a></li>
 <li><a href="pisa/stages/background/atm_muons.html">pisa.stages.background.atm_muons</a></li>

diff --git a/_modules/pisa/stages/aeff/param.html b/_modules/pisa/stages/aeff/param.html
diff --git a/_sources/pisa.stages.aeff.rst.txt b/_sources/pisa.stages.aeff.rst.txt
@@ -12,6 +12,14 @@ pisa.stages.aeff.aeff module
    :undoc-members:
    :show-inheritance:
 
+pisa.stages.aeff.param module
+-----------------------------
+
+.. automodule:: pisa.stages.aeff.param
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 pisa.stages.aeff.weight module
 ------------------------------
 

diff --git a/genindex.html b/genindex.html
@@ -207,6 +207,8 @@ <h2 id="A">A</h2>
         <li><a href="pisa.stages.absorption.html#pisa.stages.absorption.earth_absorption.earth_absorption.apply_function">(pisa.stages.absorption.earth_absorption.earth_absorption method)</a>
 </li>
         <li><a href="pisa.stages.aeff.html#pisa.stages.aeff.aeff.aeff.apply_function">(pisa.stages.aeff.aeff.aeff method)</a>
+</li>
+        <li><a href="pisa.stages.aeff.html#pisa.stages.aeff.param.param.apply_function">(pisa.stages.aeff.param.param method)</a>
 </li>
         <li><a href="pisa.stages.aeff.html#pisa.stages.aeff.weight.weight.apply_function">(pisa.stages.aeff.weight.weight method)</a>
 </li>
@@ -1715,6 +1717,8 @@ <h2 id="L">L</h2>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="pisa.stages.aeff.html#pisa.stages.aeff.param.load_aeff_param">load_aeff_param() (in module pisa.stages.aeff.param)</a>
+</li>
       <li><a href="pisa.scripts.html#pisa.scripts.fit_hypersurfaces.load_and_modify_pipeline_cfg">load_and_modify_pipeline_cfg() (in module pisa.scripts.fit_hypersurfaces)</a>
 </li>
       <li><a href="pisa.stages.data.html#pisa.stages.data.simple_data_loader.simple_data_loader.load_events">load_events() (pisa.stages.data.simple_data_loader.simple_data_loader method)</a>
@@ -1990,6 +1994,8 @@ <h2 id="M">M</h2>
         <li><a href="pisa.stages.aeff.html#module-pisa.stages.aeff">pisa.stages.aeff</a>
 </li>
         <li><a href="pisa.stages.aeff.html#module-pisa.stages.aeff.aeff">pisa.stages.aeff.aeff</a>
+</li>
+        <li><a href="pisa.stages.aeff.html#module-pisa.stages.aeff.param">pisa.stages.aeff.param</a>
 </li>
         <li><a href="pisa.stages.aeff.html#module-pisa.stages.aeff.weight">pisa.stages.aeff.weight</a>
 </li>
@@ -2423,6 +2429,8 @@ <h2 id="P">P</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="pisa.core.html#pisa.core.param.Param">Param (class in pisa.core.param)</a>
+</li>
+      <li><a href="pisa.stages.aeff.html#pisa.stages.aeff.param.param">param (class in pisa.stages.aeff.param)</a>
 </li>
       <li><a href="pisa.utils.hypersurface.html#pisa.utils.hypersurface.hyper_interpolator.HypersurfaceInterpolator.param_names">param_names (pisa.utils.hypersurface.hyper_interpolator.HypersurfaceInterpolator property)</a>
 
@@ -2720,6 +2728,13 @@ <h2 id="P">P</h2>
 
       <ul>
         <li><a href="pisa.stages.aeff.html#module-pisa.stages.aeff.aeff">module</a>
+</li>
+      </ul></li>
+      <li>
+    pisa.stages.aeff.param
+
+      <ul>
+        <li><a href="pisa.stages.aeff.html#module-pisa.stages.aeff.param">module</a>
 </li>
       </ul></li>
       <li>
@@ -3023,15 +3038,15 @@ <h2 id="P">P</h2>
         <li><a href="pisa.stages.osc.prob3numba.html#module-pisa.stages.osc.prob3numba.test_numba">module</a>
 </li>
       </ul></li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
       <li>
     pisa.stages.osc.scaling_params
 
       <ul>
         <li><a href="pisa.stages.osc.html#module-pisa.stages.osc.scaling_params">module</a>
 </li>
       </ul></li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
       <li>
     pisa.stages.osc.two_nu_osc
 

diff --git a/objects.inv b/objects.inv
diff --git a/pisa.html b/pisa.html
@@ -803,6 +803,7 @@ <h2>Subpackages<a class="headerlink" href="#subpackages" title="Link to this hea
 <li class="toctree-l3"><a class="reference internal" href="pisa.stages.aeff.html">pisa.stages.aeff package</a><ul>
 <li class="toctree-l4"><a class="reference internal" href="pisa.stages.aeff.html#submodules">Submodules</a></li>
 <li class="toctree-l4"><a class="reference internal" href="pisa.stages.aeff.html#module-pisa.stages.aeff.aeff">pisa.stages.aeff.aeff module</a></li>
+<li class="toctree-l4"><a class="reference internal" href="pisa.stages.aeff.html#module-pisa.stages.aeff.param">pisa.stages.aeff.param module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="pisa.stages.aeff.html#module-pisa.stages.aeff.weight">pisa.stages.aeff.weight module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="pisa.stages.aeff.html#module-pisa.stages.aeff.weight_hnl">pisa.stages.aeff.weight_hnl module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="pisa.stages.aeff.html#module-pisa.stages.aeff">Module contents</a></li>

diff --git a/pisa.stages.aeff.html b/pisa.stages.aeff.html
@@ -130,6 +130,98 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this headi
 
 </dd></dl>
 
+</section>
+<section id="module-pisa.stages.aeff.param">
+<span id="pisa-stages-aeff-param-module"></span><h2>pisa.stages.aeff.param module<a class="headerlink" href="#module-pisa.stages.aeff.param" title="Link to this heading"></a></h2>
+<p>This is an effective area stage designed for quick studies of how effective
+areas affect experimental observables and sensitivities. In addition, it is
+supposed to be easily reproducible as it may rely on (phenomenological)
+functions or interpolated discrete data points, dependent on energy
+(and optionally cosine zenith), and which can thus be used as reference or
+benchmark scenarios.</p>
+<dl class="py function">
+<dt class="sig sig-object py" id="pisa.stages.aeff.param.load_aeff_param">
+<span class="sig-prename descclassname"><span class="pre">pisa.stages.aeff.param.</span></span><span class="sig-name descname"><span class="pre">load_aeff_param</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">source</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pisa/stages/aeff/param.html#load_aeff_param"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pisa.stages.aeff.param.load_aeff_param" title="Link to this definition"></a></dt>
+<dd><p>Load aeff parameterisation (energy- or coszen-dependent) from file
+or dictionary.
+:param source: Source of the parameterization. If string, treat as file path or</p>
+<blockquote>
+<div><p>resource location and load from the file; this must yield a mapping. If
+<cite>source</cite> is a mapping, it is used directly. See notes below on format.</p>
+</div></blockquote>
+<dl class="field-list simple">
+<dt class="field-odd">Returns<span class="colon">:</span></dt>
+<dd class="field-odd"><p><strong>aeff_params</strong> – Keys are stringified flavintgroups and values are the callables that
+produce aeff when called with energy or coszen values.</p>
+</dd>
+<dt class="field-even">Return type<span class="colon">:</span></dt>
+<dd class="field-even"><p><a class="reference internal" href="pisa.html#pisa.OrderedDict" title="pisa.OrderedDict">OrderedDict</a></p>
+</dd>
+</dl>
+<p class="rubric">Notes</p>
+<dl>
+<dt>The mapping passed via <cite>source</cite> or loaded therefrom must have the format:</dt><dd><dl class="simple">
+<dt>{</dt><dd><p>&lt;flavintgroup_string&gt;: val,
+&lt;flavintgroup_string&gt;: val,
+…</p>
+</dd>
+</dl>
+<p>}</p>
+</dd>
+</dl>
+<p>Note that the <cite>transform_groups</cite> (container.name) defined
+in a pipeline config file using this must match the groupings defined
+above.
+<a href="#id1"><span class="problematic" id="id2">`</span></a>val`s can be one of the following:</p>
+<blockquote>
+<div><ul>
+<li><p>Callable with one argument</p></li>
+<li><p>String such that <cite>eval(val)</cite> yields a callable with one argument</p></li>
+<li><dl>
+<dt>Mapping with the format:</dt><dd><dl class="simple">
+<dt>{</dt><dd><p>&lt;”energy” or “coszen”&gt;: [sequence of values],
+“aeff”: [sequence of values]</p>
+</dd>
+</dl>
+<p>}</p>
+</dd>
+</dl>
+<p>the two sequences are used to form a linear interpolant callable that
+maps energy or coszen values to aeff values. The effective area for any
+energy or coszen outside the bounds of the corresponding sequence is
+assumed to be 0.</p>
+</li>
+</ul>
+</div></blockquote>
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="pisa.stages.aeff.param.param">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pisa.stages.aeff.param.</span></span><span class="sig-name descname"><span class="pre">param</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">std_kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pisa/stages/aeff/param.html#param"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pisa.stages.aeff.param.param" title="Link to this definition"></a></dt>
+<dd><p>Bases: <a class="reference internal" href="pisa.core.html#pisa.core.stage.Stage" title="pisa.core.stage.Stage"><code class="xref py py-class docutils literal notranslate"><span class="pre">Stage</span></code></a></p>
+<p>Effective area service based on parameterisation functions stored in a
+.json file.
+Transforms an input map of a flux of a given flavour (and interaction)
+into maps of event rates, according to energy and cosine zenith dependent
+effective areas specified by parameterisation functions.
+Requires true_energy, true_coszen, and weights to be present in the container.
+:param params: Must exclusively have parameters:</p>
+<blockquote>
+<div><p>aeff_energy_paramfile
+aeff_coszen_paramfile
+livetime
+aeff_scale</p>
+</div></blockquote>
+<dl class="field-list simple">
+</dl>
+<dl class="py method">
+<dt class="sig sig-object py" id="pisa.stages.aeff.param.param.apply_function">
+<span class="sig-name descname"><span class="pre">apply_function</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pisa/stages/aeff/param.html#param.apply_function"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pisa.stages.aeff.param.param.apply_function" title="Link to this definition"></a></dt>
+<dd><p>Implement in services (subclasses of Stage)</p>
+</dd></dl>
+
+</dd></dl>
+
 </section>
 <section id="module-pisa.stages.aeff.weight">
 <span id="pisa-stages-aeff-weight-module"></span><h2>pisa.stages.aeff.weight module<a class="headerlink" href="#module-pisa.stages.aeff.weight" title="Link to this heading"></a></h2>

diff --git a/pisa.stages.html b/pisa.stages.html
@@ -123,6 +123,14 @@ <h2>Subpackages<a class="headerlink" href="#subpackages" title="Link to this hea
 </li>
 </ul>
 </li>
+<li class="toctree-l2"><a class="reference internal" href="pisa.stages.aeff.html#module-pisa.stages.aeff.param">pisa.stages.aeff.param module</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="pisa.stages.aeff.html#pisa.stages.aeff.param.load_aeff_param"><code class="docutils literal notranslate"><span class="pre">load_aeff_param()</span></code></a></li>
+<li class="toctree-l3"><a class="reference internal" href="pisa.stages.aeff.html#pisa.stages.aeff.param.param"><code class="docutils literal notranslate"><span class="pre">param</span></code></a><ul>
+<li class="toctree-l4"><a class="reference internal" href="pisa.stages.aeff.html#pisa.stages.aeff.param.param.apply_function"><code class="docutils literal notranslate"><span class="pre">param.apply_function()</span></code></a></li>
+</ul>
+</li>
+</ul>
+</li>
 <li class="toctree-l2"><a class="reference internal" href="pisa.stages.aeff.html#module-pisa.stages.aeff.weight">pisa.stages.aeff.weight module</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="pisa.stages.aeff.html#pisa.stages.aeff.weight.weight"><code class="docutils literal notranslate"><span class="pre">weight</span></code></a><ul>
 <li class="toctree-l4"><a class="reference internal" href="pisa.stages.aeff.html#pisa.stages.aeff.weight.weight.apply_function"><code class="docutils literal notranslate"><span class="pre">weight.apply_function()</span></code></a></li>

diff --git a/py-modindex.html b/py-modindex.html
@@ -236,6 +236,11 @@ <h1>Python Module Index</h1>
        <td>&#160;&#160;&#160;
        <a href="pisa.stages.aeff.html#module-pisa.stages.aeff.aeff"><code class="xref">pisa.stages.aeff.aeff</code></a></td><td>
        <em></em></td></tr>
+     <tr class="cg-1">
+       <td></td>
+       <td>&#160;&#160;&#160;
+       <a href="pisa.stages.aeff.html#module-pisa.stages.aeff.param"><code class="xref">pisa.stages.aeff.param</code></a></td><td>
+       <em></em></td></tr>
      <tr class="cg-1">
        <td></td>
        <td>&#160;&#160;&#160;

diff --git a/searchindex.js b/searchindex.js