major update

ncc-brain · Sep 11, 2024 · 52d4e98 · 52d4e98
1 parent 3026b0b
commit 52d4e98
Show file tree

Hide file tree

Showing 40 changed files with 3,730 additions and 1,821 deletions.
diff --git a/docs/_images/tutorials_read_recording_17_1.png b/docs/_images/tutorials_read_recording_17_1.png
diff --git a/docs/_images/tutorials_read_recording_21_1.png b/docs/_images/tutorials_read_recording_21_1.png
diff --git a/docs/_images/tutorials_resample_and_concat_10_1.png b/docs/_images/tutorials_resample_and_concat_10_1.png
diff --git a/docs/_images/tutorials_resample_and_concat_12_1.png b/docs/_images/tutorials_resample_and_concat_12_1.png
diff --git a/docs/_images/tutorials_resample_and_concat_6_1.png b/docs/_images/tutorials_resample_and_concat_6_1.png
diff --git a/docs/_sources/index.rst.txt b/docs/_sources/index.rst.txt
@@ -10,7 +10,10 @@ eye-tracking data. It is a community-driven effort to provide a versatile set
 of tools to work with the rich data (gaze, eye states, IMU, events, etc.)
 provided by Neon.
 
-PyNeon is licensed under the MIT License.
+PyNeon works with the cloud-processed data from Pupil Cloud instead of
+"native" data from the Companion app. To read data in the "native" format, please
+see ``pl-neon-recording`` https://github.com/pupil-labs/pl-neon-recording/
+(which also inspired PyNeon).
 
 Here we provide tutorials and API reference to help you get started with PyNeon.
 
@@ -33,10 +36,11 @@ PyNeon works with the "Timeseries Data" or "Timeseries Data + Scene Video" forma
 as exported from Pupil Clouds. The data could be from a single recording or from a 
 project with multiple recordings.
 
-Credits
+License
 =======
 
-PyNeon was inspired by https://github.com/pupil-labs/pl-neon-recording/
+.. literalinclude:: ../LICENSE
+   :language: none
 
 .. toctree::
    :maxdepth: 2

diff --git a/docs/_sources/reference/index.rst.txt b/docs/_sources/reference/index.rst.txt
@@ -4,7 +4,7 @@ PyNeon API
 ==========
 
 .. toctree::
-    :maxdepth: 3
+    :maxdepth: 2
 
     dataset
     recording

diff --git a/docs/_sources/tutorials/index.rst.txt b/docs/_sources/tutorials/index.rst.txt
@@ -9,7 +9,6 @@ started with PyNeon.
 .. toctree::
     :maxdepth: 1
 
-    load_recording
-    load_dataset
+    read_recording
     resample_and_concat
     export_to_bids
diff --git a/docs/_sources/tutorials/load_dataset.ipynb.txt b/docs/_sources/tutorials/load_dataset.ipynb.txt
diff --git a/docs/_sources/tutorials/load_recording.ipynb.txt b/docs/_sources/tutorials/load_recording.ipynb.txt
diff --git a/docs/_sources/tutorials/read_recording.ipynb.txt b/docs/_sources/tutorials/read_recording.ipynb.txt
diff --git a/docs/_sources/tutorials/resample_and_concat.ipynb.txt b/docs/_sources/tutorials/resample_and_concat.ipynb.txt
diff --git a/docs/genindex.html b/docs/genindex.html
@@ -323,7 +323,8 @@
 <h1 id="index">Index</h1>
 
 <div class="genindex-jumpbox">
- <a href="#C"><strong>C</strong></a>
+ <a href="#B"><strong>B</strong></a>
+ | <a href="#C"><strong>C</strong></a>
  | <a href="#D"><strong>D</strong></a>
  | <a href="#E"><strong>E</strong></a>
  | <a href="#F"><strong>F</strong></a>
@@ -338,13 +339,23 @@ <h1 id="index">Index</h1>
  | <a href="#T"><strong>T</strong></a>
 
 </div>
+<h2 id="B">B</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="reference/recording.html#pyneon.NeonRecording.blinks">blinks (pyneon.NeonRecording property)</a>
+</li>
+  </ul></td>
+</tr></table>
+
 <h2 id="C">C</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="reference/preprocess.html#pyneon.preprocess.concat_channels">concat_channels() (in module pyneon.preprocess)</a>
+      <li><a href="reference/recording.html#pyneon.NeonRecording.concat_events">concat_events() (pyneon.NeonRecording method)</a>
+</li>
+      <li><a href="reference/preprocess.html#pyneon.preprocess.concat_streams">concat_streams() (in module pyneon.preprocess)</a>
 
       <ul>
-        <li><a href="reference/recording.html#pyneon.NeonRecording.concat_channels">(pyneon.NeonRecording method)</a>
+        <li><a href="reference/recording.html#pyneon.NeonRecording.concat_streams">(pyneon.NeonRecording method)</a>
 </li>
       </ul></li>
   </ul></td>
@@ -357,19 +368,23 @@ <h2 id="C">C</h2>
 <h2 id="D">D</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="reference/data.html#pyneon.data.NeonSignal.data">data (pyneon.data.NeonSignal attribute)</a>
+      <li><a href="reference/data.html#pyneon.data.NeonStream.data">data (pyneon.data.NeonStream attribute)</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="reference/dataset.html#pyneon.NeonDataset.dataset_dir">dataset_dir (pyneon.NeonDataset attribute)</a>
 </li>
-      <li><a href="reference/data.html#pyneon.data.NeonSignal.duration">duration (pyneon.data.NeonSignal attribute)</a>
+      <li><a href="reference/data.html#pyneon.data.NeonStream.duration">duration (pyneon.data.NeonStream attribute)</a>
 </li>
   </ul></td>
 </tr></table>
 
 <h2 id="E">E</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="reference/recording.html#pyneon.NeonRecording.events">events (pyneon.NeonRecording property)</a>
+</li>
+  </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="reference/recording.html#pyneon.NeonRecording.eye_states">eye_states (pyneon.NeonRecording property)</a>
 </li>
@@ -379,7 +394,11 @@ <h2 id="E">E</h2>
 <h2 id="F">F</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="reference/data.html#pyneon.data.NeonSignal.first_ts">first_ts (pyneon.data.NeonSignal attribute)</a>
+      <li><a href="reference/data.html#pyneon.data.NeonStream.first_ts">first_ts (pyneon.data.NeonStream attribute)</a>
+</li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="reference/recording.html#pyneon.NeonRecording.fixations">fixations (pyneon.NeonRecording property)</a>
 </li>
   </ul></td>
 </tr></table>
@@ -407,7 +426,7 @@ <h2 id="I">I</h2>
 <h2 id="L">L</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="reference/data.html#pyneon.data.NeonSignal.last_ts">last_ts (pyneon.data.NeonSignal attribute)</a>
+      <li><a href="reference/data.html#pyneon.data.NeonStream.last_ts">last_ts (pyneon.data.NeonStream attribute)</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
@@ -436,21 +455,31 @@ <h2 id="M">M</h2>
 <h2 id="N">N</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="reference/data.html#pyneon.data.NeonBlinks">NeonBlinks (class in pyneon.data)</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>
+      <li><a href="reference/data.html#pyneon.data.NeonEV">NeonEV (class in pyneon.data)</a>
+</li>
+      <li><a href="reference/data.html#pyneon.data.NeonEvents">NeonEvents (class in pyneon.data)</a>
 </li>
       <li><a href="reference/data.html#pyneon.data.NeonEyeStates">NeonEyeStates (class in pyneon.data)</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="reference/data.html#pyneon.data.NeonFixations">NeonFixations (class in pyneon.data)</a>
+</li>
       <li><a href="reference/data.html#pyneon.data.NeonGaze">NeonGaze (class in pyneon.data)</a>
 </li>
       <li><a href="reference/data.html#pyneon.data.NeonIMU">NeonIMU (class in pyneon.data)</a>
 </li>
       <li><a href="reference/recording.html#pyneon.NeonRecording">NeonRecording (class in pyneon)</a>
 </li>
-      <li><a href="reference/data.html#pyneon.data.NeonSignal">NeonSignal (class in pyneon.data)</a>
+      <li><a href="reference/data.html#pyneon.data.NeonSaccades">NeonSaccades (class in pyneon.data)</a>
+</li>
+      <li><a href="reference/data.html#pyneon.data.NeonStream">NeonStream (class in pyneon.data)</a>
 </li>
   </ul></td>
 </tr></table>
@@ -498,7 +527,7 @@ <h2 id="R">R</h2>
       <li><a href="reference/preprocess.html#pyneon.preprocess.resample">resample() (in module pyneon.preprocess)</a>
 
       <ul>
-        <li><a href="reference/data.html#pyneon.data.NeonSignal.resample">(pyneon.data.NeonSignal method)</a>
+        <li><a href="reference/data.html#pyneon.data.NeonStream.resample">(pyneon.data.NeonStream method)</a>
 </li>
       </ul></li>
   </ul></td>
@@ -507,12 +536,14 @@ <h2 id="R">R</h2>
 <h2 id="S">S</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="reference/data.html#pyneon.data.NeonSignal.sampling_freq_effective">sampling_freq_effective (pyneon.data.NeonSignal attribute)</a>
+      <li><a href="reference/recording.html#pyneon.NeonRecording.saccades">saccades (pyneon.NeonRecording property)</a>
 </li>
-      <li><a href="reference/data.html#pyneon.data.NeonSignal.sampling_freq_nominal">sampling_freq_nominal (pyneon.data.NeonSignal attribute)</a>
+      <li><a href="reference/data.html#pyneon.data.NeonStream.sampling_freq_effective">sampling_freq_effective (pyneon.data.NeonStream attribute)</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="reference/data.html#pyneon.data.NeonStream.sampling_freq_nominal">sampling_freq_nominal (pyneon.data.NeonStream attribute)</a>
+</li>
       <li><a href="reference/dataset.html#pyneon.NeonDataset.sections">sections (pyneon.NeonDataset attribute)</a>
 </li>
       <li><a href="reference/recording.html#pyneon.NeonRecording.start_datetime">start_datetime (pyneon.NeonRecording attribute)</a>
@@ -523,17 +554,17 @@ <h2 id="S">S</h2>
 <h2 id="T">T</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="reference/data.html#pyneon.data.NeonSignal.times">times (pyneon.data.NeonSignal attribute)</a>
+      <li><a href="reference/data.html#pyneon.data.NeonStream.times">times (pyneon.data.NeonStream attribute)</a>
 </li>
-      <li><a href="reference/data.html#pyneon.data.NeonSignal.timestamps">timestamps (pyneon.data.NeonSignal attribute)</a>
+      <li><a href="reference/data.html#pyneon.data.NeonStream.timestamps">timestamps (pyneon.data.NeonStream attribute)</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="reference/recording.html#pyneon.NeonRecording.to_eye_bids">to_eye_bids() (pyneon.NeonRecording method)</a>
 </li>
       <li><a href="reference/recording.html#pyneon.NeonRecording.to_motion_bids">to_motion_bids() (pyneon.NeonRecording method)</a>
 </li>
-      <li><a href="reference/data.html#pyneon.data.NeonSignal.ts">ts (pyneon.data.NeonSignal attribute)</a>
+      <li><a href="reference/data.html#pyneon.data.NeonStream.ts">ts (pyneon.data.NeonStream attribute)</a>
 </li>
   </ul></td>
 </tr></table>

diff --git a/docs/index.html b/docs/index.html
@@ -329,7 +329,10 @@
 eye-tracking data. It is a community-driven effort to provide a versatile set
 of tools to work with the rich data (gaze, eye states, IMU, events, etc.)
 provided by Neon.</p>
-<p>PyNeon is licensed under the MIT License.</p>
+<p>PyNeon works with the cloud-processed data from Pupil Cloud instead of
+“native” data from the Companion app. To read data in the “native” format, please
+see <code class="docutils literal notranslate"><span class="pre">pl-neon-recording</span></code> <a class="github reference external" href="https://github.com/pupil-labs/pl-neon-recording/">pupil-labs/pl-neon-recording</a>
+(which also inspired PyNeon).</p>
 <p>Here we provide tutorials and API reference to help you get started with PyNeon.</p>
 </section>
 <section id="installation">
@@ -347,9 +350,31 @@ <h1>Data format<a class="headerlink" href="#data-format" title="Link to this hea
 as exported from Pupil Clouds. The data could be from a single recording or from a
 project with multiple recordings.</p>
 </section>
-<section id="credits">
-<h1>Credits<a class="headerlink" href="#credits" title="Link to this heading">#</a></h1>
-<p>PyNeon was inspired by <a class="github reference external" href="https://github.com/pupil-labs/pl-neon-recording/">pupil-labs/pl-neon-recording</a></p>
+<section id="license">
+<h1>License<a class="headerlink" href="#license" title="Link to this heading">#</a></h1>
+<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>MIT License
+
+Copyright (c) 2024 PyNeon developers
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the &quot;Software&quot;), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED &quot;AS IS&quot;, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+</pre></div>
+</div>
 <div class="toctree-wrapper compound">
 </div>
 </section>

diff --git a/docs/objects.inv b/docs/objects.inv