Skip to content

Commit

Permalink
Deploying to gh-pages from @ f30183c 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
DaniBodor committed Mar 11, 2024
1 parent 10d68f8 commit a4ab8cd
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 8 deletions.
8 changes: 4 additions & 4 deletions _modules/eitprocessing/filters/butterworth_filters.html
Original file line number Diff line number Diff line change
Expand Up @@ -112,8 +112,8 @@ <h1>Source code for eitprocessing.filters.butterworth_filters</h1><div class="hi

<div class="viewcode-block" id="ButterworthFilter.__post_init__">
<a class="viewcode-back" href="../../../autoapi/eitprocessing/filters/butterworth_filters/index.html#eitprocessing.filters.butterworth_filters.ButterworthFilter.__post_init__">[docs]</a>
<span class="k">def</span> <span class="nf">__post_init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_check_init</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">ignore_max_order</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">__post_init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">ignore_max_order</span><span class="p">:</span> <span class="nb">bool</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_check_init</span><span class="p">(</span><span class="n">ignore_max_order</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_set_filter_type_class</span><span class="p">()</span></div>


Expand All @@ -136,7 +136,7 @@ <h1>Source code for eitprocessing.filters.butterworth_filters</h1><div class="hi

<div class="viewcode-block" id="ButterworthFilter._check_init">
<a class="viewcode-back" href="../../../autoapi/eitprocessing/filters/butterworth_filters/index.html#eitprocessing.filters.butterworth_filters.ButterworthFilter._check_init">[docs]</a>
<span class="k">def</span> <span class="nf">_check_init</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span> <span class="c1"># noqa: C901</span>
<span class="k">def</span> <span class="nf">_check_init</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">ignore_max_order</span><span class="p">:</span> <span class="nb">bool</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span> <span class="c1"># noqa:C901</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Check the arguments of __init__ and raise exceptions when they don&#39;t meet requirements.</span>

<span class="sd"> Raises:</span>
Expand Down Expand Up @@ -179,7 +179,7 @@ <h1>Source code for eitprocessing.filters.butterworth_filters</h1><div class="hi
<span class="n">msg</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;Invalid `order`. Must be an int, not </span><span class="si">{</span><span class="nb">type</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">order</span><span class="p">)</span><span class="si">}</span><span class="s2">.&quot;</span>
<span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>

<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">order</span> <span class="o">&lt;</span> <span class="mi">1</span> <span class="ow">or</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">order</span> <span class="o">&gt;</span> <span class="n">MAX_ORDER</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">ignore_max_order</span> <span class="ow">is</span> <span class="kc">False</span><span class="p">):</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">order</span> <span class="o">&lt;</span> <span class="mi">1</span> <span class="ow">or</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">order</span> <span class="o">&gt;</span> <span class="n">MAX_ORDER</span> <span class="ow">and</span> <span class="n">ignore_max_order</span> <span class="ow">is</span> <span class="kc">False</span><span class="p">):</span>
<span class="n">msg</span> <span class="o">=</span> <span class="p">(</span>
<span class="sa">f</span><span class="s2">&quot;Invalid `order` (</span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">order</span><span class="si">}</span><span class="s2">). Must be between 1 and </span><span class="si">{</span><span class="n">MAX_ORDER</span><span class="si">}</span><span class="s2">. &quot;</span>
<span class="s2">&quot;To use higher values, set `ignore_max_order` to `True`.&quot;</span>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -99,13 +99,13 @@ Attributes



.. py:method:: __post_init__()
.. py:method:: __post_init__(ignore_max_order: bool)
.. py:method:: _set_filter_type_class() -> None
.. py:method:: _check_init() -> None
.. py:method:: _check_init(ignore_max_order: bool) -> None
Check the arguments of __init__ and raise exceptions when they don't meet requirements.

Expand Down
4 changes: 2 additions & 2 deletions autoapi/eitprocessing/filters/butterworth_filters/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,7 @@ <h3>Attributes<a class="headerlink" href="#attributes" title="Link to this headi

<dl class="py method">
<dt class="sig sig-object py" id="eitprocessing.filters.butterworth_filters.ButterworthFilter.__post_init__">
<span class="sig-name descname"><span class="pre">__post_init__</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../../../_modules/eitprocessing/filters/butterworth_filters.html#ButterworthFilter.__post_init__"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#eitprocessing.filters.butterworth_filters.ButterworthFilter.__post_init__" title="Link to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">__post_init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ignore_max_order</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><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></em><span class="sig-paren">)</span><a class="reference internal" href="../../../../_modules/eitprocessing/filters/butterworth_filters.html#ButterworthFilter.__post_init__"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#eitprocessing.filters.butterworth_filters.ButterworthFilter.__post_init__" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py method">
Expand All @@ -167,7 +167,7 @@ <h3>Attributes<a class="headerlink" href="#attributes" title="Link to this headi

<dl class="py method">
<dt class="sig sig-object py" id="eitprocessing.filters.butterworth_filters.ButterworthFilter._check_init">
<span class="sig-name descname"><span class="pre">_check_init</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span></span><a class="reference internal" href="../../../../_modules/eitprocessing/filters/butterworth_filters.html#ButterworthFilter._check_init"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#eitprocessing.filters.butterworth_filters.ButterworthFilter._check_init" title="Link to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">_check_init</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ignore_max_order</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><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></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 external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span></span><a class="reference internal" href="../../../../_modules/eitprocessing/filters/butterworth_filters.html#ButterworthFilter._check_init"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#eitprocessing.filters.butterworth_filters.ButterworthFilter._check_init" title="Link to this definition"></a></dt>
<dd><p>Check the arguments of __init__ and raise exceptions when they don’t meet requirements.</p>
<dl class="field-list simple">
<dt class="field-odd">Raises<span class="colon">:</span></dt>
Expand Down

0 comments on commit a4ab8cd

Please sign in to comment.