doc
This commit is contained in:
François Boulogne
commit
82eff06057
141 changed files with 10910 additions and 0 deletions
139
docs/_build/html/_modules/optifik/io.html
vendored
Normal file
139
docs/_build/html/_modules/optifik/io.html
vendored
Normal file
|
|
@ -0,0 +1,139 @@
|
|||
<!DOCTYPE html>
|
||||
|
||||
<html lang="en" data-content_root="../../">
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>optifik.io — optifik documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=5ecbeea2" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/basic.css?v=b08954a9" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/alabaster.css?v=27fed22d" />
|
||||
<script src="../../_static/documentation_options.js?v=5929fcd5"></script>
|
||||
<script src="../../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<link rel="index" title="Index" href="../../genindex.html" />
|
||||
<link rel="search" title="Search" href="../../search.html" />
|
||||
|
||||
<link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</head><body>
|
||||
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
|
||||
|
||||
<div class="body" role="main">
|
||||
|
||||
<h1>Source code for optifik.io</h1><div class="highlight"><pre>
|
||||
<span></span><span class="kn">import</span><span class="w"> </span><span class="nn">numpy</span><span class="w"> </span><span class="k">as</span><span class="w"> </span><span class="nn">np</span>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="load_spectrum">
|
||||
<a class="viewcode-back" href="../../api_reference.html#optifik.io.load_spectrum">[docs]</a>
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">load_spectrum</span><span class="p">(</span><span class="n">spectrum_path</span><span class="p">,</span>
|
||||
<span class="n">wavelength_min</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span>
|
||||
<span class="n">wavelength_max</span><span class="o">=</span><span class="n">np</span><span class="o">.</span><span class="n">inf</span><span class="p">,</span>
|
||||
<span class="n">delimiter</span><span class="o">=</span><span class="s1">','</span><span class="p">):</span>
|
||||
<span class="w"> </span><span class="sd">"""</span>
|
||||
<span class="sd"> Load a spectrum file.</span>
|
||||
|
||||
|
||||
<span class="sd"> TODO : describe expected format</span>
|
||||
|
||||
<span class="sd"> Parameters</span>
|
||||
<span class="sd"> ----------</span>
|
||||
<span class="sd"> spectrum_path : string</span>
|
||||
<span class="sd"> File path.</span>
|
||||
<span class="sd"> wavelength_min : scalar, optional</span>
|
||||
<span class="sd"> Cut the data at this minimum wavelength (included).</span>
|
||||
<span class="sd"> wavelength_max : scalar, optional</span>
|
||||
<span class="sd"> Cut the data at this maximum wavelength (included).</span>
|
||||
<span class="sd"> delimiter : string, optional</span>
|
||||
<span class="sd"> Delimiter between columns in the datafile.</span>
|
||||
|
||||
<span class="sd"> Returns</span>
|
||||
<span class="sd"> -------</span>
|
||||
<span class="sd"> values : arrays</span>
|
||||
<span class="sd"> (lamdbas, intensities)</span>
|
||||
<span class="sd"> """</span>
|
||||
<span class="n">data</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">loadtxt</span><span class="p">(</span><span class="n">spectrum_path</span><span class="p">,</span> <span class="n">delimiter</span><span class="o">=</span><span class="n">delimiter</span><span class="p">)</span>
|
||||
<span class="n">lambdas</span><span class="p">,</span> <span class="n">intensities</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">column_stack</span><span class="p">(</span><span class="n">data</span><span class="p">)</span>
|
||||
|
||||
<span class="n">mask</span> <span class="o">=</span> <span class="p">(</span><span class="n">lambdas</span> <span class="o">>=</span> <span class="n">wavelength_min</span><span class="p">)</span> <span class="o">&</span> <span class="p">(</span><span class="n">lambdas</span> <span class="o"><=</span> <span class="n">wavelength_max</span><span class="p">)</span>
|
||||
<span class="k">return</span> <span class="n">lambdas</span><span class="p">[</span><span class="n">mask</span><span class="p">],</span> <span class="n">intensities</span><span class="p">[</span><span class="n">mask</span><span class="p">]</span></div>
|
||||
|
||||
</pre></div>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="Main">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h1 class="logo"><a href="../../index.html">optifik</a></h1>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<search id="searchbox" style="display: none" role="search">
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="../../search.html" method="get">
|
||||
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false" placeholder="Search"/>
|
||||
<input type="submit" value="Go" />
|
||||
</form>
|
||||
</div>
|
||||
</search>
|
||||
<script>document.getElementById('searchbox').style.display = "block"</script><h3>Navigation</h3>
|
||||
<p class="caption" role="heading"><span class="caption-text">Documentation</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../installation.html">Installation</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../api_reference.html">API Reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../examples.html">Examples</a></li>
|
||||
</ul>
|
||||
|
||||
<div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="../../index.html">Documentation overview</a><ul>
|
||||
<li><a href="../index.html">Module code</a><ul>
|
||||
</ul></li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
©2025, F. Boulogne et al..
|
||||
|
||||
|
|
||||
Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.2.3</a>
|
||||
& <a href="https://alabaster.readthedocs.io">Alabaster 1.0.0</a>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
Loading…
Add table
Add a link
Reference in a new issue