Generated documentation for docs//pulls/307

jenkins-neurorse-plenoptic-PR-307-26
plenoptic-org · Feb 10, 2025 · b106eae · b106eae
1 parent 75761bb
commit b106eae
Show file tree

Hide file tree

Showing 69 changed files with 162 additions and 170 deletions.
diff --git a/.../pulls/307/_downloads/3aff9c480cac3a08db7a31fcd2798f4f/conceptual_intro_matched_light.pdf b/.../pulls/307/_downloads/3aff9c480cac3a08db7a31fcd2798f4f/conceptual_intro_matched_light.pdf
diff --git a/docs/pulls/307/_downloads/4bc027cfe8443a2720d072e12b44146d/conceptual_intro_primaries.pdf b/docs/pulls/307/_downloads/4bc027cfe8443a2720d072e12b44146d/conceptual_intro_primaries.pdf
diff --git a/docs/pulls/307/_downloads/febea97ed019274548f2a31fbc3c8e94/conceptual_intro_cones.pdf b/docs/pulls/307/_downloads/febea97ed019274548f2a31fbc3c8e94/conceptual_intro_cones.pdf
diff --git a/docs/pulls/307/_modules/index.html b/docs/pulls/307/_modules/index.html
@@ -5,7 +5,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Overview: module code &mdash; plenoptic 1.1.1.dev52 documentation</title>
+  <title>Overview: module code &mdash; plenoptic 1.1.1.dev53 documentation</title>
       <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=03e43079" />
       <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" />
       <link rel="stylesheet" type="text/css" href="../_static/plot_directive.css" />
@@ -15,7 +15,7 @@
 
       <script src="../_static/jquery.js?v=5d32c60e"></script>
       <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-      <script src="../_static/documentation_options.js?v=de6600cc"></script>
+      <script src="../_static/documentation_options.js?v=7a1e84d5"></script>
       <script src="../_static/doctools.js?v=9bcbadda"></script>
       <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
       <script src="../_static/clipboard.min.js?v=a7894cd8"></script>

diff --git a/docs/pulls/307/_modules/plenoptic/data.html b/docs/pulls/307/_modules/plenoptic/data.html
@@ -5,7 +5,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>plenoptic.data &mdash; plenoptic 1.1.1.dev52 documentation</title>
+  <title>plenoptic.data &mdash; plenoptic 1.1.1.dev53 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=03e43079" />
       <link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=e59714d7" />
       <link rel="stylesheet" type="text/css" href="../../_static/plot_directive.css" />
@@ -15,7 +15,7 @@
 
       <script src="../../_static/jquery.js?v=5d32c60e"></script>
       <script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-      <script src="../../_static/documentation_options.js?v=de6600cc"></script>
+      <script src="../../_static/documentation_options.js?v=7a1e84d5"></script>
       <script src="../../_static/doctools.js?v=9bcbadda"></script>
       <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
       <script src="../../_static/clipboard.min.js?v=a7894cd8"></script>

diff --git a/docs/pulls/307/_modules/plenoptic/data/fetch.html b/docs/pulls/307/_modules/plenoptic/data/fetch.html
@@ -5,7 +5,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>plenoptic.data.fetch &mdash; plenoptic 1.1.1.dev52 documentation</title>
+  <title>plenoptic.data.fetch &mdash; plenoptic 1.1.1.dev53 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=03e43079" />
       <link rel="stylesheet" type="text/css" href="../../../_static/css/theme.css?v=e59714d7" />
       <link rel="stylesheet" type="text/css" href="../../../_static/plot_directive.css" />
@@ -15,7 +15,7 @@
 
       <script src="../../../_static/jquery.js?v=5d32c60e"></script>
       <script src="../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-      <script src="../../../_static/documentation_options.js?v=de6600cc"></script>
+      <script src="../../../_static/documentation_options.js?v=7a1e84d5"></script>
       <script src="../../../_static/doctools.js?v=9bcbadda"></script>
       <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
       <script src="../../../_static/clipboard.min.js?v=a7894cd8"></script>

diff --git a/docs/pulls/307/_modules/plenoptic/metric/classes.html b/docs/pulls/307/_modules/plenoptic/metric/classes.html
@@ -5,7 +5,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>plenoptic.metric.classes &mdash; plenoptic 1.1.1.dev52 documentation</title>
+  <title>plenoptic.metric.classes &mdash; plenoptic 1.1.1.dev53 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=03e43079" />
       <link rel="stylesheet" type="text/css" href="../../../_static/css/theme.css?v=e59714d7" />
       <link rel="stylesheet" type="text/css" href="../../../_static/plot_directive.css" />
@@ -15,7 +15,7 @@
 
       <script src="../../../_static/jquery.js?v=5d32c60e"></script>
       <script src="../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-      <script src="../../../_static/documentation_options.js?v=de6600cc"></script>
+      <script src="../../../_static/documentation_options.js?v=7a1e84d5"></script>
       <script src="../../../_static/doctools.js?v=9bcbadda"></script>
       <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
       <script src="../../../_static/clipboard.min.js?v=a7894cd8"></script>

diff --git a/docs/pulls/307/_modules/plenoptic/metric/model_metric.html b/docs/pulls/307/_modules/plenoptic/metric/model_metric.html
@@ -5,7 +5,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>plenoptic.metric.model_metric &mdash; plenoptic 1.1.1.dev52 documentation</title>
+  <title>plenoptic.metric.model_metric &mdash; plenoptic 1.1.1.dev53 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=03e43079" />
       <link rel="stylesheet" type="text/css" href="../../../_static/css/theme.css?v=e59714d7" />
       <link rel="stylesheet" type="text/css" href="../../../_static/plot_directive.css" />
@@ -15,7 +15,7 @@
 
       <script src="../../../_static/jquery.js?v=5d32c60e"></script>
       <script src="../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-      <script src="../../../_static/documentation_options.js?v=de6600cc"></script>
+      <script src="../../../_static/documentation_options.js?v=7a1e84d5"></script>
       <script src="../../../_static/doctools.js?v=9bcbadda"></script>
       <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
       <script src="../../../_static/clipboard.min.js?v=a7894cd8"></script>

diff --git a/docs/pulls/307/_modules/plenoptic/metric/naive.html b/docs/pulls/307/_modules/plenoptic/metric/naive.html
@@ -5,7 +5,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>plenoptic.metric.naive &mdash; plenoptic 1.1.1.dev52 documentation</title>
+  <title>plenoptic.metric.naive &mdash; plenoptic 1.1.1.dev53 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=03e43079" />
       <link rel="stylesheet" type="text/css" href="../../../_static/css/theme.css?v=e59714d7" />
       <link rel="stylesheet" type="text/css" href="../../../_static/plot_directive.css" />
@@ -15,7 +15,7 @@
 
       <script src="../../../_static/jquery.js?v=5d32c60e"></script>
       <script src="../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-      <script src="../../../_static/documentation_options.js?v=de6600cc"></script>
+      <script src="../../../_static/documentation_options.js?v=7a1e84d5"></script>
       <script src="../../../_static/doctools.js?v=9bcbadda"></script>
       <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
       <script src="../../../_static/clipboard.min.js?v=a7894cd8"></script>

diff --git a/docs/pulls/307/_modules/plenoptic/metric/perceptual_distance.html b/docs/pulls/307/_modules/plenoptic/metric/perceptual_distance.html
@@ -5,7 +5,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>plenoptic.metric.perceptual_distance &mdash; plenoptic 1.1.1.dev52 documentation</title>
+  <title>plenoptic.metric.perceptual_distance &mdash; plenoptic 1.1.1.dev53 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=03e43079" />
       <link rel="stylesheet" type="text/css" href="../../../_static/css/theme.css?v=e59714d7" />
       <link rel="stylesheet" type="text/css" href="../../../_static/plot_directive.css" />
@@ -15,7 +15,7 @@
 
       <script src="../../../_static/jquery.js?v=5d32c60e"></script>
       <script src="../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-      <script src="../../../_static/documentation_options.js?v=de6600cc"></script>
+      <script src="../../../_static/documentation_options.js?v=7a1e84d5"></script>
       <script src="../../../_static/doctools.js?v=9bcbadda"></script>
       <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
       <script src="../../../_static/clipboard.min.js?v=a7894cd8"></script>
@@ -158,8 +158,7 @@ <h1>Source code for plenoptic.metric.perceptual_distance</h1><div class="highlig
 
     <span class="k">if</span> <span class="ow">not</span> <span class="n">img1</span><span class="o">.</span><span class="n">ndim</span> <span class="o">==</span> <span class="n">img2</span><span class="o">.</span><span class="n">ndim</span> <span class="o">==</span> <span class="mi">4</span><span class="p">:</span>
         <span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span>
-            <span class="s2">&quot;Input images should have four dimensions: (batch, channel,&quot;</span>
-            <span class="s2">&quot; height, width)&quot;</span>
+            <span class="s2">&quot;Input images should have four dimensions: (batch, channel, height, width)&quot;</span>
         <span class="p">)</span>
     <span class="k">if</span> <span class="n">img1</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="o">-</span><span class="mi">2</span><span class="p">:]</span> <span class="o">!=</span> <span class="n">img2</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="o">-</span><span class="mi">2</span><span class="p">:]:</span>
         <span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s2">&quot;img1 and img2 must have the same height and width!&quot;</span><span class="p">)</span>
@@ -580,8 +579,7 @@ <h1>Source code for plenoptic.metric.perceptual_distance</h1><div class="highlig
 
     <span class="k">if</span> <span class="ow">not</span> <span class="n">img1</span><span class="o">.</span><span class="n">ndim</span> <span class="o">==</span> <span class="n">img2</span><span class="o">.</span><span class="n">ndim</span> <span class="o">==</span> <span class="mi">4</span><span class="p">:</span>
         <span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span>
-            <span class="s2">&quot;Input images should have four dimensions: (batch, channel,&quot;</span>
-            <span class="s2">&quot; height, width)&quot;</span>
+            <span class="s2">&quot;Input images should have four dimensions: (batch, channel, height, width)&quot;</span>
         <span class="p">)</span>
     <span class="k">if</span> <span class="n">img1</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="o">-</span><span class="mi">2</span><span class="p">:]</span> <span class="o">!=</span> <span class="n">img2</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="o">-</span><span class="mi">2</span><span class="p">:]:</span>
         <span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s2">&quot;img1 and img2 must have the same height and width!&quot;</span><span class="p">)</span>

diff --git a/docs/pulls/307/_modules/plenoptic/simulate/canonical_computations/filters.html b/docs/pulls/307/_modules/plenoptic/simulate/canonical_computations/filters.html
@@ -5,7 +5,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>plenoptic.simulate.canonical_computations.filters &mdash; plenoptic 1.1.1.dev52 documentation</title>
+  <title>plenoptic.simulate.canonical_computations.filters &mdash; plenoptic 1.1.1.dev53 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../../../_static/pygments.css?v=03e43079" />
       <link rel="stylesheet" type="text/css" href="../../../../_static/css/theme.css?v=e59714d7" />
       <link rel="stylesheet" type="text/css" href="../../../../_static/plot_directive.css" />
@@ -15,7 +15,7 @@
 
       <script src="../../../../_static/jquery.js?v=5d32c60e"></script>
       <script src="../../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-      <script src="../../../../_static/documentation_options.js?v=de6600cc"></script>
+      <script src="../../../../_static/documentation_options.js?v=7a1e84d5"></script>
       <script src="../../../../_static/doctools.js?v=9bcbadda"></script>
       <script src="../../../../_static/sphinx_highlight.js?v=dc90522c"></script>
       <script src="../../../../_static/clipboard.min.js?v=a7894cd8"></script>

diff --git a/docs/pulls/307/_modules/plenoptic/simulate/canonical_computations/laplacian_pyramid.html b/docs/pulls/307/_modules/plenoptic/simulate/canonical_computations/laplacian_pyramid.html
@@ -5,7 +5,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>plenoptic.simulate.canonical_computations.laplacian_pyramid &mdash; plenoptic 1.1.1.dev52 documentation</title>
+  <title>plenoptic.simulate.canonical_computations.laplacian_pyramid &mdash; plenoptic 1.1.1.dev53 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../../../_static/pygments.css?v=03e43079" />
       <link rel="stylesheet" type="text/css" href="../../../../_static/css/theme.css?v=e59714d7" />
       <link rel="stylesheet" type="text/css" href="../../../../_static/plot_directive.css" />
@@ -15,7 +15,7 @@
 
       <script src="../../../../_static/jquery.js?v=5d32c60e"></script>
       <script src="../../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-      <script src="../../../../_static/documentation_options.js?v=de6600cc"></script>
+      <script src="../../../../_static/documentation_options.js?v=7a1e84d5"></script>
       <script src="../../../../_static/doctools.js?v=9bcbadda"></script>
       <script src="../../../../_static/sphinx_highlight.js?v=dc90522c"></script>
       <script src="../../../../_static/clipboard.min.js?v=a7894cd8"></script>

diff --git a/docs/pulls/307/_modules/plenoptic/simulate/canonical_computations/non_linearities.html b/docs/pulls/307/_modules/plenoptic/simulate/canonical_computations/non_linearities.html
@@ -5,7 +5,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>plenoptic.simulate.canonical_computations.non_linearities &mdash; plenoptic 1.1.1.dev52 documentation</title>
+  <title>plenoptic.simulate.canonical_computations.non_linearities &mdash; plenoptic 1.1.1.dev53 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../../../_static/pygments.css?v=03e43079" />
       <link rel="stylesheet" type="text/css" href="../../../../_static/css/theme.css?v=e59714d7" />
       <link rel="stylesheet" type="text/css" href="../../../../_static/plot_directive.css" />
@@ -15,7 +15,7 @@
 
       <script src="../../../../_static/jquery.js?v=5d32c60e"></script>
       <script src="../../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-      <script src="../../../../_static/documentation_options.js?v=de6600cc"></script>
+      <script src="../../../../_static/documentation_options.js?v=7a1e84d5"></script>
       <script src="../../../../_static/doctools.js?v=9bcbadda"></script>
       <script src="../../../../_static/sphinx_highlight.js?v=dc90522c"></script>
       <script src="../../../../_static/clipboard.min.js?v=a7894cd8"></script>