deploy: 7a7cc25

b-heifets · Jun 7, 2024 · 46c7e05 · 46c7e05
1 parent dc0346e
commit 46c7e05
Show file tree

Hide file tree

Showing 16 changed files with 791 additions and 79 deletions.
diff --git a/_sources/modules.rst.txt b/_sources/modules.rst.txt
@@ -4,6 +4,7 @@ unravel
 .. toctree::
    :maxdepth: 4
 
+   unravel
    unravel.cluster_stats
    unravel.core
    unravel.image_io
@@ -15,52 +16,69 @@ unravel
    unravel.voxel_stats
    unravel.warp
 
+.. automodule:: unravel
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :noindex:
+
+
 .. automodule:: unravel.cluster_stats
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :noindex:
 
 .. automodule:: unravel.core
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :noindex:
 
 .. automodule:: unravel.image_io
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :noindex:
 
 .. automodule:: unravel.image_tools
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :noindex:
 
 .. automodule:: unravel.region_stats
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :noindex:
 
 .. automodule:: unravel.register
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :noindex:
 
 .. automodule:: unravel.segment
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :noindex:
 
 .. automodule:: unravel.utilities
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :noindex:
 
 .. automodule:: unravel.voxel_stats
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :noindex:
 
 .. automodule:: unravel.warp
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :noindex:
diff --git a/index.html b/index.html
@@ -465,6 +465,7 @@ <h2>Support is welcome for:<a class="headerlink" href="#support-is-welcome-for"
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="modules.html">unravel</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="unravel.html">unravel package</a></li>
 <li class="toctree-l2"><a class="reference internal" href="unravel.cluster_stats.html">unravel.cluster_stats package</a></li>
 <li class="toctree-l2"><a class="reference internal" href="unravel.core.html">unravel.core package</a></li>
 <li class="toctree-l2"><a class="reference internal" href="unravel.image_io.html">unravel.image_io package</a></li>

diff --git a/modules.html b/modules.html
diff --git a/unravel.cluster_stats.effect_sizes.html b/unravel.cluster_stats.effect_sizes.html
@@ -153,7 +153,7 @@
 </li>
 
 
-<li class="nav-item pst-header-nav-item">
+<li class="nav-item pst-header-nav-item current active">
   <a class="nav-link nav-internal" href="modules.html">
     unravel
   </a>
@@ -264,7 +264,7 @@
 </li>
 
 
-<li class="nav-item pst-header-nav-item">
+<li class="nav-item pst-header-nav-item current active">
   <a class="nav-link nav-internal" href="modules.html">
     unravel
   </a>
@@ -302,7 +302,41 @@
      aria-label="Section Navigation">
   <p class="bd-links__title" role="heading" aria-level="1">Section Navigation</p>
   <div class="bd-toc-item navbar-nav"><ul class="current nav bd-sidenav">
-<li class="toctree-l1 current active"><a class="current reference internal" href="#">unravel.cluster_stats.effect_sizes package</a></li>
+<li class="toctree-l1 current active has-children"><a class="reference internal" href="unravel.html">unravel package</a><details open="open"><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul class="current">
+<li class="toctree-l2 current active has-children"><a class="reference internal" href="unravel.cluster_stats.html">unravel.cluster_stats package</a><details open="open"><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul class="current">
+<li class="toctree-l3 current active"><a class="current reference internal" href="#">unravel.cluster_stats.effect_sizes package</a></li>
+</ul>
+</details></li>
+<li class="toctree-l2"><a class="reference internal" href="unravel.core.html">unravel.core package</a></li>
+<li class="toctree-l2"><a class="reference internal" href="unravel.image_io.html">unravel.image_io package</a></li>
+<li class="toctree-l2 has-children"><a class="reference internal" href="unravel.image_tools.html">unravel.image_tools package</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
+<li class="toctree-l3"><a class="reference internal" href="unravel.image_tools.atlas.html">unravel.image_tools.atlas package</a></li>
+</ul>
+</details></li>
+<li class="toctree-l2"><a class="reference internal" href="unravel.region_stats.html">unravel.region_stats package</a></li>
+<li class="toctree-l2"><a class="reference internal" href="unravel.register.html">unravel.register package</a></li>
+<li class="toctree-l2"><a class="reference internal" href="unravel.segment.html">unravel.segment package</a></li>
+<li class="toctree-l2"><a class="reference internal" href="unravel.utilities.html">unravel.utilities package</a></li>
+<li class="toctree-l2"><a class="reference internal" href="unravel.voxel_stats.html">unravel.voxel_stats package</a></li>
+<li class="toctree-l2"><a class="reference internal" href="unravel.warp.html">unravel.warp package</a></li>
+</ul>
+</details></li>
+<li class="toctree-l1 current active has-children"><a class="reference internal" href="unravel.cluster_stats.html">unravel.cluster_stats package</a><details open="open"><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul class="current">
+<li class="toctree-l2 current active"><a class="current reference internal" href="#">unravel.cluster_stats.effect_sizes package</a></li>
+</ul>
+</details></li>
+<li class="toctree-l1"><a class="reference internal" href="unravel.core.html">unravel.core package</a></li>
+<li class="toctree-l1"><a class="reference internal" href="unravel.image_io.html">unravel.image_io package</a></li>
+<li class="toctree-l1 has-children"><a class="reference internal" href="unravel.image_tools.html">unravel.image_tools package</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
+<li class="toctree-l2"><a class="reference internal" href="unravel.image_tools.atlas.html">unravel.image_tools.atlas package</a></li>
+</ul>
+</details></li>
+<li class="toctree-l1"><a class="reference internal" href="unravel.region_stats.html">unravel.region_stats package</a></li>
+<li class="toctree-l1"><a class="reference internal" href="unravel.register.html">unravel.register package</a></li>
+<li class="toctree-l1"><a class="reference internal" href="unravel.segment.html">unravel.segment package</a></li>
+<li class="toctree-l1"><a class="reference internal" href="unravel.utilities.html">unravel.utilities package</a></li>
+<li class="toctree-l1"><a class="reference internal" href="unravel.voxel_stats.html">unravel.voxel_stats package</a></li>
+<li class="toctree-l1"><a class="reference internal" href="unravel.warp.html">unravel.warp package</a></li>
 </ul>
 </div>
 </nav></div>
@@ -332,6 +366,8 @@
 
 
 
+
+
 <nav aria-label="Breadcrumb" class="d-print-none">
   <ul class="bd-breadcrumbs">
 
@@ -344,6 +380,9 @@
     <li class="breadcrumb-item"><a href="modules.html" class="nav-link">unravel</a></li>
 
 
+    <li class="breadcrumb-item"><i class="fa-solid fa-ellipsis"></i></li>
+
+
     <li class="breadcrumb-item"><a href="unravel.cluster_stats.html" class="nav-link">unravel.cluster_stats package</a></li>
 
     <li class="breadcrumb-item active" aria-current="page">unravel.clus...</li>

diff --git a/unravel.cluster_stats.html b/unravel.cluster_stats.html
@@ -44,7 +44,7 @@
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
     <link rel="next" title="unravel.cluster_stats.effect_sizes package" href="unravel.cluster_stats.effect_sizes.html" />
-    <link rel="prev" title="unravel" href="modules.html" />
+    <link rel="prev" title="unravel package" href="unravel.html" />
   <meta name="viewport" content="width=device-width, initial-scale=1"/>
   <meta name="docsearch:language" content="en"/>
   </head>
@@ -153,7 +153,7 @@
 </li>
 
 
-<li class="nav-item pst-header-nav-item">
+<li class="nav-item pst-header-nav-item current active">
   <a class="nav-link nav-internal" href="modules.html">
     unravel
   </a>
@@ -264,7 +264,7 @@
 </li>
 
 
-<li class="nav-item pst-header-nav-item">
+<li class="nav-item pst-header-nav-item current active">
   <a class="nav-link nav-internal" href="modules.html">
     unravel
   </a>
@@ -301,8 +301,42 @@
 <nav class="bd-docs-nav bd-links"
      aria-label="Section Navigation">
   <p class="bd-links__title" role="heading" aria-level="1">Section Navigation</p>
-  <div class="bd-toc-item navbar-nav"><ul class="nav bd-sidenav">
-<li class="toctree-l1"><a class="reference internal" href="unravel.cluster_stats.effect_sizes.html">unravel.cluster_stats.effect_sizes package</a></li>
+  <div class="bd-toc-item navbar-nav"><ul class="current nav bd-sidenav">
+<li class="toctree-l1 current active has-children"><a class="reference internal" href="unravel.html">unravel package</a><details open="open"><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul class="current">
+<li class="toctree-l2 current active has-children"><a class="current reference internal" href="#">unravel.cluster_stats package</a><details open="open"><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
+<li class="toctree-l3"><a class="reference internal" href="unravel.cluster_stats.effect_sizes.html">unravel.cluster_stats.effect_sizes package</a></li>
+</ul>
+</details></li>
+<li class="toctree-l2"><a class="reference internal" href="unravel.core.html">unravel.core package</a></li>
+<li class="toctree-l2"><a class="reference internal" href="unravel.image_io.html">unravel.image_io package</a></li>
+<li class="toctree-l2 has-children"><a class="reference internal" href="unravel.image_tools.html">unravel.image_tools package</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
+<li class="toctree-l3"><a class="reference internal" href="unravel.image_tools.atlas.html">unravel.image_tools.atlas package</a></li>
+</ul>
+</details></li>
+<li class="toctree-l2"><a class="reference internal" href="unravel.region_stats.html">unravel.region_stats package</a></li>
+<li class="toctree-l2"><a class="reference internal" href="unravel.register.html">unravel.register package</a></li>
+<li class="toctree-l2"><a class="reference internal" href="unravel.segment.html">unravel.segment package</a></li>
+<li class="toctree-l2"><a class="reference internal" href="unravel.utilities.html">unravel.utilities package</a></li>
+<li class="toctree-l2"><a class="reference internal" href="unravel.voxel_stats.html">unravel.voxel_stats package</a></li>
+<li class="toctree-l2"><a class="reference internal" href="unravel.warp.html">unravel.warp package</a></li>
+</ul>
+</details></li>
+<li class="toctree-l1 current active has-children"><a class="current reference internal" href="#">unravel.cluster_stats package</a><details open="open"><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
+<li class="toctree-l2"><a class="reference internal" href="unravel.cluster_stats.effect_sizes.html">unravel.cluster_stats.effect_sizes package</a></li>
+</ul>
+</details></li>
+<li class="toctree-l1"><a class="reference internal" href="unravel.core.html">unravel.core package</a></li>
+<li class="toctree-l1"><a class="reference internal" href="unravel.image_io.html">unravel.image_io package</a></li>
+<li class="toctree-l1 has-children"><a class="reference internal" href="unravel.image_tools.html">unravel.image_tools package</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
+<li class="toctree-l2"><a class="reference internal" href="unravel.image_tools.atlas.html">unravel.image_tools.atlas package</a></li>
+</ul>
+</details></li>
+<li class="toctree-l1"><a class="reference internal" href="unravel.region_stats.html">unravel.region_stats package</a></li>
+<li class="toctree-l1"><a class="reference internal" href="unravel.register.html">unravel.register package</a></li>
+<li class="toctree-l1"><a class="reference internal" href="unravel.segment.html">unravel.segment package</a></li>
+<li class="toctree-l1"><a class="reference internal" href="unravel.utilities.html">unravel.utilities package</a></li>
+<li class="toctree-l1"><a class="reference internal" href="unravel.voxel_stats.html">unravel.voxel_stats package</a></li>
+<li class="toctree-l1"><a class="reference internal" href="unravel.warp.html">unravel.warp package</a></li>
 </ul>
 </div>
 </nav></div>
@@ -343,6 +377,9 @@
 
     <li class="breadcrumb-item"><a href="modules.html" class="nav-link">unravel</a></li>
 
+
+    <li class="breadcrumb-item"><a href="unravel.html" class="nav-link">unravel package</a></li>
+
     <li class="breadcrumb-item active" aria-current="page">unravel.clus...</li>
   </ul>
 </nav>
@@ -447,12 +484,12 @@ <h2>Module contents<a class="headerlink" href="#module-contents" title="Link to
 
 <div class="prev-next-area">
     <a class="left-prev"
-       href="modules.html"
+       href="unravel.html"
        title="previous page">
       <i class="fa-solid fa-angle-left"></i>
       <div class="prev-next-info">
         <p class="prev-next-subtitle">previous</p>
-        <p class="prev-next-title">unravel</p>
+        <p class="prev-next-title">unravel package</p>
       </div>
     </a>
     <a class="right-next"

diff --git a/unravel.core.html b/unravel.core.html
@@ -153,7 +153,7 @@
 </li>
 
 
-<li class="nav-item pst-header-nav-item">
+<li class="nav-item pst-header-nav-item current active">
   <a class="nav-link nav-internal" href="modules.html">
     unravel
   </a>
@@ -264,7 +264,7 @@
 </li>
 
 
-<li class="nav-item pst-header-nav-item">
+<li class="nav-item pst-header-nav-item current active">
   <a class="nav-link nav-internal" href="modules.html">
     unravel
   </a>
@@ -301,7 +301,44 @@
 <nav class="bd-docs-nav bd-links"
      aria-label="Section Navigation">
   <p class="bd-links__title" role="heading" aria-level="1">Section Navigation</p>
-  <div class="bd-toc-item navbar-nav"></div>
+  <div class="bd-toc-item navbar-nav"><ul class="current nav bd-sidenav">
+<li class="toctree-l1 current active has-children"><a class="reference internal" href="unravel.html">unravel package</a><details open="open"><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul class="current">
+<li class="toctree-l2 has-children"><a class="reference internal" href="unravel.cluster_stats.html">unravel.cluster_stats package</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
+<li class="toctree-l3"><a class="reference internal" href="unravel.cluster_stats.effect_sizes.html">unravel.cluster_stats.effect_sizes package</a></li>
+</ul>
+</details></li>
+<li class="toctree-l2 current active"><a class="current reference internal" href="#">unravel.core package</a></li>
+<li class="toctree-l2"><a class="reference internal" href="unravel.image_io.html">unravel.image_io package</a></li>
+<li class="toctree-l2 has-children"><a class="reference internal" href="unravel.image_tools.html">unravel.image_tools package</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
+<li class="toctree-l3"><a class="reference internal" href="unravel.image_tools.atlas.html">unravel.image_tools.atlas package</a></li>
+</ul>
+</details></li>
+<li class="toctree-l2"><a class="reference internal" href="unravel.region_stats.html">unravel.region_stats package</a></li>
+<li class="toctree-l2"><a class="reference internal" href="unravel.register.html">unravel.register package</a></li>
+<li class="toctree-l2"><a class="reference internal" href="unravel.segment.html">unravel.segment package</a></li>
+<li class="toctree-l2"><a class="reference internal" href="unravel.utilities.html">unravel.utilities package</a></li>
+<li class="toctree-l2"><a class="reference internal" href="unravel.voxel_stats.html">unravel.voxel_stats package</a></li>
+<li class="toctree-l2"><a class="reference internal" href="unravel.warp.html">unravel.warp package</a></li>
+</ul>
+</details></li>
+<li class="toctree-l1 has-children"><a class="reference internal" href="unravel.cluster_stats.html">unravel.cluster_stats package</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
+<li class="toctree-l2"><a class="reference internal" href="unravel.cluster_stats.effect_sizes.html">unravel.cluster_stats.effect_sizes package</a></li>
+</ul>
+</details></li>
+<li class="toctree-l1 current active"><a class="current reference internal" href="#">unravel.core package</a></li>
+<li class="toctree-l1"><a class="reference internal" href="unravel.image_io.html">unravel.image_io package</a></li>
+<li class="toctree-l1 has-children"><a class="reference internal" href="unravel.image_tools.html">unravel.image_tools package</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
+<li class="toctree-l2"><a class="reference internal" href="unravel.image_tools.atlas.html">unravel.image_tools.atlas package</a></li>
+</ul>
+</details></li>
+<li class="toctree-l1"><a class="reference internal" href="unravel.region_stats.html">unravel.region_stats package</a></li>
+<li class="toctree-l1"><a class="reference internal" href="unravel.register.html">unravel.register package</a></li>
+<li class="toctree-l1"><a class="reference internal" href="unravel.segment.html">unravel.segment package</a></li>
+<li class="toctree-l1"><a class="reference internal" href="unravel.utilities.html">unravel.utilities package</a></li>
+<li class="toctree-l1"><a class="reference internal" href="unravel.voxel_stats.html">unravel.voxel_stats package</a></li>
+<li class="toctree-l1"><a class="reference internal" href="unravel.warp.html">unravel.warp package</a></li>
+</ul>
+</div>
 </nav></div>
     </div>
 
@@ -340,6 +377,9 @@
 
     <li class="breadcrumb-item"><a href="modules.html" class="nav-link">unravel</a></li>
 
+
+    <li class="breadcrumb-item"><a href="unravel.html" class="nav-link">unravel package</a></li>
+
     <li class="breadcrumb-item active" aria-current="page">unravel.core package</li>
   </ul>
 </nav>