Difference between revisions of "Contributions:gHIamp"

From BCI2000 Wiki
Jump to: navigation, search
m (Added Valid Operating Modes)
(Work in Progress)
Line 33: Line 33:
 
==Parameters==
 
==Parameters==
 
* '''SourceCh''' represents the total number of channels to be logged from the source module.
 
* '''SourceCh''' represents the total number of channels to be logged from the source module.
* '''SampleBlockSize''' should be set equal to the size of the sample block pulled from the device.
+
* '''SampleBlockSize''' should be set equal to the size of the sample block pulled from the device. <br/>
* '''SampleRate'''
+
** '''NOTE:''' <span style="text-decoration: underline;">Only specific combinations of SampleBlockSize and SampleRate are valid!  See [[#Valid Operating Modes]]</span>
* '''ChannelNames'''
+
* '''SampleRate''' determines the rate at which the device samples data. <br/>
* '''SourceChOffset'''
+
** '''NOTE:''' <span style="text-decoration: underline;">Only specific combinations of SampleBlockSize and SampleRate are valid!  See [[#Valid Operating Modes]]</span>
* '''SourceChGain'''
+
* '''ChannelNames''' is a convenience parameter.  Name channels here and they can be referenced by these names later.
* '''DeviceIDMaster'''
+
* '''SourceChOffset''' should be set to a list of "0"s -- one 0 for each channel as indicated by SourceCh, separated by spaces.
* '''DeviceIDs'''
+
* '''SourceChGain''' should be set to a list of "1"s -- one 0 for each channel as indicated by SourceCh, separated by spaces.
* '''RefChList'''
+
* '''DeviceIDMaster''' is the serial number identifier of the master g.HIamp device.  This serial can be found on the physical device and is typically in a "'''HA-20XX.XX.XX'''" format.  This parameter can also be set to "'''auto'''" if there is only one g.HIamp device connected to the machine.
 +
* '''DeviceIDs''' is a list of device serials (typically in "'''HA-20XX.XX.XX'''" format) which corresponds to the devices to record channels from.  One of these serials must be specified as the master device in the "DeviceIDMaster" parameter.  This parameter can also be set to "'''auto'''" if there is only one g.HIamp device connected to the machine.  <br/>
 +
** '''NOTE:''' <span style="text-decoration: underline;">Device slaving is not yet supported by the module OR the g.HIamp C API. -- This parameter only exists for future compatibility. </span>
 +
* '''RefChList''' is a list of channels which can act as "Reference" channels for each amp.  If left blank, no channel will be used as a reference, and the raw signal will be recorded in the output.  <br/>
 +
** '''NOTE:''' <span style="text-decoration: underline;">If specifying reference channels, there must be one reference channel per device specified in "DeviceIDs" in the same order. </span>
 
* '''SourceChList'''
 
* '''SourceChList'''
 
* '''FilterEnabled'''
 
* '''FilterEnabled'''
Line 57: Line 61:
 
The gHIamp only accepts specific combinations of sampling rates and sample block sizes.  The following table shows all valid combinations of sample rate and block size.  Operating outside of these modes is untested and could result in problems.
 
The gHIamp only accepts specific combinations of sampling rates and sample block sizes.  The following table shows all valid combinations of sample rate and block size.  Operating outside of these modes is untested and could result in problems.
  
{|
+
{| border="1"
 
!Sample Rate
 
!Sample Rate
 
!Valid Sample Block Sizes
 
!Valid Sample Block Sizes

Revision as of 17:48, 24 February 2012

Synopsis

The g.HIamp is a 256 channel amplifier from g.tec. The contributed source module acquires raw signals from the amplifier in real time for use in BCI2000.

Location

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

Versioning

Authors

Griffin Milsap (griffin.milsap@gmail.com) Rensselaer Polytechnic Institute

Version History

Version 0.9: August 2011

  • Supports one g.HIamp
  • Supports Filters
  • Referencing by any channel
  • Future compatible with g.HIamp master/slave configurations
  • Using g.HIamp C API version 1.11.02

Source Code Revisions

  • Initial development: 3472
  • Tested under: 3763
  • Known to compile under: 3798
  • Broken since: --

Functional Description

Acquires raw data from the g.HIamp.

Installation

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

Parameters

  • SourceCh represents the total number of channels to be logged from the source module.
  • SampleBlockSize should be set equal to the size of the sample block pulled from the device.
  • SampleRate 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.
  • 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.
  • DeviceIDMaster is the serial number identifier of the master g.HIamp device. This serial can be found on the physical device and is typically in a "HA-20XX.XX.XX" format. This parameter can also be set to "auto" if there is only one g.HIamp device connected to the machine.
  • DeviceIDs is a list of device serials (typically in "HA-20XX.XX.XX" format) which corresponds to the devices to record channels from. One of these serials must be specified as the master device in the "DeviceIDMaster" parameter. This parameter can also be set to "auto" if there is only one g.HIamp device connected to the machine.
    • NOTE: Device slaving is not yet supported by the module OR the g.HIamp C API. -- This parameter only exists for future compatibility.
  • RefChList is a list of channels which can act as "Reference" channels for each amp. If left blank, no channel will be used as a reference, and the raw signal will be recorded in the output.
    • NOTE: If specifying reference channels, there must be one reference channel per device specified in "DeviceIDs" in the same order.
  • SourceChList
  • FilterEnabled
  • FilterHighPass
  • FilterLowPass
  • FilterModelOrder
  • FilterType
  • NotchEnabled
  • NotchHighPass
  • NotchLowPass
  • NotchModelOrder
  • NotchType
  • SourceBufferSize

Valid Operating Modes

The gHIamp only accepts specific combinations of sampling rates and sample block sizes. The following table shows all valid combinations of sample rate and block size. Operating outside of these modes is untested and could result in problems.

Sample Rate Valid Sample Block Sizes
256 Samples per second 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 32 64 128 256
512 Samples per second 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 32 64 128 256
600 Samples per second 4 5 6 7 8 9 10 11 12 13 15 16 17 32 64 128 256
1200 Samples per second 8 9 10 11 12 13 14 15 16 32 64 128 256
2400 Samples per second 16 32 64 128 256
4800 Samples per second 32 64 128 256

See also

User Reference:Filters, Contributions:ADCs