Difference between revisions of "Contributions:gHIamp"

From BCI2000 Wiki
Jump to: navigation, search
(Authors)
Line 60: Line 60:
 
* '''NotchType'''
 
* '''NotchType'''
 
* '''SourceBufferSize'''
 
* '''SourceBufferSize'''
 +
* '''EnableDigitalInputs''' is a toggle button to enable both digital input ports on the back of the amp and save them as synchronous states from each individual pin
  
 
===Valid Operating Modes===
 
===Valid Operating Modes===
Line 87: Line 88:
 
|}
 
|}
  
 +
==Digital Input==
 +
 +
There are two digital input ports on the back of the gHIamp. With the newest source code, data can be read through them and saved as synchronous states while reading the data from the analog channels simultaneously.
 +
{|style="margin: 2 auto;"
 +
| [[File:DigIn1.JPG|thumb|left| Digital Input 1 port (Click to enlarge image)]]
 +
| [[File:DigIn2.JPG|thumb|left| Digital Input 2 port (Click to enlarge image)]]
 +
|}
 +
 +
===State Variables===
 +
 +
The state name gives which pin the value was read from. They are saved synchronously as data is gathered. Their value can be either a 0 or a 1.
 +
 +
<pre>
 +
-----------------------------------------
 +
StateName          == Sensor
 +
-----------------------------------------
 +
HIampDigitalInput1  == DigitalIn Pin1
 +
HIampDigitalInput2  == DigitalIn Pin2
 +
HIampDigitalInput3  == DigitalIn Pin3
 +
HIampDigitalInput4  == DigitalIn Pin4
 +
HIampDigitalInput5  == DigitalIn Pin5
 +
HIampDigitalInput6  == DigitalIn Pin6
 +
HIampDigitalInput7  == DigitalIn Pin7
 +
HIampDigitalInput8  == DigitalIn Pin8
 +
HIampDigitalInput9  == DigitalIn Pin9
 +
HIampDigitalInput10 == DigitalIn Pin10
 +
HIampDigitalInput11 == DigitalIn Pin11
 +
HIampDigitalInput12 == DigitalIn Pin12
 +
HIampDigitalInput13 == DigitalIn Pin13
 +
HIampDigitalInput14 == DigitalIn Pin14
 +
HIampDigitalInput15 == DigitalIn Pin15
 +
HIampDigitalInput16 == DigitalIn Pin16
 +
-----------------------------------------
 +
</pre>
 
==See also==
 
==See also==
 
[[User Reference:Filters]], [[Contributions:ADCs]]
 
[[User Reference:Filters]], [[Contributions:ADCs]]
  
 
[[Category:Contributions]][[Category:Data Acquisition]]
 
[[Category:Contributions]][[Category:Data Acquisition]]

Revision as of 18:06, 12 June 2015

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

Kristopher Kaleb Goering (kaleb.goering@gmail.com) University of Kansas

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
  • EnableDigitalInputs is a toggle button to enable both digital input ports on the back of the amp and save them as synchronous states from each individual pin

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

Digital Input

There are two digital input ports on the back of the gHIamp. With the newest source code, data can be read through them and saved as synchronous states while reading the data from the analog channels simultaneously.

Digital Input 1 port (Click to enlarge image)
Digital Input 2 port (Click to enlarge image)

State Variables

The state name gives which pin the value was read from. They are saved synchronously as data is gathered. Their value can be either a 0 or a 1.

-----------------------------------------
StateName           == Sensor
-----------------------------------------
HIampDigitalInput1  == DigitalIn Pin1
HIampDigitalInput2  == DigitalIn Pin2
HIampDigitalInput3  == DigitalIn Pin3
HIampDigitalInput4  == DigitalIn Pin4
HIampDigitalInput5  == DigitalIn Pin5
HIampDigitalInput6  == DigitalIn Pin6
HIampDigitalInput7  == DigitalIn Pin7
HIampDigitalInput8  == DigitalIn Pin8
HIampDigitalInput9  == DigitalIn Pin9
HIampDigitalInput10 == DigitalIn Pin10
HIampDigitalInput11 == DigitalIn Pin11
HIampDigitalInput12 == DigitalIn Pin12
HIampDigitalInput13 == DigitalIn Pin13
HIampDigitalInput14 == DigitalIn Pin14
HIampDigitalInput15 == DigitalIn Pin15
HIampDigitalInput16 == DigitalIn Pin16
-----------------------------------------

See also

User Reference:Filters, Contributions:ADCs