Contributions:gSTIMbox: Difference between revisions
Created page with "==Synopsis== The gSTIMbox is a digital signal acquisition device with 14 digital inputs and 16 digital outputs. This page currently serves as a technical specification to a fu..." |
No edit summary |
||
| Line 24: | Line 24: | ||
===OutputTriggerList=== | ===OutputTriggerList=== | ||
The output trigger list is a matrix, where each row is an entry binding an output channel to a trigger. | The output trigger list is a matrix, where each row is an entry binding an output channel to a trigger. All fields in this matrix are required. The channel corresponds to output channels on the gSTIMbox. The table below describes the function of the other matrix parameters. | ||
* Channel -- output channel of gSTIMbox (1-16) | |||
* TriggerType -- 1, 2 or 3 corresponding to gSTIMbox input, EEG input, or State Respectively | |||
* TriggerName -- Values dependent on TriggerType see table below. | |||
* Threshold -- Threshold to quantify if a output is in the triggered state. Values dependent on TriggerType see table below. | |||
{| class="wikitable" | |||
| '''Allowed of TriggerTypes ''' || '''Meaning''' || '''Allowable TriggerName for TriggerType''' || '''Allowable Threshold for TriggerType''' | |||
|- | |||
| 0 || gSTIMbox Input Channel || 1-14 corresponding to gSTIMbox Inputs || 1 or 0; triggered when channel value == threshold value | |||
|- | |||
| 1 || EEG Input Channel || 1 - Signal Channel Size, corresponding to EEG channels || a BCI2000 recognized voltage (e.g. 125mV); triggered when channel value >= threshold value | |||
|- | |||
| 2 || State || Valid State Name || any integer value; triggered when state value == threshold value | |||
|} | |||
An example OutputTriggerList which triggers the first output channel on the first input channel of the gSTIMbox when the value is 1, the second output channel on the first EEG channel when the value is greater than or equal to 125 mV, and the third output channel when the space bar is pressed. | |||
{| class="wikitable" | {| class="wikitable" | ||
| '''Channel''' || '''TriggerType''' || '''TriggerName''' || '''Threshold''' | | '''Channel''' || '''TriggerType''' || '''TriggerName''' || '''Threshold''' | ||
|- | |- | ||
| 1 || 0 || | | 1 || 0 || 1 || 1 | ||
|- | |- | ||
| 2 || 1 || | | 2 || 1 || 1 || 125mV | ||
|- | |- | ||
| 3 || 2 || KeyDown || | | 3 || 2 || KeyDown || 20 | ||
|} | |} | ||
| Line 40: | Line 56: | ||
The table below describes the other parameters. | The table below describes the other parameters. | ||
===OutputMatrix=== | |||
The output matrix describes output states, and how they react to being triggered. For example | |||
{| class="wikitable" | {| class="wikitable" | ||
| ''' | | '''Channel''' || '''Default State''' || '''Default Mode''' || | ||
|} | |} | ||
==See also== | ==See also== | ||
Revision as of 22:54, 21 May 2013
Synopsis
The gSTIMbox is a digital signal acquisition device with 14 digital inputs and 16 digital outputs. This page currently serves as a technical specification to a future module.
Location
Unreleased
~~http://www.bci2000.org/svn/trunk/src/contrib/SignalSource/gSTIMbox~~
Versioning
Authors
Paul Ignatenko (paul dot ignatenko at gmail dot com)
Functional Description
Allows the gSTIMbox to run as a co-Source module, allowing you to monitor inputs, and trigger outputs.
Installation
Compile the gSTIMbox module using CMake and your compiler.
Parameters
OutputTriggerList
The output trigger list is a matrix, where each row is an entry binding an output channel to a trigger. All fields in this matrix are required. The channel corresponds to output channels on the gSTIMbox. The table below describes the function of the other matrix parameters.
- Channel -- output channel of gSTIMbox (1-16)
- TriggerType -- 1, 2 or 3 corresponding to gSTIMbox input, EEG input, or State Respectively
- TriggerName -- Values dependent on TriggerType see table below.
- Threshold -- Threshold to quantify if a output is in the triggered state. Values dependent on TriggerType see table below.
| Allowed of TriggerTypes | Meaning | Allowable TriggerName for TriggerType | Allowable Threshold for TriggerType |
| 0 | gSTIMbox Input Channel | 1-14 corresponding to gSTIMbox Inputs | 1 or 0; triggered when channel value == threshold value |
| 1 | EEG Input Channel | 1 - Signal Channel Size, corresponding to EEG channels | a BCI2000 recognized voltage (e.g. 125mV); triggered when channel value >= threshold value |
| 2 | State | Valid State Name | any integer value; triggered when state value == threshold value |
An example OutputTriggerList which triggers the first output channel on the first input channel of the gSTIMbox when the value is 1, the second output channel on the first EEG channel when the value is greater than or equal to 125 mV, and the third output channel when the space bar is pressed.
| Channel | TriggerType | TriggerName | Threshold |
| 1 | 0 | 1 | 1 |
| 2 | 1 | 1 | 125mV |
| 3 | 2 | KeyDown | 20 |
The channel corresponds to the output channel of the gSTIMbox (1-16).
The table below describes the other parameters.
OutputMatrix
The output matrix describes output states, and how they react to being triggered. For example
| Channel | Default State | Default Mode |