Deploying to gh-pages from @ 9d94e1a 🚀

_modules/eitprocessing.html

@@ -37,7 +37,7 @@ <h3>Navigation</h3>
   <h1>Source code for eitprocessing</h1><div class="highlight"><pre>
 <div class="viewcode-block" id="__version__">
 <a class="viewcode-back" href="../autoapi/eitprocessing/index.html#eitprocessing.__version__">[docs]</a>
-<span></span><span class="n">__version__</span> <span class="o">=</span> <span class="s2">&quot;1.2.1&quot;</span></div>
+<span></span><span class="n">__version__</span> <span class="o">=</span> <span class="s2">&quot;1.3.0&quot;</span></div>
 
 </pre></div>
 

_modules/eitprocessing/datahandling/continuousdata.html

@@ -39,6 +39,7 @@ <h3>Navigation</h3>
   <h1>Source code for eitprocessing.datahandling.continuousdata</h1><div class="highlight"><pre>
 <span></span><span class="kn">from</span> <span class="nn">__future__</span> <span class="kn">import</span> <span class="n">annotations</span>
 
+<span class="kn">import</span> <span class="nn">warnings</span>
 <span class="kn">from</span> <span class="nn">dataclasses</span> <span class="kn">import</span> <span class="n">dataclass</span><span class="p">,</span> <span class="n">field</span>
 <span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">TYPE_CHECKING</span><span class="p">,</span> <span class="n">TypeVar</span>
 
@@ -116,13 +117,24 @@ <h1>Source code for eitprocessing.datahandling.continuousdata</h1><div class="hi
 <a class="viewcode-back" href="../../../autoapi/eitprocessing/datahandling/continuousdata/index.html#eitprocessing.datahandling.continuousdata.ContinuousData.values">[docs]</a>
     <span class="n">values</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="n">kw_only</span><span class="o">=</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="ContinuousData.sample_frequency">
+<a class="viewcode-back" href="../../../autoapi/eitprocessing/datahandling/continuousdata/index.html#eitprocessing.datahandling.continuousdata.ContinuousData.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="kc">None</span> <span class="o">=</span> <span class="n">field</span><span class="p">(</span><span class="n">kw_only</span><span class="o">=</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> <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="n">default</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span></div>
+
 
 <div class="viewcode-block" id="ContinuousData.__post_init__">
 <a class="viewcode-back" href="../../../autoapi/eitprocessing/datahandling/continuousdata/index.html#eitprocessing.datahandling.continuousdata.ContinuousData.__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="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
         <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">loaded</span><span class="p">:</span>
             <span class="bp">self</span><span class="o">.</span><span class="n">lock</span><span class="p">()</span>
-        <span class="bp">self</span><span class="o">.</span><span class="n">lock</span><span class="p">(</span><span class="s2">&quot;time&quot;</span><span class="p">)</span></div>
+        <span class="bp">self</span><span class="o">.</span><span class="n">lock</span><span class="p">(</span><span class="s2">&quot;time&quot;</span><span class="p">)</span>
+
+        <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">sample_frequency</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
+            <span class="n">msg</span> <span class="o">=</span> <span class="p">(</span>
+                <span class="s2">&quot;`sample_frequency` is set to `None`. This will not be supported in future versions. &quot;</span>
+                <span class="s2">&quot;Provide a sample frequency when creating a ContinuousData object.&quot;</span>
+            <span class="p">)</span>
+            <span class="n">warnings</span><span class="o">.</span><span class="n">warn</span><span class="p">(</span><span class="n">msg</span><span class="p">,</span> <span class="ne">DeprecationWarning</span><span class="p">)</span></div>
 
 
 <div class="viewcode-block" id="ContinuousData.__setattr__">
@@ -168,6 +180,7 @@ <h1>Source code for eitprocessing.datahandling.continuousdata</h1><div class="hi
             <span class="c1"># make a copy if they want to edit the data directly</span>
             <span class="n">time</span><span class="o">=</span><span class="n">np</span><span class="o">.</span><span class="n">copy</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">values</span><span class="o">=</span><span class="n">np</span><span class="o">.</span><span class="n">copy</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">values</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="p">)</span>
         <span class="n">obj</span><span class="o">.</span><span class="n">unlock</span><span class="p">()</span>
         <span class="k">return</span> <span class="n">obj</span></div>
@@ -200,6 +213,7 @@ <h1>Source code for eitprocessing.datahandling.continuousdata</h1><div class="hi
             <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">values</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">values</span><span class="p">,</span> <span class="n">other</span><span class="o">.</span><span class="n">values</span><span class="p">)),</span>
             <span class="n">derived_from</span><span class="o">=</span><span class="p">[</span><span class="o">*</span><span class="bp">self</span><span class="o">.</span><span class="n">derived_from</span><span class="p">,</span> <span class="o">*</span><span class="n">other</span><span class="o">.</span><span class="n">derived_from</span><span class="p">,</span> <span class="bp">self</span><span class="p">,</span> <span class="n">other</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="p">)</span></div>
 
 
@@ -348,6 +362,7 @@ <h1>Source code for eitprocessing.datahandling.continuousdata</h1><div class="hi
             <span class="n">derived_from</span><span class="o">=</span><span class="p">[</span><span class="o">*</span><span class="bp">self</span><span class="o">.</span><span class="n">derived_from</span><span class="p">,</span> <span class="bp">self</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">values</span><span class="o">=</span><span class="n">values</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="p">)</span></div>
 </div>
 

_modules/eitprocessing/datahandling/eitdata.html

@@ -39,6 +39,7 @@ <h3>Navigation</h3>
   <h1>Source code for eitprocessing.datahandling.eitdata</h1><div class="highlight"><pre>
 <span></span><span class="kn">from</span> <span class="nn">__future__</span> <span class="kn">import</span> <span class="n">annotations</span>
 
+<span class="kn">import</span> <span class="nn">warnings</span>
 <span class="kn">from</span> <span class="nn">dataclasses</span> <span class="kn">import</span> <span class="n">dataclass</span><span class="p">,</span> <span class="n">field</span>
 <span class="kn">from</span> <span class="nn">enum</span> <span class="kn">import</span> <span class="n">auto</span>
 <span class="kn">from</span> <span class="nn">pathlib</span> <span class="kn">import</span> <span class="n">Path</span>
@@ -73,7 +74,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">        sample_frequency: The (average) frequency at which the frames are collection, in Hz.</span>
+<span class="sd">        sample_frequency: The (average) frequency at which the frames are collected, 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>
@@ -126,6 +127,18 @@ <h1>Source code for eitprocessing.datahandling.eitdata</h1><div class="highlight
         <span class="bp">self</span><span class="o">.</span><span class="n">name</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">name</span> <span class="ow">or</span> <span class="bp">self</span><span class="o">.</span><span class="n">label</span></div>
 
 
+    <span class="nd">@property</span>
+<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="k">def</span> <span class="nf">framerate</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">float</span><span class="p">:</span>
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Deprecated alias to `sample_frequency`.&quot;&quot;&quot;</span>
+        <span class="n">warnings</span><span class="o">.</span><span class="n">warn</span><span class="p">(</span>
+            <span class="s2">&quot;The `framerate` attribute has been deprecated. Use `sample_frequency` instead.&quot;</span><span class="p">,</span>
+            <span class="ne">DeprecationWarning</span><span class="p">,</span>
+        <span class="p">)</span>
+        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">sample_frequency</span></div>
+
+
     <span class="nd">@staticmethod</span>
 <div class="viewcode-block" id="EITData.ensure_path_list">
 <a class="viewcode-back" href="../../../autoapi/eitprocessing/datahandling/loading/index.html#eitprocessing.datahandling.eitdata.EITData.ensure_path_list">[docs]</a>

_modules/eitprocessing/datahandling/loading/draeger.html

@@ -155,7 +155,7 @@ <h1>Source code for eitprocessing.datahandling.loading.draeger</h1><div class="h
     <span class="p">(</span>
         <span class="n">continuousdata_collection</span><span class="p">,</span>
         <span class="n">sparsedata_collection</span><span class="p">,</span>
-    <span class="p">)</span> <span class="o">=</span> <span class="n">_convert_medibus_data</span><span class="p">(</span><span class="n">medibus_data</span><span class="p">,</span> <span class="n">time</span><span class="p">)</span>
+    <span class="p">)</span> <span class="o">=</span> <span class="n">_convert_medibus_data</span><span class="p">(</span><span class="n">medibus_data</span><span class="p">,</span> <span class="n">time</span><span class="p">,</span> <span class="n">sample_frequency</span><span class="p">)</span>
     <span class="n">intervaldata_collection</span> <span class="o">=</span> <span class="n">DataCollection</span><span class="p">(</span><span class="n">IntervalData</span><span class="p">)</span>
     <span class="c1"># TODO: move some medibus data to sparse / interval</span>
     <span class="c1"># TODO: move phases and events to sparse / interval</span>
@@ -169,6 +169,7 @@ <h1>Source code for eitprocessing.datahandling.loading.draeger</h1><div class="h
             <span class="n">derived_from</span><span class="o">=</span><span class="p">[</span><span class="n">eit_data</span><span class="p">],</span>
             <span class="n">time</span><span class="o">=</span><span class="n">eit_data</span><span class="o">.</span><span class="n">time</span><span class="p">,</span>
             <span class="n">values</span><span class="o">=</span><span class="n">eit_data</span><span class="o">.</span><span class="n">calculate_global_impedance</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="p">),</span>
     <span class="p">)</span>
     <span class="n">sparsedata_collection</span><span class="o">.</span><span class="n">add</span><span class="p">(</span>
@@ -223,6 +224,7 @@ <h1>Source code for eitprocessing.datahandling.loading.draeger</h1><div class="h
 <span class="k">def</span> <span class="nf">_convert_medibus_data</span><span class="p">(</span>
     <span class="n">medibus_data</span><span class="p">:</span> <span class="n">NDArray</span><span class="p">,</span>
     <span class="n">time</span><span class="p">:</span> <span class="n">NDArray</span><span class="p">,</span>
+    <span class="n">sample_frequency</span><span class="p">:</span> <span class="nb">float</span><span class="p">,</span>
 <span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">tuple</span><span class="p">[</span><span class="n">DataCollection</span><span class="p">,</span> <span class="n">DataCollection</span><span class="p">]:</span>
     <span class="n">continuousdata_collection</span> <span class="o">=</span> <span class="n">DataCollection</span><span class="p">(</span><span class="n">ContinuousData</span><span class="p">)</span>
     <span class="n">sparsedata_collection</span> <span class="o">=</span> <span class="n">DataCollection</span><span class="p">(</span><span class="n">SparseData</span><span class="p">)</span>
@@ -237,6 +239,7 @@ <h1>Source code for eitprocessing.datahandling.loading.draeger</h1><div class="h
                 <span class="n">time</span><span class="o">=</span><span class="n">time</span><span class="p">,</span>
                 <span class="n">values</span><span class="o">=</span><span class="n">data</span><span class="p">,</span>
                 <span class="n">category</span><span class="o">=</span><span class="n">field_info</span><span class="o">.</span><span class="n">signal_name</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="p">)</span>
             <span class="n">continuous_data</span><span class="o">.</span><span class="n">lock</span><span class="p">()</span>
             <span class="n">continuousdata_collection</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">continuous_data</span><span class="p">)</span>

_modules/eitprocessing/datahandling/loading/timpel.html

@@ -168,6 +168,7 @@ <h1>Source code for eitprocessing.datahandling.loading.timpel</h1><div class="hi
             <span class="s2">&quot;Global impedance calculated from raw EIT data&quot;</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">values</span><span class="o">=</span><span class="n">eit_data</span><span class="o">.</span><span class="n">calculate_global_impedance</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="p">),</span>
     <span class="p">)</span>
     <span class="n">continuousdata_collection</span><span class="o">.</span><span class="n">add</span><span class="p">(</span>
@@ -179,6 +180,7 @@ <h1>Source code for eitprocessing.datahandling.loading.timpel</h1><div class="hi
             <span class="n">description</span><span class="o">=</span><span class="s2">&quot;Airway pressure measured by Timpel device&quot;</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">values</span><span class="o">=</span><span class="n">data</span><span class="p">[:,</span> <span class="mi">1024</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="p">),</span>
     <span class="p">)</span>
 
@@ -191,6 +193,7 @@ <h1>Source code for eitprocessing.datahandling.loading.timpel</h1><div class="hi
             <span class="n">description</span><span class="o">=</span><span class="s2">&quot;Flow measures by Timpel device&quot;</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">values</span><span class="o">=</span><span class="n">data</span><span class="p">[:,</span> <span class="mi">1025</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="p">),</span>
     <span class="p">)</span>
 
@@ -203,6 +206,7 @@ <h1>Source code for eitprocessing.datahandling.loading.timpel</h1><div class="hi
             <span class="n">description</span><span class="o">=</span><span class="s2">&quot;Volume measured by Timpel device&quot;</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">values</span><span class="o">=</span><span class="n">data</span><span class="p">[:,</span> <span class="mi">1026</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="p">),</span>
     <span class="p">)</span>
 

_sources/autoapi/eitprocessing/datahandling/continuousdata/index.rst.txt

@@ -83,6 +83,10 @@ Module Contents
       :type:  numpy.ndarray
 
 
+   .. py:attribute:: sample_frequency
+      :type:  float | None
+
+
    .. py:method:: __post_init__() -> None