Files
cristallina_analysis_package/docs/_build/html/api/modules.html
2026-02-03 11:06:33 +01:00

194 lines
15 KiB
HTML
Executable File

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<title>cristallina &#8212; cristallina 0.0.post1.dev53+g9be81e9.d20230129 documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../_static/alabaster.css" />
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/sphinx_highlight.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="cristallina package" href="cristallina.html" />
<link rel="prev" title="Changelog" href="../changelog.html" />
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
</head><body>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="cristallina">
<h1>cristallina<a class="headerlink" href="#cristallina" title="Permalink to this heading"></a></h1>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="cristallina.html">cristallina package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="cristallina.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="cristallina.html#module-cristallina.SEA_GraphClient">cristallina.SEA_GraphClient module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cristallina.html#cristallina.SEA_GraphClient.GraphClient"><code class="docutils literal notranslate"><span class="pre">GraphClient</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="cristallina.html#cristallina.SEA_GraphClient.GraphClient.close"><code class="docutils literal notranslate"><span class="pre">GraphClient.close()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cristallina.html#cristallina.SEA_GraphClient.GraphClient.get_curves"><code class="docutils literal notranslate"><span class="pre">GraphClient.get_curves()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cristallina.html#cristallina.SEA_GraphClient.GraphClient.get_names"><code class="docutils literal notranslate"><span class="pre">GraphClient.get_names()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cristallina.html#cristallina.SEA_GraphClient.GraphClient.get_raw"><code class="docutils literal notranslate"><span class="pre">GraphClient.get_raw()</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="cristallina.html#cristallina.SEA_GraphClient.expect_reply"><code class="docutils literal notranslate"><span class="pre">expect_reply()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="cristallina.html#cristallina.SEA_GraphClient.raw_sics_client"><code class="docutils literal notranslate"><span class="pre">raw_sics_client()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="cristallina.html#cristallina.SEA_GraphClient.sics_client"><code class="docutils literal notranslate"><span class="pre">sics_client()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cristallina.html#module-cristallina.analysis">cristallina.analysis module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cristallina.html#cristallina.analysis.fit_2d_gaussian"><code class="docutils literal notranslate"><span class="pre">fit_2d_gaussian()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="cristallina.html#cristallina.analysis.get_contrast_images"><code class="docutils literal notranslate"><span class="pre">get_contrast_images()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="cristallina.html#cristallina.analysis.setup_cachedirs"><code class="docutils literal notranslate"><span class="pre">setup_cachedirs()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cristallina.html#module-cristallina.config">cristallina.config module</a></li>
<li class="toctree-l2"><a class="reference internal" href="cristallina.html#module-cristallina.plot">cristallina.plot module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cristallina.html#cristallina.plot.axis_styling"><code class="docutils literal notranslate"><span class="pre">axis_styling()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="cristallina.html#cristallina.plot.ju_patch_less_verbose"><code class="docutils literal notranslate"><span class="pre">ju_patch_less_verbose()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="cristallina.html#cristallina.plot.plot_1d_channel"><code class="docutils literal notranslate"><span class="pre">plot_1d_channel()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="cristallina.html#cristallina.plot.plot_2d_channel"><code class="docutils literal notranslate"><span class="pre">plot_2d_channel()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="cristallina.html#cristallina.plot.plot_channel"><code class="docutils literal notranslate"><span class="pre">plot_channel()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="cristallina.html#cristallina.plot.plot_correlation"><code class="docutils literal notranslate"><span class="pre">plot_correlation()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="cristallina.html#cristallina.plot.plot_image_channel"><code class="docutils literal notranslate"><span class="pre">plot_image_channel()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="cristallina.html#cristallina.plot.plot_spectrum_channel"><code class="docutils literal notranslate"><span class="pre">plot_spectrum_channel()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cristallina.html#module-cristallina.skeleton">cristallina.skeleton module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cristallina.html#cristallina.skeleton.fib"><code class="docutils literal notranslate"><span class="pre">fib()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="cristallina.html#cristallina.skeleton.main"><code class="docutils literal notranslate"><span class="pre">main()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="cristallina.html#cristallina.skeleton.parse_args"><code class="docutils literal notranslate"><span class="pre">parse_args()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="cristallina.html#cristallina.skeleton.run"><code class="docutils literal notranslate"><span class="pre">run()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="cristallina.html#cristallina.skeleton.setup_logging"><code class="docutils literal notranslate"><span class="pre">setup_logging()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cristallina.html#module-cristallina.utils">cristallina.utils module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cristallina.html#cristallina.utils.FWHM_to_sigma"><code class="docutils literal notranslate"><span class="pre">FWHM_to_sigma()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="cristallina.html#cristallina.utils.ROI"><code class="docutils literal notranslate"><span class="pre">ROI</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="cristallina.html#cristallina.utils.ROI.LeftRightBottomTop"><code class="docutils literal notranslate"><span class="pre">ROI.LeftRightBottomTop</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cristallina.html#cristallina.utils.ROI.cols"><code class="docutils literal notranslate"><span class="pre">ROI.cols</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cristallina.html#cristallina.utils.ROI.from_centers_widths"><code class="docutils literal notranslate"><span class="pre">ROI.from_centers_widths()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cristallina.html#cristallina.utils.ROI.height"><code class="docutils literal notranslate"><span class="pre">ROI.height</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cristallina.html#cristallina.utils.ROI.rows"><code class="docutils literal notranslate"><span class="pre">ROI.rows</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="cristallina.html#cristallina.utils.ROI.width"><code class="docutils literal notranslate"><span class="pre">ROI.width</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="cristallina.html#cristallina.utils.channel_names"><code class="docutils literal notranslate"><span class="pre">channel_names()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="cristallina.html#cristallina.utils.eV_to_joules"><code class="docutils literal notranslate"><span class="pre">eV_to_joules()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="cristallina.html#cristallina.utils.find_nearest"><code class="docutils literal notranslate"><span class="pre">find_nearest()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="cristallina.html#cristallina.utils.find_two_nearest"><code class="docutils literal notranslate"><span class="pre">find_two_nearest()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="cristallina.html#cristallina.utils.gauss"><code class="docutils literal notranslate"><span class="pre">gauss()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="cristallina.html#cristallina.utils.gauss_fit"><code class="docutils literal notranslate"><span class="pre">gauss_fit()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="cristallina.html#cristallina.utils.heuristic_extract_base_path"><code class="docutils literal notranslate"><span class="pre">heuristic_extract_base_path()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="cristallina.html#cristallina.utils.heuristic_extract_pgroup"><code class="docutils literal notranslate"><span class="pre">heuristic_extract_pgroup()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="cristallina.html#cristallina.utils.heuristic_extract_smalldata_path"><code class="docutils literal notranslate"><span class="pre">heuristic_extract_smalldata_path()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="cristallina.html#cristallina.utils.joules_to_eV"><code class="docutils literal notranslate"><span class="pre">joules_to_eV()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="cristallina.html#cristallina.utils.photon_energy_from_wavelength"><code class="docutils literal notranslate"><span class="pre">photon_energy_from_wavelength()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="cristallina.html#cristallina.utils.print_run_info"><code class="docutils literal notranslate"><span class="pre">print_run_info()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="cristallina.html#cristallina.utils.process_run"><code class="docutils literal notranslate"><span class="pre">process_run()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="cristallina.html#cristallina.utils.scan_info"><code class="docutils literal notranslate"><span class="pre">scan_info()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="cristallina.html#cristallina.utils.sigma_to_FWHM"><code class="docutils literal notranslate"><span class="pre">sigma_to_FWHM()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="cristallina.html#cristallina.utils.wavelength_from_photon_energy"><code class="docutils literal notranslate"><span class="pre">wavelength_from_photon_energy()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="cristallina.html#cristallina.utils.xray_transmission"><code class="docutils literal notranslate"><span class="pre">xray_transmission()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cristallina.html#module-cristallina">Module contents</a></li>
</ul>
</li>
</ul>
</div>
</section>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="../index.html">cristallina</a></h1>
<h3>Navigation</h3>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../readme.html">Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="../contributing.html">TODO</a></li>
<li class="toctree-l1"><a class="reference internal" href="../contributing.html#contributing">Contributing</a></li>
<li class="toctree-l1"><a class="reference internal" href="../license.html">License</a></li>
<li class="toctree-l1"><a class="reference internal" href="../authors.html">Authors</a></li>
<li class="toctree-l1"><a class="reference internal" href="../changelog.html">Changelog</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Module Reference</a><ul>
<li class="toctree-l2"><a class="reference internal" href="cristallina.html">cristallina package</a></li>
</ul>
</li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="../index.html">Documentation overview</a><ul>
<li>Previous: <a href="../changelog.html" title="previous chapter">Changelog</a></li>
<li>Next: <a href="cristallina.html" title="next chapter">cristallina package</a></li>
</ul></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<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"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
&copy;2023, Alexander Steppke.
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 6.1.3</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.13</a>
|
<a href="../_sources/api/modules.rst.txt"
rel="nofollow">Page source</a>
</div>
</body>
</html>