Jump to content

Contributions:NeuralynxADC: Difference between revisions

From BCI2000 Wiki
Madamek2 (talk | contribs)
Created page with "==Synopsis== The NeuralynxNetComADC allows data acquisition from [https://neuralynx.com/ Neuralynx] Cheetah or Pegasus system. <br> The module is able to record data with two..."
 
Madamek2 (talk | contribs)
No edit summary
Line 28: Line 28:


==Parameters==
==Parameters==
* '''SourceCh:''' The number of channels that the Neuralynx software reads (including the events channel if EventCh is on).
===Signal Properties===
* '''SamplingRate:''' This is the sampling rate of the Neuralynx software after subsampling. Use the value (with the decimals) as it appears in the Acquisition Entities panel of Neuralynx under the Sample Frequency entry when only one channel is selected.
Signal Properties describe Settings common to most Amplifiers.
* '''SourceChOffset:''' This is not used in the module.  Set it to 0 to be safe.
* '''SourceCh:''' The number of channels that the Neuralynx software reads.
* '''SourceChGain:''' This is also not used. Set it to 1.
* '''SampleBlockSize:''' Samples per channel per digitized block. Together with the sampling rate, this parameter determines how often per second data is collected, processed, and feedback is updated.
* '''SampleBlockSize:''' Neuralynx has a set packet of data acquisition of 512 points. Although the module will work with other values it is good to keep this parameter as a multiple of 512. This will provide a much more constant block time.  
* '''SamplingRate:''' Sampling rate of the data. The SamplingRate has to be an integer fraction of 32kHz.
* '''EventCh:''' A boolean parameter allowing the capture of the events channel of the Neuralynx software as an extra channel into the BCI2000 data stream. If this is set to yes then another channel must be added to the SourceCh, the ChannelNames, SourceChOffset and SourceChGain Parameters.
* '''ChannelNames:''' List of Names for Channels. Space-separated list; Must be the same length as Number of Channels. If set to auto, BCI2000 will query the Names from the Neuralynx system.
* '''SourceChOffset:''' Setting is not used in this module, default is 0
* '''SourceChGain:''' This is also not used, default is 1
===NeuralynxNetCom===
This Section describes Settings Necessary to communicate with the Cheetah/Pegasus System via the NetCom Interface
* '''ServerName:''' IP Address of the NetCom server (Typically the IP of your Cheetah/Pegasus System)
 
===NeuralynxUDPStream===
Settings if you want to use the Low Latency Stream. This requires a fiber-optic connection between the Amplifier and the BCI2000 computer.
 
* '''Boards:''' The Number of Boards which are connected in the Neuralynx Chassis
* '''SourceChnList:''' List of transmitted Channels. This allows you to only submit a subset of Channels. Its a list of channel ids (starting from 0). If set to auto, all channels will be transmitted.
* '''UseDirectUDPSTream:''' Easy way to switch the UDP stream on or off. This has to be enabled for low latency communication
* '''UDPStreamPort:''' Port through which the BCI2000 computer receives data from the Neuralynx System. This port is provided by Neuralynx.
* '''DecimationFactor:''' Decimation Factor for incoming Data. Incoming Data is sampled at 32kHz. If Decimation Factor is set, SamplingRate has to match or has to be set to auto. similarly, if SamplingRate is set, DecimationFactor can be set to auto and the system will determine the correct decimation factor automatically. Downsampling will be achieved by a simple moving average filter.
* '''NRDStreamingFile:''' Leave Empty. This can be used to stream data from a Neuralynx NRD file for debugging purposes.  


==States==
==States==

Revision as of 15:56, 15 July 2020

Synopsis

The NeuralynxNetComADC allows data acquisition from Neuralynx Cheetah or Pegasus system.
The module is able to record data with two different modes:
(1) Acquisition via the NetCom interface, which connects to Cheetah/Pegasus.
(2) Low-latency data acquisition via a fiber cable directly connected to the Acquisition amplifier.

Known Issues

BCI2000 will not be able to keep up for high sampling rates & channel counts. This will result in a high roundtrip time and increasing memory usage over time, as incoming data is buffered but not processed in time. If the low latency data acquisition is used, make sure to downsample data from 32kHz!

Location

Versioning

Authors

Markus Adamek

Version History

Source Code Revisions

  • Initial development: 6024
  • Tested under: --
  • Known to compile under: 6024
  • Broken since: --

Functional Description

Parameters

Signal Properties

Signal Properties describe Settings common to most Amplifiers.

  • SourceCh: The number of channels that the Neuralynx software reads.
  • SampleBlockSize: Samples per channel per digitized block. Together with the sampling rate, this parameter determines how often per second data is collected, processed, and feedback is updated.
  • SamplingRate: Sampling rate of the data. The SamplingRate has to be an integer fraction of 32kHz.
  • ChannelNames: List of Names for Channels. Space-separated list; Must be the same length as Number of Channels. If set to auto, BCI2000 will query the Names from the Neuralynx system.
  • SourceChOffset: Setting is not used in this module, default is 0
  • SourceChGain: This is also not used, default is 1

NeuralynxNetCom

This Section describes Settings Necessary to communicate with the Cheetah/Pegasus System via the NetCom Interface

  • ServerName: IP Address of the NetCom server (Typically the IP of your Cheetah/Pegasus System)

NeuralynxUDPStream

Settings if you want to use the Low Latency Stream. This requires a fiber-optic connection between the Amplifier and the BCI2000 computer.

  • Boards: The Number of Boards which are connected in the Neuralynx Chassis
  • SourceChnList: List of transmitted Channels. This allows you to only submit a subset of Channels. Its a list of channel ids (starting from 0). If set to auto, all channels will be transmitted.
  • UseDirectUDPSTream: Easy way to switch the UDP stream on or off. This has to be enabled for low latency communication
  • UDPStreamPort: Port through which the BCI2000 computer receives data from the Neuralynx System. This port is provided by Neuralynx.
  • DecimationFactor: Decimation Factor for incoming Data. Incoming Data is sampled at 32kHz. If Decimation Factor is set, SamplingRate has to match or has to be set to auto. similarly, if SamplingRate is set, DecimationFactor can be set to auto and the system will determine the correct decimation factor automatically. Downsampling will be achieved by a simple moving average filter.
  • NRDStreamingFile: Leave Empty. This can be used to stream data from a Neuralynx NRD file for debugging purposes.

States

See also

User Reference:Filters, Contributions:ADCs