Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Nov 8, 2024
1 parent a4c829d commit 0e15689
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion User-Manual/Recording-data/Binary-format.html
Original file line number Diff line number Diff line change
Expand Up @@ -539,7 +539,7 @@ <h3>Continuous<a class="headerlink" href="#continuous" title="Permalink to this
<a class="reference internal image-reference" href="../../_images/continuous.png"><img alt="Binary data continuous format" src="../../_images/continuous.png" style="width: 300px;" /></a>
<p>Each <strong>continuous</strong> directory contains the following files:</p>
<ul class="simple">
<li><p><code class="code docutils literal notranslate"><span class="pre">continuous.dat</span></code>: A simple binary file containing <em>N</em> channels x <em>M</em> samples 16-bit integers in little-endian format. Data is saved as <code class="code docutils literal notranslate"><span class="pre">ch1_samp1,</span> <span class="pre">ch2_samp1,</span> <span class="pre">...</span> <span class="pre">chN_samp1,</span> <span class="pre">ch1_samp2,</span> <span class="pre">ch2_samp2,</span> <span class="pre">...,</span> <span class="pre">chN_sampM</span></code>. The value of the least significant bit needed to convert the 16-bit integers to physical units is specified in the <code class="code docutils literal notranslate"><span class="pre">bitVolts</span></code> field of the relevant channel in the <code class="code docutils literal notranslate"><span class="pre">structure.oebin</span></code> JSON file. For “headstage” channels, multiplying by <code class="code docutils literal notranslate"><span class="pre">bitVolts</span></code> converts the values to microvolts, whereas for “ADC” channels, <code class="code docutils literal notranslate"><span class="pre">bitVolts</span></code> converts the values to volts.</p></li>
<li><p><code class="code docutils literal notranslate"><span class="pre">continuous.dat</span></code>: A simple binary file containing <em>N</em> channels x <em>M</em> samples signed 16-bit integers in little-endian format. Data is saved as <code class="code docutils literal notranslate"><span class="pre">ch1_samp1,</span> <span class="pre">ch2_samp1,</span> <span class="pre">...</span> <span class="pre">chN_samp1,</span> <span class="pre">ch1_samp2,</span> <span class="pre">ch2_samp2,</span> <span class="pre">...,</span> <span class="pre">chN_sampM</span></code>. The value of the least significant bit needed to convert the signed 16-bit integers to physical units is specified in the <code class="code docutils literal notranslate"><span class="pre">bitVolts</span></code> field of the relevant channel in the <code class="code docutils literal notranslate"><span class="pre">structure.oebin</span></code> JSON file. For “headstage” channels, multiplying by <code class="code docutils literal notranslate"><span class="pre">bitVolts</span></code> converts the values to microvolts, whereas for “ADC” channels, <code class="code docutils literal notranslate"><span class="pre">bitVolts</span></code> converts the values to volts.</p></li>
<li><p><code class="code docutils literal notranslate"><span class="pre">sample_numbers.npy</span></code>: A numpy array containing <em>M</em> 64-bit integers that represent the index of each sample in the <code class="code docutils literal notranslate"><span class="pre">.dat</span></code> file since the start of acquisition. <strong>Note:</strong> This file was called <code class="code docutils literal notranslate"><span class="pre">timestamps.npy</span></code> in GUI version 0.5.X. To avoid ambiguity, “sample numbers” always refer to integer sample index values starting in version 0.6.0.</p></li>
<li><p><code class="code docutils literal notranslate"><span class="pre">timestamps.npy</span></code>: A numpy array containing <em>M</em> 64-bit floats representing the global timestamps in seconds relative to the start of the Record Node’s main data stream (assuming this stream was synchronized before starting recording). <strong>Note:</strong> This file was called <code class="code docutils literal notranslate"><span class="pre">synchronized_timestamps.npy</span></code> in GUI version 0.5.X. To avoid ambiguity, “timestamps” always refer to float values (in units of seconds) starting in version 0.6.0.</p></li>
</ul>
Expand Down
2 changes: 1 addition & 1 deletion _sources/User-Manual/Recording-data/Binary-format.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ Continuous data is written separately for each stream within a processor (a bloc

Each **continuous** directory contains the following files:

* :code:`continuous.dat`: A simple binary file containing *N* channels x *M* samples 16-bit integers in little-endian format. Data is saved as :code:`ch1_samp1, ch2_samp1, ... chN_samp1, ch1_samp2, ch2_samp2, ..., chN_sampM`. The value of the least significant bit needed to convert the 16-bit integers to physical units is specified in the :code:`bitVolts` field of the relevant channel in the :code:`structure.oebin` JSON file. For "headstage" channels, multiplying by :code:`bitVolts` converts the values to microvolts, whereas for "ADC" channels, :code:`bitVolts` converts the values to volts.
* :code:`continuous.dat`: A simple binary file containing *N* channels x *M* samples signed 16-bit integers in little-endian format. Data is saved as :code:`ch1_samp1, ch2_samp1, ... chN_samp1, ch1_samp2, ch2_samp2, ..., chN_sampM`. The value of the least significant bit needed to convert the signed 16-bit integers to physical units is specified in the :code:`bitVolts` field of the relevant channel in the :code:`structure.oebin` JSON file. For "headstage" channels, multiplying by :code:`bitVolts` converts the values to microvolts, whereas for "ADC" channels, :code:`bitVolts` converts the values to volts.

* :code:`sample_numbers.npy`: A numpy array containing *M* 64-bit integers that represent the index of each sample in the :code:`.dat` file since the start of acquisition. **Note:** This file was called :code:`timestamps.npy` in GUI version 0.5.X. To avoid ambiguity, "sample numbers" always refer to integer sample index values starting in version 0.6.0.

Expand Down
2 changes: 1 addition & 1 deletion searchindex.js

Large diffs are not rendered by default.

0 comments on commit 0e15689

Please sign in to comment.