Difference between revisions of "Contributions:actiCHamp"

From BCI2000 Wiki
Jump to: navigation, search
 
Line 18: Line 18:
  
 
===Source Code Revisions===
 
===Source Code Revisions===
*Initial development: --
+
*Initial development: 4337
 
*Tested under: --
 
*Tested under: --
 
*Known to compile under: --
 
*Known to compile under: --
Line 24: Line 24:
  
 
==Functional Description==
 
==Functional Description==
Acquires raw data from the actiCHamp.
+
Acquires raw data from the BrainProducts actiCHamp.
  
 
==Installation==
 
==Installation==
Line 30: Line 30:
  
 
==Parameters==
 
==Parameters==
* '''SourceCh''' represents the total number of channels to be logged from the source module. The AUX channels follow the EEG channels. <br />
+
 
** '''NOTE:''' If you would like to record the AUX channels and have only 1 module installed you set this to 40 channels. 72 for 2 modules, 104 for 3, etc.
+
===SourceCh===
** '''NOTE:''' This ADC module only supports card modules on the actiCHamp in order (for example if you have module cards in slots 1, 2 and 3) if you have cards in slots 1, 2, and 4, the module '''WILL NOT WORK''', in fact such mode is currently '''UNTESTED'''.
+
This represents the total number of channels to be logged from the source module. The last 8 slots will be taken up with AUX channels, so specify 8 + the number of EEG channels you want ( 40 channels if you have 1 hardware module installed, 72 for 2 modules, 104 for 3, etc).
* '''SampleBlockSize''' should be set equal to the size of the sample block pulled from the device.  
+
* '''NOTE:''' This ADC module only supports card modules on the actiCHamp in order (for example if you have module cards in slots 1, 2 and 3) if you have cards in slots 1, 2, and 4, the module '''WILL NOT WORK''', in fact such mode is currently '''UNTESTED'''.
** '''NOTE:''' The actiCHamp runs at frequencies lower than 10,000 Hz through decimation, some SampleRate/SampleBlockSize frequencies work better (ones that can be easily evenly divided). A list of valid modes is coming soon.
+
 
* '''SampleRate''' determines the rate at which the device samples data. <br/>
+
===SampleRate===
** '''NOTE:''' Only specific SampleRates are valid, ones that can divide into 10,000 without a remainder. The system will not run on SampleRates that are not evenly factored.
+
Determines the rate at which the device samples data.
* '''ChannelNames''' is a convenience parameter.  Name channels here and they can be referenced by these names later.
+
* '''NOTE:''' Only specific SampleRates are valid, ones that can divide into 10,000 without a remainder. The system will not run on SampleRates that are not evenly factored.
* '''SourceChOffset''' should be set to a list of "0"s -- one 0 for each channel as indicated by SourceCh, separated by spaces.
+
 
* '''SourceChGain''' should be set to a list of "1"s -- one 0 for each channel as indicated by SourceCh, separated by spaces.
+
===SampleBlockSize===
* '''actiCHampAmplifierID''' The ID of the amplifier to acquire signals from, amplifiers are enumerated by the library, 0 will work properly if you have only 1 amplifier installed.
+
Should be set equal to the size of the sample block to be pulled from the device.  
** '''NOTE:''' Currently there is no way to specify which device to open without knowing it's number on the system.
+
 
* '''AcquistionMode''' Is the mode in which to operate the device, 0 for normal signal acquisition, 1 for shielded signal acquisition, 3 for impedance values, 4 for a test square wave generated out of the GND channel.
+
* '''NOTE:''' The actiCHamp runs at frequencies lower than 10,000 Hz through decimation, some SampleRate/SampleBlockSize frequencies work better than others (ones that can be easily evenly divided). A list of valid modes is coming soon (Jan 2013).
** '''NOTE:''' Only normal signal acquisition is supported for now.
+
 
* '''ReferenceChannel''' Use this value to automatically use a channel as a reference(subtract that EEG channel from all others), use 0 to disable this value.
+
===SourceChOffset===
**" '''NOTE:''' You probably want to set this value in order to have intelligible output, and have that channel's electrode as close to GND as possible.
+
This should be set to a list of "0"s -- one 0 for each channel as indicated by SourceCh, separated by spaces.
 +
 
 +
===SourceChGain===
 +
The appropriate respective gain values for the EEG and AUX channel banks are hard-coded into the driver, so this should just be set to a list of "1"s -- one 1 for each channel as indicated by SourceCh, separated by spaces.  
 +
 
 +
===actiCHampAmplifierID===
 +
The ID of the amplifier to acquire signals from, amplifiers are enumerated by the library, 0 will work properly if you have only 1 amplifier installed.
 +
* '''NOTE:''' Currently there is no way to specify which device to open without knowing its number on the system.
 +
 
 +
===AcquistionMode===
 +
Is the mode in which to operate the device, 0 for normal signal acquisition, 1 for shielded signal acquisition, 3 for impedance values, 4 for a test square wave generated out of the GND channel.
 +
* '''NOTE:''' Only normal signal acquisition is supported for now.
 +
 
 +
===ReferenceChannel===
 +
Use this value to automatically use a channel as a reference (subtract that EEG channel from all others); use 0 to disable this and use actiCHamp's built-in reference.
 +
*" '''NOTE:''' You probably want to set this value in order to have intelligible output, and have that channel's electrode as close to GND as possible.
  
  
===Valid Operating Modes===
 
This list will be generated in January 2013.
 
  
 
==See also==
 
==See also==

Revision as of 02:21, 15 December 2012

Synopsis

actiCHamp is a modular amplifier from BrainVision products. This contributed module allows you to use the actiCHamp in BCI2000.

Location

http://www.bci2000.org/svn/trunk/src/contrib/SignalSource/actiCHamp

Versioning

Authors

Paul Ignatenko (paul dot ignatenko at gmail dot com) Rensselaer Polytechnic Institute

Version History

Version 0.1: December 2012

  • Supports EEG Channels
  • Supports AUX Channels
  • Referencing by any channel

Source Code Revisions

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

Functional Description

Acquires raw data from the BrainProducts actiCHamp.

Installation

Compile the actiCHamp module using CMake and your compiler. The resulting actiCHampSource.exe should be placed in the prog directory automatically.

Parameters

SourceCh

This represents the total number of channels to be logged from the source module. The last 8 slots will be taken up with AUX channels, so specify 8 + the number of EEG channels you want ( 40 channels if you have 1 hardware module installed, 72 for 2 modules, 104 for 3, etc).

  • NOTE: This ADC module only supports card modules on the actiCHamp in order (for example if you have module cards in slots 1, 2 and 3) if you have cards in slots 1, 2, and 4, the module WILL NOT WORK, in fact such mode is currently UNTESTED.

SampleRate

Determines the rate at which the device samples data.

  • NOTE: Only specific SampleRates are valid, ones that can divide into 10,000 without a remainder. The system will not run on SampleRates that are not evenly factored.

SampleBlockSize

Should be set equal to the size of the sample block to be pulled from the device.

  • NOTE: The actiCHamp runs at frequencies lower than 10,000 Hz through decimation, some SampleRate/SampleBlockSize frequencies work better than others (ones that can be easily evenly divided). A list of valid modes is coming soon (Jan 2013).

SourceChOffset

This should be set to a list of "0"s -- one 0 for each channel as indicated by SourceCh, separated by spaces.

SourceChGain

The appropriate respective gain values for the EEG and AUX channel banks are hard-coded into the driver, so this should just be set to a list of "1"s -- one 1 for each channel as indicated by SourceCh, separated by spaces.

actiCHampAmplifierID

The ID of the amplifier to acquire signals from, amplifiers are enumerated by the library, 0 will work properly if you have only 1 amplifier installed.

  • NOTE: Currently there is no way to specify which device to open without knowing its number on the system.

AcquistionMode

Is the mode in which to operate the device, 0 for normal signal acquisition, 1 for shielded signal acquisition, 3 for impedance values, 4 for a test square wave generated out of the GND channel.

  • NOTE: Only normal signal acquisition is supported for now.

ReferenceChannel

Use this value to automatically use a channel as a reference (subtract that EEG channel from all others); use 0 to disable this and use actiCHamp's built-in reference.

  • " NOTE: You probably want to set this value in order to have intelligible output, and have that channel's electrode as close to GND as possible.


See also

User Reference:Filters, Contributions:ADCs