Deploy 8641093

v0.0.x/api/sdr.LeakyIntegrator.__init__/index.html

@@ -2103,7 +2103,7 @@
 
           <li class="md-nav__item">
   <a href="#p-alpha" class="md-nav__link">
-    <span aria-label="Python parameter" class="objinfo-icon objinfo-icon__sub-data" title="Python parameter">p</span><span title="sdr.LeakyIntegrator.__init__.alpha (Python parameter) — The leaky factor $alpha$. The leaky factor indicates how much of the previous output to preserve. When $alpha = 1$, the filter is an integrator. When $alpha = 0$, the filter is a pass-through." class="md-ellipsis">alpha</span>
+    <span aria-label="Python parameter" class="objinfo-icon objinfo-icon__sub-data" title="Python parameter">p</span><span title="sdr.LeakyIntegrator.__init__.alpha (Python parameter) — The leaky factor $alpha$. An FIR moving average with length $L$ is approximated when $alpha = 1 - 2/L$." class="md-ellipsis">alpha</span>
   </a>
 
 </li>
@@ -9743,7 +9743,7 @@
 
           <li class="md-nav__item">
   <a href="#p-alpha" class="md-nav__link">
-    <span aria-label="Python parameter" class="objinfo-icon objinfo-icon__sub-data" title="Python parameter">p</span><span title="sdr.LeakyIntegrator.__init__.alpha (Python parameter) — The leaky factor $alpha$. The leaky factor indicates how much of the previous output to preserve. When $alpha = 1$, the filter is an integrator. When $alpha = 0$, the filter is a pass-through." class="md-ellipsis">alpha</span>
+    <span aria-label="Python parameter" class="objinfo-icon objinfo-icon__sub-data" title="Python parameter">p</span><span title="sdr.LeakyIntegrator.__init__.alpha (Python parameter) — The leaky factor $alpha$. An FIR moving average with length $L$ is approximated when $alpha = 1 - 2/L$." class="md-ellipsis">alpha</span>
   </a>
 
 </li>
@@ -9783,13 +9783,13 @@
 
 <dl class="py method objdesc">
 <dt class="sig sig-object highlight py">
-<span class="sig-prename descclassname"><span class="pre">sdr.</span></span><span class="sig-name descname"><span class="pre">LeakyIntegrator</span></span><span class="sig-paren">(</span><span class="sig-param-decl"><em class="sig-param"><a class="n reference internal" href="#p-alpha" title="sdr.LeakyIntegrator.__init__.alpha (Python parameter) — The leaky factor $alpha$. The leaky factor indicates how much of the previous output to preserve. When $alpha = 1$, the filter is an integrator. When $alpha = 0$, the filter is a pass-through."><span class="n"><span class="pre">alpha</span></span></a><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="desctype"><a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.12)"><span class="pre">float</span></a></span></span></em>, </span><span class="sig-param-decl"><em class="sig-param"><a class="n reference internal" href="#p-streaming" title="sdr.LeakyIntegrator.__init__.streaming (Python parameter) — Indicates whether to use streaming mode. In streaming mode, previous inputs and outputs are preserved between calls to __call__()."><span class="n"><span class="pre">streaming</span></span></a><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="desctype"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><span class="pre">bool</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">False</span></code></em></span><span class="sig-paren">)</span></dt>
+<span class="sig-prename descclassname"><span class="pre">sdr.</span></span><span class="sig-name descname"><span class="pre">LeakyIntegrator</span></span><span class="sig-paren">(</span><span class="sig-param-decl"><em class="sig-param"><a class="n reference internal" href="#p-alpha" title="sdr.LeakyIntegrator.__init__.alpha (Python parameter) — The leaky factor $alpha$. An FIR moving average with length $L$ is approximated when $alpha = 1 - 2/L$."><span class="n"><span class="pre">alpha</span></span></a><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="desctype"><a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.12)"><span class="pre">float</span></a></span></span></em>, </span><span class="sig-param-decl"><em class="sig-param"><a class="n reference internal" href="#p-streaming" title="sdr.LeakyIntegrator.__init__.streaming (Python parameter) — Indicates whether to use streaming mode. In streaming mode, previous inputs and outputs are preserved between calls to __call__()."><span class="n"><span class="pre">streaming</span></span></a><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="desctype"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><span class="pre">bool</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">False</span></code></em></span><span class="sig-paren">)</span></dt>
 <dd><p>Creates a leaky integrator IIR filter.</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-alpha"><span class="n sig-name">alpha</span><span class="p">:</span><span class="w">   </span><span class="n"><span class="desctype"><a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.12)">float</a></span></span><a class="headerlink" href="#p-alpha" title="Permalink to this definition">¶</a></dt><dd><p>The leaky factor <span class="math notranslate nohighlight">\(\alpha\)</span>. The leaky factor indicates how much of the previous output to preserve.
-When <span class="math notranslate nohighlight">\(\alpha = 1\)</span>, the filter is an integrator. When <span class="math notranslate nohighlight">\(\alpha = 0\)</span>, the filter is a pass-through.</p>
+<dt id="p-alpha"><span class="n sig-name">alpha</span><span class="p">:</span><span class="w">   </span><span class="n"><span class="desctype"><a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.12)">float</a></span></span><a class="headerlink" href="#p-alpha" title="Permalink to this definition">¶</a></dt><dd><p>The leaky factor <span class="math notranslate nohighlight">\(\alpha\)</span>. An FIR moving average with length <span class="math notranslate nohighlight">\(L\)</span> is approximated when
+<span class="math notranslate nohighlight">\(\alpha = 1 - 2/L\)</span>.</p>
 </dd>
 <dt id="p-streaming"><span class="n sig-name">streaming</span><span class="p">:</span><span class="w">   </span><span class="n"><span class="desctype"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)">bool</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">False</span></code><a class="headerlink" href="#p-streaming" title="Permalink to this definition">¶</a></dt><dd><p>Indicates whether to use streaming mode. In streaming mode, previous inputs and outputs are
 preserved between calls to <code class="xref py py-meth docutils literal notranslate"><span class="pre">__call__()</span></code>.</p>