Deploying to gh-pages from @ b16cf9e 🚀

_modules/eitprocessing/datahandling/continuousdata.html

@@ -65,9 +65,9 @@ <h1>Source code for eitprocessing.datahandling.continuousdata</h1><div class="hi
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;Container for data with a continuous time axis.</span>
 
 <span class="sd">    Continuous data is assumed to be sequential (i.e. a single data point at each time point, sorted by time) and</span>
-<span class="sd">    continuously measured/created at a fixed sampling rate. However, a fixed interval between consecutive time points is</span>
-<span class="sd">    not enforced to account for floating point arithmetic, devices with imperfect sampling rates, and other sources of</span>
-<span class="sd">    variation.</span>
+<span class="sd">    continuously measured/created at a fixed sampling frequency. However, a fixed interval between consecutive time</span>
+<span class="sd">    points is not enforced to account for floating point arithmetic, devices with imperfect sampling frequencies, and</span>
+<span class="sd">    other sources of variation.</span>
 
 <span class="sd">    Args:</span>
 <span class="sd">        label: Computer readable naming of the instance.</span>

_modules/eitprocessing/datahandling/eitdata.html

@@ -73,7 +73,7 @@ <h1>Source code for eitprocessing.datahandling.eitdata</h1><div class="highlight
 <span class="sd">        path: The path of list of paths of the source from which data was derived.</span>
 <span class="sd">        nframes: Number of frames.</span>
 <span class="sd">        time: The time of each frame (since start measurement).</span>
-<span class="sd">        framerate: The (average) rate at which the frames are collection, in Hz.</span>
+<span class="sd">        sample_frequency: The (average) frequency at which the frames are collection, in Hz.</span>
 <span class="sd">        vendor: The vendor of the device the data was collected with.</span>
 <span class="sd">        label: Computer readable label identifying this dataset.</span>
 <span class="sd">        name: Human readable name for the data.</span>
@@ -92,9 +92,9 @@ <h1>Source code for eitprocessing.datahandling.eitdata</h1><div class="highlight
 <a class="viewcode-back" href="../../../autoapi/eitprocessing/datahandling/eitdata/index.html#eitprocessing.datahandling.eitdata.EITData.time">[docs]</a>
     <span class="n">time</span><span class="p">:</span> <span class="n">np</span><span class="o">.</span><span class="n">ndarray</span> <span class="o">=</span> <span class="n">field</span><span class="p">(</span><span class="nb">repr</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span></div>
 
-<div class="viewcode-block" id="EITData.framerate">
-<a class="viewcode-back" href="../../../autoapi/eitprocessing/datahandling/eitdata/index.html#eitprocessing.datahandling.eitdata.EITData.framerate">[docs]</a>
-    <span class="n">framerate</span><span class="p">:</span> <span class="nb">float</span> <span class="o">=</span> <span class="n">field</span><span class="p">(</span><span class="n">metadata</span><span class="o">=</span><span class="p">{</span><span class="s2">&quot;check_equivalence&quot;</span><span class="p">:</span> <span class="kc">True</span><span class="p">},</span> <span class="nb">repr</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span></div>
+<div class="viewcode-block" id="EITData.sample_frequency">
+<a class="viewcode-back" href="../../../autoapi/eitprocessing/datahandling/eitdata/index.html#eitprocessing.datahandling.eitdata.EITData.sample_frequency">[docs]</a>
+    <span class="n">sample_frequency</span><span class="p">:</span> <span class="nb">float</span> <span class="o">=</span> <span class="n">field</span><span class="p">(</span><span class="n">metadata</span><span class="o">=</span><span class="p">{</span><span class="s2">&quot;check_equivalence&quot;</span><span class="p">:</span> <span class="kc">True</span><span class="p">},</span> <span class="nb">repr</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span></div>
 
 <div class="viewcode-block" id="EITData.vendor">
 <a class="viewcode-back" href="../../../autoapi/eitprocessing/datahandling/eitdata/index.html#eitprocessing.datahandling.eitdata.EITData.vendor">[docs]</a>
@@ -165,7 +165,7 @@ <h1>Source code for eitprocessing.datahandling.eitdata</h1><div class="highlight
             <span class="n">vendor</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">vendor</span><span class="p">,</span>
             <span class="n">path</span><span class="o">=</span><span class="p">[</span><span class="o">*</span><span class="n">self_path</span><span class="p">,</span> <span class="o">*</span><span class="n">other_path</span><span class="p">],</span>
             <span class="n">label</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">label</span><span class="p">,</span>  <span class="c1"># TODO: using newlabel leads to errors</span>
-            <span class="n">framerate</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">framerate</span><span class="p">,</span>
+            <span class="n">sample_frequency</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">sample_frequency</span><span class="p">,</span>
             <span class="n">nframes</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">nframes</span> <span class="o">+</span> <span class="n">other</span><span class="o">.</span><span class="n">nframes</span><span class="p">,</span>
             <span class="n">time</span><span class="o">=</span><span class="n">np</span><span class="o">.</span><span class="n">concatenate</span><span class="p">((</span><span class="bp">self</span><span class="o">.</span><span class="n">time</span><span class="p">,</span> <span class="n">other</span><span class="o">.</span><span class="n">time</span><span class="p">)),</span>
             <span class="n">pixel_impedance</span><span class="o">=</span><span class="n">np</span><span class="o">.</span><span class="n">concatenate</span><span class="p">((</span><span class="bp">self</span><span class="o">.</span><span class="n">pixel_impedance</span><span class="p">,</span> <span class="n">other</span><span class="o">.</span><span class="n">pixel_impedance</span><span class="p">),</span> <span class="n">axis</span><span class="o">=</span><span class="mi">0</span><span class="p">),</span>
@@ -191,7 +191,7 @@ <h1>Source code for eitprocessing.datahandling.eitdata</h1><div class="highlight
             <span class="n">nframes</span><span class="o">=</span><span class="n">nframes</span><span class="p">,</span>
             <span class="n">vendor</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">vendor</span><span class="p">,</span>
             <span class="n">time</span><span class="o">=</span><span class="n">time</span><span class="p">,</span>
-            <span class="n">framerate</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">framerate</span><span class="p">,</span>
+            <span class="n">sample_frequency</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">sample_frequency</span><span class="p">,</span>
             <span class="n">label</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">label</span><span class="p">,</span>  <span class="c1"># newlabel gives errors</span>
             <span class="n">pixel_impedance</span><span class="o">=</span><span class="n">pixel_impedance</span><span class="p">,</span>
         <span class="p">)</span></div>

_modules/eitprocessing/datahandling/loading.html

@@ -53,7 +53,7 @@ <h1>Source code for eitprocessing.datahandling.loading</h1><div class="highlight
     <span class="n">label</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
     <span class="n">name</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
     <span class="n">description</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;&quot;</span><span class="p">,</span>
-    <span class="n">framerate</span><span class="p">:</span> <span class="nb">float</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
+    <span class="n">sample_frequency</span><span class="p">:</span> <span class="nb">float</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
     <span class="n">first_frame</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span>
     <span class="n">max_frames</span><span class="p">:</span> <span class="nb">int</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
 <span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Sequence</span><span class="p">:</span>
@@ -69,7 +69,7 @@ <h1>Source code for eitprocessing.datahandling.loading</h1><div class="highlight
 <span class="sd">        name: short description of sequence for human interpretation.</span>
 <span class="sd">            Defaults to the same value as label.</span>
 <span class="sd">        description: long description of sequence for human interpretation.</span>
-<span class="sd">        framerate: framerate at which the data was recorded.</span>
+<span class="sd">        sample_frequency: sample frequency at which the data was recorded.</span>
 <span class="sd">            Default for Draeger: 20</span>
 <span class="sd">            Default for Timpel: 50</span>
 <span class="sd">            Default for Sentec: 50.2</span>
@@ -116,7 +116,7 @@ <h1>Source code for eitprocessing.datahandling.loading</h1><div class="highlight
     <span class="k">for</span> <span class="n">single_path</span> <span class="ow">in</span> <span class="n">paths</span><span class="p">:</span>
         <span class="n">loaded_data</span> <span class="o">=</span> <span class="n">load_from_single_path</span><span class="p">(</span>
             <span class="n">path</span><span class="o">=</span><span class="n">single_path</span><span class="p">,</span>
-            <span class="n">framerate</span><span class="o">=</span><span class="n">framerate</span><span class="p">,</span>
+            <span class="n">sample_frequency</span><span class="o">=</span><span class="n">sample_frequency</span><span class="p">,</span>
             <span class="n">first_frame</span><span class="o">=</span><span class="n">first_frame</span><span class="p">,</span>
             <span class="n">max_frames</span><span class="o">=</span><span class="n">max_frames</span><span class="p">,</span>
         <span class="p">)</span>

_modules/eitprocessing/datahandling/loading/draeger.html

@@ -66,9 +66,9 @@ <h1>Source code for eitprocessing.datahandling.loading.draeger</h1><div class="h
 <a class="viewcode-back" href="../../../../autoapi/eitprocessing/datahandling/loading/draeger/index.html#eitprocessing.datahandling.loading.draeger._FRAME_SIZE_BYTES">[docs]</a>
 <span class="n">_FRAME_SIZE_BYTES</span> <span class="o">=</span> <span class="mi">4358</span></div>
 
-<div class="viewcode-block" id="DRAEGER_FRAMERATE">
-<a class="viewcode-back" href="../../../../autoapi/eitprocessing/datahandling/loading/draeger/index.html#eitprocessing.datahandling.loading.draeger.DRAEGER_FRAMERATE">[docs]</a>
-<span class="n">DRAEGER_FRAMERATE</span> <span class="o">=</span> <span class="mi">20</span></div>
+<div class="viewcode-block" id="DRAEGER_SAMPLE_FREQUENCY">
+<a class="viewcode-back" href="../../../../autoapi/eitprocessing/datahandling/loading/draeger/index.html#eitprocessing.datahandling.loading.draeger.DRAEGER_SAMPLE_FREQUENCY">[docs]</a>
+<span class="n">DRAEGER_SAMPLE_FREQUENCY</span> <span class="o">=</span> <span class="mi">20</span></div>
 
 <div class="viewcode-block" id="load_draeger_data">
 <a class="viewcode-back" href="../../../../autoapi/eitprocessing/datahandling/loading/draeger/index.html#eitprocessing.datahandling.loading.draeger.load_draeger_data">[docs]</a>
@@ -80,7 +80,7 @@ <h1>Source code for eitprocessing.datahandling.loading.draeger</h1><div class="h
 <a class="viewcode-back" href="../../../../autoapi/eitprocessing/datahandling/loading/draeger/index.html#eitprocessing.datahandling.loading.draeger.load_from_single_path">[docs]</a>
 <span class="k">def</span> <span class="nf">load_from_single_path</span><span class="p">(</span>
     <span class="n">path</span><span class="p">:</span> <span class="n">Path</span><span class="p">,</span>
-    <span class="n">framerate</span><span class="p">:</span> <span class="nb">float</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="mi">20</span><span class="p">,</span>
+    <span class="n">sample_frequency</span><span class="p">:</span> <span class="nb">float</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="mi">20</span><span class="p">,</span>
     <span class="n">first_frame</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span>
     <span class="n">max_frames</span><span class="p">:</span> <span class="nb">int</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
 <span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">DataCollection</span><span class="p">]:</span>
@@ -138,13 +138,13 @@ <h1>Source code for eitprocessing.datahandling.loading.draeger</h1><div class="h
                 <span class="n">previous_marker</span><span class="p">,</span>
             <span class="p">)</span>
 
-    <span class="k">if</span> <span class="ow">not</span> <span class="n">framerate</span><span class="p">:</span>
-        <span class="n">framerate</span> <span class="o">=</span> <span class="n">DRAEGER_FRAMERATE</span>
+    <span class="k">if</span> <span class="ow">not</span> <span class="n">sample_frequency</span><span class="p">:</span>
+        <span class="n">sample_frequency</span> <span class="o">=</span> <span class="n">DRAEGER_SAMPLE_FREQUENCY</span>
 
     <span class="n">eit_data</span> <span class="o">=</span> <span class="n">EITData</span><span class="p">(</span>
         <span class="n">vendor</span><span class="o">=</span><span class="n">Vendor</span><span class="o">.</span><span class="n">DRAEGER</span><span class="p">,</span>
         <span class="n">path</span><span class="o">=</span><span class="n">path</span><span class="p">,</span>
-        <span class="n">framerate</span><span class="o">=</span><span class="n">framerate</span><span class="p">,</span>
+        <span class="n">sample_frequency</span><span class="o">=</span><span class="n">sample_frequency</span><span class="p">,</span>
         <span class="n">nframes</span><span class="o">=</span><span class="n">n_frames</span><span class="p">,</span>
         <span class="n">time</span><span class="o">=</span><span class="n">time</span><span class="p">,</span>
         <span class="n">label</span><span class="o">=</span><span class="s2">&quot;raw&quot;</span><span class="p">,</span>