Skip to content

Commit

Permalink
deploy: 8d6fed6
Browse files Browse the repository at this point in the history
  • Loading branch information
jmbhughes committed Oct 21, 2024
1 parent 33b14ca commit 40bf2e3
Show file tree
Hide file tree
Showing 9 changed files with 93 additions and 3 deletions.
12 changes: 12 additions & 0 deletions _sources/autoapi/punchbowl/data/wcs/index.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@ Functions
punchbowl.data.wcs.gcrs_to_hpc
punchbowl.data.wcs.calculate_celestial_wcs_from_helio
punchbowl.data.wcs.load_trefoil_wcs
punchbowl.data.wcs.load_quickpunch_mosaic_wcs
punchbowl.data.wcs.load_quickpunch_nfi_wcs


Module Contents
Expand Down Expand Up @@ -102,3 +104,13 @@ Module Contents
Load Level 2 trefoil world coordinate system and shape.


.. py:function:: load_quickpunch_mosaic_wcs() -> (astropy.wcs.WCS, (int, int))
Load Level quickPUNCH mosaic world coordinate system and shape.


.. py:function:: load_quickpunch_nfi_wcs() -> (astropy.wcs.WCS, (int, int))
Load Level quickPUNCH NFI world coordinate system and shape.


6 changes: 6 additions & 0 deletions _sources/autoapi/punchbowl/level1/flow/index.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ Functions

punchbowl.level1.flow.generate_psf_model_core_flow
punchbowl.level1.flow.level1_core_flow
punchbowl.level1.flow.level05_core_flow


Module Contents
Expand All @@ -34,5 +35,10 @@ Module Contents
Core flow for level 1.


.. py:function:: level05_core_flow(input_data: list[str] | list[ndcube.NDCube], gain: float = 4.9, bias_level: float = 100, dark_level: float = 55.81, read_noise_level: float = 17, bitrate_signal: int = 16, quartic_coefficient_path: str | None = None, exposure_time: float = 49 * 1000, readout_line_time: float = 163 / 2148, reset_line_time: float = 163 / 2148, output_filename: str | None = None) -> list[ndcube.NDCube]
Core flow for level 0.5.


.. py:data:: filenames
12 changes: 12 additions & 0 deletions _sources/autoapi/punchbowl/level2/flow/index.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ Functions
.. autoapisummary::

punchbowl.level2.flow.level2_core_flow
punchbowl.level2.flow.remix_polarization
punchbowl.level2.flow.levelq_core_flow


Module Contents
Expand All @@ -33,5 +35,15 @@ Module Contents
Level 2 core flow.


.. py:function:: remix_polarization(input_data: ndcube.NDCube) -> ndcube.NDCube
Remix polarization from (M,Z,P) to (B, pB) using solpolpy.


.. py:function:: levelq_core_flow(data_list: list[str] | list[ndcube.NDCube], output_filename: str | None = None) -> list[ndcube.NDCube]
Level quickPUNCH core flow.


.. py:data:: filenames
20 changes: 20 additions & 0 deletions autoapi/punchbowl/data/wcs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -572,6 +572,12 @@ <h2>Functions<a class="headerlink" href="#functions" title="Link to this heading
<tr class="row-even"><td><p><a class="reference internal" href="#punchbowl.data.wcs.load_trefoil_wcs" title="punchbowl.data.wcs.load_trefoil_wcs"><code class="xref py py-obj docutils literal notranslate"><span class="pre">load_trefoil_wcs</span></code></a>() →)</p></td>
<td><p>Load Level 2 trefoil world coordinate system and shape.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#punchbowl.data.wcs.load_quickpunch_mosaic_wcs" title="punchbowl.data.wcs.load_quickpunch_mosaic_wcs"><code class="xref py py-obj docutils literal notranslate"><span class="pre">load_quickpunch_mosaic_wcs</span></code></a>() →)</p></td>
<td><p>Load Level quickPUNCH mosaic world coordinate system and shape.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#punchbowl.data.wcs.load_quickpunch_nfi_wcs" title="punchbowl.data.wcs.load_quickpunch_nfi_wcs"><code class="xref py py-obj docutils literal notranslate"><span class="pre">load_quickpunch_nfi_wcs</span></code></a>() →)</p></td>
<td><p>Load Level quickPUNCH NFI world coordinate system and shape.</p></td>
</tr>
</tbody>
</table>
</div>
Expand Down Expand Up @@ -675,6 +681,18 @@ <h2>Module Contents<a class="headerlink" href="#module-contents" title="Link to
<dd><p>Load Level 2 trefoil world coordinate system and shape.</p>
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="punchbowl.data.wcs.load_quickpunch_mosaic_wcs">
<span class="sig-prename descclassname"><span class="pre">punchbowl.data.wcs.</span></span><span class="sig-name descname"><span class="pre">load_quickpunch_mosaic_wcs</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#punchbowl.data.wcs.load_quickpunch_mosaic_wcs" title="Link to this definition">#</a></dt>
<dd><p>Load Level quickPUNCH mosaic world coordinate system and shape.</p>
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="punchbowl.data.wcs.load_quickpunch_nfi_wcs">
<span class="sig-prename descclassname"><span class="pre">punchbowl.data.wcs.</span></span><span class="sig-name descname"><span class="pre">load_quickpunch_nfi_wcs</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#punchbowl.data.wcs.load_quickpunch_nfi_wcs" title="Link to this definition">#</a></dt>
<dd><p>Load Level quickPUNCH NFI world coordinate system and shape.</p>
</dd></dl>

</section>
</section>

Expand Down Expand Up @@ -739,6 +757,8 @@ <h2>Module Contents<a class="headerlink" href="#module-contents" title="Link to
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#punchbowl.data.wcs.gcrs_to_hpc"><code class="docutils literal notranslate"><span class="pre">gcrs_to_hpc()</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#punchbowl.data.wcs.calculate_celestial_wcs_from_helio"><code class="docutils literal notranslate"><span class="pre">calculate_celestial_wcs_from_helio()</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#punchbowl.data.wcs.load_trefoil_wcs"><code class="docutils literal notranslate"><span class="pre">load_trefoil_wcs()</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#punchbowl.data.wcs.load_quickpunch_mosaic_wcs"><code class="docutils literal notranslate"><span class="pre">load_quickpunch_mosaic_wcs()</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#punchbowl.data.wcs.load_quickpunch_nfi_wcs"><code class="docutils literal notranslate"><span class="pre">load_quickpunch_nfi_wcs()</span></code></a></li>
</ul>
</li>
</ul>
Expand Down
10 changes: 10 additions & 0 deletions autoapi/punchbowl/level1/flow/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -545,6 +545,9 @@ <h2>Functions<a class="headerlink" href="#functions" title="Link to this heading
<tr class="row-even"><td><p><a class="reference internal" href="#punchbowl.level1.flow.level1_core_flow" title="punchbowl.level1.flow.level1_core_flow"><code class="xref py py-obj docutils literal notranslate"><span class="pre">level1_core_flow</span></code></a>(→ list[ndcube.NDCube])</p></td>
<td><p>Core flow for level 1.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#punchbowl.level1.flow.level05_core_flow" title="punchbowl.level1.flow.level05_core_flow"><code class="xref py py-obj docutils literal notranslate"><span class="pre">level05_core_flow</span></code></a>(→ list[ndcube.NDCube])</p></td>
<td><p>Core flow for level 0.5.</p></td>
</tr>
</tbody>
</table>
</div>
Expand All @@ -563,6 +566,12 @@ <h2>Module Contents<a class="headerlink" href="#module-contents" title="Link to
<dd><p>Core flow for level 1.</p>
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="punchbowl.level1.flow.level05_core_flow">
<span class="sig-prename descclassname"><span class="pre">punchbowl.level1.flow.</span></span><span class="sig-name descname"><span class="pre">level05_core_flow</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">input_data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">ndcube.NDCube</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">gain</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">4.9</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bias_level</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">100</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dark_level</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">55.81</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">read_noise_level</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">17</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bitrate_signal</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">16</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">quartic_coefficient_path</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exposure_time</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">49</span> <span class="pre">*</span> <span class="pre">1000</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">readout_line_time</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">163</span> <span class="pre">/</span> <span class="pre">2148</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">reset_line_time</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">163</span> <span class="pre">/</span> <span class="pre">2148</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_filename</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">ndcube.NDCube</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#punchbowl.level1.flow.level05_core_flow" title="Link to this definition">#</a></dt>
<dd><p>Core flow for level 0.5.</p>
</dd></dl>

<dl class="py data">
<dt class="sig sig-object py" id="punchbowl.level1.flow.filenames">
<span class="sig-prename descclassname"><span class="pre">punchbowl.level1.flow.</span></span><span class="sig-name descname"><span class="pre">filenames</span></span><a class="headerlink" href="#punchbowl.level1.flow.filenames" title="Link to this definition">#</a></dt>
Expand Down Expand Up @@ -622,6 +631,7 @@ <h2>Module Contents<a class="headerlink" href="#module-contents" title="Link to
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#module-contents">Module Contents</a><ul class="visible nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#punchbowl.level1.flow.generate_psf_model_core_flow"><code class="docutils literal notranslate"><span class="pre">generate_psf_model_core_flow()</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#punchbowl.level1.flow.level1_core_flow"><code class="docutils literal notranslate"><span class="pre">level1_core_flow()</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#punchbowl.level1.flow.level05_core_flow"><code class="docutils literal notranslate"><span class="pre">level05_core_flow()</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#punchbowl.level1.flow.filenames"><code class="docutils literal notranslate"><span class="pre">filenames</span></code></a></li>
</ul>
</li>
Expand Down
20 changes: 20 additions & 0 deletions autoapi/punchbowl/level2/flow/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -545,6 +545,12 @@ <h2>Functions<a class="headerlink" href="#functions" title="Link to this heading
<tr class="row-odd"><td><p><a class="reference internal" href="#punchbowl.level2.flow.level2_core_flow" title="punchbowl.level2.flow.level2_core_flow"><code class="xref py py-obj docutils literal notranslate"><span class="pre">level2_core_flow</span></code></a>(→ list[ndcube.NDCube])</p></td>
<td><p>Level 2 core flow.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#punchbowl.level2.flow.remix_polarization" title="punchbowl.level2.flow.remix_polarization"><code class="xref py py-obj docutils literal notranslate"><span class="pre">remix_polarization</span></code></a>(→ ndcube.NDCube)</p></td>
<td><p>Remix polarization from (M,Z,P) to (B, pB) using solpolpy.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#punchbowl.level2.flow.levelq_core_flow" title="punchbowl.level2.flow.levelq_core_flow"><code class="xref py py-obj docutils literal notranslate"><span class="pre">levelq_core_flow</span></code></a>(→ list[ndcube.NDCube])</p></td>
<td><p>Level quickPUNCH core flow.</p></td>
</tr>
</tbody>
</table>
</div>
Expand All @@ -562,6 +568,18 @@ <h2>Module Contents<a class="headerlink" href="#module-contents" title="Link to
<dd><p>Level 2 core flow.</p>
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="punchbowl.level2.flow.remix_polarization">
<span class="sig-prename descclassname"><span class="pre">punchbowl.level2.flow.</span></span><span class="sig-name descname"><span class="pre">remix_polarization</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">input_data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndcube.NDCube</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">ndcube.NDCube</span></span></span><a class="headerlink" href="#punchbowl.level2.flow.remix_polarization" title="Link to this definition">#</a></dt>
<dd><p>Remix polarization from (M,Z,P) to (B, pB) using solpolpy.</p>
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="punchbowl.level2.flow.levelq_core_flow">
<span class="sig-prename descclassname"><span class="pre">punchbowl.level2.flow.</span></span><span class="sig-name descname"><span class="pre">levelq_core_flow</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data_list</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">ndcube.NDCube</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_filename</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">ndcube.NDCube</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#punchbowl.level2.flow.levelq_core_flow" title="Link to this definition">#</a></dt>
<dd><p>Level quickPUNCH core flow.</p>
</dd></dl>

<dl class="py data">
<dt class="sig sig-object py" id="punchbowl.level2.flow.filenames">
<span class="sig-prename descclassname"><span class="pre">punchbowl.level2.flow.</span></span><span class="sig-name descname"><span class="pre">filenames</span></span><a class="headerlink" href="#punchbowl.level2.flow.filenames" title="Link to this definition">#</a></dt>
Expand Down Expand Up @@ -621,6 +639,8 @@ <h2>Module Contents<a class="headerlink" href="#module-contents" title="Link to
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#module-contents">Module Contents</a><ul class="visible nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#punchbowl.level2.flow.ORDER"><code class="docutils literal notranslate"><span class="pre">ORDER</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#punchbowl.level2.flow.level2_core_flow"><code class="docutils literal notranslate"><span class="pre">level2_core_flow()</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#punchbowl.level2.flow.remix_polarization"><code class="docutils literal notranslate"><span class="pre">remix_polarization()</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#punchbowl.level2.flow.levelq_core_flow"><code class="docutils literal notranslate"><span class="pre">levelq_core_flow()</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#punchbowl.level2.flow.filenames"><code class="docutils literal notranslate"><span class="pre">filenames</span></code></a></li>
</ul>
</li>
Expand Down
Loading

0 comments on commit 40bf2e3

Please sign in to comment.