deploy: cca296a

_sources/tutorials/read_recording.ipynb.txt

@@ -8,7 +8,7 @@
     "In this tutorial, we will show how to load a single Neon recording downloaded from [Pupil Cloud](https://docs.pupil-labs.com/neon/pupil-cloud/).\n",
     "\n",
     "## Reading sample data\n",
-    "We will use a sample recording produced by the NCC Lab called `OfficeWalk`. It's a project with 2 recordings and multiple enrichments and can be downloaded with the `get_sample_data()` function. It returns a [`Pathlib.Path`](https://docs.python.org/3/library/pathlib.html) object to the downloaded & unzipped directory."
+    "We will use a sample recording produced by the NCC Lab called `OfficeWalk`. It's a project with 2 recordings and multiple enrichments and can be downloaded with the `get_sample_data()` function. It returns a `Pathlib.Path` object to the downloaded & unzipped directory."
    ]
   },
   {
@@ -46,7 +46,7 @@
     "└── OfficeWalk_STATIC-IMAGE-MAPPER_ManualMap_csv\n",
     "```\n",
     "\n",
-    "The `Timeseries Data` folder contains what PyNeon calls a [`NeonDataset`](https://ncc-brain.github.io/PyNeon/reference/dataset.html#pyneon.NeonDataset). It contains multiple recordings, each with its own `info.json` file and data files. These recordings can either be loaded individually as a [`NeonRecording`](https://ncc-brain.github.io/PyNeon/reference/recording.html#pyneon.NeonRecording) or as a wholist `NeonDataset`.\n",
+    "The `Timeseries Data` folder contains what PyNeon calls a `NeonDataset`. It contains multiple recordings, each with its own `info.json` file and data files. These recordings can either be loaded individually as a `NeonRecording` as a wholist `NeonDataset`.\n",
     "\n",
     "If loading a `NeonDataset`, specify the path to the `Timeseries Data` folder to create a `NeonDataset` object:"
    ]
@@ -451,7 +451,7 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "pyneon",
+   "display_name": "Python 3",
    "language": "python",
    "name": "python3"
   },

genindex.html

@@ -530,8 +530,6 @@ <h2 id="N">N</h2>
       <li><a href="reference/data.html#pyneon.video.NeonVideo.n_frames">n_frames (pyneon.video.NeonVideo attribute)</a>
 </li>
       <li><a href="reference/data.html#pyneon.events.NeonBlinks">NeonBlinks (class in pyneon.events)</a>
-</li>
-      <li><a href="reference/data.html#pyneon.data.NeonData">NeonData (class in pyneon.data)</a>
 </li>
       <li><a href="reference/dataset.html#pyneon.NeonDataset">NeonDataset (class in pyneon)</a>
 </li>
@@ -541,10 +539,10 @@ <h2 id="N">N</h2>
 </li>
       <li><a href="reference/data.html#pyneon.stream.NeonEyeStates">NeonEyeStates (class in pyneon.stream)</a>
 </li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="reference/data.html#pyneon.events.NeonFixations">NeonFixations (class in pyneon.events)</a>
 </li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="reference/data.html#pyneon.stream.NeonGaze">NeonGaze (class in pyneon.stream)</a>
 </li>
       <li><a href="reference/data.html#pyneon.stream.NeonIMU">NeonIMU (class in pyneon.stream)</a>
@@ -554,6 +552,8 @@ <h2 id="N">N</h2>
       <li><a href="reference/data.html#pyneon.events.NeonSaccades">NeonSaccades (class in pyneon.events)</a>
 </li>
       <li><a href="reference/data.html#pyneon.stream.NeonStream">NeonStream (class in pyneon.stream)</a>
+</li>
+      <li><a href="reference/data.html#pyneon.data.NeonTabular">NeonTabular (class in pyneon.data)</a>
 </li>
       <li><a href="reference/data.html#pyneon.video.NeonVideo">NeonVideo (class in pyneon.video)</a>
 </li>

reference/data.html

@@ -373,17 +373,18 @@
   <section id="module-pyneon.data">
 <span id="classes-for-individual-data-types"></span><h1>Classes for individual data types<a class="headerlink" href="#module-pyneon.data" title="Link to this heading">#</a></h1>
 <dl class="py class">
-<dt class="sig sig-object py" id="pyneon.data.NeonData">
-<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyneon.data.</span></span><span class="sig-name descname"><span class="pre">NeonData</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">file</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/pathlib.html#pathlib.Path" title="(in Python v3.12)"><span class="pre">Path</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyneon.data.NeonData" title="Link to this definition">#</a></dt>
+<dt class="sig sig-object py" id="pyneon.data.NeonTabular">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyneon.data.</span></span><span class="sig-name descname"><span class="pre">NeonTabular</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">file</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/pathlib.html#pathlib.Path" title="(in Python v3.12)"><span class="pre">Path</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyneon.data.NeonTabular" title="Link to this definition">#</a></dt>
 <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
 <p>Base for Neon tabular data. It reads from a CSV file and stores the data
-as a pandas DataFrame (with section and recording IDs removed).</p>
+as a pandas DataFrame (with section and recording IDs removed). The <cite>timestamp [ns]</cite>
+(for streams) or <cite>start timestamp [ns]</cite> (for events) column is set as the index.</p>
 </dd></dl>
 
 <dl class="py class" id="module-pyneon.stream">
 <dt class="sig sig-object py" id="pyneon.stream.NeonStream">
 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyneon.stream.</span></span><span class="sig-name descname"><span class="pre">NeonStream</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">file</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/pathlib.html#pathlib.Path" title="(in Python v3.12)"><span class="pre">Path</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyneon.stream.NeonStream" title="Link to this definition">#</a></dt>
-<dd><p>Bases: <a class="reference internal" href="#pyneon.data.NeonData" title="pyneon.data.NeonData"><code class="xref py py-class docutils literal notranslate"><span class="pre">NeonData</span></code></a></p>
+<dd><p>Bases: <a class="reference internal" href="#pyneon.data.NeonTabular" title="pyneon.data.NeonTabular"><code class="xref py py-class docutils literal notranslate"><span class="pre">NeonTabular</span></code></a></p>
 <p>Base for Neon continuous data (gaze, eye states, IMU).
 It must contain a <code class="docutils literal notranslate"><span class="pre">timestamp</span> <span class="pre">[ns]</span></code> column.</p>
 <dl class="field-list simple">
@@ -589,7 +590,7 @@
 <dl class="py class" id="module-pyneon.events">
 <dt class="sig sig-object py" id="pyneon.events.NeonEV">
 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyneon.events.</span></span><span class="sig-name descname"><span class="pre">NeonEV</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">file</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyneon.events.NeonEV" title="Link to this definition">#</a></dt>
-<dd><p>Bases: <a class="reference internal" href="#pyneon.data.NeonData" title="pyneon.data.NeonData"><code class="xref py py-class docutils literal notranslate"><span class="pre">NeonData</span></code></a></p>
+<dd><p>Bases: <a class="reference internal" href="#pyneon.data.NeonTabular" title="pyneon.data.NeonTabular"><code class="xref py py-class docutils literal notranslate"><span class="pre">NeonTabular</span></code></a></p>
 <p>Base for Neon event data (blinks, fixations, saccades, “events” messages).</p>
 </dd></dl>
 
@@ -775,7 +776,7 @@
   </div>
   <nav class="bd-toc-nav page-toc" aria-labelledby="pst-page-navigation-heading-2">
     <ul class="visible nav section-nav flex-column">
-<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#pyneon.data.NeonData"><code class="docutils literal notranslate"><span class="pre">NeonData</span></code></a></li>
+<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#pyneon.data.NeonTabular"><code class="docutils literal notranslate"><span class="pre">NeonTabular</span></code></a></li>
 <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#pyneon.stream.NeonStream"><code class="docutils literal notranslate"><span class="pre">NeonStream</span></code></a><ul class="nav section-nav flex-column">
 <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#pyneon.stream.NeonStream.file"><code class="docutils literal notranslate"><span class="pre">NeonStream.file</span></code></a></li>
 <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#pyneon.stream.NeonStream.data"><code class="docutils literal notranslate"><span class="pre">NeonStream.data</span></code></a></li>

reference/index.html

@@ -380,7 +380,7 @@
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="data.html">Classes for individual data types</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="data.html#pyneon.data.NeonData"><code class="docutils literal notranslate"><span class="pre">NeonData</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="data.html#pyneon.data.NeonTabular"><code class="docutils literal notranslate"><span class="pre">NeonTabular</span></code></a></li>
 <li class="toctree-l2"><a class="reference internal" href="data.html#pyneon.stream.NeonStream"><code class="docutils literal notranslate"><span class="pre">NeonStream</span></code></a></li>
 <li class="toctree-l2"><a class="reference internal" href="data.html#pyneon.stream.NeonGaze"><code class="docutils literal notranslate"><span class="pre">NeonGaze</span></code></a></li>
 <li class="toctree-l2"><a class="reference internal" href="data.html#pyneon.stream.NeonEyeStates"><code class="docutils literal notranslate"><span class="pre">NeonEyeStates</span></code></a></li>

tutorials/read_recording.html

@@ -376,7 +376,7 @@ <h1>Reading a Neon dataset/recording<a class="headerlink" href="#Reading-a-Neon-
 <p>In this tutorial, we will show how to load a single Neon recording downloaded from <a class="reference external" href="https://docs.pupil-labs.com/neon/pupil-cloud/">Pupil Cloud</a>.</p>
 <section id="Reading-sample-data">
 <h2>Reading sample data<a class="headerlink" href="#Reading-sample-data" title="Link to this heading">#</a></h2>
-<p>We will use a sample recording produced by the NCC Lab called <code class="docutils literal notranslate"><span class="pre">OfficeWalk</span></code>. It’s a project with 2 recordings and multiple enrichments and can be downloaded with the <code class="docutils literal notranslate"><span class="pre">get_sample_data()</span></code> function. It returns a <code class="docutils literal notranslate"><span class="pre">`Pathlib.Path</span></code> &lt;<a class="reference external" href="https://docs.python.org/3/library/pathlib.html">https://docs.python.org/3/library/pathlib.html</a>&gt;`__ object to the downloaded &amp; unzipped directory.</p>
+<p>We will use a sample recording produced by the NCC Lab called <code class="docutils literal notranslate"><span class="pre">OfficeWalk</span></code>. It’s a project with 2 recordings and multiple enrichments and can be downloaded with the <code class="docutils literal notranslate"><span class="pre">get_sample_data()</span></code> function. It returns a <code class="docutils literal notranslate"><span class="pre">Pathlib.Path</span></code> object to the downloaded &amp; unzipped directory.</p>
 <div class="nbinput nblast docutils container">
 <div class="prompt highlight-none notranslate"><div class="highlight"><pre><span></span>[1]:
 </pre></div>
@@ -405,7 +405,7 @@ <h2>Reading sample data<a class="headerlink" href="#Reading-sample-data" title="
 └── OfficeWalk_STATIC-IMAGE-MAPPER_ManualMap_csv
 </pre></div>
 </div>
-<p>The <code class="docutils literal notranslate"><span class="pre">Timeseries</span> <span class="pre">Data</span></code> folder contains what PyNeon calls a <code class="docutils literal notranslate"><span class="pre">`NeonDataset</span></code> &lt;<a class="reference external" href="https://ncc-brain.github.io/PyNeon/reference/dataset.html#pyneon.NeonDataset">https://ncc-brain.github.io/PyNeon/reference/dataset.html#pyneon.NeonDataset</a>&gt;`__. It contains multiple recordings, each with its own <code class="docutils literal notranslate"><span class="pre">info.json</span></code> file and data files. These recordings can either be loaded individually as a <code class="docutils literal notranslate"><span class="pre">`NeonRecording</span></code> &lt;<a class="reference external" href="https://ncc-brain.github.io/PyNeon/reference/recording.html#pyneon.NeonRecording">https://ncc-brain.github.io/PyNeon/reference/recording.html#pyneon.NeonRecording</a>&gt;`__ or as a wholist <code class="docutils literal notranslate"><span class="pre">NeonDataset</span></code>.</p>
+<p>The <code class="docutils literal notranslate"><span class="pre">Timeseries</span> <span class="pre">Data</span></code> folder contains what PyNeon calls a <code class="docutils literal notranslate"><span class="pre">NeonDataset</span></code>. It contains multiple recordings, each with its own <code class="docutils literal notranslate"><span class="pre">info.json</span></code> file and data files. These recordings can either be loaded individually as a <code class="docutils literal notranslate"><span class="pre">NeonRecording</span></code> as a wholist <code class="docutils literal notranslate"><span class="pre">NeonDataset</span></code>.</p>
 <p>If loading a <code class="docutils literal notranslate"><span class="pre">NeonDataset</span></code>, specify the path to the <code class="docutils literal notranslate"><span class="pre">Timeseries</span> <span class="pre">Data</span></code> folder to create a <code class="docutils literal notranslate"><span class="pre">NeonDataset</span></code> object:</p>
 <div class="nbinput docutils container">
 <div class="prompt highlight-none notranslate"><div class="highlight"><pre><span></span>[2]:

tutorials/read_recording.ipynb

@@ -8,7 +8,7 @@
     "In this tutorial, we will show how to load a single Neon recording downloaded from [Pupil Cloud](https://docs.pupil-labs.com/neon/pupil-cloud/).\n",
     "\n",
     "## Reading sample data\n",
-    "We will use a sample recording produced by the NCC Lab called `OfficeWalk`. It's a project with 2 recordings and multiple enrichments and can be downloaded with the `get_sample_data()` function. It returns a [`Pathlib.Path`](https://docs.python.org/3/library/pathlib.html) object to the downloaded & unzipped directory."
+    "We will use a sample recording produced by the NCC Lab called `OfficeWalk`. It's a project with 2 recordings and multiple enrichments and can be downloaded with the `get_sample_data()` function. It returns a `Pathlib.Path` object to the downloaded & unzipped directory."
    ]
   },
   {
@@ -46,7 +46,7 @@
     "└── OfficeWalk_STATIC-IMAGE-MAPPER_ManualMap_csv\n",
     "```\n",
     "\n",
-    "The `Timeseries Data` folder contains what PyNeon calls a [`NeonDataset`](https://ncc-brain.github.io/PyNeon/reference/dataset.html#pyneon.NeonDataset). It contains multiple recordings, each with its own `info.json` file and data files. These recordings can either be loaded individually as a [`NeonRecording`](https://ncc-brain.github.io/PyNeon/reference/recording.html#pyneon.NeonRecording) or as a wholist `NeonDataset`.\n",
+    "The `Timeseries Data` folder contains what PyNeon calls a `NeonDataset`. It contains multiple recordings, each with its own `info.json` file and data files. These recordings can either be loaded individually as a `NeonRecording` as a wholist `NeonDataset`.\n",
     "\n",
     "If loading a `NeonDataset`, specify the path to the `Timeseries Data` folder to create a `NeonDataset` object:"
    ]
@@ -451,7 +451,7 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "pyneon",
+   "display_name": "Python 3",
    "language": "python",
    "name": "python3"
   },