diff --git a/doc/build/doctrees/cfelpyutils.crystfel_utils.doctree b/doc/build/doctrees/cfelpyutils.crystfel_utils.doctree
index 1fda736dd872107a04ddb6ddaa4cbaee57638274..880d0b728247eb60ad19b2503cd50f4080d81639 100644
Binary files a/doc/build/doctrees/cfelpyutils.crystfel_utils.doctree and b/doc/build/doctrees/cfelpyutils.crystfel_utils.doctree differ
diff --git a/doc/build/doctrees/cfelpyutils.doctree b/doc/build/doctrees/cfelpyutils.doctree
index a2db9d86a967ee3cb935502715293c168b36f211..7f6b5f2fa5295917dffb8d46eec3321f1dd5cf80 100644
Binary files a/doc/build/doctrees/cfelpyutils.doctree and b/doc/build/doctrees/cfelpyutils.doctree differ
diff --git a/doc/build/doctrees/cfelpyutils.geometry_utils.doctree b/doc/build/doctrees/cfelpyutils.geometry_utils.doctree
index 1e5ccfadc38ebf4c9b1ff3360ed66e5a6667eaba..e9213098cd7c7f54b473dc591f864b15ba5d856d 100644
Binary files a/doc/build/doctrees/cfelpyutils.geometry_utils.doctree and b/doc/build/doctrees/cfelpyutils.geometry_utils.doctree differ
diff --git a/doc/build/doctrees/cfelpyutils.parameter_utils.doctree b/doc/build/doctrees/cfelpyutils.parameter_utils.doctree
index 75cb037dd9a936690b94971e078198f7f686a3ff..af2b18f621844b418c465883b7b1b2e34ffae71b 100644
Binary files a/doc/build/doctrees/cfelpyutils.parameter_utils.doctree and b/doc/build/doctrees/cfelpyutils.parameter_utils.doctree differ
diff --git a/doc/build/doctrees/environment.pickle b/doc/build/doctrees/environment.pickle
index 5c034ea296cb14001b0aecdcf59b9d851194f636..22427ebdc4b23a4c7524305b28ecde4af83d6a14 100644
Binary files a/doc/build/doctrees/environment.pickle and b/doc/build/doctrees/environment.pickle differ
diff --git a/doc/build/doctrees/index.doctree b/doc/build/doctrees/index.doctree
index f5d0ebcaece3d183b097316574c19a550ef50061..d56c9586fa0d068f0c18a4f623500e634cd03cca 100644
Binary files a/doc/build/doctrees/index.doctree and b/doc/build/doctrees/index.doctree differ
diff --git a/doc/build/doctrees/modules.doctree b/doc/build/doctrees/modules.doctree
index 80d31ec402191e61cafbd19f4dcc0483376048ab..28d0cc033db2087350b9542db40f668f3063e9c5 100644
Binary files a/doc/build/doctrees/modules.doctree and b/doc/build/doctrees/modules.doctree differ
diff --git a/doc/build/html/.buildinfo b/doc/build/html/.buildinfo
index 84b02eea3e92d6a5529f100db832a597fc40a725..ff6c4f2a6a3e7d06d6ba52ede8bd4a924317c8b8 100644
--- a/doc/build/html/.buildinfo
+++ b/doc/build/html/.buildinfo
@@ -1,4 +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: b3b7939111dbbf905db0123cb645320e
+config: d40e958a7d3fc689b5ae78674cab31f2
tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/doc/build/html/_static/basic.css b/doc/build/html/_static/basic.css
index 6df76b0a6c56968b5e521311839cf4139adba1cc..dc88b5a2d0086b2364d6626b16700bbb0f82821e 100644
--- a/doc/build/html/_static/basic.css
+++ b/doc/build/html/_static/basic.css
@@ -398,13 +398,6 @@ table.field-list td, table.field-list th {
margin: 0;
}
-.field-name {
- -moz-hyphens: manual;
- -ms-hyphens: manual;
- -webkit-hyphens: manual;
- hyphens: manual;
-}
-
/* -- other body styles ----------------------------------------------------- */
ol.arabic {
diff --git a/doc/build/html/cfelpyutils.crystfel_utils.html b/doc/build/html/cfelpyutils.crystfel_utils.html
index 38cf1ba1065ae0747860a5da687067ac6b3a1e00..fb516cdbef717a87d93a1f0ec3e5904a0c79c361 100644
--- a/doc/build/html/cfelpyutils.crystfel_utils.html
+++ b/doc/build/html/cfelpyutils.crystfel_utils.html
@@ -1,13 +1,16 @@
-
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
<title>cfelpyutils.crystfel_utils module — cfelpyutils 0.5 documentation</title>
+
<link rel="stylesheet" href="_static/sphinxdoc.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
+
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
@@ -24,7 +27,7 @@
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
</head>
- <body>
+ <body role="document">
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
@@ -74,22 +77,23 @@ get_detector_geometry_2 function from CrystFEL.</p>
<dt id="cfelpyutils.crystfel_utils.load_crystfel_geometry">
<code class="descclassname">cfelpyutils.crystfel_utils.</code><code class="descname">load_crystfel_geometry</code><span class="sig-paren">(</span><em>filename</em><span class="sig-paren">)</span><a class="headerlink" href="#cfelpyutils.crystfel_utils.load_crystfel_geometry" title="Permalink to this definition">¶</a></dt>
<dd><p>Load a CrystFEL geometry file into a dictionary.</p>
-<p>Reimplementation of the get_detector_geometry_2 function from CrystFEL
-in python. Return a dictionary with the geometry information read from
-the file. Convert entries in the geometry file to keys in the
-returned dictionary. For a full documentation on the CrystFEL geometry
-format, see:</p>
+<p>Reimplementation of the get_detector_geometry_2 function from
+CrystFEL in python. Return a dictionary with the geometry
+information read from the file. Convert entries in the geometry
+file to keys in the returned dictionary. For a full documentation
+on the CrystFEL geometry format, see:</p>
<p><a class="reference external" href="http://www.desy.de/~twhite/crystfel/manual-crystfel_geometry.html">http://www.desy.de/~twhite/crystfel/manual-crystfel_geometry.html</a></p>
<p>The code of this function is synced with the code of the function
-‘get_detector_geometry_2’ in CrystFEL at commit
+‘get_detector_geometry_2’ in CrystFEL at commit
41a8fa9819010fe8ddeb66676fee717f5226c7b8.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>filename</strong> (<em>str</em>) – filename of the geometry file.</td>
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>filename</strong> (<em>str</em>) – filename of the geometry file.</td>
</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">dictionary with the geometry information loaded from the file.</td>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">dictionary with the geometry information loaded from the
+file.</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">dict</td>
</tr>
@@ -119,7 +123,7 @@ format, see:</p>
</div>
<div class="footer" role="contentinfo">
© Copyright 2016, CFEL Team.
- Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.3.
+ Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.6.
</div>
</body>
</html>
\ No newline at end of file
diff --git a/doc/build/html/cfelpyutils.geometry_utils.html b/doc/build/html/cfelpyutils.geometry_utils.html
index da24f3af8f975f5fe03d44589bfedac09da533e3..d95cf85a80fd43ac7cac63f2da6dc78ea64f0b2e 100644
--- a/doc/build/html/cfelpyutils.geometry_utils.html
+++ b/doc/build/html/cfelpyutils.geometry_utils.html
@@ -1,13 +1,16 @@
-
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
<title>cfelpyutils.geometry_utils module — cfelpyutils 0.5 documentation</title>
+
<link rel="stylesheet" href="_static/sphinxdoc.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
+
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
@@ -24,7 +27,7 @@
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
</head>
- <body>
+ <body role="document">
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
@@ -67,59 +70,38 @@
<div class="section" id="module-cfelpyutils.geometry_utils">
<span id="cfelpyutils-geometry-utils-module"></span><h1>cfelpyutils.geometry_utils module<a class="headerlink" href="#module-cfelpyutils.geometry_utils" title="Permalink to this headline">¶</a></h1>
<p>Geometry utilities.</p>
-<p>Functions that load, manipulate and apply geometry information to detector
-pixel data.</p>
-<dl class="class">
-<dt id="cfelpyutils.geometry_utils.PixelMaps">
-<em class="property">class </em><code class="descclassname">cfelpyutils.geometry_utils.</code><code class="descname">PixelMaps</code><span class="sig-paren">(</span><em>x</em>, <em>y</em>, <em>r</em><span class="sig-paren">)</span><a class="headerlink" href="#cfelpyutils.geometry_utils.PixelMaps" title="Permalink to this definition">¶</a></dt>
-<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">tuple</span></code></p>
-<p>A namedtuple used for pixel maps objects.</p>
-<p>Pixel maps are arrays of the same shape of the data whose geometry they
-describe. Each cell in the array holds the coordinate, in the reference system
-of the physical detector, of the corresponding pixel in the data array.</p>
-<p>The first two fields store the pixel maps for the x coordinate
-and the y coordinate respectively. The third field is instead a pixel map
-storing the distance of each pixel in the data array from the center of the
-reference system.</p>
-<dl class="attribute">
-<dt id="cfelpyutils.geometry_utils.PixelMaps.r">
-<code class="descname">r</code><a class="headerlink" href="#cfelpyutils.geometry_utils.PixelMaps.r" title="Permalink to this definition">¶</a></dt>
-<dd><p>Alias for field number 2</p>
-</dd></dl>
-
-<dl class="attribute">
-<dt id="cfelpyutils.geometry_utils.PixelMaps.x">
-<code class="descname">x</code><a class="headerlink" href="#cfelpyutils.geometry_utils.PixelMaps.x" title="Permalink to this definition">¶</a></dt>
-<dd><p>Alias for field number 0</p>
-</dd></dl>
-
-<dl class="attribute">
-<dt id="cfelpyutils.geometry_utils.PixelMaps.y">
-<code class="descname">y</code><a class="headerlink" href="#cfelpyutils.geometry_utils.PixelMaps.y" title="Permalink to this definition">¶</a></dt>
-<dd><p>Alias for field number 1</p>
-</dd></dl>
-
-</dd></dl>
-
+<p>Functions that load, manipulate and apply geometry information to
+detector pixel data.</p>
<dl class="function">
<dt id="cfelpyutils.geometry_utils.adjust_pixel_maps_for_pyqtgraph">
<code class="descclassname">cfelpyutils.geometry_utils.</code><code class="descname">adjust_pixel_maps_for_pyqtgraph</code><span class="sig-paren">(</span><em>pixel_maps</em><span class="sig-paren">)</span><a class="headerlink" href="#cfelpyutils.geometry_utils.adjust_pixel_maps_for_pyqtgraph" title="Permalink to this definition">¶</a></dt>
-<dd><p>Adjust pixel maps for visualization of the data in a pyqtgraph widget.</p>
-<p>The adjusted maps can be used for a Pyqtgraph ImageView widget.
-Essentially, the origin of the reference system is moved to the
-top-left of the image.</p>
+<dd><p>Adjust pixel maps for visualization of the data in a pyqtgraph
+widget.</p>
+<p>The adjusted maps can be used for a Pyqtgraph ImageView widget.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>pixel_maps</strong> (<a class="reference internal" href="#cfelpyutils.geometry_utils.PixelMaps" title="cfelpyutils.geometry_utils.PixelMaps"><em>PixelMaps</em></a>) – pixel maps, as returned by the
-<a class="reference internal" href="#cfelpyutils.geometry_utils.compute_pixel_maps" title="cfelpyutils.geometry_utils.compute_pixel_maps"><code class="xref py py-obj docutils literal"><span class="pre">compute_pixel_maps</span></code></a> function in this module.</td>
-</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">a PixelMaps tuple containing the ajusted pixel maps for
-the x and y coordinates in the first two fields, and the
-value None in the third.</td>
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
+<li><strong>ndarray</strong><strong>, </strong><strong>ndarray</strong><strong>]</strong> (<em>Tuple</em><em>[</em><em>ndarray</em><em>,</em>) – a named tuple containing the</li>
+<li><strong>maps. The first two fields</strong><strong>, </strong><strong>"x" and "y"</strong><strong>, </strong><strong>should store the</strong> (<em>pixel</em>) – </li>
+<li><strong>maps for the x coordinateand the y coordinate. The third</strong><strong>,</strong> (<em>pixel</em>) – </li>
+<li><strong>should instead store the distance of each pixel in the</strong> (<em>"r"</em><em>,</em>) – </li>
+<li><strong>array from the center of the reference system.</strong> (<em>data</em>) – </li>
+</ul>
+</td>
</tr>
-<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#cfelpyutils.geometry_utils.PixelMaps" title="cfelpyutils.geometry_utils.PixelMaps">PixelMaps</a></td>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last"><dl class="docutils">
+<dt>Tuple[ndarray, ndarray] A tuple containing the pixel</dt>
+<dd><p class="first last">maps. The first two fields, named “x” and “y” respectively,
+store the pixel maps for the x coordinate and the y
+coordinate. The third field, named “r”, is instead a pixel
+map storing the distance of each pixel in the data array
+from the center of the reference system.</p>
+</dd>
+</dl>
+</p>
+</td>
</tr>
</tbody>
</table>
@@ -136,22 +118,22 @@ containing a representation of the physical layout of the detector.</p>
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
-<li><strong>data</strong> (<em>ndarray</em>) – array containing the data on which the geometry
+<li><strong>data</strong> (<em>ndarray</em>) – array containing the data on which the geometry
will be applied.</li>
-<li><strong>pixel_maps</strong> (<a class="reference internal" href="#cfelpyutils.geometry_utils.PixelMaps" title="cfelpyutils.geometry_utils.PixelMaps"><em>PixelMaps</em></a>) – a pixelmap tuple, as returned by the
+<li><strong>pixel_maps</strong> (<em>PixelMaps</em>) – a pixelmap tuple, as returned by the
<a class="reference internal" href="#cfelpyutils.geometry_utils.compute_pixel_maps" title="cfelpyutils.geometry_utils.compute_pixel_maps"><code class="xref py py-obj docutils literal"><span class="pre">compute_pixel_maps</span></code></a> function in this module.</li>
-<li><strong>output_array</strong> (<em>Optional</em><em>[</em><em>ndarray</em><em>]</em>) – a preallocated array (of dtype
-numpy.float32) to store the function output. If provided, this
-array will be filled by the function and returned to the user.
-If not provided, the function will create a new array
-automatically and return it to the user. Defaults to None
-(No array provided).</li>
+<li><strong>output_array</strong> (<em>Optional</em><em>[</em><em>ndarray</em><em>]</em>) – a preallocated array (of
+dtype numpy.float32) to store the function output. If
+provided, this array will be filled by the function and
+and returned to the user. If not provided, the function
+will create a new array automatically and return it to the
+user. Defaults to None (No array provided).</li>
</ul>
</td>
</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">a numpy.float32 array containing the geometry information
-applied to the input data (i.e.: a physical representation of the
-layout of the detector).</p>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">a numpy.float32 array containing the geometry
+information applied to the input data (i.e.: a representation
+of the physical layout of the detector).</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">ndarray</p>
@@ -164,23 +146,30 @@ layout of the detector).</p>
<dl class="function">
<dt id="cfelpyutils.geometry_utils.compute_minimum_array_size">
<code class="descclassname">cfelpyutils.geometry_utils.</code><code class="descname">compute_minimum_array_size</code><span class="sig-paren">(</span><em>pixel_maps</em><span class="sig-paren">)</span><a class="headerlink" href="#cfelpyutils.geometry_utils.compute_minimum_array_size" title="Permalink to this definition">¶</a></dt>
-<dd><p>Compute the minimum size of an array that can store the applied geometry.</p>
-<p>Return the minimum size of an array that can store data on which the
-geometry information described by the pixel maps has been applied.</p>
-<p>The returned array shape is big enough to display all the input pixel
-values in the reference system of the physical detector. The array is
-supposed to be centered at the center of the reference system of the
-detector (i.e: the beam interaction point).</p>
+<dd><p>Compute the minimum size of an array that can store the applied
+geometry.</p>
+<p>Return the minimum size of an array that can store data on which
+the geometry information described by the pixel maps has been
+applied.</p>
+<p>The returned array shape is big enough to display all the input
+pixel values in the reference system of the physical detector. The
+array is supposed to be centered at the center of the reference
+system of the detector (i.e: the beam interaction point).</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>pixel_maps</strong> (<a class="reference internal" href="#cfelpyutils.geometry_utils.PixelMaps" title="cfelpyutils.geometry_utils.PixelMaps"><em>PixelMaps</em></a>) – a PixelMaps tuple, as returned by the
-<a class="reference internal" href="#cfelpyutils.geometry_utils.compute_pixel_maps" title="cfelpyutils.geometry_utils.compute_pixel_maps"><code class="xref py py-obj docutils literal"><span class="pre">compute_pixel_maps</span></code></a> function in this module.</td>
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>ndarray</strong><strong>, </strong><strong>ndarray</strong><strong>]</strong> (<em>Tuple</em><em>[</em><em>ndarray</em><em>,</em>) – a named tuple containing the
+pixel maps. The first two fields, “x” and “y”, should store
+the pixel maps for the x coordinateand the y coordinate.
+The third, “r”, should instead store the distance of each
+pixel in the data array from the center of the reference
+system.</td>
</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">numpy shape-like tuple storing the minimum array size.</td>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">a numpy-style shape tuple storing the minimum
+array size.</td>
</tr>
-<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">tuple</td>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">Tuple[int, int]</td>
</tr>
</tbody>
</table>
@@ -192,20 +181,24 @@ detector (i.e: the beam interaction point).</p>
<dd><p>Compute pixel maps from a CrystFEL geometry object.</p>
<p>Take as input a CrystFEL-style geometry object (A dictionary
returned by the function load_crystfel_geometry function in the
-crystfel_utils module) and return a PixelMap tuple . The origin
-the reference system used by the pixel maps is set at the beam interaction
-point.</p>
+crystfel_utils module) and return a PixelMap tuple . The origin the
+reference system used by the pixel maps is set at the beam
+interaction point.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>geometry</strong> (<em>dict</em>) – A CrystFEL geometry object (A dictionary returned by
-the <a class="reference internal" href="cfelpyutils.crystfel_utils.html#cfelpyutils.crystfel_utils.load_crystfel_geometry" title="cfelpyutils.crystfel_utils.load_crystfel_geometry"><code class="xref py py-obj docutils literal"><span class="pre">cfelpyutils.crystfel_utils.load_crystfel_geometry</span></code></a>
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>geometry</strong> (<em>dict</em>) – A CrystFEL geometry object (A dictionary
+returned by the
+<a class="reference internal" href="cfelpyutils.crystfel_utils.html#cfelpyutils.crystfel_utils.load_crystfel_geometry" title="cfelpyutils.crystfel_utils.load_crystfel_geometry"><code class="xref py py-obj docutils literal"><span class="pre">cfelpyutils.crystfel_utils.load_crystfel_geometry</span></code></a>
function).</td>
</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">a PixelMaps tuple.</td>
-</tr>
-<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#cfelpyutils.geometry_utils.PixelMaps" title="cfelpyutils.geometry_utils.PixelMaps">PixelMaps</a></td>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Tuple[ndarray, ndarray, ndarray] A tuple containing the pixel
+maps. The first two fields, named “x” and “y” respectively,
+store the pixel maps for the x coordinate and the y coordinate.
+The third field, named “r”, is instead a pixel map storing the
+distance of each pixel in the data array from the center of the
+reference system.</td>
</tr>
</tbody>
</table>
@@ -233,7 +226,7 @@ function).</td>
</div>
<div class="footer" role="contentinfo">
© Copyright 2016, CFEL Team.
- Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.3.
+ Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.6.
</div>
</body>
</html>
\ No newline at end of file
diff --git a/doc/build/html/cfelpyutils.html b/doc/build/html/cfelpyutils.html
index 0ffa52b435b28adfda496fd9ba1e0e7d530d0e98..bb9c7a185017dccdca214a727475b03732791a08 100644
--- a/doc/build/html/cfelpyutils.html
+++ b/doc/build/html/cfelpyutils.html
@@ -1,13 +1,16 @@
-
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
<title>cfelpyutils package — cfelpyutils 0.5 documentation</title>
+
<link rel="stylesheet" href="_static/sphinxdoc.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
+
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
@@ -24,7 +27,7 @@
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
</head>
- <body>
+ <body role="document">
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
@@ -119,7 +122,7 @@ python to work with several file format used in x-ray imaging).</p>
</div>
<div class="footer" role="contentinfo">
© Copyright 2016, CFEL Team.
- Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.3.
+ Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.6.
</div>
</body>
</html>
\ No newline at end of file
diff --git a/doc/build/html/cfelpyutils.parameter_utils.html b/doc/build/html/cfelpyutils.parameter_utils.html
index bff0b82165d2ef265c644b5c4273e57154a3ecae..b67466866088ddd46d3578c34609e19b44597449 100644
--- a/doc/build/html/cfelpyutils.parameter_utils.html
+++ b/doc/build/html/cfelpyutils.parameter_utils.html
@@ -1,13 +1,16 @@
-
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
<title>cfelpyutils.parameter_utils module — cfelpyutils 0.5 documentation</title>
+
<link rel="stylesheet" href="_static/sphinxdoc.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
+
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
@@ -24,7 +27,7 @@
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
</head>
- <body>
+ <body role="document">
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
@@ -71,24 +74,27 @@
<dt id="cfelpyutils.parameter_utils.convert_parameters">
<code class="descclassname">cfelpyutils.parameter_utils.</code><code class="descname">convert_parameters</code><span class="sig-paren">(</span><em>config_dict</em><span class="sig-paren">)</span><a class="headerlink" href="#cfelpyutils.parameter_utils.convert_parameters" title="Permalink to this definition">¶</a></dt>
<dd><p>Convert strings in parameter dictionaries to the corrent data type.</p>
-<p>Read a parameter dictionary returned by the ConfigParser python module,
-and convert each entry in an object of the corresponding type,
-without changing the structure of the dictionary.</p>
-<p>Try to convert each entry in the dictionary according to the following
-rules. The first rule that applies to the entry determines the type.</p>
+<p>Read a parameter dictionary returned by the ConfigParser python
+module, and convert each entry in an object of the corresponding
+type, without changing the structure of the dictionary.</p>
+<p>Try to convert each entry in the dictionary according to the
+following rules. The first rule that applies to the entry
+determines the type.</p>
<ul>
<li><p class="first">If the entry starts and ends with a single quote or double quote,
leave it as a string.</p>
</li>
-<li><p class="first">If the entry starts and ends with a square bracket, convert it to a list.</p>
+<li><p class="first">If the entry starts and ends with a square bracket, convert it to
+a list.</p>
</li>
<li><p class="first">If the entry starts and ends with a curly braces, convert it to a
dictionary or a set.</p>
</li>
-<li><p class="first">If the entry is the word None, without quotes, convert it to NoneType.</p>
+<li><p class="first">If the entry is the word None, without quotes, convert it to
+NoneType.</p>
</li>
-<li><p class="first">If the entry is the word False, without quotes, convert it to a boolean
-False.</p>
+<li><p class="first">If the entry is the word False, without quotes, convert it to a
+boolean False.</p>
</li>
<li><p class="first">If the entry is the word True, without quotes, convert it to a
boolean True.</p>
@@ -110,15 +116,22 @@ try to interpret the entry in order as:</p>
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>config</strong> (<em>dict</em>) – a dictionary containing strings (the dictionary
-returned by Config Parser).</td>
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>config</strong> (<em>dict</em>) – a dictionary containing strings (the dictionary
+returned by Config Parser).</p>
+</td>
</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">dictionary with the same structure as the input
-dictionary, but with correct types assigned to each entry.</td>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">dictionary with the same structure as the input
+dictionary, but with correct types assigned to each entry.</p>
+</td>
</tr>
-<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">dict</td>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first">dict</p>
+</td>
</tr>
-<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><code class="xref py py-exc docutils literal"><span class="pre">RuntimeError</span></code> – if an entry cannot be converted to any supported type.</td>
+<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><ul class="first last simple">
+<li><code class="xref py py-exc docutils literal"><span class="pre">RuntimeError</span></code> – if an entry cannot be converted to any supported</li>
+<li><code class="xref py py-exc docutils literal"><span class="pre">type.</span></code></li>
+</ul>
+</td>
</tr>
</tbody>
</table>
@@ -146,7 +159,7 @@ dictionary, but with correct types assigned to each entry.</td>
</div>
<div class="footer" role="contentinfo">
© Copyright 2016, CFEL Team.
- Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.3.
+ Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.6.
</div>
</body>
</html>
\ No newline at end of file
diff --git a/doc/build/html/genindex.html b/doc/build/html/genindex.html
index 402882fa00a33c466652271aa053a550a75d7e53..8e3eaeb99a43e027e5dcb15320d9faa2484a06df 100644
--- a/doc/build/html/genindex.html
+++ b/doc/build/html/genindex.html
@@ -1,14 +1,17 @@
-
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
<title>Index — cfelpyutils 0.5 documentation</title>
+
<link rel="stylesheet" href="_static/sphinxdoc.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
+
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
@@ -25,7 +28,7 @@
<link rel="index" title="Index" href="#" />
<link rel="search" title="Search" href="search.html" />
</head>
- <body>
+ <body role="document">
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
@@ -68,10 +71,6 @@
<a href="#A"><strong>A</strong></a>
| <a href="#C"><strong>C</strong></a>
| <a href="#L"><strong>L</strong></a>
- | <a href="#P"><strong>P</strong></a>
- | <a href="#R"><strong>R</strong></a>
- | <a href="#X"><strong>X</strong></a>
- | <a href="#Y"><strong>Y</strong></a>
</div>
<h2 id="A">A</h2>
@@ -116,38 +115,6 @@
</ul></td>
</tr></table>
-<h2 id="P">P</h2>
-<table style="width: 100%" class="indextable genindextable"><tr>
- <td style="width: 33%; vertical-align: top;"><ul>
- <li><a href="cfelpyutils.geometry_utils.html#cfelpyutils.geometry_utils.PixelMaps">PixelMaps (class in cfelpyutils.geometry_utils)</a>
-</li>
- </ul></td>
-</tr></table>
-
-<h2 id="R">R</h2>
-<table style="width: 100%" class="indextable genindextable"><tr>
- <td style="width: 33%; vertical-align: top;"><ul>
- <li><a href="cfelpyutils.geometry_utils.html#cfelpyutils.geometry_utils.PixelMaps.r">r (cfelpyutils.geometry_utils.PixelMaps attribute)</a>
-</li>
- </ul></td>
-</tr></table>
-
-<h2 id="X">X</h2>
-<table style="width: 100%" class="indextable genindextable"><tr>
- <td style="width: 33%; vertical-align: top;"><ul>
- <li><a href="cfelpyutils.geometry_utils.html#cfelpyutils.geometry_utils.PixelMaps.x">x (cfelpyutils.geometry_utils.PixelMaps attribute)</a>
-</li>
- </ul></td>
-</tr></table>
-
-<h2 id="Y">Y</h2>
-<table style="width: 100%" class="indextable genindextable"><tr>
- <td style="width: 33%; vertical-align: top;"><ul>
- <li><a href="cfelpyutils.geometry_utils.html#cfelpyutils.geometry_utils.PixelMaps.y">y (cfelpyutils.geometry_utils.PixelMaps attribute)</a>
-</li>
- </ul></td>
-</tr></table>
-
</div>
@@ -169,7 +136,7 @@
</div>
<div class="footer" role="contentinfo">
© Copyright 2016, CFEL Team.
- Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.3.
+ Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.6.
</div>
</body>
</html>
\ No newline at end of file
diff --git a/doc/build/html/index.html b/doc/build/html/index.html
index 7f484cb5cbae0dd0b572f04e6c581fd1d61643cf..211403123ab8fe7838d4295af5ba74881ca02833 100644
--- a/doc/build/html/index.html
+++ b/doc/build/html/index.html
@@ -1,13 +1,16 @@
-
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
<title>Welcome to cfelpyutils’s documentation! — cfelpyutils 0.5 documentation</title>
+
<link rel="stylesheet" href="_static/sphinxdoc.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
+
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
@@ -24,7 +27,7 @@
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
</head>
- <body>
+ <body role="document">
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
@@ -41,7 +44,7 @@
<div class="sphinxsidebarwrapper">
<h3><a href="#">Table Of Contents</a></h3>
<ul>
-<li><a class="reference internal" href="#">Welcome to cfelpyutils’s documentation!</a></li>
+<li><a class="reference internal" href="#">Welcome to cfelpyutils’s documentation!</a></li>
<li><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li>
</ul>
@@ -71,7 +74,7 @@
<div class="body" role="main">
<div class="section" id="welcome-to-cfelpyutils-s-documentation">
-<h1>Welcome to cfelpyutils’s documentation!<a class="headerlink" href="#welcome-to-cfelpyutils-s-documentation" title="Permalink to this headline">¶</a></h1>
+<h1>Welcome to cfelpyutils’s documentation!<a class="headerlink" href="#welcome-to-cfelpyutils-s-documentation" title="Permalink to this headline">¶</a></h1>
<p>Contents:</p>
<div class="toctree-wrapper compound">
</div>
@@ -105,7 +108,7 @@
</div>
<div class="footer" role="contentinfo">
© Copyright 2016, CFEL Team.
- Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.3.
+ Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.6.
</div>
</body>
</html>
\ No newline at end of file
diff --git a/doc/build/html/modules.html b/doc/build/html/modules.html
index 4d9e51f8bd42ac3a867f966ae60798921e4d9ed4..5562e7c6f844c03ea0cc0890a588ab007fe5ff92 100644
--- a/doc/build/html/modules.html
+++ b/doc/build/html/modules.html
@@ -1,13 +1,16 @@
-
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
<title>cfelpyutils — cfelpyutils 0.5 documentation</title>
+
<link rel="stylesheet" href="_static/sphinxdoc.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
+
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
@@ -24,7 +27,7 @@
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
</head>
- <body>
+ <body role="document">
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
@@ -102,7 +105,7 @@
</div>
<div class="footer" role="contentinfo">
© Copyright 2016, CFEL Team.
- Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.3.
+ Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.6.
</div>
</body>
</html>
\ No newline at end of file
diff --git a/doc/build/html/objects.inv b/doc/build/html/objects.inv
index 3a4683af811c503ddd611e3e57561bcc002846b7..ec0b69617810b39692e04b3d4c1c20a3b1e6e378 100644
Binary files a/doc/build/html/objects.inv and b/doc/build/html/objects.inv differ
diff --git a/doc/build/html/py-modindex.html b/doc/build/html/py-modindex.html
index 7a1639ebe55be23688f57a03646a8f130e7c9d40..01f0bcc5a461134581ba714245a73d1b227937fc 100644
--- a/doc/build/html/py-modindex.html
+++ b/doc/build/html/py-modindex.html
@@ -1,13 +1,16 @@
-
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
<title>Python Module Index — cfelpyutils 0.5 documentation</title>
+
<link rel="stylesheet" href="_static/sphinxdoc.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
+
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
@@ -27,7 +30,7 @@
</head>
- <body>
+ <body role="document">
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
@@ -114,7 +117,7 @@
</div>
<div class="footer" role="contentinfo">
© Copyright 2016, CFEL Team.
- Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.3.
+ Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.6.
</div>
</body>
</html>
\ No newline at end of file
diff --git a/doc/build/html/search.html b/doc/build/html/search.html
index 949f0598db71eac41c9e6ebef0d4385e5b0f2cc2..81cbbb6427346e757469fe17d1fba35834d37923 100644
--- a/doc/build/html/search.html
+++ b/doc/build/html/search.html
@@ -1,13 +1,16 @@
-
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
<title>Search — cfelpyutils 0.5 documentation</title>
+
<link rel="stylesheet" href="_static/sphinxdoc.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
+
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
@@ -32,7 +35,7 @@
</head>
- <body>
+ <body role="document">
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
@@ -98,7 +101,7 @@
</div>
<div class="footer" role="contentinfo">
© Copyright 2016, CFEL Team.
- Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.3.
+ Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.6.
</div>
</body>
</html>
\ No newline at end of file
diff --git a/doc/build/html/searchindex.js b/doc/build/html/searchindex.js
index 849a4c818b32dea83efcf03556ed6e6834636c3e..98399e185796caa2074a6945eff5fd64fce0b787 100644
--- a/doc/build/html/searchindex.js
+++ b/doc/build/html/searchindex.js
@@ -1 +1 @@
-Search.setIndex({docnames:["cfelpyutils","cfelpyutils.crystfel_utils","cfelpyutils.geometry_utils","cfelpyutils.parameter_utils","index","modules"],envversion:53,filenames:["cfelpyutils.rst","cfelpyutils.crystfel_utils.rst","cfelpyutils.geometry_utils.rst","cfelpyutils.parameter_utils.rst","index.rst","modules.rst"],objects:{"":{cfelpyutils:[0,0,0,"-"]},"cfelpyutils.crystfel_utils":{load_crystfel_geometry:[1,1,1,""]},"cfelpyutils.geometry_utils":{PixelMaps:[2,2,1,""],adjust_pixel_maps_for_pyqtgraph:[2,1,1,""],apply_pixel_maps:[2,1,1,""],compute_minimum_array_size:[2,1,1,""],compute_pixel_maps:[2,1,1,""]},"cfelpyutils.geometry_utils.PixelMaps":{r:[2,3,1,""],x:[2,3,1,""],y:[2,3,1,""]},"cfelpyutils.parameter_utils":{convert_parameters:[3,1,1,""]},cfelpyutils:{crystfel_utils:[1,0,0,"-"],geometry_utils:[2,0,0,"-"],parameter_utils:[3,0,0,"-"]}},objnames:{"0":["py","module","Python module"],"1":["py","function","Python function"],"2":["py","class","Python class"],"3":["py","attribute","Python attribute"]},objtypes:{"0":"py:module","1":"py:function","2":"py:class","3":"py:attribute"},terms:{"41a8fa9819010fe8ddeb66676fee717f5226c7b8":1,"boolean":3,"class":[0,2],"default":2,"float":3,"function":[0,1,2],"import":0,"new":2,"return":[1,2,3],"true":3,"try":3,For:1,The:[1,2,3],accord:3,adjust:2,adjust_pixel_maps_for_pyqtgraph:2,ajust:2,alia:2,all:[2,3],allow:0,ani:3,appli:[2,3],apply_pixel_map:2,argument:0,arrai:2,assign:3,automat:[0,2],base:[0,2],beam:2,been:2,big:2,brace:3,bracket:3,can:2,cannot:3,cell:2,center:2,cfel:0,cfelfabio:0,cfelgeom:0,cfelhdf5:0,cfeloptarg:0,cfelpsana:0,chang:3,code:1,command:[0,3],commit:1,comput:2,compute_minimum_array_s:2,compute_pixel_map:2,config:3,config_dict:3,configpars:3,configur:3,contain:[0,1,2,3],content:[3,4,5],convert:[1,3],convert_paramet:3,coordin:2,correct:3,corrent:3,correspond:[2,3],creat:2,crystfel:[0,1,2],crystfel_geometri:1,crystfel_util:[0,2,5],curli:3,current:1,data:[1,2,3],describ:2,desi:1,detector:2,determin:3,dict:[1,2,3],dictionari:[1,2,3],displai:2,distanc:2,document:1,doubl:3,dtype:2,each:[2,3],els:3,end:3,enough:2,entri:[1,3],essenti:2,etc:0,except:3,expand:0,fabio:0,fail:3,fals:3,field:2,file:[0,1,3],filenam:1,fill:2,first:[2,3],float32:2,follow:[0,3],format:[0,1,2],from:[1,2],full:1,geometri:[0,1,2],geometry_util:[0,5],get_detector_geometry_2:1,h5py:0,has:2,hdf5:0,hold:2,html:1,http:1,imag:[0,2],imageview:2,index:4,inform:[1,2],input:[2,3],instead:2,integ:3,interact:2,interoper:1,interpret:3,kei:1,layout:2,leav:3,left:2,like:2,line:[0,3],list:3,load:[1,2],load_crystfel_geometri:[1,2],mani:0,manipul:2,manual:1,map:2,match:3,minimum:2,modul:[4,5],move:2,namedtupl:2,ndarrai:2,non:0,none:[2,3],nonetyp:3,number:[2,3],numpi:2,object:[2,3],option:[2,3],order:3,origin:2,output:2,output_arrai:2,packag:[1,5],page:4,paramet:[0,1,2,3],parameter_util:[0,5],pars:[0,3],parser:3,physic:2,pixel:2,pixel_map:2,pixelmap:2,point:2,prealloc:2,previou:3,process:0,project:0,provid:[0,2],psana:0,pyqtgraph:2,python:[0,1,3],quot:3,rai:0,rais:3,read:[1,3],refer:2,reimplement:1,represent:2,respect:2,rule:3,runtimeerror:3,same:[2,3],search:4,see:1,set:[2,3],sever:0,shape:2,singl:3,size:2,softwar:[0,1],some:[],squar:3,start:3,store:2,str:1,string:3,structur:3,style:[0,2],submodul:5,support:3,suppos:2,sync:1,system:2,take:2,thei:2,thi:[0,1,2],third:2,top:2,tupl:2,turn:2,twhite:1,two:2,type:[1,2,3],used:[0,1,2],user:2,util:[0,1,2,3],valu:2,visual:2,which:[0,2],whose:2,widget:2,without:3,word:3,work:0,www:1},titles:["cfelpyutils package","cfelpyutils.crystfel_utils module","cfelpyutils.geometry_utils module","cfelpyutils.parameter_utils module","Welcome to cfelpyutils\u2019s documentation!","cfelpyutils"],titleterms:{cfelpyutil:[0,1,2,3,4,5],content:0,crystfel_util:1,document:4,geometry_util:2,indic:4,modul:[0,1,2,3],packag:0,parameter_util:3,submodul:0,tabl:4,welcom:4}})
\ No newline at end of file
+Search.setIndex({docnames:["cfelpyutils","cfelpyutils.crystfel_utils","cfelpyutils.geometry_utils","cfelpyutils.parameter_utils","index","modules"],envversion:51,filenames:["cfelpyutils.rst","cfelpyutils.crystfel_utils.rst","cfelpyutils.geometry_utils.rst","cfelpyutils.parameter_utils.rst","index.rst","modules.rst"],objects:{"":{cfelpyutils:[0,0,0,"-"]},"cfelpyutils.crystfel_utils":{load_crystfel_geometry:[1,1,1,""]},"cfelpyutils.geometry_utils":{adjust_pixel_maps_for_pyqtgraph:[2,1,1,""],apply_pixel_maps:[2,1,1,""],compute_minimum_array_size:[2,1,1,""],compute_pixel_maps:[2,1,1,""]},"cfelpyutils.parameter_utils":{convert_parameters:[3,1,1,""]},cfelpyutils:{crystfel_utils:[1,0,0,"-"],geometry_utils:[2,0,0,"-"],parameter_utils:[3,0,0,"-"]}},objnames:{"0":["py","module","Python module"],"1":["py","function","Python function"]},objtypes:{"0":"py:module","1":"py:function"},terms:{"41a8fa9819010fe8ddeb66676fee717f5226c7b8":1,"boolean":3,"class":0,"default":2,"float":3,"function":[0,1,2],"import":0,"int":2,"new":2,"return":[1,2,3],"true":3,"try":3,For:1,The:[1,2,3],accord:3,adjust:2,adjust_pixel_maps_for_pyqtgraph:2,all:[2,3],allow:0,ani:3,appli:[2,3],apply_pixel_map:2,argument:0,arrai:2,assign:3,automat:[0,2],base:0,beam:2,been:2,big:2,brace:3,bracket:3,can:2,cannot:3,center:2,cfel:0,cfelfabio:0,cfelgeom:0,cfelhdf5:0,cfeloptarg:0,cfelpsana:0,chang:3,code:1,command:[0,3],commit:1,comput:2,compute_minimum_array_s:2,compute_pixel_map:2,config:3,config_dict:3,configpars:3,configur:3,contain:[0,1,2,3],content:[3,4,5],convert:[1,3],convert_paramet:3,coordin:2,coordinateand:2,correct:3,corrent:3,correspond:3,creat:2,crystfel:[0,1,2],crystfel_geometri:1,crystfel_util:[0,2,5],curli:3,current:1,data:[1,2,3],describ:2,desi:1,detector:2,determin:3,dict:[1,2,3],dictionari:[1,2,3],displai:2,distanc:2,document:1,doubl:3,dtype:2,each:[2,3],els:3,end:3,enough:2,entri:[1,3],etc:0,except:3,expand:0,fabio:0,fail:3,fals:3,field:2,file:[0,1,3],filenam:1,fill:2,first:[2,3],float32:2,follow:[0,3],format:[0,1,2],from:[1,2],full:1,geometri:[0,1,2],geometry_util:[0,5],get_detector_geometry_2:1,h5py:0,has:2,hdf5:0,html:1,http:1,imag:0,imageview:2,index:4,inform:[1,2],input:[2,3],instead:2,integ:3,interact:2,interoper:1,interpret:3,kei:1,layout:2,leav:3,line:[0,3],list:3,load:[1,2],load_crystfel_geometri:[1,2],mani:0,manipul:2,manual:1,map:2,match:3,minimum:2,modul:[4,5],name:2,ndarrai:2,non:0,none:[2,3],nonetyp:3,number:3,numpi:2,object:[2,3],option:[2,3],order:3,origin:2,output:2,output_arrai:2,packag:[1,5],page:4,paramet:[0,1,2,3],parameter_util:[0,5],pars:[0,3],parser:3,physic:2,pixel:2,pixel_map:2,pixelmap:2,point:2,prealloc:2,previou:3,process:0,project:0,provid:[0,2],psana:0,pyqtgraph:2,python:[0,1,3],quot:3,rai:0,rais:3,read:[1,3],refer:2,reimplement:1,represent:2,respect:2,rule:3,runtimeerror:3,same:3,search:4,see:1,set:[2,3],sever:0,shape:2,should:2,singl:3,size:2,softwar:[0,1],squar:3,start:3,store:2,str:1,string:3,structur:3,style:[0,2],submodul:5,support:3,suppos:2,sync:1,system:2,take:2,thi:[0,1,2],third:2,tupl:2,turn:2,twhite:1,two:2,type:[1,2,3],used:[0,1,2],user:2,util:[0,1,2,3],valu:2,visual:2,which:[0,2],widget:2,without:3,word:3,work:0,www:1},titles:["cfelpyutils package","cfelpyutils.crystfel_utils module","cfelpyutils.geometry_utils module","cfelpyutils.parameter_utils module","Welcome to cfelpyutils’s documentation!","cfelpyutils"],titleterms:{cfelpyutil:[0,1,2,3,4,5],content:0,crystfel_util:1,document:4,geometry_util:2,indic:4,modul:[0,1,2,3],packag:0,parameter_util:3,submodul:0,tabl:4,welcom:4}})
\ No newline at end of file