BCI2000 Wiki - User contributions [en]

User Reference:Python FileLoader

2019-01-15T21:59:42Z

Madamek: Created page with "== Introduction == The [https://github.com/markusadamek/BCI2kReader BCI2kReader] package allows to read BCI2000 .dat files in Python. The reader is written completely in pytho..."

== Introduction ==
The [https://github.com/markusadamek/BCI2kReader BCI2kReader] package allows to read BCI2000 .dat files in Python. The reader is written completely in python and works with python 2 and python 3.

== Installing the package==

The package can either be installed with the python package manager (pip) or you can download the latest version from [https://github.com/markusadamek/BCI2kReader GitHub].

To install the package via pip:

pip install BCI2kReader

To get the latest (development) version from GitHub

git clone https://github.com/markusadamek/BCI2kReader

To Install the development version move to the cloned directory and run:
pip install .

== Usage ==

To use the reader you have to create a BCI2kReader object, which inherits from [https://docs.python.org/3/library/io.html#io.IOBase io.IOBase]. The reader has two basic modes, caching and non-caching. In caching mode, the BCI2kReader object will retain the data in memory as soon as a full readout of the file has taken place. If you need to save memory, the BCI2kReader object also supports that all read operations are done directly from the file.

=== Reading a File ===
The simplest way to open a file is with pythons with command (see https://docs.python.org/3/tutorial/inputoutput.html#methods-of-file-objects for more information about file IO and the with statement).

from BCI2kReader import BCI2kReader as b2k

with b2k.BCI2kReader('yourbci2000testfile.dat') as file:

if you want to open the file without caching enabled:

with b2k.BCI2kReader('yourbci2000testfile.dat', False) as file:

It is also possible to clear the cache to free memory:
file.purge()

=== Getting Data from the object ===

The easiest way to get the data is to use the properties for signals and states. The signals are provided as a [https://docs.scipy.org/doc/numpy-1.15.0/reference/generated/numpy.ndarray.html numpy ndarray] with the dimensions (channels, samples). The states are provided as a StateDictionary which inherits from [https://docs.python.org/3/tutorial/datastructures.html#dictionaries dict] with the state name as key.

eeg_data = file.signals
states = file.states

=== Working with random access ===

User Reference:gUnicornADC

2019-01-04T22:21:31Z

Madamek: /* Function */

==Function==
The gUSBampADC filter acquires data from a Unicorn EEG amplifier. Unicorn is an amplifier/digitizer combination from g.tec medical engineering GmbH/Guger Technologies OEG (https://www.unicorn-bi.com/).

===Unicorn Hardware===
The Unicorn consists of 8 independent 24-bit A/D converters that sample with 250Hz per channel. In addition, the Unicorn features a 3-axis accelerometer and a 3-axis gyroscope. The data is transmitted wirelessly via a Bluetooth 2.1 interface. Since the Unicorn device itself does not offer hardware filters the [[User_Reference:SourceFilter | Source Filter]] module is enabled to provide filtering capabilities.

====Drivers====

==Parameters==

===SampleBlockSize===
Samples per channel per digitized block.
Together with the sampling rate, this parameter determines how often per second data are collected, processed, and feedback is updated. For example, at 600 Hz sampling and a SampleBlockSize of 20, the system (e.g., source signal display, signal processing, and stimulus presentation) would be updated 30 times per second.

===SamplingRate===
The Unicorn has a fixed sampling rate of 250 Hz.

===SourceCh===
Number of channels to be acquired from the device. if this parameter is set to auto, the number of channels will be determined by the ''SourceChannelList'' or ''ChannelNames'' respectively.

===SourceChList===
The list of channels that should be acquired from each device.
The total number of channels listed should correspond to ''SourceCh'' if it is not set to auto. The order of channels does not matter; i.e., '1 2 3 4' is the same as '2 3 1 4'.
Channels may not be listed twice; e.g., entering '1 2 3 4 5 6 7 1' will result in an error.
If this parameter is set to auto, the channels are equal to ''SourceCh'' in ascending order.

===SourceChGain===
''SourceChGain'' should be set to auto.

===SourceChOffset===
''SourceChOffset'' should be set to auto.

===ChannelNames===
Alias for each Channel. If ''ChannelNames'' are set to auto, the names will be set according to the standard positions defined by the Unicorn. If ''ChannelNames'' are set manually, a name must be assigned for each channel specified in ''SourceChannelList''.

==States==
===Counter===
The Counter is incremented with every received sample during data acquisition.

===AccelerationX===
X coordinate of the three-axis accelerometer.
===AccelerationY===
Y coordinate of the three-axis accelerometer.
===AccelerationZ===
Z coordinate of the three-axis accelerometer.
===GyroscopeX===
X coordinate of the three-axis gyroscope.
===GyroscopeY===
Y coordinate of the three-axis gyroscope.
===GyroscopeZ===
Z coordinate of the three-axis gyroscope.
===Battery===
Battery charge in percent.
===Validation===
The validation state indicates if samples were lost during data acquisition.

==See also==
[[User Reference:DataIOFilter]], [[Programming Reference:GenericADC Class]]
[[Category:Filters]][[Category:Data Acquisition]]

User Reference:gUnicornADC

2018-12-26T15:56:21Z

Madamek: /* SourceCh */

==Function==
The gUSBampADC filter acquires data from a Unicorn EEG amplifier. Unicorn is an amplifier/digitizer combination from g.tec medical engineering GmbH/Guger Technologies OEG (https://www.unicorn-bi.com/).

===Unicorn Hardware===
The Unicorn consists of 8 independent 24-bit A/D converters that sample with 250Hz per channel. In addition, the Unicorn features a 3-axis accelerometer and a 3-axis gyroscope. The data is transmitted wirelessly via a Bluetooth 2.1 interface.

====Drivers====

==Parameters==

===SampleBlockSize===
Samples per channel per digitized block.
Together with the sampling rate, this parameter determines how often per second data are collected, processed, and feedback is updated. For example, at 600 Hz sampling and a SampleBlockSize of 20, the system (e.g., source signal display, signal processing, and stimulus presentation) would be updated 30 times per second.

===SamplingRate===
The Unicorn has a fixed sampling rate of 250 Hz.

===SourceCh===
Number of channels to be acquired from the device. if this parameter is set to auto, the number of channels will be determined by the ''SourceChannelList'' or ''ChannelNames'' respectively.

===SourceChList===
The list of channels that should be acquired from each device.
The total number of channels listed should correspond to ''SourceCh'' if it is not set to auto. The order of channels does not matter; i.e., '1 2 3 4' is the same as '2 3 1 4'.
Channels may not be listed twice; e.g., entering '1 2 3 4 5 6 7 1' will result in an error.
If this parameter is set to auto, the channels are equal to ''SourceCh'' in ascending order.

===SourceChGain===
''SourceChGain'' should be set to auto.

===SourceChOffset===
''SourceChOffset'' should be set to auto.

===ChannelNames===
Alias for each Channel. If ''ChannelNames'' are set to auto, the names will be set according to the standard positions defined by the Unicorn. If ''ChannelNames'' are set manually, a name must be assigned for each channel specified in ''SourceChannelList''.

==States==
===Counter===
The Counter is incremented with every received sample during data acquisition.

===AccelerationX===
X coordinate of the three-axis accelerometer.
===AccelerationY===
Y coordinate of the three-axis accelerometer.
===AccelerationZ===
Z coordinate of the three-axis accelerometer.
===GyroscopeX===
X coordinate of the three-axis gyroscope.
===GyroscopeY===
Y coordinate of the three-axis gyroscope.
===GyroscopeZ===
Z coordinate of the three-axis gyroscope.
===Battery===
Battery charge in percent.
===Validation===
The validation state indicates if samples were lost during data acquisition.

==See also==
[[User Reference:DataIOFilter]], [[Programming Reference:GenericADC Class]]
[[Category:Filters]][[Category:Data Acquisition]]

User Reference:gUnicornADC

2018-12-26T15:56:13Z

Madamek: /* SamplingRate */

==Function==
The gUSBampADC filter acquires data from a Unicorn EEG amplifier. Unicorn is an amplifier/digitizer combination from g.tec medical engineering GmbH/Guger Technologies OEG (https://www.unicorn-bi.com/).

===Unicorn Hardware===
The Unicorn consists of 8 independent 24-bit A/D converters that sample with 250Hz per channel. In addition, the Unicorn features a 3-axis accelerometer and a 3-axis gyroscope. The data is transmitted wirelessly via a Bluetooth 2.1 interface.

====Drivers====

==Parameters==

===SampleBlockSize===
Samples per channel per digitized block.
Together with the sampling rate, this parameter determines how often per second data are collected, processed, and feedback is updated. For example, at 600 Hz sampling and a SampleBlockSize of 20, the system (e.g., source signal display, signal processing, and stimulus presentation) would be updated 30 times per second.

===SamplingRate===
The Unicorn has a fixed sampling rate of 250 Hz.

===SourceCh===
Number of channels to be acquired from the device. if this parameter is set to auto, the number of channels will be determined by the ''SourceChannelList'' or ''ChannelNames'' respectively.

===SourceChList===
The list of channels that should be acquired from each device.
The total number of channels listed should correspond to ''SourceCh'' if it is not set to auto. The order of channels does not matter; i.e., '1 2 3 4' is the same as '2 3 1 4'.
Channels may not be listed twice; e.g., entering '1 2 3 4 5 6 7 1' will result in an error.
If this parameter is set to auto, the channels are equal to ''SourceCh'' in ascending order.

===SourceChGain===
''SourceChGain'' should be set to auto.

===SourceChOffset===
''SourceChOffset'' should be set to auto.

===ChannelNames===
Alias for each Channel. If ''ChannelNames'' are set to auto, the names will be set according to the standard positions defined by the Unicorn. If ''ChannelNames'' are set manually, a name must be assigned for each channel specified in ''SourceChannelList''.

==States==
===Counter===
The Counter is incremented with every received sample during data acquisition.

===AccelerationX===
X coordinate of the three-axis accelerometer.
===AccelerationY===
Y coordinate of the three-axis accelerometer.
===AccelerationZ===
Z coordinate of the three-axis accelerometer.
===GyroscopeX===
X coordinate of the three-axis gyroscope.
===GyroscopeY===
Y coordinate of the three-axis gyroscope.
===GyroscopeZ===
Z coordinate of the three-axis gyroscope.
===Battery===
Battery charge in percent.
===Validation===
The validation state indicates if samples were lost during data acquisition.

==See also==
[[User Reference:DataIOFilter]], [[Programming Reference:GenericADC Class]]
[[Category:Filters]][[Category:Data Acquisition]]

User Reference:gUnicornADC

2018-12-26T15:40:27Z

Madamek: /* Additional Information */

==Function==
The gUSBampADC filter acquires data from a Unicorn EEG amplifier. Unicorn is an amplifier/digitizer combination from g.tec medical engineering GmbH/Guger Technologies OEG (https://www.unicorn-bi.com/).

===Unicorn Hardware===
The Unicorn consists of 8 independent 24-bit A/D converters that sample with 250Hz per channel. In addition, the Unicorn features a 3-axis accelerometer and a 3-axis gyroscope. The data is transmitted wirelessly via a Bluetooth 2.1 interface.

====Drivers====

==Parameters==

===SampleBlockSize===
Samples per channel per digitized block.
Together with the sampling rate, this parameter determines how often per second data are collected, processed, and feedback is updated. For example, at 600 Hz sampling and a SampleBlockSize of 20, the system (e.g., source signal display, signal processing, and stimulus presentation) would be updated 30 times per second.

===SamplingRate===
The Unicorn has a fixed sampling rate of 250 Hz.

===SourceCh===
Number of channels to be acquired from the device. if this parameter is set to auto, the number of channels will be determined by the ''SourceChannelList'' or ''ChannelNames'' respectively.

===SourceChList===
The list of channels that should be acquired from each device.
The total number of channels listed should correspond to ''SourceCh'' if it is not set to auto. The order of channels does not matter; i.e., '1 2 3 4' is the same as '2 3 1 4'.
Channels may not be listed twice; e.g., entering '1 2 3 4 5 6 7 1' will result in an error.
If this parameter is set to auto, the channels are equal to ''SourceCh'' in ascending order.

===SourceChGain===
''SourceChGain'' should be set to auto.

===SourceChOffset===
''SourceChOffset'' should be set to auto.

===ChannelNames===
Alias for each Channel. If ''ChannelNames'' are set to auto, the names will be set according to the standard positions defined by the Unicorn. If ''ChannelNames'' are set manually, a name must be assigned for each channel specified in ''SourceChannelList''.

==States==
===Counter===
The Counter is incremented with every received sample during data acquisition.

===AccelerationX===
X coordinate of the three-axis accelerometer.
===AccelerationY===
Y coordinate of the three-axis accelerometer.
===AccelerationZ===
Z coordinate of the three-axis accelerometer.
===GyroscopeX===
X coordinate of the three-axis gyroscope.
===GyroscopeY===
Y coordinate of the three-axis gyroscope.
===GyroscopeZ===
Z coordinate of the three-axis gyroscope.
===Battery===
Battery charge in percent.
===Validation===
The validation state indicates if samples were lost during data acquisition.

==See also==
[[User Reference:DataIOFilter]], [[Programming Reference:GenericADC Class]]
[[Category:Filters]][[Category:Data Acquisition]]

User Reference:gUnicornADC

2018-12-26T15:39:15Z

Madamek: /* States */

==Function==
The gUSBampADC filter acquires data from a Unicorn EEG amplifier. Unicorn is an amplifier/digitizer combination from g.tec medical engineering GmbH/Guger Technologies OEG (https://www.unicorn-bi.com/).

===Unicorn Hardware===
The Unicorn consists of 8 independent 24-bit A/D converters that sample with 250Hz per channel. In addition, the Unicorn features a 3-axis accelerometer and a 3-axis gyroscope. The data is transmitted wirelessly via a Bluetooth 2.1 interface.

====Drivers====

==Parameters==

===SampleBlockSize===
Samples per channel per digitized block.
Together with the sampling rate, this parameter determines how often per second data are collected, processed, and feedback is updated. For example, at 600 Hz sampling and a SampleBlockSize of 20, the system (e.g., source signal display, signal processing, and stimulus presentation) would be updated 30 times per second.

===SamplingRate===
The Unicorn has a fixed sampling rate of 250 Hz.

===SourceCh===
Number of channels to be acquired from the device. if this parameter is set to auto, the number of channels will be determined by the ''SourceChannelList'' or ''ChannelNames'' respectively.

===SourceChList===
The list of channels that should be acquired from each device.
The total number of channels listed should correspond to ''SourceCh'' if it is not set to auto. The order of channels does not matter; i.e., '1 2 3 4' is the same as '2 3 1 4'.
Channels may not be listed twice; e.g., entering '1 2 3 4 5 6 7 1' will result in an error.
If this parameter is set to auto, the channels are equal to ''SourceCh'' in ascending order.

===SourceChGain===
''SourceChGain'' should be set to auto.

===SourceChOffset===
''SourceChOffset'' should be set to auto.

===ChannelNames===
Alias for each Channel. If ''ChannelNames'' are set to auto, the names will be set according to the standard positions defined by the Unicorn. If ''ChannelNames'' are set manually, a name must be assigned for each channel specified in ''SourceChannelList''.

==States==
===Counter===
The Counter is incremented with every received sample during data acquisition.

===AccelerationX===
X coordinate of the three-axis accelerometer.
===AccelerationY===
Y coordinate of the three-axis accelerometer.
===AccelerationZ===
Z coordinate of the three-axis accelerometer.
===GyroscopeX===
X coordinate of the three-axis gyroscope.
===GyroscopeY===
Y coordinate of the three-axis gyroscope.
===GyroscopeZ===
Z coordinate of the three-axis gyroscope.
===Battery===
Battery charge in percent.
===Validation===
The validation state indicates if samples were lost during data acquisition.

==Additional Information==

===Using 32bit Executables on 64bit Installations===
BCI2000 supports compilation of the gUSBamp source module for 64bit targets. The resulting executable will run on 64bit systems, and work with the 64bit version of the gUSBamp drivers. However, the binary distribution of BCI2000 contains 32bit executables. These run fine under 64bit systems, but you will need to perform these additional driver installation steps to install 32bit gUSBamp API DLLs on 64bit systems:
*Execute gtec's 32bit driver installer on your 64bit system.
*After successful installation, execute gtec's 64bit driver installer on your 64bit system.
*You will now have both the 32bit API DLL and the 64bit API DLL installed, such that both 32bit and 64bit executables will be able to connect to a gUSBamp attached to the system's USB ports.

==See also==
[[User Reference:DataIOFilter]], [[Programming Reference:GenericADC Class]]
[[Category:Filters]][[Category:Data Acquisition]]

User Reference:gUnicornADC

2018-12-26T15:36:01Z

Madamek: /* Counter */

==Function==
The gUSBampADC filter acquires data from a Unicorn EEG amplifier. Unicorn is an amplifier/digitizer combination from g.tec medical engineering GmbH/Guger Technologies OEG (https://www.unicorn-bi.com/).

===Unicorn Hardware===
The Unicorn consists of 8 independent 24-bit A/D converters that sample with 250Hz per channel. In addition, the Unicorn features a 3-axis accelerometer and a 3-axis gyroscope. The data is transmitted wirelessly via a Bluetooth 2.1 interface.

====Drivers====

==Parameters==

===SampleBlockSize===
Samples per channel per digitized block.
Together with the sampling rate, this parameter determines how often per second data are collected, processed, and feedback is updated. For example, at 600 Hz sampling and a SampleBlockSize of 20, the system (e.g., source signal display, signal processing, and stimulus presentation) would be updated 30 times per second.

===SamplingRate===
The Unicorn has a fixed sampling rate of 250 Hz.

===SourceCh===
Number of channels to be acquired from the device. if this parameter is set to auto, the number of channels will be determined by the ''SourceChannelList'' or ''ChannelNames'' respectively.

===SourceChList===
The list of channels that should be acquired from each device.
The total number of channels listed should correspond to ''SourceCh'' if it is not set to auto. The order of channels does not matter; i.e., '1 2 3 4' is the same as '2 3 1 4'.
Channels may not be listed twice; e.g., entering '1 2 3 4 5 6 7 1' will result in an error.
If this parameter is set to auto, the channels are equal to ''SourceCh'' in ascending order.

===SourceChGain===
''SourceChGain'' should be set to auto.

===SourceChOffset===
''SourceChOffset'' should be set to auto.

===ChannelNames===
Alias for each Channel. If ''ChannelNames'' are set to auto, the names will be set according to the standard positions defined by the Unicorn. If ''ChannelNames'' are set manually, a name must be assigned for each channel specified in ''SourceChannelList''.

==States==
===Counter===
The Counter is incremented with every received sample during data acquisition.

===AccelerationX===
===AccelerationY===
===AccelerationZ===
===GyroscopeX===
===GyroscopeY===
===GyroscopeZ===
===Battery===
===Validation===

==Additional Information==

===Using 32bit Executables on 64bit Installations===
BCI2000 supports compilation of the gUSBamp source module for 64bit targets. The resulting executable will run on 64bit systems, and work with the 64bit version of the gUSBamp drivers. However, the binary distribution of BCI2000 contains 32bit executables. These run fine under 64bit systems, but you will need to perform these additional driver installation steps to install 32bit gUSBamp API DLLs on 64bit systems:
*Execute gtec's 32bit driver installer on your 64bit system.
*After successful installation, execute gtec's 64bit driver installer on your 64bit system.
*You will now have both the 32bit API DLL and the 64bit API DLL installed, such that both 32bit and 64bit executables will be able to connect to a gUSBamp attached to the system's USB ports.

==See also==
[[User Reference:DataIOFilter]], [[Programming Reference:GenericADC Class]]
[[Category:Filters]][[Category:Data Acquisition]]

User Reference:gUnicornADC

2018-12-26T15:28:06Z

Madamek: /* SourceChannelList */

==Function==
The gUSBampADC filter acquires data from a Unicorn EEG amplifier. Unicorn is an amplifier/digitizer combination from g.tec medical engineering GmbH/Guger Technologies OEG (https://www.unicorn-bi.com/).

===Unicorn Hardware===
The Unicorn consists of 8 independent 24-bit A/D converters that sample with 250Hz per channel. In addition, the Unicorn features a 3-axis accelerometer and a 3-axis gyroscope. The data is transmitted wirelessly via a Bluetooth 2.1 interface.

====Drivers====

==Parameters==

===SampleBlockSize===
Samples per channel per digitized block.
Together with the sampling rate, this parameter determines how often per second data are collected, processed, and feedback is updated. For example, at 600 Hz sampling and a SampleBlockSize of 20, the system (e.g., source signal display, signal processing, and stimulus presentation) would be updated 30 times per second.

===SamplingRate===
The Unicorn has a fixed sampling rate of 250 Hz.

===SourceCh===
Number of channels to be acquired from the device. if this parameter is set to auto, the number of channels will be determined by the ''SourceChannelList'' or ''ChannelNames'' respectively.

===SourceChList===
The list of channels that should be acquired from each device.
The total number of channels listed should correspond to ''SourceCh'' if it is not set to auto. The order of channels does not matter; i.e., '1 2 3 4' is the same as '2 3 1 4'.
Channels may not be listed twice; e.g., entering '1 2 3 4 5 6 7 1' will result in an error.
If this parameter is set to auto, the channels are equal to ''SourceCh'' in ascending order.

===SourceChGain===
''SourceChGain'' should be set to auto.

===SourceChOffset===
''SourceChOffset'' should be set to auto.

===ChannelNames===
Alias for each Channel. If ''ChannelNames'' are set to auto, the names will be set according to the standard positions defined by the Unicorn. If ''ChannelNames'' are set manually, a name must be assigned for each channel specified in ''SourceChannelList''.

==States==
===Counter===
===AccelerationX===
===AccelerationY===
===AccelerationZ===
===GyroscopeX===
===GyroscopeY===
===GyroscopeZ===
===Battery===
===Validation===

==Additional Information==

===Using 32bit Executables on 64bit Installations===
BCI2000 supports compilation of the gUSBamp source module for 64bit targets. The resulting executable will run on 64bit systems, and work with the 64bit version of the gUSBamp drivers. However, the binary distribution of BCI2000 contains 32bit executables. These run fine under 64bit systems, but you will need to perform these additional driver installation steps to install 32bit gUSBamp API DLLs on 64bit systems:
*Execute gtec's 32bit driver installer on your 64bit system.
*After successful installation, execute gtec's 64bit driver installer on your 64bit system.
*You will now have both the 32bit API DLL and the 64bit API DLL installed, such that both 32bit and 64bit executables will be able to connect to a gUSBamp attached to the system's USB ports.

==See also==
[[User Reference:DataIOFilter]], [[Programming Reference:GenericADC Class]]
[[Category:Filters]][[Category:Data Acquisition]]

User Reference:gUnicornADC

2018-12-26T15:21:15Z

Madamek: /* Parameters */

==Function==
The gUSBampADC filter acquires data from a Unicorn EEG amplifier. Unicorn is an amplifier/digitizer combination from g.tec medical engineering GmbH/Guger Technologies OEG (https://www.unicorn-bi.com/).

===Unicorn Hardware===
The Unicorn consists of 8 independent 24-bit A/D converters that sample with 250Hz per channel. In addition, the Unicorn features a 3-axis accelerometer and a 3-axis gyroscope. The data is transmitted wirelessly via a Bluetooth 2.1 interface.

====Drivers====

==Parameters==

===SampleBlockSize===
Samples per channel per digitized block.
Together with the sampling rate, this parameter determines how often per second data are collected, processed, and feedback is updated. For example, at 600 Hz sampling and a SampleBlockSize of 20, the system (e.g., source signal display, signal processing, and stimulus presentation) would be updated 30 times per second.

===SamplingRate===
The Unicorn has a fixed sampling rate of 250 Hz.

===SourceCh===
Number of channels to be acquired from the device. if this parameter is set to auto, the number of channels will be determined by the ''SourceChannelList'' or ''ChannelNames'' respectively.

===SourceChannelList===
The list of channels that should be acquired from each device.
The total number of channels listed should correspond to ''SourceCh'' if it is not set to auto. The order of channels does not matter; i.e., '1 2 3 4' is the same as '2 3 1 4'.
Channels may not be listed twice; e.g., entering '1 2 3 4 5 6 7 1' will result in an error.
If this parameter is set to auto, the channels are equal to ''SourceCh'' in ascending order.

===SourceChGain===
''SourceChGain'' should be set to auto.

===SourceChOffset===
''SourceChOffset'' should be set to auto.

===ChannelNames===
Alias for each Channel. If ''ChannelNames'' are set to auto, the names will be set according to the standard positions defined by the Unicorn. If ''ChannelNames'' are set manually, a name must be assigned for each channel specified in ''SourceChannelList''.

==States==
===Counter===
===AccelerationX===
===AccelerationY===
===AccelerationZ===
===GyroscopeX===
===GyroscopeY===
===GyroscopeZ===
===Battery===
===Validation===

==Additional Information==

===Using 32bit Executables on 64bit Installations===
BCI2000 supports compilation of the gUSBamp source module for 64bit targets. The resulting executable will run on 64bit systems, and work with the 64bit version of the gUSBamp drivers. However, the binary distribution of BCI2000 contains 32bit executables. These run fine under 64bit systems, but you will need to perform these additional driver installation steps to install 32bit gUSBamp API DLLs on 64bit systems:
*Execute gtec's 32bit driver installer on your 64bit system.
*After successful installation, execute gtec's 64bit driver installer on your 64bit system.
*You will now have both the 32bit API DLL and the 64bit API DLL installed, such that both 32bit and 64bit executables will be able to connect to a gUSBamp attached to the system's USB ports.

==See also==
[[User Reference:DataIOFilter]], [[Programming Reference:GenericADC Class]]
[[Category:Filters]][[Category:Data Acquisition]]

User Reference:gUnicornADC

2018-12-26T14:56:34Z

Madamek: /* Function */

==Function==
The gUSBampADC filter acquires data from a Unicorn EEG amplifier. Unicorn is an amplifier/digitizer combination from g.tec medical engineering GmbH/Guger Technologies OEG (https://www.unicorn-bi.com/).

===Unicorn Hardware===
The Unicorn consists of 8 independent 24-bit A/D converters that sample with 250Hz per channel. In addition, the Unicorn features a 3-axis accelerometer and a 3-axis gyroscope. The data is transmitted wirelessly via a Bluetooth 2.1 interface.

====Drivers====

==Parameters==

===SampleBlockSize===
Samples per channel per digitized block.
Together with the sampling rate, this parameter determines how often per second data are collected, processed, and feedback is updated. For example, at 600 Hz sampling and a SampleBlockSize of 20, the system (e.g., source signal display, signal processing, and stimulus presentation) would be updated 30 times per second.

===SamplingRate===

===SourceCh===

===SourceChannelList===
The list of channels that should be acquired from each device.
The total number of channels listed should correspond to ''SourceCh''. For more than one device, ''SourceChDevices'' determines how the ''SourceChList'' values are mapped to each device. For example if ''SourceChDevices'' = '8 8' and ''SourceChList'' = '1 2 3 4 13 14 15 16 5 6 7 8 9 10 11 12', then channels 1-4 and 13-16 will be acquired on the first device, and channels 5-12 will be acquired on the second device. These channels will be saved in the data file as 16 contiguous channels.
The order of channels does not matter; i.e., '1 2 3 4' is the same as '2 3 1 4'. The channels are always in ascending order on a single device.
Channels may not be listed twice on a single device; e.g., entering '1 2 3 4 5 6 7 1' if ''SourceChDevices'' = '8' will result in an error.
If this parameter is left blank (the default), then all channels are acquired on all devices.

===SourceChGain===

===SourceChOffset===

===ChannelNames===

==States==
===Counter===
===AccelerationX===
===AccelerationY===
===AccelerationZ===
===GyroscopeX===
===GyroscopeY===
===GyroscopeZ===
===Battery===
===Validation===

==Additional Information==

===Using 32bit Executables on 64bit Installations===
BCI2000 supports compilation of the gUSBamp source module for 64bit targets. The resulting executable will run on 64bit systems, and work with the 64bit version of the gUSBamp drivers. However, the binary distribution of BCI2000 contains 32bit executables. These run fine under 64bit systems, but you will need to perform these additional driver installation steps to install 32bit gUSBamp API DLLs on 64bit systems:
*Execute gtec's 32bit driver installer on your 64bit system.
*After successful installation, execute gtec's 64bit driver installer on your 64bit system.
*You will now have both the 32bit API DLL and the 64bit API DLL installed, such that both 32bit and 64bit executables will be able to connect to a gUSBamp attached to the system's USB ports.

==See also==
[[User Reference:DataIOFilter]], [[Programming Reference:GenericADC Class]]
[[Category:Filters]][[Category:Data Acquisition]]

User Reference:gUnicornADC

2018-12-21T20:21:15Z

Madamek: /* Data Storage */

User Reference:gUnicornADC

2018-12-21T20:20:38Z

Madamek: /* States */

==Function==

===g.Unicorn Hardware===

====Drivers====

==Parameters==

===SampleBlockSize===
Samples per channel per digitized block.
Together with the sampling rate, this parameter determines how often per second data are collected, processed, and feedback is updated. For example, at 600 Hz sampling and a SampleBlockSize of 20, the system (e.g., source signal display, signal processing, and stimulus presentation) would be updated 30 times per second.

===SamplingRate===

===SourceCh===

===SourceChannelList===
The list of channels that should be acquired from each device.
The total number of channels listed should correspond to ''SourceCh''. For more than one device, ''SourceChDevices'' determines how the ''SourceChList'' values are mapped to each device. For example if ''SourceChDevices'' = '8 8' and ''SourceChList'' = '1 2 3 4 13 14 15 16 5 6 7 8 9 10 11 12', then channels 1-4 and 13-16 will be acquired on the first device, and channels 5-12 will be acquired on the second device. These channels will be saved in the data file as 16 contiguous channels.
The order of channels does not matter; i.e., '1 2 3 4' is the same as '2 3 1 4'. The channels are always in ascending order on a single device.
Channels may not be listed twice on a single device; e.g., entering '1 2 3 4 5 6 7 1' if ''SourceChDevices'' = '8' will result in an error.
If this parameter is left blank (the default), then all channels are acquired on all devices.

===SourceChGain===

===SourceChOffset===

===ChannelNames===

==States==
===Counter===
===AccelerationX===
===AccelerationY===
===AccelerationZ===
===GyroscopeX===
===GyroscopeY===
===GyroscopeZ===
===Battery===
===Validation===

==Additional Information==

===Using 32bit Executables on 64bit Installations===
BCI2000 supports compilation of the gUSBamp source module for 64bit targets. The resulting executable will run on 64bit systems, and work with the 64bit version of the gUSBamp drivers. However, the binary distribution of BCI2000 contains 32bit executables. These run fine under 64bit systems, but you will need to perform these additional driver installation steps to install 32bit gUSBamp API DLLs on 64bit systems:
*Execute gtec's 32bit driver installer on your 64bit system.
*After successful installation, execute gtec's 64bit driver installer on your 64bit system.
*You will now have both the 32bit API DLL and the 64bit API DLL installed, such that both 32bit and 64bit executables will be able to connect to a gUSBamp attached to the system's USB ports.

===Data Storage===
Unlike other systems, the USBamp is a DC amplifier system that digitizes at 24 bit.
Bandpass and notch filtering is performed on the digitized samples, resulting in floating point signal samples in units of <math>\mu V</math>.
BCI2000 currently supports signed 16 bit integers and floating point numbers for its data storage.
If ''SignalType'' is set to int16, the floating point values have to be converted back into integers before they can be stored and transmitted to Signal Processing.
This is done by the following transformation:

<math>\mathrm{sample}_\mathrm{stored}\mathrm{(A/D\,units)}=\frac{\mathrm{sample}_\mathrm{acquired}(\mu V)}\mathrm{SourceChGain}</math>.

(''SourceChOffset'' is assumed (and required) to be zero for all channels.)
BCI2000 Signal Processing or any offline analysis routine can derive, as with
any other BCI2000 source module, sample values in <math>\mu V</math> by subtracting, from
each stored sample, ''SourceChOffset'' (i.e., zero), and multiplying it with
''SourceChGain'' for each channel. If ''SignalType'' is set to float32,
data samples are stored in units of <math>\mu V</math>. In this case, ''SourceChGain'' should be
a list of 1's (because the conversion factor between data samples into <math>\mu V</math> is
1.0 for each channel).

Still, when values other than 0 and 1 are specified, a consistent data file will be produced, i.e. values will be transformed before they are written to the file, such that applying SourceChOffset and SourceChGain will reproduce the original values in <math>\mu V</math>.

==See also==
[[User Reference:DataIOFilter]], [[Programming Reference:GenericADC Class]]
[[Category:Filters]][[Category:Data Acquisition]]

User Reference:gUnicornADC

2018-12-21T20:19:13Z

Madamek: /* Parameters */

==Function==

===g.Unicorn Hardware===

====Drivers====

==Parameters==

===SampleBlockSize===
Samples per channel per digitized block.
Together with the sampling rate, this parameter determines how often per second data are collected, processed, and feedback is updated. For example, at 600 Hz sampling and a SampleBlockSize of 20, the system (e.g., source signal display, signal processing, and stimulus presentation) would be updated 30 times per second.

===SamplingRate===

===SourceCh===

===SourceChannelList===
The list of channels that should be acquired from each device.
The total number of channels listed should correspond to ''SourceCh''. For more than one device, ''SourceChDevices'' determines how the ''SourceChList'' values are mapped to each device. For example if ''SourceChDevices'' = '8 8' and ''SourceChList'' = '1 2 3 4 13 14 15 16 5 6 7 8 9 10 11 12', then channels 1-4 and 13-16 will be acquired on the first device, and channels 5-12 will be acquired on the second device. These channels will be saved in the data file as 16 contiguous channels.
The order of channels does not matter; i.e., '1 2 3 4' is the same as '2 3 1 4'. The channels are always in ascending order on a single device.
Channels may not be listed twice on a single device; e.g., entering '1 2 3 4 5 6 7 1' if ''SourceChDevices'' = '8' will result in an error.
If this parameter is left blank (the default), then all channels are acquired on all devices.

===SourceChGain===

===SourceChOffset===

===ChannelNames===

==States==

==Additional Information==

===Using 32bit Executables on 64bit Installations===
BCI2000 supports compilation of the gUSBamp source module for 64bit targets. The resulting executable will run on 64bit systems, and work with the 64bit version of the gUSBamp drivers. However, the binary distribution of BCI2000 contains 32bit executables. These run fine under 64bit systems, but you will need to perform these additional driver installation steps to install 32bit gUSBamp API DLLs on 64bit systems:
*Execute gtec's 32bit driver installer on your 64bit system.
*After successful installation, execute gtec's 64bit driver installer on your 64bit system.
*You will now have both the 32bit API DLL and the 64bit API DLL installed, such that both 32bit and 64bit executables will be able to connect to a gUSBamp attached to the system's USB ports.

===Data Storage===
Unlike other systems, the USBamp is a DC amplifier system that digitizes at 24 bit.
Bandpass and notch filtering is performed on the digitized samples, resulting in floating point signal samples in units of <math>\mu V</math>.
BCI2000 currently supports signed 16 bit integers and floating point numbers for its data storage.
If ''SignalType'' is set to int16, the floating point values have to be converted back into integers before they can be stored and transmitted to Signal Processing.
This is done by the following transformation:

<math>\mathrm{sample}_\mathrm{stored}\mathrm{(A/D\,units)}=\frac{\mathrm{sample}_\mathrm{acquired}(\mu V)}\mathrm{SourceChGain}</math>.

(''SourceChOffset'' is assumed (and required) to be zero for all channels.)
BCI2000 Signal Processing or any offline analysis routine can derive, as with
any other BCI2000 source module, sample values in <math>\mu V</math> by subtracting, from
each stored sample, ''SourceChOffset'' (i.e., zero), and multiplying it with
''SourceChGain'' for each channel. If ''SignalType'' is set to float32,
data samples are stored in units of <math>\mu V</math>. In this case, ''SourceChGain'' should be
a list of 1's (because the conversion factor between data samples into <math>\mu V</math> is
1.0 for each channel).

Still, when values other than 0 and 1 are specified, a consistent data file will be produced, i.e. values will be transformed before they are written to the file, such that applying SourceChOffset and SourceChGain will reproduce the original values in <math>\mu V</math>.

==See also==
[[User Reference:DataIOFilter]], [[Programming Reference:GenericADC Class]]
[[Category:Filters]][[Category:Data Acquisition]]

System Features

2018-12-21T16:47:56Z

Madamek: /* Hardware Support */

BCI2000 supports a variety of [[#Data_Acquisition_Systems|data acquisition systems]], [[#Brain_Signals|brain signals]], and [[#Paradigms|study/feedback paradigms]]. During operation, BCI2000 stores data in a common format (BCI2000 native or GDF), along with all relevant event markers and information about system configuration. BCI2000 also includes several tools for data import/conversion (e.g., a routine to load BCI2000 data files directly into Matlab) and export facilities into ASCII.

BCI2000 also facilitates interactions with other software. For example, Matlab scripts can be executed in real-time from within BCI2000, or BCI2000 filters can be compiled to execute as stand-alone programs. Furthermore, a simple network-based interface allows for interactions with external programs written in any programming language. For example, a robotic arm application that is external to BCI2000 may be controlled in real time based on brain signals processed by BCI2000, or BCI2000 may use and store along with brain signals behavioral-based inputs such as eye-tracker coordinates.
BCI2000 requires any of the supported data acquisition systems listed above. We provide BCI2000 with full source code and all executables, which run on most current PCs running Microsoft Windows.

We provide the complete source code to the BCI2000 system. It may be compiled using VisualStudio, and MinGW on Windows. For the status on other operating systems, and more details, see [[Programming Reference:Build System]].

==Data Acquisition Systems==
===Hardware Support===
*[[User_Reference:gUSBampADC|g.USBamp]]
*[[User_Reference:gMOBIlabADC|g.MOBIlab]]
*[[User_Reference:gMOBIlabPlusADC|g.MOBIlab+ Bluetooth (g.tec)]]
*[[User_Reference:gUnicornADC|g.Unicorn]]

===Support Through User Contributions===
====A/D Converter Boards====
*[[Contributions:DTADC|Data Translations, Inc.]]
*[[Contributions:NIADC|National Instruments, Inc.]], also [[Contributions:NIDAQ-MX|MX boards]]
*[[Contributions:DAS_ADC|Measurement Computing, Inc.]]
*[[Contributions:ModularEEG|Modular-EEG Systems]]
====Amplifiers/Digitizers====
*[[Contributions:TDTADC|Tucker-Davis Pentusa]]
*[[Contributions:Biosemi2ADC|Biosemi]]
*[[Contributions:BioRadioADC|BioRadio 150 (Cleveland Medical Devices, Inc.)]]
*[[Contributions:TMSiADC|Refa System (TMSi, Inc.)]]
*[[Contributions:EnobioADC|Enobio]]
*Ripple Grapevine
*[[Contributions:NeuroSky|NeuroSky]]
*[[Contributions:Emotiv|Emotiv EPOC]]

====EEG Systems====
*[[Contributions:NeuroscanADC|Neuroscan, Inc.]]
*[[Contributions:RDAClientADC|BrainAmp]], [[Contributions:vAmpADC|V-Amp, QuickAmp]] (Brain Products)
*[[Contributions:MicromedADC|Micromed EEG Systems]]
*[[Contributions:AmpServerProADC|Electrical Geodesics Amp Server]]
*[[Contributions:NicoletOne|Viasys]]

====MEG Systems====
*[[Contributions:ctfneurod|Whole-head systems from CTF, Inc.]]

===Miscellaneous===
*[[User_Reference:SignalGeneratorADC|Virtual Device (i.e., Function Generator) for testing purposes]]

==Brain Signals==
*[[Contributions:SWSignalProcessing|Slow Cortical Potentials (SCPs)]]
*[[User_Reference:P3TemporalFilter|Evoked Potentials]]
*EEG mu/beta Rhythms (ERD/ERS) (2 methods: [[User_Reference:ARFilter|AR]], [[User_Reference:FFTFilter|FFT]])
*ECoG Oscillations
*Single-Neuron Action Potentials

==Paradigms==
===Feedback Applications===
*[[User_Reference:CursorTask|3D Cursor Movement Task]]
*[[User_Reference:StimulusPresentationTask|Auditory + Visual Stimulus Presentation incl. Real-Time Feedback]]
*[[User_Reference:P3SpellerTask|P300 Matrix Speller]]

===User Contributions===
*[[Contributions:Speller|4-Choice Speller]]
*2D Robotic Arm Control (RCS-6, Robix, Inc.)
*[[Contributions:SlowWaveApp|Slow-Cortical Potential Spelling Paradigm]]
*[[Contributions:MFCdemo|Visual-C++ (MFC) Demo Application]]

===User Interface Devices===
*[[User Reference:Logging Input|Joystick]]
*[[User Reference:Logging Input|Mouse]]
*[[User Reference:Logging Input|Keyboard]]
*[[Contributions:DataGloveLogger|7/14-Sensor Data Glove (Fifth Dimension Technologies, Inc.)]]
*Tobii Eye Trackers
*Nintendo Wii controller
*[[Contributions:NIDAQLogger|National Instruments MX boards to acquire analog/digital input in addition to the main data acquisition device]]
*[[Contributions:MicRecorderFilter|Audio input]]

==See also==
[[User Reference:Filters]], [[Programming Reference:Build System]], [[Contributions:Contents]]

User Reference:gUnicorn

2018-12-21T16:47:25Z

Madamek: Madamek moved page User Reference:gUnicorn to User Reference:gUnicornADC: consistency

#REDIRECT [[User Reference:gUnicornADC]]

User Reference:gUnicornADC

2018-12-21T16:47:25Z

Madamek: Madamek moved page User Reference:gUnicorn to User Reference:gUnicornADC: consistency

==Function==

===g.Unicorn Hardware===

====Drivers====

==Parameters==

===SampleBlockSize===
Samples per channel per digitized block.
Together with the sampling rate, this parameter determines how often per second data are collected, processed, and feedback is updated. For example, at 600 Hz sampling and a SampleBlockSize of 20, the system (e.g., source signal display, signal processing, and stimulus presentation) would be updated 30 times per second.

===SamplingRate===

===SourceCh===

===SourceChList===
The list of channels that should be acquired from each device.
The total number of channels listed should correspond to ''SourceCh''. For more than one device, ''SourceChDevices'' determines how the ''SourceChList'' values are mapped to each device. For example if ''SourceChDevices'' = '8 8' and ''SourceChList'' = '1 2 3 4 13 14 15 16 5 6 7 8 9 10 11 12', then channels 1-4 and 13-16 will be acquired on the first device, and channels 5-12 will be acquired on the second device. These channels will be saved in the data file as 16 contiguous channels.
The order of channels does not matter; i.e., '1 2 3 4' is the same as '2 3 1 4'. The channels are always in ascending order on a single device.
Channels may not be listed twice on a single device; e.g., entering '1 2 3 4 5 6 7 1' if ''SourceChDevices'' = '8' will result in an error.
If this parameter is left blank (the default), then all channels are acquired on all devices.

==States==

==Additional Information==

===Using 32bit Executables on 64bit Installations===
BCI2000 supports compilation of the gUSBamp source module for 64bit targets. The resulting executable will run on 64bit systems, and work with the 64bit version of the gUSBamp drivers. However, the binary distribution of BCI2000 contains 32bit executables. These run fine under 64bit systems, but you will need to perform these additional driver installation steps to install 32bit gUSBamp API DLLs on 64bit systems:
*Execute gtec's 32bit driver installer on your 64bit system.
*After successful installation, execute gtec's 64bit driver installer on your 64bit system.
*You will now have both the 32bit API DLL and the 64bit API DLL installed, such that both 32bit and 64bit executables will be able to connect to a gUSBamp attached to the system's USB ports.

===Data Storage===
Unlike other systems, the USBamp is a DC amplifier system that digitizes at 24 bit.
Bandpass and notch filtering is performed on the digitized samples, resulting in floating point signal samples in units of <math>\mu V</math>.
BCI2000 currently supports signed 16 bit integers and floating point numbers for its data storage.
If ''SignalType'' is set to int16, the floating point values have to be converted back into integers before they can be stored and transmitted to Signal Processing.
This is done by the following transformation:

<math>\mathrm{sample}_\mathrm{stored}\mathrm{(A/D\,units)}=\frac{\mathrm{sample}_\mathrm{acquired}(\mu V)}\mathrm{SourceChGain}</math>.

(''SourceChOffset'' is assumed (and required) to be zero for all channels.)
BCI2000 Signal Processing or any offline analysis routine can derive, as with
any other BCI2000 source module, sample values in <math>\mu V</math> by subtracting, from
each stored sample, ''SourceChOffset'' (i.e., zero), and multiplying it with
''SourceChGain'' for each channel. If ''SignalType'' is set to float32,
data samples are stored in units of <math>\mu V</math>. In this case, ''SourceChGain'' should be
a list of 1's (because the conversion factor between data samples into <math>\mu V</math> is
1.0 for each channel).

Still, when values other than 0 and 1 are specified, a consistent data file will be produced, i.e. values will be transformed before they are written to the file, such that applying SourceChOffset and SourceChGain will reproduce the original values in <math>\mu V</math>.

==See also==
[[User Reference:DataIOFilter]], [[Programming Reference:GenericADC Class]]
[[Category:Filters]][[Category:Data Acquisition]]

User Reference:gUnicornADC

2018-12-21T16:45:24Z

Madamek: /* g.USBamp Hardware */

==Function==

===g.Unicorn Hardware===

====Drivers====

==Parameters==

===SampleBlockSize===
Samples per channel per digitized block.
Together with the sampling rate, this parameter determines how often per second data are collected, processed, and feedback is updated. For example, at 600 Hz sampling and a SampleBlockSize of 20, the system (e.g., source signal display, signal processing, and stimulus presentation) would be updated 30 times per second.

===SamplingRate===

===SourceCh===

===SourceChList===
The list of channels that should be acquired from each device.
The total number of channels listed should correspond to ''SourceCh''. For more than one device, ''SourceChDevices'' determines how the ''SourceChList'' values are mapped to each device. For example if ''SourceChDevices'' = '8 8' and ''SourceChList'' = '1 2 3 4 13 14 15 16 5 6 7 8 9 10 11 12', then channels 1-4 and 13-16 will be acquired on the first device, and channels 5-12 will be acquired on the second device. These channels will be saved in the data file as 16 contiguous channels.
The order of channels does not matter; i.e., '1 2 3 4' is the same as '2 3 1 4'. The channels are always in ascending order on a single device.
Channels may not be listed twice on a single device; e.g., entering '1 2 3 4 5 6 7 1' if ''SourceChDevices'' = '8' will result in an error.
If this parameter is left blank (the default), then all channels are acquired on all devices.

==States==

==Additional Information==

===Using 32bit Executables on 64bit Installations===
BCI2000 supports compilation of the gUSBamp source module for 64bit targets. The resulting executable will run on 64bit systems, and work with the 64bit version of the gUSBamp drivers. However, the binary distribution of BCI2000 contains 32bit executables. These run fine under 64bit systems, but you will need to perform these additional driver installation steps to install 32bit gUSBamp API DLLs on 64bit systems:
*Execute gtec's 32bit driver installer on your 64bit system.
*After successful installation, execute gtec's 64bit driver installer on your 64bit system.
*You will now have both the 32bit API DLL and the 64bit API DLL installed, such that both 32bit and 64bit executables will be able to connect to a gUSBamp attached to the system's USB ports.

===Data Storage===
Unlike other systems, the USBamp is a DC amplifier system that digitizes at 24 bit.
Bandpass and notch filtering is performed on the digitized samples, resulting in floating point signal samples in units of <math>\mu V</math>.
BCI2000 currently supports signed 16 bit integers and floating point numbers for its data storage.
If ''SignalType'' is set to int16, the floating point values have to be converted back into integers before they can be stored and transmitted to Signal Processing.
This is done by the following transformation:

<math>\mathrm{sample}_\mathrm{stored}\mathrm{(A/D\,units)}=\frac{\mathrm{sample}_\mathrm{acquired}(\mu V)}\mathrm{SourceChGain}</math>.

(''SourceChOffset'' is assumed (and required) to be zero for all channels.)
BCI2000 Signal Processing or any offline analysis routine can derive, as with
any other BCI2000 source module, sample values in <math>\mu V</math> by subtracting, from
each stored sample, ''SourceChOffset'' (i.e., zero), and multiplying it with
''SourceChGain'' for each channel. If ''SignalType'' is set to float32,
data samples are stored in units of <math>\mu V</math>. In this case, ''SourceChGain'' should be
a list of 1's (because the conversion factor between data samples into <math>\mu V</math> is
1.0 for each channel).

Still, when values other than 0 and 1 are specified, a consistent data file will be produced, i.e. values will be transformed before they are written to the file, such that applying SourceChOffset and SourceChGain will reproduce the original values in <math>\mu V</math>.

==See also==
[[User Reference:DataIOFilter]], [[Programming Reference:GenericADC Class]]
[[Category:Filters]][[Category:Data Acquisition]]

User Reference:gUnicornADC

2018-12-21T16:45:12Z

Madamek: structure set

==Function==

===g.USBamp Hardware===

====Drivers====

==Parameters==

===SampleBlockSize===
Samples per channel per digitized block.
Together with the sampling rate, this parameter determines how often per second data are collected, processed, and feedback is updated. For example, at 600 Hz sampling and a SampleBlockSize of 20, the system (e.g., source signal display, signal processing, and stimulus presentation) would be updated 30 times per second.

===SamplingRate===

===SourceCh===

===SourceChList===
The list of channels that should be acquired from each device.
The total number of channels listed should correspond to ''SourceCh''. For more than one device, ''SourceChDevices'' determines how the ''SourceChList'' values are mapped to each device. For example if ''SourceChDevices'' = '8 8' and ''SourceChList'' = '1 2 3 4 13 14 15 16 5 6 7 8 9 10 11 12', then channels 1-4 and 13-16 will be acquired on the first device, and channels 5-12 will be acquired on the second device. These channels will be saved in the data file as 16 contiguous channels.
The order of channels does not matter; i.e., '1 2 3 4' is the same as '2 3 1 4'. The channels are always in ascending order on a single device.
Channels may not be listed twice on a single device; e.g., entering '1 2 3 4 5 6 7 1' if ''SourceChDevices'' = '8' will result in an error.
If this parameter is left blank (the default), then all channels are acquired on all devices.

==States==

==Additional Information==

===Using 32bit Executables on 64bit Installations===
BCI2000 supports compilation of the gUSBamp source module for 64bit targets. The resulting executable will run on 64bit systems, and work with the 64bit version of the gUSBamp drivers. However, the binary distribution of BCI2000 contains 32bit executables. These run fine under 64bit systems, but you will need to perform these additional driver installation steps to install 32bit gUSBamp API DLLs on 64bit systems:
*Execute gtec's 32bit driver installer on your 64bit system.
*After successful installation, execute gtec's 64bit driver installer on your 64bit system.
*You will now have both the 32bit API DLL and the 64bit API DLL installed, such that both 32bit and 64bit executables will be able to connect to a gUSBamp attached to the system's USB ports.

===Data Storage===
Unlike other systems, the USBamp is a DC amplifier system that digitizes at 24 bit.
Bandpass and notch filtering is performed on the digitized samples, resulting in floating point signal samples in units of <math>\mu V</math>.
BCI2000 currently supports signed 16 bit integers and floating point numbers for its data storage.
If ''SignalType'' is set to int16, the floating point values have to be converted back into integers before they can be stored and transmitted to Signal Processing.
This is done by the following transformation:

<math>\mathrm{sample}_\mathrm{stored}\mathrm{(A/D\,units)}=\frac{\mathrm{sample}_\mathrm{acquired}(\mu V)}\mathrm{SourceChGain}</math>.

(''SourceChOffset'' is assumed (and required) to be zero for all channels.)
BCI2000 Signal Processing or any offline analysis routine can derive, as with
any other BCI2000 source module, sample values in <math>\mu V</math> by subtracting, from
each stored sample, ''SourceChOffset'' (i.e., zero), and multiplying it with
''SourceChGain'' for each channel. If ''SignalType'' is set to float32,
data samples are stored in units of <math>\mu V</math>. In this case, ''SourceChGain'' should be
a list of 1's (because the conversion factor between data samples into <math>\mu V</math> is
1.0 for each channel).

Still, when values other than 0 and 1 are specified, a consistent data file will be produced, i.e. values will be transformed before they are written to the file, such that applying SourceChOffset and SourceChGain will reproduce the original values in <math>\mu V</math>.

==See also==
[[User Reference:DataIOFilter]], [[Programming Reference:GenericADC Class]]
[[Category:Filters]][[Category:Data Acquisition]]

System Features

2018-12-21T16:41:39Z

Madamek: /* Hardware Support */

BCI2000 supports a variety of [[#Data_Acquisition_Systems|data acquisition systems]], [[#Brain_Signals|brain signals]], and [[#Paradigms|study/feedback paradigms]]. During operation, BCI2000 stores data in a common format (BCI2000 native or GDF), along with all relevant event markers and information about system configuration. BCI2000 also includes several tools for data import/conversion (e.g., a routine to load BCI2000 data files directly into Matlab) and export facilities into ASCII.

BCI2000 also facilitates interactions with other software. For example, Matlab scripts can be executed in real-time from within BCI2000, or BCI2000 filters can be compiled to execute as stand-alone programs. Furthermore, a simple network-based interface allows for interactions with external programs written in any programming language. For example, a robotic arm application that is external to BCI2000 may be controlled in real time based on brain signals processed by BCI2000, or BCI2000 may use and store along with brain signals behavioral-based inputs such as eye-tracker coordinates.
BCI2000 requires any of the supported data acquisition systems listed above. We provide BCI2000 with full source code and all executables, which run on most current PCs running Microsoft Windows.

We provide the complete source code to the BCI2000 system. It may be compiled using VisualStudio, and MinGW on Windows. For the status on other operating systems, and more details, see [[Programming Reference:Build System]].

==Data Acquisition Systems==
===Hardware Support===
*[[User_Reference:gUSBampADC|g.USBamp]]
*[[User_Reference:gMOBIlabADC|g.MOBIlab]]
*[[User_Reference:gMOBIlabPlusADC|g.MOBIlab+ Bluetooth (g.tec)]]
*[[User_Reference:gUnicorn|g.Unicorn]]

===Support Through User Contributions===
====A/D Converter Boards====
*[[Contributions:DTADC|Data Translations, Inc.]]
*[[Contributions:NIADC|National Instruments, Inc.]], also [[Contributions:NIDAQ-MX|MX boards]]
*[[Contributions:DAS_ADC|Measurement Computing, Inc.]]
*[[Contributions:ModularEEG|Modular-EEG Systems]]
====Amplifiers/Digitizers====
*[[Contributions:TDTADC|Tucker-Davis Pentusa]]
*[[Contributions:Biosemi2ADC|Biosemi]]
*[[Contributions:BioRadioADC|BioRadio 150 (Cleveland Medical Devices, Inc.)]]
*[[Contributions:TMSiADC|Refa System (TMSi, Inc.)]]
*[[Contributions:EnobioADC|Enobio]]
*Ripple Grapevine
*[[Contributions:NeuroSky|NeuroSky]]
*[[Contributions:Emotiv|Emotiv EPOC]]

====EEG Systems====
*[[Contributions:NeuroscanADC|Neuroscan, Inc.]]
*[[Contributions:RDAClientADC|BrainAmp]], [[Contributions:vAmpADC|V-Amp, QuickAmp]] (Brain Products)
*[[Contributions:MicromedADC|Micromed EEG Systems]]
*[[Contributions:AmpServerProADC|Electrical Geodesics Amp Server]]
*[[Contributions:NicoletOne|Viasys]]

====MEG Systems====
*[[Contributions:ctfneurod|Whole-head systems from CTF, Inc.]]

===Miscellaneous===
*[[User_Reference:SignalGeneratorADC|Virtual Device (i.e., Function Generator) for testing purposes]]

==Brain Signals==
*[[Contributions:SWSignalProcessing|Slow Cortical Potentials (SCPs)]]
*[[User_Reference:P3TemporalFilter|Evoked Potentials]]
*EEG mu/beta Rhythms (ERD/ERS) (2 methods: [[User_Reference:ARFilter|AR]], [[User_Reference:FFTFilter|FFT]])
*ECoG Oscillations
*Single-Neuron Action Potentials

==Paradigms==
===Feedback Applications===
*[[User_Reference:CursorTask|3D Cursor Movement Task]]
*[[User_Reference:StimulusPresentationTask|Auditory + Visual Stimulus Presentation incl. Real-Time Feedback]]
*[[User_Reference:P3SpellerTask|P300 Matrix Speller]]

===User Contributions===
*[[Contributions:Speller|4-Choice Speller]]
*2D Robotic Arm Control (RCS-6, Robix, Inc.)
*[[Contributions:SlowWaveApp|Slow-Cortical Potential Spelling Paradigm]]
*[[Contributions:MFCdemo|Visual-C++ (MFC) Demo Application]]

===User Interface Devices===
*[[User Reference:Logging Input|Joystick]]
*[[User Reference:Logging Input|Mouse]]
*[[User Reference:Logging Input|Keyboard]]
*[[Contributions:DataGloveLogger|7/14-Sensor Data Glove (Fifth Dimension Technologies, Inc.)]]
*Tobii Eye Trackers
*Nintendo Wii controller
*[[Contributions:NIDAQLogger|National Instruments MX boards to acquire analog/digital input in addition to the main data acquisition device]]
*[[Contributions:MicRecorderFilter|Audio input]]

==See also==
[[User Reference:Filters]], [[Programming Reference:Build System]], [[Contributions:Contents]]

User Reference:gUnicornADC

2018-12-21T16:39:37Z

Madamek: Created blank page