Deploying to gh-pages from @ f0a89b1 🚀

_modules/eitprocessing/binreader/sequence.html

@@ -111,6 +111,8 @@ <h1>Source code for eitprocessing.binreader.sequence</h1><div class="highlight">
 <span class="sd">    Args:</span>
 <span class="sd">        path (Path | str | List[Path | str]): path(s) to data file.</span>
 <span class="sd">        vendor (Vendor | str): vendor indicating the device used.</span>
+<span class="sd">        label (str): description of object for human interpretation.</span>
+<span class="sd">            Defaults to &quot;Sequence_&lt;unique_id&gt;&quot;.</span>
 <span class="sd">        time (NDArray[float]): list of time label for each data point (can be</span>
 <span class="sd">            true time or relative time)</span>
 <span class="sd">        max_frames (int): number of frames in sequence</span>
@@ -136,7 +138,7 @@ <h1>Source code for eitprocessing.binreader.sequence</h1><div class="highlight">
 
 <div class="viewcode-block" id="Sequence.label">
 <a class="viewcode-back" href="../../../autoapi/eitprocessing/binreader/sequence/index.html#eitprocessing.binreader.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>
+    <span class="n">label</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span></div>
 
 <div class="viewcode-block" id="Sequence.time">
 <a class="viewcode-back" href="../../../autoapi/eitprocessing/binreader/sequence/index.html#eitprocessing.binreader.Sequence.time">[docs]</a>
@@ -312,8 +314,10 @@ <h1>Source code for eitprocessing.binreader.sequence</h1><div class="highlight">
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;Load sequence from path(s)</span>
 
 <span class="sd">        Args:</span>
-<span class="sd">            path (Path | str | List[Path | str]): path(s) to data file</span>
-<span class="sd">            vendor (Vendor | str): vendor indicating the device used</span>
+<span class="sd">            path (Path | str | List[Path | str]): path(s) to data file.</span>
+<span class="sd">            vendor (Vendor | str): vendor indicating the device used.</span>
+<span class="sd">            label (str): description of object for human interpretation.</span>
+<span class="sd">                Defaults to &quot;Sequence_&lt;unique_id&gt;&quot;.</span>
 <span class="sd">            framerate (int, optional): framerate at which the data was recorded.</span>
 <span class="sd">                Default for Draeger: 20</span>
 <span class="sd">                Default for Timpel: 50</span>

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

@@ -178,6 +178,9 @@ Classes
    :type path: Path | str | List[Path | str]
    :param vendor: vendor indicating the device used.
    :type vendor: Vendor | str
+   :param label: description of object for human interpretation.
+                 Defaults to "Sequence_<unique_id>".
+   :type label: str
    :param time: list of time label for each data point (can be
                 true time or relative time)
    :type time: NDArray[float]
@@ -210,7 +213,7 @@ Classes
 
 
    .. py:attribute:: label
-      :type: str | None
+      :type: str
 
 
 
@@ -288,10 +291,13 @@ Classes
 
       Load sequence from path(s)
 
-      :param path: path(s) to data file
+      :param path: path(s) to data file.
       :type path: Path | str | List[Path | str]
-      :param vendor: vendor indicating the device used
+      :param vendor: vendor indicating the device used.
       :type vendor: Vendor | str
+      :param label: description of object for human interpretation.
+                    Defaults to "Sequence_<unique_id>".
+      :type label: str
       :param framerate: framerate at which the data was recorded.
                         Default for Draeger: 20
                         Default for Timpel: 50

_sources/autoapi/eitprocessing/binreader/sequence/index.rst.txt

@@ -73,6 +73,9 @@ Classes
    :type path: Path | str | List[Path | str]
    :param vendor: vendor indicating the device used.
    :type vendor: Vendor | str
+   :param label: description of object for human interpretation.
+                 Defaults to "Sequence_<unique_id>".
+   :type label: str
    :param time: list of time label for each data point (can be
                 true time or relative time)
    :type time: NDArray[float]
@@ -105,7 +108,7 @@ Classes
 
 
    .. py:attribute:: label
-      :type: str | None
+      :type: str
 
 
 
@@ -183,10 +186,13 @@ Classes
 
       Load sequence from path(s)
 
-      :param path: path(s) to data file
+      :param path: path(s) to data file.
       :type path: Path | str | List[Path | str]
-      :param vendor: vendor indicating the device used
+      :param vendor: vendor indicating the device used.
       :type vendor: Vendor | str
+      :param label: description of object for human interpretation.
+                    Defaults to "Sequence_<unique_id>".
+      :type label: str
       :param framerate: framerate at which the data was recorded.
                         Default for Draeger: 20
                         Default for Timpel: 50

autoapi/eitprocessing/binreader/index.html

@@ -249,6 +249,8 @@ <h3>Classes<a class="headerlink" href="#classes" title="Link to this heading">¶
 <dd class="field-odd"><ul class="simple">
 <li><p><strong>path</strong> (<em>Path</em><em> | </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.11)"><em>str</em></a><em> | </em><em>List</em><em>[</em><em>Path</em><em> | </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.11)"><em>str</em></a><em>]</em>) – path(s) to data file.</p></li>
 <li><p><strong>vendor</strong> (<a class="reference internal" href="#eitprocessing.binreader.Vendor" title="eitprocessing.binreader.Vendor"><em>Vendor</em></a><em> | </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.11)"><em>str</em></a>) – vendor indicating the device used.</p></li>
+<li><p><strong>label</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.11)"><em>str</em></a>) – description of object for human interpretation.
+Defaults to “Sequence_&lt;unique_id&gt;”.</p></li>
 <li><p><strong>time</strong> (<em>NDArray</em><em>[</em><a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><em>float</em></a><em>]</em>) – list of time label for each data point (can be
 true time or relative time)</p></li>
 <li><p><strong>max_frames</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.11)"><em>int</em></a>) – number of frames in sequence</p></li>
@@ -280,7 +282,7 @@ <h3>Classes<a class="headerlink" href="#classes" title="Link to this heading">¶
 
 <dl class="py attribute">
 <dt class="sig sig-object py" id="eitprocessing.binreader.Sequence.label">
-<span class="sig-name descname"><span class="pre">label</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.11)"><span class="pre">str</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.11)"><span class="pre">None</span></a></em><a class="headerlink" href="#eitprocessing.binreader.Sequence.label" title="Link to this definition">¶</a></dt>
+<span class="sig-name descname"><span class="pre">label</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.11)"><span class="pre">str</span></a></em><a class="headerlink" href="#eitprocessing.binreader.Sequence.label" title="Link to this definition">¶</a></dt>
 <dd></dd></dl>
 
 <dl class="py attribute">
@@ -370,8 +372,10 @@ <h3>Classes<a class="headerlink" href="#classes" title="Link to this heading">¶
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dd class="field-odd"><ul class="simple">
-<li><p><strong>path</strong> (<em>Path</em><em> | </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.11)"><em>str</em></a><em> | </em><em>List</em><em>[</em><em>Path</em><em> | </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.11)"><em>str</em></a><em>]</em>) – path(s) to data file</p></li>
-<li><p><strong>vendor</strong> (<a class="reference internal" href="#eitprocessing.binreader.Vendor" title="eitprocessing.binreader.Vendor"><em>Vendor</em></a><em> | </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.11)"><em>str</em></a>) – vendor indicating the device used</p></li>
+<li><p><strong>path</strong> (<em>Path</em><em> | </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.11)"><em>str</em></a><em> | </em><em>List</em><em>[</em><em>Path</em><em> | </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.11)"><em>str</em></a><em>]</em>) – path(s) to data file.</p></li>
+<li><p><strong>vendor</strong> (<a class="reference internal" href="#eitprocessing.binreader.Vendor" title="eitprocessing.binreader.Vendor"><em>Vendor</em></a><em> | </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.11)"><em>str</em></a>) – vendor indicating the device used.</p></li>
+<li><p><strong>label</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.11)"><em>str</em></a>) – description of object for human interpretation.
+Defaults to “Sequence_&lt;unique_id&gt;”.</p></li>
 <li><p><strong>framerate</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.11)"><em>int</em></a><em>, </em><em>optional</em>) – framerate at which the data was recorded.
 Default for Draeger: 20
 Default for Timpel: 50</p></li>

autoapi/eitprocessing/binreader/sequence/index.html

@@ -117,6 +117,8 @@ <h3>Classes<a class="headerlink" href="#classes" title="Link to this heading">¶
 <dd class="field-odd"><ul class="simple">
 <li><p><strong>path</strong> (<em>Path</em><em> | </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.11)"><em>str</em></a><em> | </em><em>List</em><em>[</em><em>Path</em><em> | </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.11)"><em>str</em></a><em>]</em>) – path(s) to data file.</p></li>
 <li><p><strong>vendor</strong> (<a class="reference internal" href="#eitprocessing.binreader.sequence.Vendor" title="eitprocessing.binreader.sequence.Vendor"><em>Vendor</em></a><em> | </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.11)"><em>str</em></a>) – vendor indicating the device used.</p></li>
+<li><p><strong>label</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.11)"><em>str</em></a>) – description of object for human interpretation.
+Defaults to “Sequence_&lt;unique_id&gt;”.</p></li>
 <li><p><strong>time</strong> (<em>NDArray</em><em>[</em><a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><em>float</em></a><em>]</em>) – list of time label for each data point (can be
 true time or relative time)</p></li>
 <li><p><strong>max_frames</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.11)"><em>int</em></a>) – number of frames in sequence</p></li>
@@ -148,7 +150,7 @@ <h3>Classes<a class="headerlink" href="#classes" title="Link to this heading">¶
 
 <dl class="py attribute">
 <dt class="sig sig-object py" id="eitprocessing.binreader.sequence.Sequence.label">
-<span class="sig-name descname"><span class="pre">label</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.11)"><span class="pre">str</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.11)"><span class="pre">None</span></a></em><a class="reference internal" href="../../../../_modules/eitprocessing/binreader/sequence.html#Sequence.label"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#eitprocessing.binreader.sequence.Sequence.label" title="Link to this definition">¶</a></dt>
+<span class="sig-name descname"><span class="pre">label</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.11)"><span class="pre">str</span></a></em><a class="reference internal" href="../../../../_modules/eitprocessing/binreader/sequence.html#Sequence.label"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#eitprocessing.binreader.sequence.Sequence.label" title="Link to this definition">¶</a></dt>
 <dd></dd></dl>
 
 <dl class="py attribute">
@@ -238,8 +240,10 @@ <h3>Classes<a class="headerlink" href="#classes" title="Link to this heading">¶
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dd class="field-odd"><ul class="simple">
-<li><p><strong>path</strong> (<em>Path</em><em> | </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.11)"><em>str</em></a><em> | </em><em>List</em><em>[</em><em>Path</em><em> | </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.11)"><em>str</em></a><em>]</em>) – path(s) to data file</p></li>
-<li><p><strong>vendor</strong> (<a class="reference internal" href="#eitprocessing.binreader.sequence.Vendor" title="eitprocessing.binreader.sequence.Vendor"><em>Vendor</em></a><em> | </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.11)"><em>str</em></a>) – vendor indicating the device used</p></li>
+<li><p><strong>path</strong> (<em>Path</em><em> | </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.11)"><em>str</em></a><em> | </em><em>List</em><em>[</em><em>Path</em><em> | </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.11)"><em>str</em></a><em>]</em>) – path(s) to data file.</p></li>
+<li><p><strong>vendor</strong> (<a class="reference internal" href="#eitprocessing.binreader.sequence.Vendor" title="eitprocessing.binreader.sequence.Vendor"><em>Vendor</em></a><em> | </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.11)"><em>str</em></a>) – vendor indicating the device used.</p></li>
+<li><p><strong>label</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.11)"><em>str</em></a>) – description of object for human interpretation.
+Defaults to “Sequence_&lt;unique_id&gt;”.</p></li>
 <li><p><strong>framerate</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.11)"><em>int</em></a><em>, </em><em>optional</em>) – framerate at which the data was recorded.
 Default for Draeger: 20
 Default for Timpel: 50</p></li>