Deploy 8d60d02

mhostetter · Jul 8, 2023 · d11621c · d11621c
1 parent 8e7652d
commit d11621c
Show file tree

Hide file tree

Showing 6 changed files with 88 additions and 3 deletions.
diff --git a/v0.0.x/.doctrees/api/sdr.FarrowResampler.reset.doctree b/v0.0.x/.doctrees/api/sdr.FarrowResampler.reset.doctree
diff --git a/v0.0.x/.doctrees/environment.pickle b/v0.0.x/.doctrees/environment.pickle
diff --git a/v0.0.x/api/sdr.FarrowResampler.reset/index.html b/v0.0.x/api/sdr.FarrowResampler.reset/index.html
@@ -76,6 +76,11 @@
     <label class="md-overlay" for="__drawer"></label>
     <div data-md-component="skip">
 
+
+        <a href="#parameters" class="md-skip">
+          Skip to content
+        </a>
+
     </div>
     <div data-md-component="announce">
 
@@ -615,10 +620,53 @@
 
       <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
 
+        <label class="md-nav__link md-nav__link--active" for="__toc">
+          <span aria-label="Python method" class="objinfo-icon objinfo-icon__procedure" title="Python method">M</span><span title="sdr.FarrowResampler.reset (Python method) — Resets the filter state and fractional sample index. Only useful for streaming mode." class="md-ellipsis">reset</span>
+          <span class="md-nav__icon md-icon"></span>
+        </label>
+
       <a href="#" class="md-nav__link md-nav__link--active">
         <span aria-label="Python method" class="objinfo-icon objinfo-icon__procedure" title="Python method">M</span><span title="sdr.FarrowResampler.reset (Python method) — Resets the filter state and fractional sample index. Only useful for streaming mode." class="md-ellipsis">reset</span>
       </a>
 
+
+
+<nav class="md-nav md-nav--secondary">
+
+
+
+
+
+    <label class="md-nav__title" for="__toc">
+      <span class="md-nav__icon md-icon"></span>
+      Table of contents
+    </label>
+    <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
+
+        <li class="md-nav__item">
+  <a href="#parameters" class="md-nav__link">
+    <span class="md-ellipsis">Parameters</span>
+  </a>
+
+    <nav class="md-nav" aria-label="Parameters">
+      <ul class="md-nav__list">
+
+          <li class="md-nav__item">
+  <a href="#p-state" class="md-nav__link">
+    <span aria-label="Python parameter" class="objinfo-icon objinfo-icon__sub-data" title="Python parameter">p</span><span title="sdr.FarrowResampler.reset.state (Python parameter) — The filter state to reset to. The state vector should equal the previous three inputs. If None, the filter state will be reset to zero." class="md-ellipsis">state</span>
+  </a>
+
+</li>
+
+      </ul>
+    </nav>
+
+</li>
+
+    </ul>
+
+</nav>
+
     </li>
 
 
@@ -861,6 +909,34 @@
 
 
 
+    <label class="md-nav__title" for="__toc">
+      <span class="md-nav__icon md-icon"></span>
+      Table of contents
+    </label>
+    <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
+
+        <li class="md-nav__item">
+  <a href="#parameters" class="md-nav__link">
+    <span class="md-ellipsis">Parameters</span>
+  </a>
+
+    <nav class="md-nav" aria-label="Parameters">
+      <ul class="md-nav__list">
+
+          <li class="md-nav__item">
+  <a href="#p-state" class="md-nav__link">
+    <span aria-label="Python parameter" class="objinfo-icon objinfo-icon__sub-data" title="Python parameter">p</span><span title="sdr.FarrowResampler.reset.state (Python parameter) — The filter state to reset to. The state vector should equal the previous three inputs. If None, the filter state will be reset to zero." class="md-ellipsis">state</span>
+  </a>
+
+</li>
+
+      </ul>
+    </nav>
+
+</li>
+
+    </ul>
+
 </nav>
                   </div>
                 </div>
@@ -875,8 +951,17 @@
 
 <dl class="py method objdesc">
 <dt class="sig sig-object highlight py">
-<span class="sig-prename descclassname"><span class="pre">sdr.</span><span class="pre">FarrowResampler.</span></span><span class="sig-name descname"><span class="pre">reset</span></span><span class="sig-paren">(</span><span class="sig-param-decl"><em class="sig-param"><span class="n"><span class="pre">state</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="desctype"><span class="pre">np.ndarray</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.11)"><span class="pre">None</span></a></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><code class="code python default_value docutils literal highlight highlight-python"><span class="kc">None</span></code></em></span><span class="sig-paren">)</span></dt>
+<span class="sig-prename descclassname"><span class="pre">sdr.</span><span class="pre">FarrowResampler.</span></span><span class="sig-name descname"><span class="pre">reset</span></span><span class="sig-paren">(</span><span class="sig-param-decl"><em class="sig-param"><a class="n reference internal" href="#p-state" title="sdr.FarrowResampler.reset.state (Python parameter) — The filter state to reset to. The state vector should equal the previous three inputs. If None, the filter state will be reset to zero."><span class="n"><span class="pre">state</span></span></a><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="desctype"><span class="pre">np.ndarray</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.11)"><span class="pre">None</span></a></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><code class="code python default_value docutils literal highlight highlight-python"><span class="kc">None</span></code></em></span><span class="sig-paren">)</span></dt>
 <dd><p>Resets the filter state and fractional sample index. Only useful for streaming mode.</p>
+<dl class="field-list simple">
+<dt class="field-odd" id="parameters">Parameters<span class="colon">:</span><a class="headerlink" href="#parameters" title="Permalink to this headline">¶</a></dt>
+<dd class="field-odd"><dl class="simple api-field highlight">
+<dt id="p-state"><span class="n sig-name">state</span><span class="p">:</span><span class="w">   </span><span class="n"><span class="desctype">np.ndarray<span class="w">   </span><span class="p">|</span><span class="w">   </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.11)">None</a></span></span><span class="w">   </span><span class="o">=</span><span class="w">   </span><code class="code python default_value docutils literal highlight highlight-python"><span class="kc">None</span></code><a class="headerlink" href="#p-state" title="Permalink to this definition">¶</a></dt><dd><p>The filter state to reset to. The state vector should equal the previous three
+inputs. If <code class="code highlight python docutils literal highlight-python"><span class="kc">None</span></code>, the filter state will be reset to zero.</p>
+</dd>
+</dl>
+</dd>
+</dl>
 </dd></dl>
 
 

diff --git a/v0.0.x/api/sdr.FarrowResampler/index.html b/v0.0.x/api/sdr.FarrowResampler/index.html
@@ -1070,7 +1070,7 @@ <h2 id="methods">Methods<a class="headerlink" href="#methods" title="Permalink t
 
 <dl class="py method summary objdesc">
 <dt class="sig sig-object highlight py">
-<a class="sig-name descname pseudo-toc-entry reference internal" href="../sdr.FarrowResampler.reset/" title="sdr.FarrowResampler.reset (Python method) — Resets the filter state and fractional sample index. Only useful for streaming mode."><span class="sig-name descname pseudo-toc-entry"><span class="pre">reset</span></span></a><span class="sig-paren">(</span><span class="sig-param-decl"><em class="sig-param"><span class="n"><span class="pre">state</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="desctype"><span class="pre">np.ndarray</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.11)"><span class="pre">None</span></a></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><code class="code python default_value docutils literal highlight highlight-python"><span class="kc">None</span></code></em></span><span class="sig-paren">)</span></dt>
+<a class="sig-name descname pseudo-toc-entry reference internal" href="../sdr.FarrowResampler.reset/" title="sdr.FarrowResampler.reset (Python method) — Resets the filter state and fractional sample index. Only useful for streaming mode."><span class="sig-name descname pseudo-toc-entry"><span class="pre">reset</span></span></a><span class="sig-paren">(</span><span class="sig-param-decl"><em class="sig-param"><a class="n reference internal" href="../sdr.FarrowResampler.reset/#p-state" title="sdr.FarrowResampler.reset.state (Python parameter) — The filter state to reset to. The state vector should equal the previous three inputs. If None, the filter state will be reset to zero."><span class="n"><span class="pre">state</span></span></a><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="desctype"><span class="pre">np.ndarray</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.11)"><span class="pre">None</span></a></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><code class="code python default_value docutils literal highlight highlight-python"><span class="kc">None</span></code></em></span><span class="sig-paren">)</span></dt>
 <dd><p>Resets the filter state and fractional sample index. Only useful for streaming mode.</p>
 </dd></dl>
 

diff --git a/v0.0.x/objects.inv b/v0.0.x/objects.inv