Skip to content

Commit 8378e9d

Browse files
committed
Add more links and details to ONIX Source page
- Add a note about what will happen if memory usage continually goes up - Add links to the LFP Viewer plugin where appropriate - Add specifics of what the calibration file pattern should
1 parent bcfc724 commit 8378e9d

File tree

1 file changed

+14
-8
lines changed

1 file changed

+14
-8
lines changed

source/User-Manual/Plugins/Onix-Source.rst

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -207,6 +207,11 @@ total hardware buffer memory (see image below).
207207
.. image:: ../../_static/images/plugins/onixsource/memory-monitor-usage.png
208208
:alt: Memory Usage Monitor in the ONIX Source plugin
209209

210+
.. note::
211+
Ideally the memory usage should never go above 0%, and if it does go up it should quickly return
212+
to 0%. If the memory continually climbs up, eventually the acquisition session will terminate with
213+
an error
214+
210215
The memory usage is also saved as a stream in the ONIX Source plugin, allowing you to visualize
211216
memory usage over time in the GUI. This allows identification of trends in memory usage over longer
212217
recordings and supports diagnosis of performance issues related to memory usage. This data stream is
@@ -324,10 +329,10 @@ The Digital IO tab allows you to configure the Digital IO on the breakout board.
324329
be used to stream digital data from external devices, as well as to record digital events from
325330
button presses on the breakout board.
326331

327-
Digital data is saved as both continuous channels and events, and can be visualized using the "LFP
328-
Viewer" plugin. The digital channels are sampled at 25 kHz, and can be used to record button presses
329-
or digital inputs on the breakout board. The first 8 digital channels record the digital inputs, and
330-
the last 6 digital channels record the button presses.
332+
Digital data is saved as both continuous channels and events, and can be visualized using the
333+
:ref:`lfpviewer` plugin. The digital channels are sampled at 25 kHz, and can be used to record
334+
button presses or digital inputs on the breakout board. The first 8 digital channels record the
335+
digital inputs, and the last 6 digital channels record the button presses.
331336

332337
.. note::
333338
Digital channels are pulled high by default if no connection is given to the digital input. Events are overlaid on data, meaning that if no connections are made to any digital inputs, there will be eight event overlays on the data stream. To avoid this, you can either connect the digital inputs to ground, or disable the event overlays in the LFP Viewer.
@@ -338,7 +343,7 @@ Analog IO
338343
The Analog IO tab allows you to configure the Analog IO on the breakout board. The Analog IO can be
339344
used to stream analog data from external devices.
340345

341-
Analog data is saved as a separate data stream, and can be visualized using the "LFP Viewer" plugin.
346+
Analog data is saved as a separate data stream, and can be visualized using the :ref:`lfpviewer` plugin.
342347
There are twelve analog channels available, and all channels are always enabled to record data. The
343348
analog data is streamed at 25 kHz.
344349

@@ -517,12 +522,13 @@ any of the following triggers occur:
517522
- A new Neuropixels probe is connected, updating the probe serial number
518523

519524
The automated search uses the probe serial number to match files with the expected naming scheme.
520-
The name of the folder is not important, but the name of the file must match the naming scheme or it
521-
will not be automatically discovered.
525+
The name of the folder is not important, but the name of the file must match the calibration file
526+
naming scheme (e.g. :code:`<probe_serial_number>_ADCCalibration.csv` or
527+
:code:`<probe_serial_number>_gainCalValues.csv`)
522528

523529
The automated search algorithm will search up to two levels deep from the root folder selected,
524530
meaning that files can be automatically discovered in the root folder, or at most two folders away
525-
(e.g., `./<probe_serial_number>/*.csv` or `./np1_files/<probe_serial_number>/*.csv`). If the
531+
(e.g., :code:`./<probe_serial_number>/*.csv` or :code:`./np1_files/<probe_serial_number>/*.csv`). If the
526532
calibration file is nested too deeply, then the automated detection will not find it. Consider
527533
changing where the root directory is pointing to, or modify the folder structure to take advantage
528534
of the automated detection.

0 commit comments

Comments
 (0)