Deploying to gh-pages from @ 9b76a23 🚀

_modules/eitprocessing/eit_data/vendor.html

@@ -42,28 +42,28 @@ <h1>Source code for eitprocessing.eit_data.vendor</h1><div class="highlight"><pr
 
 
 <div class="viewcode-block" id="Vendor">
-<a class="viewcode-back" href="../../../autoapi/eitprocessing/eit_data/vendor/index.html#eitprocessing.eit_data.Vendor">[docs]</a>
+<a class="viewcode-back" href="../../../autoapi/eitprocessing/eit_data/vendor/index.html#eitprocessing.eit_data.loading.Vendor">[docs]</a>
 <span class="k">class</span> <span class="nc">Vendor</span><span class="p">(</span><span class="n">LowercaseStrEnum</span><span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;Enum indicating the vendor (manufacturer) of the source EIT device.&quot;&quot;&quot;</span>
 
 <div class="viewcode-block" id="Vendor.DRAEGER">
-<a class="viewcode-back" href="../../../autoapi/eitprocessing/eit_data/vendor/index.html#eitprocessing.eit_data.Vendor.DRAEGER">[docs]</a>
+<a class="viewcode-back" href="../../../autoapi/eitprocessing/eit_data/vendor/index.html#eitprocessing.eit_data.loading.Vendor.DRAEGER">[docs]</a>
     <span class="n">DRAEGER</span> <span class="o">=</span> <span class="n">auto</span><span class="p">()</span></div>
 
 <div class="viewcode-block" id="Vendor.TIMPEL">
-<a class="viewcode-back" href="../../../autoapi/eitprocessing/eit_data/vendor/index.html#eitprocessing.eit_data.Vendor.TIMPEL">[docs]</a>
+<a class="viewcode-back" href="../../../autoapi/eitprocessing/eit_data/vendor/index.html#eitprocessing.eit_data.loading.Vendor.TIMPEL">[docs]</a>
     <span class="n">TIMPEL</span> <span class="o">=</span> <span class="n">auto</span><span class="p">()</span></div>
 
 <div class="viewcode-block" id="Vendor.SENTEC">
-<a class="viewcode-back" href="../../../autoapi/eitprocessing/eit_data/vendor/index.html#eitprocessing.eit_data.Vendor.SENTEC">[docs]</a>
+<a class="viewcode-back" href="../../../autoapi/eitprocessing/eit_data/vendor/index.html#eitprocessing.eit_data.loading.Vendor.SENTEC">[docs]</a>
     <span class="n">SENTEC</span> <span class="o">=</span> <span class="n">auto</span><span class="p">()</span></div>
 
 <div class="viewcode-block" id="Vendor.DRAGER">
-<a class="viewcode-back" href="../../../autoapi/eitprocessing/eit_data/vendor/index.html#eitprocessing.eit_data.Vendor.DRAGER">[docs]</a>
+<a class="viewcode-back" href="../../../autoapi/eitprocessing/eit_data/vendor/index.html#eitprocessing.eit_data.loading.Vendor.DRAGER">[docs]</a>
     <span class="n">DRAGER</span> <span class="o">=</span> <span class="n">DRAEGER</span></div>
 
 <div class="viewcode-block" id="Vendor.DRÄGER">
-<a class="viewcode-back" href="../../../autoapi/eitprocessing/eit_data/vendor/index.html#eitprocessing.eit_data.Vendor.DRÄGER">[docs]</a>
+<a class="viewcode-back" href="../../../autoapi/eitprocessing/eit_data/vendor/index.html#eitprocessing.eit_data.loading.Vendor.DRÄGER">[docs]</a>
     <span class="n">DRÄGER</span> <span class="o">=</span> <span class="n">DRAEGER</span></div>
 </div>
 

_modules/eitprocessing/sequence.html

@@ -54,7 +54,7 @@ <h1>Source code for eitprocessing.sequence</h1><div class="highlight"><pre>
 
 <span class="nd">@dataclass</span><span class="p">(</span><span class="n">eq</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
 <div class="viewcode-block" id="Sequence">
-<a class="viewcode-back" href="../../autoapi/eitprocessing/sequence/index.html#eitprocessing.sequence.Sequence">[docs]</a>
+<a class="viewcode-back" href="../../autoapi/eitprocessing/sequence/index.html#eitprocessing.eit_data.loading.Sequence">[docs]</a>
 <span class="k">class</span> <span class="nc">Sequence</span><span class="p">(</span><span class="n">Equivalence</span><span class="p">,</span> <span class="n">SelectByTime</span><span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;Sequence of timepoints containing respiratory data.</span>
 
@@ -78,39 +78,41 @@ <h1>Source code for eitprocessing.sequence</h1><div class="highlight"><pre>
 <span class="sd">    &quot;&quot;&quot;</span>
 
 <div class="viewcode-block" id="Sequence.label">
-<a class="viewcode-back" href="../../autoapi/eitprocessing/sequence/index.html#eitprocessing.sequence.Sequence.label">[docs]</a>
-    <span class="n">label</span><span class="p">:</span> <span class="nb">str</span></div>
+<a class="viewcode-back" href="../../autoapi/eitprocessing/sequence/index.html#eitprocessing.eit_data.loading.Sequence.label">[docs]</a>
+    <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></div>
 
 <div class="viewcode-block" id="Sequence.name">
-<a class="viewcode-back" href="../../autoapi/eitprocessing/sequence/index.html#eitprocessing.sequence.Sequence.name">[docs]</a>
-    <span class="n">name</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;&quot;</span></div>
+<a class="viewcode-back" href="../../autoapi/eitprocessing/sequence/index.html#eitprocessing.eit_data.loading.Sequence.name">[docs]</a>
+    <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></div>
 
 <div class="viewcode-block" id="Sequence.description">
-<a class="viewcode-back" href="../../autoapi/eitprocessing/sequence/index.html#eitprocessing.sequence.Sequence.description">[docs]</a>
+<a class="viewcode-back" href="../../autoapi/eitprocessing/sequence/index.html#eitprocessing.eit_data.loading.Sequence.description">[docs]</a>
     <span class="n">description</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;&quot;</span></div>
 
 <div class="viewcode-block" id="Sequence.eit_data">
-<a class="viewcode-back" href="../../autoapi/eitprocessing/sequence/index.html#eitprocessing.sequence.Sequence.eit_data">[docs]</a>
+<a class="viewcode-back" href="../../autoapi/eitprocessing/sequence/index.html#eitprocessing.eit_data.loading.Sequence.eit_data">[docs]</a>
     <span class="n">eit_data</span><span class="p">:</span> <span class="n">DataCollection</span> <span class="o">=</span> <span class="n">field</span><span class="p">(</span><span class="n">default_factory</span><span class="o">=</span><span class="k">lambda</span><span class="p">:</span> <span class="n">DataCollection</span><span class="p">(</span><span class="n">EITData</span><span class="p">))</span></div>
 
 <div class="viewcode-block" id="Sequence.continuous_data">
-<a class="viewcode-back" href="../../autoapi/eitprocessing/sequence/index.html#eitprocessing.sequence.Sequence.continuous_data">[docs]</a>
+<a class="viewcode-back" href="../../autoapi/eitprocessing/sequence/index.html#eitprocessing.eit_data.loading.Sequence.continuous_data">[docs]</a>
     <span class="n">continuous_data</span><span class="p">:</span> <span class="n">DataCollection</span> <span class="o">=</span> <span class="n">field</span><span class="p">(</span><span class="n">default_factory</span><span class="o">=</span><span class="k">lambda</span><span class="p">:</span> <span class="n">DataCollection</span><span class="p">(</span><span class="n">ContinuousData</span><span class="p">))</span></div>
 
 <div class="viewcode-block" id="Sequence.sparse_data">
-<a class="viewcode-back" href="../../autoapi/eitprocessing/sequence/index.html#eitprocessing.sequence.Sequence.sparse_data">[docs]</a>
+<a class="viewcode-back" href="../../autoapi/eitprocessing/sequence/index.html#eitprocessing.eit_data.loading.Sequence.sparse_data">[docs]</a>
     <span class="n">sparse_data</span><span class="p">:</span> <span class="n">DataCollection</span> <span class="o">=</span> <span class="n">field</span><span class="p">(</span><span class="n">default_factory</span><span class="o">=</span><span class="k">lambda</span><span class="p">:</span> <span class="n">DataCollection</span><span class="p">(</span><span class="n">SparseData</span><span class="p">))</span></div>
 
 
 <div class="viewcode-block" id="Sequence.__post_init__">
-<a class="viewcode-back" href="../../autoapi/eitprocessing/sequence/index.html#eitprocessing.sequence.Sequence.__post_init__">[docs]</a>
+<a class="viewcode-back" href="../../autoapi/eitprocessing/sequence/index.html#eitprocessing.eit_data.loading.Sequence.__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="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">label</span><span class="p">:</span>
+            <span class="bp">self</span><span class="o">.</span><span class="n">label</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;Sequence_</span><span class="si">{</span><span class="nb">id</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span><span class="si">}</span><span class="s2">&quot;</span>
         <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="Sequence.time">
-<a class="viewcode-back" href="../../autoapi/eitprocessing/sequence/index.html#eitprocessing.sequence.Sequence.time">[docs]</a>
+<a class="viewcode-back" href="../../autoapi/eitprocessing/sequence/index.html#eitprocessing.eit_data.loading.Sequence.time">[docs]</a>
     <span class="k">def</span> <span class="nf">time</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">np</span><span class="o">.</span><span class="n">ndarray</span><span class="p">:</span>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;Time axis from either EITData or ContinuousData.&quot;&quot;&quot;</span>
         <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">eit_data</span><span class="p">):</span>
@@ -123,20 +125,20 @@ <h1>Source code for eitprocessing.sequence</h1><div class="highlight"><pre>
 
 
 <div class="viewcode-block" id="Sequence.__len__">
-<a class="viewcode-back" href="../../autoapi/eitprocessing/sequence/index.html#eitprocessing.sequence.Sequence.__len__">[docs]</a>
+<a class="viewcode-back" href="../../autoapi/eitprocessing/sequence/index.html#eitprocessing.eit_data.loading.Sequence.__len__">[docs]</a>
     <span class="k">def</span> <span class="fm">__len__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
         <span class="k">return</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">time</span><span class="p">)</span></div>
 
 
 <div class="viewcode-block" id="Sequence.__add__">
-<a class="viewcode-back" href="../../autoapi/eitprocessing/sequence/index.html#eitprocessing.sequence.Sequence.__add__">[docs]</a>
+<a class="viewcode-back" href="../../autoapi/eitprocessing/sequence/index.html#eitprocessing.eit_data.loading.Sequence.__add__">[docs]</a>
     <span class="k">def</span> <span class="fm">__add__</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">Sequence</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Sequence</span><span class="p">:</span>
         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">concatenate</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">)</span></div>
 
 
     <span class="nd">@classmethod</span>
 <div class="viewcode-block" id="Sequence.concatenate">
-<a class="viewcode-back" href="../../autoapi/eitprocessing/sequence/index.html#eitprocessing.sequence.Sequence.concatenate">[docs]</a>
+<a class="viewcode-back" href="../../autoapi/eitprocessing/sequence/index.html#eitprocessing.eit_data.loading.Sequence.concatenate">[docs]</a>
     <span class="k">def</span> <span class="nf">concatenate</span><span class="p">(</span>
         <span class="bp">cls</span><span class="p">,</span>
         <span class="n">a</span><span class="p">:</span> <span class="n">Sequence</span><span class="p">,</span>
@@ -153,7 +155,7 @@ <h1>Source code for eitprocessing.sequence</h1><div class="highlight"><pre>
 
 
 <div class="viewcode-block" id="Sequence._sliced_copy">
-<a class="viewcode-back" href="../../autoapi/eitprocessing/sequence/index.html#eitprocessing.sequence.Sequence._sliced_copy">[docs]</a>
+<a class="viewcode-back" href="../../autoapi/eitprocessing/sequence/index.html#eitprocessing.eit_data.loading.Sequence._sliced_copy">[docs]</a>
     <span class="k">def</span> <span class="nf">_sliced_copy</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">start_index</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span> <span class="n">end_index</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span> <span class="n">label</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Self</span><span class="p">:</span>
         <span class="n">eit_data</span> <span class="o">=</span> <span class="n">DataCollection</span><span class="p">(</span><span class="n">EITData</span><span class="p">)</span>
         <span class="k">for</span> <span class="n">value</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">eit_data</span><span class="o">.</span><span class="n">values</span><span class="p">():</span>

_modules/index.html

@@ -38,11 +38,12 @@ <h1>All modules for which code is available</h1>
 <li><a href="eitprocessing/continuous_data.html">eitprocessing.continuous_data</a></li>
 <li><a href="eitprocessing/data_collection.html">eitprocessing.data_collection</a></li>
 <li><a href="eitprocessing/eit_data.html">eitprocessing.eit_data</a></li>
-<ul><li><a href="eitprocessing/eit_data/draeger.html">eitprocessing.eit_data.draeger</a></li>
-<li><a href="eitprocessing/eit_data/event.html">eitprocessing.eit_data.event</a></li>
-<li><a href="eitprocessing/eit_data/phases.html">eitprocessing.eit_data.phases</a></li>
-<li><a href="eitprocessing/eit_data/sentec.html">eitprocessing.eit_data.sentec</a></li>
-<li><a href="eitprocessing/eit_data/timpel.html">eitprocessing.eit_data.timpel</a></li>
+<ul><li><a href="eitprocessing/eit_data/event.html">eitprocessing.eit_data.event</a></li>
+<li><a href="eitprocessing/eit_data/loading.html">eitprocessing.eit_data.loading</a></li>
+<ul><li><a href="eitprocessing/eit_data/loading/draeger.html">eitprocessing.eit_data.loading.draeger</a></li>
+<li><a href="eitprocessing/eit_data/loading/sentec.html">eitprocessing.eit_data.loading.sentec</a></li>
+<li><a href="eitprocessing/eit_data/loading/timpel.html">eitprocessing.eit_data.loading.timpel</a></li>
+</ul><li><a href="eitprocessing/eit_data/phases.html">eitprocessing.eit_data.phases</a></li>
 <li><a href="eitprocessing/eit_data/vendor.html">eitprocessing.eit_data.vendor</a></li>
 </ul><li><a href="eitprocessing/filters.html">eitprocessing.filters</a></li>
 <ul><li><a href="eitprocessing/filters/butterworth_filters.html">eitprocessing.filters.butterworth_filters</a></li>

_sources/autoapi/eitprocessing/data_collection/index.rst.txt

@@ -202,7 +202,7 @@ Attributes
 .. py:class:: EITData
 
 
-   Bases: :py:obj:`eitprocessing.mixins.slicing.SelectByTime`, :py:obj:`eitprocessing.mixins.equality.Equivalence`, :py:obj:`abc.ABC`
+   Bases: :py:obj:`eitprocessing.mixins.slicing.SelectByTime`, :py:obj:`eitprocessing.mixins.equality.Equivalence`
 
    Container for EIT data.
 
@@ -293,54 +293,16 @@ Attributes
    .. py:method:: __post_init__()
 
 
-   .. py:method:: from_path(path: str | pathlib.Path | list[str | pathlib.Path], vendor: vendor.Vendor | str, framerate: float | None = None, first_frame: int = 0, max_frames: int | None = None, return_non_eit_data: bool = False) -> eitprocessing.data_collection.DataCollection | tuple[eitprocessing.data_collection.DataCollection, eitprocessing.data_collection.DataCollection, eitprocessing.data_collection.DataCollection]
-      :classmethod:
-
-      Load sequence from path(s).
-
-      :param path: relative or absolute path(s) to data file.
-      :param vendor: vendor indicating the device used.
-      :param label: description of object for human interpretation.
-                    Defaults to "Sequence_<unique_id>".
-      :param framerate: framerate at which the data was recorded.
-                        Default for Draeger: 20
-                        Default for Timpel: 50
-                        Default for Sentec: 50.2
-      :param first_frame: index of first frame to load.
-                          Defaults to 0.
-      :param max_frames: maximum number of frames to load.
-                         The actual number of frames can be lower than this if this
-                         would surpass the final frame.
-      :param return_non_eit_data: whether to load available continuous and sparse data.
-
-      :raises NotImplementedError: is raised when there is no loading method for
-      :raises the given vendor.:
-
-      :returns: container for the loaded data and metadata from all files in path.
-      :rtype: EITData
-
-
-   .. py:method:: _from_path(path: pathlib.Path, framerate: float | None = None, first_frame: int | None = None, max_frames: int | None = None, return_non_eit_data: bool = False) -> eitprocessing.data_collection.DataCollection | tuple[eitprocessing.data_collection.DataCollection, eitprocessing.data_collection.DataCollection, eitprocessing.data_collection.DataCollection]
-      :classmethod:
-      :abstractmethod:
-
-
-   .. py:method:: _ensure_path_list(path: str | pathlib.Path | list[str | pathlib.Path]) -> list[pathlib.Path]
+   .. py:method:: ensure_path_list(path: str | pathlib.Path | list[str | pathlib.Path]) -> list[pathlib.Path]
       :staticmethod:
 
+      Return the path or paths as a list.
 
-   .. py:method:: _get_vendor_class(vendor: vendor.Vendor) -> type[EITData_]
-      :staticmethod:
-
+      The path of any EITData object can be a single str/Path or a list of str/Path objects. This method returns a
+      list of Path objects given either a str/Path or list of str/Paths.
 
-   .. py:method:: _check_first_frame(first_frame: int | None) -> int
-      :staticmethod:
-
-
-   .. py:method:: _ensure_vendor(vendor: vendor.Vendor | str) -> vendor.Vendor
-      :staticmethod:
 
-      Check whether vendor exists, and assure it's a Vendor object.
+   .. py:method:: __add__(other: T) -> T
 
 
    .. py:method:: concatenate(other: T, label: str | None = None) -> T