Skip to content
Closed
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
79 commits
Select commit Hold shift + click to select a range
7de1bb8
Update Crossing Detector docs and images for v1.0
anjaldoshi Feb 9, 2025
ff1125d
Update Spectrum Viewer images
anjaldoshi Feb 10, 2025
e1450a6
Use standard page size for editor screenshots
anjaldoshi Feb 17, 2025
09d9bb8
Update Bandpass Filter documentation and images
anjaldoshi Feb 18, 2025
6e73281
Update Event Broadcaster editor image
anjaldoshi Feb 18, 2025
0eabe6d
Update LFP Viewer images and docs
anjaldoshi Feb 20, 2025
8a4cb98
Update Falcon Output images and docs
anjaldoshi Feb 25, 2025
7c482a8
Update Data Snapshot images and docs
anjaldoshi Feb 25, 2025
aa71dfa
Update Latency Histogram image
anjaldoshi Feb 28, 2025
9d4e374
Update Network Events image and docs
anjaldoshi Feb 28, 2025
a422e46
Update Online PSTH images
anjaldoshi Mar 6, 2025
cadf1e1
Update Neuropixels CAR editor image
anjaldoshi Mar 7, 2025
06fdd4f
Update OSC Events docs and images
anjaldoshi Mar 7, 2025
e33afb5
Update tracking plugin images
anjaldoshi Mar 7, 2025
89a1cd7
Update TTL Panels images
anjaldoshi Mar 7, 2025
cf1e009
Update ZMQ Interface images
anjaldoshi Mar 8, 2025
c33c0f5
Update merger and splitter images
anjaldoshi Mar 11, 2025
d71f22a
Update Probe Viewer and Neuropix-PXI docs and images
anjaldoshi Mar 15, 2025
243edd2
Update CNN Ripple docs
medengineer Mar 4, 2025
4f4f019
Update LSL Inlet docs
medengineer Mar 4, 2025
a2691dd
Update Mean Spike Rate docs
medengineer Mar 4, 2025
60081f5
Update Multi-Band Integrator docs
medengineer Mar 4, 2025
273252c
Update Pulse Pal Output docs
medengineer Mar 13, 2025
6158e09
Update Ripple Detector docs
medengineer Mar 15, 2025
d6a70fb
Add Source Sim docs
medengineer Mar 15, 2025
5c7694d
Update Spike Sorter docs
medengineer Mar 15, 2025
df4d395
Update Virtual Reference docs
medengineer Feb 26, 2025
d22c22e
Update Arduino docs
medengineer Mar 15, 2025
ff2e6b6
Update Spike Viewer docs
medengineer Mar 15, 2025
be53681
Update NIDAQmx docs
medengineer Mar 6, 2025
7b4c9be
Update Phase Detector docs
medengineer Mar 15, 2025
e914cc7
Update Record Node docs
medengineer Mar 15, 2025
e9f6f2d
Update File Reader docs
medengineer Mar 15, 2025
5e70b94
Update Channel Map docs
medengineer Mar 15, 2025
c13f7ab
Update Virtual Reference image
medengineer Mar 15, 2025
ca203c7
Update Acquisition Board docs
anjaldoshi Mar 15, 2025
aac45f8
Update Audio Monitor docs
anjaldoshi Mar 15, 2025
4f5a93b
Update Neuropixels-PXI images
anjaldoshi Mar 15, 2025
6286fc6
Update CAR docs
anjaldoshi Mar 16, 2025
de38dbc
Update Record Control docs
anjaldoshi Mar 16, 2025
de1e973
Update user guide
jsiegle Mar 16, 2025
4f54abc
Remove River Output plugin
jsiegle Mar 16, 2025
302b2e6
Merge branch 'juce8' of https://github.com/open-ephys/gui-docs into j…
jsiegle Mar 16, 2025
f68ffe9
Add Benchmarking page
jsiegle Mar 16, 2025
b99285b
Update CoreServices documentation
jsiegle Apr 4, 2025
4eed980
Update Data Thread documentation
jsiegle Apr 4, 2025
94e2581
Update File Source documentation
jsiegle Apr 4, 2025
8ae78c2
Update Record Engine documentation
jsiegle Apr 4, 2025
fc77258
Update Visualizer documentation
jsiegle Apr 4, 2025
592caf5
Update processor plugin documentation
jsiegle Apr 4, 2025
1a28348
Update FAQs
jsiegle Apr 6, 2025
664f74d
Fix matlab-tools link formatting
medengineer Apr 8, 2025
89e5fb0
intro to hardware used with the GUI
ChucklesOnGitHub Apr 9, 2025
087e195
sections
ChucklesOnGitHub Apr 9, 2025
d872506
added images
ChucklesOnGitHub Apr 9, 2025
ee8651f
typo
ChucklesOnGitHub Apr 9, 2025
12a2d71
onix initial text
ChucklesOnGitHub Apr 9, 2025
0951776
changed onix pic
ChucklesOnGitHub Apr 9, 2025
6cf8cae
acq-board 3d text and image
ChucklesOnGitHub Apr 9, 2025
21dd38c
uniformize. headstage options are missing in the npix parts
ChucklesOnGitHub Apr 9, 2025
36de261
onix1 doc link
ChucklesOnGitHub Apr 9, 2025
54d32fa
added links to plugins
ChucklesOnGitHub Apr 9, 2025
57dff3c
Update UI overview image
anjaldoshi Apr 23, 2025
ffb5b83
Add Scale Converter docs
medengineer Apr 25, 2025
4023d11
Update building a signal chain docs and images
anjaldoshi May 1, 2025
997f08c
Merge branch 'main' into juce8
bparks13 May 6, 2025
d146223
Fix missing refs, remove nonexistent pages
bparks13 May 6, 2025
5ea5f95
Some edits to ONIX hardware requirements
jonnew May 6, 2025
89d8b2d
Merge branch 'juce8' into hw-requirements
bparks13 May 8, 2025
ba487f1
Spelling fixes and link updates
bparks13 May 8, 2025
c17269c
Spelling and grammar check
bparks13 May 8, 2025
822691f
Add commutator plugin page (#54)
cjsha May 9, 2025
eb1e7e3
Update acq board plugin page for v3 (#55)
cjsha May 9, 2025
df690fc
addressed reviews
ChucklesOnGitHub May 9, 2025
32ba8b8
added onix to landing page
ChucklesOnGitHub May 9, 2025
d4e0b24
Fix merge conflict
jsiegle May 10, 2025
8fbfbdb
Split up computer requirements and compatible hardware
jsiegle May 10, 2025
f844439
Merge pull request #48 from open-ephys/hw-requirements
jsiegle May 12, 2025
152db21
Initial commutator tutorial progress
cjsha May 18, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Update NIDAQmx docs
  • Loading branch information
medengineer committed Mar 15, 2025
commit be53681f4e04c2e7d2d4d5cdeb3bbca130a24cbb
24 changes: 16 additions & 8 deletions source/User-Manual/Plugins/NIDAQmx.rst
Original file line number Diff line number Diff line change
Expand Up @@ -60,9 +60,17 @@ If you're using the NI-DAQmx plugin alongside the :ref:`neuropixelspxi` module,
Connecting to your NIDAQ hardware
##################################

When inserting the NI-DAQmx plugin from the Processor List into the Editor Viewport, the plugin automatically checks for all connected NI devices. If multiple devices are found, a 'Device Swap' button will appear in the top right corner of the plugin editor that acts as a toggle switch to cycle through all available devices. The plugin only searches for devices when initially is inserted into the EditorViewport. If a new device is connected after the plugin is inserted, you will need to drop a new NI-DAQmx plugin to detect the new device.
When inserting the NI-DAQmx plugin from the Processor List into the Editor Viewport, the plugin automatically checks for all connected NI devices. If multiple devices are found, all detected devices will be listed in the Device pull-down menu. The plugin only searches for devices when initially is inserted into the EditorViewport. If a new device is connected after the plugin is inserted, you will need to remove and drop a new NI-DAQmx plugin to select the new device.

The editor will automatically generate control buttons for each analog and digital input available on the selected NI device. Each analog channel contains a channel status toggle button as well as a terminal configuration toggle button. The channel status toggle button is set to on (green) by default for all channels and is intended to enable/disable channels on the fly. Toggling an enabled channel to off (gray) will simply 'zero-out' the data coming in on that channel.
The editor will automatically generate control buttons for each analog and digital input available on the selected NI device. Each analog channel contains a channel status toggle button as well as a terminal configuration toggle button. The channel status toggle button is set to on (green) by default for all channels and is intended to enable/disable channels on the fly. Toggling an enabled channel to off (gray) will simply 'zero-out' the data coming in on that channel.

The editor defaults to 8 analog and 8 digital channels which is common across most NI devices. If your device supports more channels, you can change the number of channels included in the plugin by using the Device configuration button directly above the Device pull-down menu. This will open the popover menu shown below:

.. image:: ../../_static/images/plugins/nidaqmx/NIDAQ-device-config.png
:alt: NI-DAQmx plugin device configuration popover
:align: center

In the above menu, in addition to setting the number of analog and digital channels, you can configure the digital read size to be 8, 16, or 32 bits, depending on what is supported by your NI device. Additionally you can configure which digital ports to be enabled as input. This is useful if you have a NI device with more than 8 digital channels, but you may want to use other ports for output. A NIDAQ Output plugin will be available soon!

Each analog channel also contains a terminal configuration toggle specific to the device connected. Possible terminal device configurations are RSE (Referenced Single-Ended), NRSE (Non-Referenced Single-Ended), DIFF (Differential), and PDIF (Pseudo-Differential). The terminal configuration toggle setting in the plugin should match the configuration in your experimental setup. Since most NI devices cannot infer the terminal configuration electronically, it is up to the user to ensure the module configuration matches the experimental setup prior to acquiring and recording data. An inconsistent terminal configuration can affect the amplitude and voltage offset of the incoming data.

Expand Down Expand Up @@ -94,18 +102,18 @@ The "aligned_timestamps" will now be aligned to the master clock, and are ready
Online Synchronization
#########################################

An Open Ephys Record Node can automatically synchronize data sources that share the same physical sync signal. Since each device acquires data asynchronously, a shared clock signal between two different devices will have different timestamps for corresponding TTL events. A Record Node can designate one of these channels as the main synchronization channel and scale the timestamps coming auxiliary devices to be in alignment with the main device.
An Open Ephys Record Node can automatically synchronize data sources that share the same physical sync signal. Since each device acquires data asynchronously, a shared clock signal between two different devices will have different sample numbers for corresponding TTL events. A Record Node can designate one of these channels as the main 'synchronization channel' and scale the timestamps coming auxiliary devices to be in alignment with the main device.

For Neuropixels probes, you can use the Neuropixels PXI as the main synchronization device by physically connecting the SMA output of the Neuropixels basestation to any digital input channel on the NIDAQ device.

In Open Ephys, place a :ref:`merger` before the Record Node and connect both the :ref:`neuropixelspxi` plugin and the NI-DAQmx plugin. The Record Node will show either one or two subprocessors per Neuropixels probe (depending if the 2.5kHz LFP band is included by the probe model) and one subprocessor for the NIDAQ device. Each subprocessor’s sync channel monitor will turn green if the digital line on that subprocessor is synchronized with any of the other subprocessors coming into that Record Node.
In Open Ephys, place a :ref:`merger` before the Record Node and connect both the :ref:`neuropixelspxi` plugin and the NI-DAQmx plugin. The Record Node will show either one or two streams per Neuropixels probe (depending if the 2.5kHz LFP band is included by the probe model) and one stream for the NIDAQ device. Each streams's sync channel monitor will turn green if the digital line on that stream is synchronized with any of the other streams coming into that Record Node.

.. image:: ../../_static/images/plugins/nidaqmx/NIDAQ_NPXMerged.png
.. image:: ../../_static/images/plugins/nidaqmx/nidaq-syncing.png
:alt: NI-DAQmx plugin syncing

Upon starting acquisition, the first and third sync channel monitors in the Record Node turn green first, as these contain the 30 kHz AP band of the probes and the source of the synchronization signal. Shortly after, the fifth sync channel monitor turns green, which contains the sync signal coming into the NIDAQ device from the Neuropixels probe's basestation.
Upon starting acquisition, the main sync channel monitor in the Record Node will turn green first. The remaining sync channel monitors will turn green as streams are synchronized with the main sync channel. It can take up to 10 seconds for the synchronizer to detect the synchronization signal across all streams to be synchronized.

.. image:: ../../_static/images/plugins/nidaqmx/NPX_NIDAQSynchronized.png
.. image:: ../../_static/images/plugins/nidaqmx/nidaq-synced.png
:alt: NI-DAQmx plugin synced

.. tip:: For more information about recording and synchronization in Open Ephys, please see the :ref:`recordingdata` page.
Expand Down Expand Up @@ -136,7 +144,7 @@ Furthermore, the analog input channels on the 6133 are well-isolated and there i

PXIe-6341
----------
The PXIe-6341 performs almost as well as the 6133, however, there is cross-talk across unused channels when applying the same test signal as above. That is, if a signal is physically connected to only the first analog input channel, a ghost of the signal will appear across all of the open analog input channels as shown below:
The PXIe-6341 performs almost as well as the 6133, however, there is cross-talk across unused channels when applying the same test signal as above. That is, if a signal is physically connected to only the first analog input channel, a 'ghost' of the signal will appear across all of the open analog input channels as shown below:

.. image:: ../../_static/images/plugins/nidaqmx/6341_SyncedPulse.png
:alt: NI-DAQmx plugin PXIE-6341 syned input signal
Expand Down
Binary file modified source/_static/images/plugins/nidaqmx/6133_SyncedPulse.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified source/_static/images/plugins/nidaqmx/6321_synced_ringing.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified source/_static/images/plugins/nidaqmx/6341_Combo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file not shown.
Binary file modified source/_static/images/plugins/nidaqmx/6341_SyncedPulse.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading