update docs

hanjinliu · Jan 25, 2022 · 011e296 · 011e296
1 parent e3bf1b8
commit 011e296
Show file tree

Hide file tree

Showing 24 changed files with 94 additions and 116 deletions.
diff --git a/docs/.buildinfo b/docs/.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: 4cceaf713fd3e950f9fba85eb852f32b
+config: e19337f968ebb208f3d9eb69a3546e77
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/.doctrees/environment.pickle b/docs/.doctrees/environment.pickle
diff --git a/docs/.doctrees/impy.arrays.doctree b/docs/.doctrees/impy.arrays.doctree
diff --git a/docs/_modules/impy/arrays/lazy.html b/docs/_modules/impy/arrays/lazy.html
diff --git a/docs/_modules/index.html b/docs/_modules/index.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Overview: module code &mdash; impy 1.25.0 documentation</title>
+  <title>Overview: module code &mdash; impy 1.25.1 documentation</title>
       <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
   <!--[if lt IE 9]>
@@ -27,7 +27,7 @@
             <a href="../index.html" class="icon icon-home"> impy
           </a>
               <div class="version">
-                1.25.0
+                1.25.1
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">

diff --git a/docs/_static/documentation_options.js b/docs/_static/documentation_options.js
@@ -1,6 +1,6 @@
 var DOCUMENTATION_OPTIONS = {
     URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
-    VERSION: '1.25.0',
+    VERSION: '1.25.1',
     LANGUAGE: 'None',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

diff --git a/docs/api.html b/docs/api.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>API References &mdash; impy 1.25.0 documentation</title>
+  <title>API References &mdash; impy 1.25.1 documentation</title>
       <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
   <!--[if lt IE 9]>
@@ -30,7 +30,7 @@
             <a href="index.html" class="icon icon-home"> impy
           </a>
               <div class="version">
-                1.25.0
+                1.25.1
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">

diff --git a/docs/genindex.html b/docs/genindex.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Index &mdash; impy 1.25.0 documentation</title>
+  <title>Index &mdash; impy 1.25.1 documentation</title>
       <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
   <!--[if lt IE 9]>
@@ -27,7 +27,7 @@
             <a href="index.html" class="icon icon-home"> impy
           </a>
               <div class="version">
-                1.25.0
+                1.25.1
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
@@ -1554,11 +1554,11 @@ <h2 id="R">R</h2>
       <li><a href="impy.arrays.html#impy.arrays.imgarray.ImgArray.remove_fine_objects">remove_fine_objects() (impy.arrays.imgarray.ImgArray method)</a>
 </li>
       <li><a href="impy.arrays.html#impy.arrays.imgarray.ImgArray.remove_large_objects">remove_large_objects() (impy.arrays.imgarray.ImgArray method)</a>
-</li>
-      <li><a href="impy.arrays.html#impy.arrays.imgarray.ImgArray.remove_skeleton_structure">remove_skeleton_structure() (impy.arrays.imgarray.ImgArray method)</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="impy.arrays.html#impy.arrays.imgarray.ImgArray.remove_skeleton_structure">remove_skeleton_structure() (impy.arrays.imgarray.ImgArray method)</a>
+</li>
       <li><a href="impy.html#impy.axes.Axes.replace">replace() (impy.axes.Axes method)</a>
 
       <ul>
@@ -1604,11 +1604,7 @@ <h2 id="R">R</h2>
       <li><a href="impy.arrays.html#impy.arrays.imgarray.ImgArray.rotate">rotate() (impy.arrays.imgarray.ImgArray method)</a>
 </li>
       <li><a href="impy.arrays.html#impy.arrays.labeledarray.LabeledArray.rotated_crop">rotated_crop() (impy.arrays.labeledarray.LabeledArray method)</a>
-
-      <ul>
-        <li><a href="impy.arrays.html#impy.arrays.lazy.LazyImgArray.rotated_crop">(impy.arrays.lazy.LazyImgArray method)</a>
 </li>
-      </ul></li>
       <li><a href="impy.viewer.widgets.html#impy.viewer.widgets.gui.Rotator">Rotator (class in impy.viewer.widgets.gui)</a>
 </li>
       <li><a href="impy.viewer.widgets.html#impy.viewer.widgets.dialog.DuplicateDialog.run">run() (impy.viewer.widgets.dialog.DuplicateDialog method)</a>

diff --git a/docs/impy.arrays.bases.html b/docs/impy.arrays.bases.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>impy.arrays.bases package &mdash; impy 1.25.0 documentation</title>
+  <title>impy.arrays.bases package &mdash; impy 1.25.1 documentation</title>
       <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
   <!--[if lt IE 9]>
@@ -30,7 +30,7 @@
             <a href="index.html" class="icon icon-home"> impy
           </a>
               <div class="version">
-                1.25.0
+                1.25.1
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">

diff --git a/docs/impy.arrays.html b/docs/impy.arrays.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>impy.arrays package &mdash; impy 1.25.0 documentation</title>
+  <title>impy.arrays package &mdash; impy 1.25.1 documentation</title>
       <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
   <!--[if lt IE 9]>
@@ -31,7 +31,7 @@
             <a href="index.html" class="icon icon-home"> impy
           </a>
               <div class="version">
-                1.25.0
+                1.25.1
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
@@ -4670,34 +4670,6 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
 again.</p>
 </dd></dl>
 
-<dl class="py method">
-<dt class="sig sig-object py" id="impy.arrays.lazy.LazyImgArray.rotated_crop">
-<span class="sig-name descname"><span class="pre">rotated_crop</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">origin</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dst1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dst2</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dims</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">2</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#impy.arrays.lazy.LazyImgArray" title="impy.arrays.lazy.LazyImgArray"><span class="pre">impy.arrays.lazy.LazyImgArray</span></a></span></span><a class="reference internal" href="_modules/impy/arrays/lazy.html#LazyImgArray.rotated_crop"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#impy.arrays.lazy.LazyImgArray.rotated_crop" title="Permalink to this definition">¶</a></dt>
-<dd><p>Copy of LabeledArray.rotated_crop. This function returns the same result but the value is evaluated lazily as an dask array.</p>
-<p>Crop the image at four courners of an rotated rectangle. Currently only supports rotation within
-yx-plane. An rotated rectangle is specified with positions of a origin and two destinations <cite>dst1</cite>
-and <cite>dst2</cite>, i.e., vectors (dst1-origin) and (dst2-origin) represent a rotated rectangle. Let
-origin be the origin of a xy-plane, the rotation direction from dst1 to dst2 must be counter-
-clockwise, or the cropped image will be reversed.</p>
-<dl class="field-list simple">
-<dt class="field-odd">Parameters</dt>
-<dd class="field-odd"><ul class="simple">
-<li><p><strong>origin</strong> (<em>(</em><em>float</em><em>, </em><em>float</em><em>)</em>) – </p></li>
-<li><p><strong>dst1</strong> (<em>(</em><em>float</em><em>, </em><em>float</em><em>)</em>) – </p></li>
-<li><p><strong>dst2</strong> (<em>(</em><em>float</em><em>, </em><em>float</em><em>)</em>) – </p></li>
-<li><p><strong>dims</strong> (<em>str</em><em> or </em><em>int</em><em>, </em><em>optional</em>) – Spatial dimensions. If string is given, each symbol is interpeted as an axis name of spatial dimensions. If an integer is given, it is interpreted as the number of spatial dimensions.
-For instance, <code class="docutils literal notranslate"><span class="pre">dims=&quot;yx&quot;</span></code> means axes <code class="docutils literal notranslate"><span class="pre">&quot;y&quot;</span></code> and <code class="docutils literal notranslate"><span class="pre">&quot;x&quot;</span></code> are spatial dimensions and function is applied to other axes, say, <code class="docutils literal notranslate"><span class="pre">&quot;t&quot;</span></code> and/or <code class="docutils literal notranslate"><span class="pre">&quot;c&quot;</span></code>. <code class="docutils literal notranslate"><span class="pre">dims=3</span></code> is equivalent to <code class="docutils literal notranslate"><span class="pre">dims=&quot;zyx&quot;</span></code>.</p></li>
-</ul>
-</dd>
-<dt class="field-even">Returns</dt>
-<dd class="field-even"><p>Cropped array.</p>
-</dd>
-<dt class="field-odd">Return type</dt>
-<dd class="field-odd"><p><a class="reference internal" href="#impy.arrays.lazy.LazyImgArray" title="impy.arrays.lazy.LazyImgArray">LazyImgArray</a></p>
-</dd>
-</dl>
-</dd></dl>
-
 <dl class="py property">
 <dt class="sig sig-object py" id="impy.arrays.lazy.LazyImgArray.shape">
 <em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">shape</span></span><a class="headerlink" href="#impy.arrays.lazy.LazyImgArray.shape" title="Permalink to this definition">¶</a></dt>

diff --git a/docs/impy.frame.html b/docs/impy.frame.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>impy.frame package &mdash; impy 1.25.0 documentation</title>
+  <title>impy.frame package &mdash; impy 1.25.1 documentation</title>
       <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
   <!--[if lt IE 9]>
@@ -30,7 +30,7 @@
             <a href="index.html" class="icon icon-home"> impy
           </a>
               <div class="version">
-                1.25.0
+                1.25.1
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">

diff --git a/docs/impy.html b/docs/impy.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>impy package &mdash; impy 1.25.0 documentation</title>
+  <title>impy package &mdash; impy 1.25.1 documentation</title>
       <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
   <!--[if lt IE 9]>
@@ -31,7 +31,7 @@
             <a href="index.html" class="icon icon-home"> impy
           </a>
               <div class="version">
-                1.25.0
+                1.25.1
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">

diff --git a/docs/impy.utils.html b/docs/impy.utils.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>impy.utils package &mdash; impy 1.25.0 documentation</title>
+  <title>impy.utils package &mdash; impy 1.25.1 documentation</title>
       <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
   <!--[if lt IE 9]>
@@ -30,7 +30,7 @@
             <a href="index.html" class="icon icon-home"> impy
           </a>
               <div class="version">
-                1.25.0
+                1.25.1
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">

diff --git a/docs/impy.viewer.html b/docs/impy.viewer.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>impy.viewer package &mdash; impy 1.25.0 documentation</title>
+  <title>impy.viewer package &mdash; impy 1.25.1 documentation</title>
       <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
   <!--[if lt IE 9]>
@@ -30,7 +30,7 @@
             <a href="index.html" class="icon icon-home"> impy
           </a>
               <div class="version">
-                1.25.0
+                1.25.1
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">

diff --git a/docs/impy.viewer.widgets.html b/docs/impy.viewer.widgets.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>impy.viewer.widgets package &mdash; impy 1.25.0 documentation</title>
+  <title>impy.viewer.widgets package &mdash; impy 1.25.1 documentation</title>
       <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
   <!--[if lt IE 9]>
@@ -29,7 +29,7 @@
             <a href="index.html" class="icon icon-home"> impy
           </a>
               <div class="version">
-                1.25.0
+                1.25.1
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">

diff --git a/docs/index.html b/docs/index.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Welcome to impy’s documentation! &mdash; impy 1.25.0 documentation</title>
+  <title>Welcome to impy’s documentation! &mdash; impy 1.25.1 documentation</title>
       <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
   <!--[if lt IE 9]>
@@ -29,7 +29,7 @@
             <a href="#" class="icon icon-home"> impy
           </a>
               <div class="version">
-                1.25.0
+                1.25.1
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">

diff --git a/docs/modules.html b/docs/modules.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>impy &mdash; impy 1.25.0 documentation</title>
+  <title>impy &mdash; impy 1.25.1 documentation</title>
       <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
   <!--[if lt IE 9]>
@@ -28,7 +28,7 @@
             <a href="index.html" class="icon icon-home"> impy
           </a>
               <div class="version">
-                1.25.0
+                1.25.1
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">

diff --git a/docs/objects.inv b/docs/objects.inv
diff --git a/docs/py-modindex.html b/docs/py-modindex.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Python Module Index &mdash; impy 1.25.0 documentation</title>
+  <title>Python Module Index &mdash; impy 1.25.1 documentation</title>
       <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
   <!--[if lt IE 9]>
@@ -30,7 +30,7 @@
             <a href="index.html" class="icon icon-home"> impy
           </a>
               <div class="version">
-                1.25.0
+                1.25.1
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">

diff --git a/docs/search.html b/docs/search.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Search &mdash; impy 1.25.0 documentation</title>
+  <title>Search &mdash; impy 1.25.1 documentation</title>
       <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
 
@@ -30,7 +30,7 @@
             <a href="index.html" class="icon icon-home"> impy
           </a>
               <div class="version">
-                1.25.0
+                1.25.1
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="#" method="get">

diff --git a/docs/searchindex.js b/docs/searchindex.js
diff --git a/docs/tutorial.html b/docs/tutorial.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Tutorial &mdash; impy 1.25.0 documentation</title>
+  <title>Tutorial &mdash; impy 1.25.1 documentation</title>
       <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
   <!--[if lt IE 9]>
@@ -30,7 +30,7 @@
             <a href="index.html" class="icon icon-home"> impy
           </a>
               <div class="version">
-                1.25.0
+                1.25.1
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">

diff --git a/docs/tutorial_cmd.html b/docs/tutorial_cmd.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Command Line Usage &mdash; impy 1.25.0 documentation</title>
+  <title>Command Line Usage &mdash; impy 1.25.1 documentation</title>
       <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
   <!--[if lt IE 9]>
@@ -30,7 +30,7 @@
             <a href="index.html" class="icon icon-home"> impy
           </a>
               <div class="version">
-                1.25.0
+                1.25.1
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">

diff --git a/docs/tutorial_viewer.html b/docs/tutorial_viewer.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Viewer Tutorial &mdash; impy 1.25.0 documentation</title>
+  <title>Viewer Tutorial &mdash; impy 1.25.1 documentation</title>
       <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
   <!--[if lt IE 9]>
@@ -30,7 +30,7 @@
             <a href="index.html" class="icon icon-home"> impy
           </a>
               <div class="version">
-                1.25.0
+                1.25.1
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">