OpenEEG Signal Element

Modified on 2018/08/03 21:33 by Administrator Categorized as Elements, Signal Acquisition
<div style="margin-right: 10px; margin-left: 16px; margin-bottom:10px; float: right; width: 500px; overflow: hidden; height: auto; padding: 0px; background: #fafafa; background: -webkit-gradient(linear, left top, left bottom, from(#fbfbfb), to(#fafafa));background: -moz-linear-gradient(top, #fbfbfb, #fafafa);border: 1px dashed #ddd;box-shadow: 0 0 0 3px #fff, 0 0 0 5px #ddd, 0 0 0 10px #fff, 0 0 2px 10px #eee;">
== Summary ==
{s:Element Info Panel
| title=OpenEEG Signal
| category=Signal Acquisition
| icon=[image|Element Icon|{UP(OpenEEG-Signal-Element)}OpenEEG-Signal-Element-Icon.png]
| author= OkazoLab
| addin= Signal Processing
| scope= Experiment
| usage= Snippets
| ownsnippets= None
}
== Properties ==
{|
|-
! Name
! Description                              
! Constraints
! Type
! On<br/>runtime<br/>change
|-
| colspan="5" bgcolor="#AADDDDD" | Port Settings
|-
| Port Name        
| Defines the name of serial port that is connected to EEG hardware        
| {s:atDesign}        
| String        
|  
|-
| Baud Rate        
| Defines the serial baud rate (samples per second) of the serial port        
| {s:atDesign}        
| Int32        
|  
|-
| Stop Bits        
| Defines the number of stopbits per each transferred byte        
| {s:atDesign}        
| StopBi..        
|  
|-
| Parity        
| Defines the parity-checking protocol for the port        
| {s:atDesign}        
| Parity        
|  
|-
| Data Bits Number        
| Defines the number of data bits in each transferred byte        
| {s:atDesign}        
| Int32        
|  
|-
| colspan="5" bgcolor="#AADDDDD" | Signal Generator
|-
| Signal Source        
| Defines a source for the signal. The emulated rhythmes can be used for offline validation of the chosen analysis settings        
| {s:atDesign}        
| enEmul..        
|  
|-
| Emulated Sampling Rate        
| Defines the emulation sampling rate (samples per second), when data is generated or streamed from a file.        
| {s:atDesign}        
| Double        
|  
|-
| Primary Frequency        
| Defines the frequency of the primary rhythm in the generated signal, in Hz. Assign the zero to exclude the primary frequency from the generated signal.        
| {s:atDesign}        
| Double        
|  
|-
| Secondary Frequency        
| Defines the frequency of the secondary rhythm in the generated signal, in Hz. The secondary frequency magnitude is a half of the primary frequency magnitude. Assign the zero to exclude the secondary frequency from the generated signal.        
| {s:atDesign}        
| Double        
|  
|-
| Noise Level        
| Defines the noise level (in % to the norm magnitude of the primary frequency). The noise is added to the generated signal. Assign the zero the exclude the noise from the generated signal.        
| {s:atDesign}        
| Double        
|  
|-
| External Datafile        
| Opens the dialog for selecting a data file containing a stream of double numbers representing a signal. If a file name without a path is defined, the data file will be picked up in the location of the experiment file.        
| {s:atDesign}        
| String        
|  
|-
| colspan="5" bgcolor="#AADDDDD" | Channel Configuration
|-
| Selected Channels        
| Defines what signal channels are selected for acquisition within EventIDE. Selected channels are registered in the EventIDE signal pool at runtime and become available for the signal analysis elements.        
| {s:atDesign}        
| IList        
|  
|-
| Selected Channel Count        
| Indicates how many signal channels are currently selected for acquisition        
| {s:atStatus}        
| Int32        
|  
|-
| Total Channel Count        
| Indicates how many signal channels are available for acquisition in the total        
| {s:atStatus}        
| Int32        
|  
|-
| Buffer Size        
| Defines the size (in samples) of a circular buffer that stores incoming signal data.        
| {s:atDesign}        
| Int32        
|  
|-
| colspan="5" bgcolor="#AADDDDD" | Runtime Control
|-
| Reset Signals Now        
| Runtime commands that resets the signal buffers and data acquisition        
| {s:atRuntimeAction}        
| Boolean        
|  
|-
| colspan="5" bgcolor="#AADDDDD" | Control
|-
| Is Enabled        
| If set to false the element is completely omitted when the experiment is run        
| {s:atDesign}        
| Boolean        
|  
|-
| Title        
| Title of the element        
| {s:atDesign}        
| String        
|  
|-            
|}
== ==
</div>
<!--*****************************************************************************************************************************************************************************-->
<!--*****************************************************************************************************************************************************************************-->
<!--*****************************************************************************************************************************************************************************-->
<!--*****************************************************************************************************************************************************************************-->
<!--*****************************************************************************************************************************************************************************-->
<!--*****************************************************************************************************************************************************************************-->
<!--*****************************************************************************************************************************************************************************-->
<!--*****************************************************************************************************************************************************************************-->
<!--*****************************************************************************************************************************************************************************-->
<!--*****************************************************************************************************************************************************************************-->
<!--*****************************************************************************************************************************************************************************-->
<!--*****************************************************************************************************************************************************************************-->
<!--*****************************************************************************************************************************************************************************-->
<!--*****************************************************************************************************************************************************************************-->
'''OpenEEG Signal Element''' allows a real-time signal acquisition from any EEG hardware supporting the [openeeg.sourceforge.net|OpenEEG protocol]. Check a list of all supported acquisition devices [http://openvibe.inria.fr/supported-hardware/|here]

{TOC}

== Description ==

The OpenEEG Signal element reads an EEG signal conveyed directly from EEG hardware via the OpenEEG protocol. As an experiment starts, the element begins receiving data and buffering samples into circular buffers, maintained by EventIDE (the buffers can collect data from multiple signal acquisition elements). The signal processing elements, e.g. [Signal-Analyzer-Element|Signal Analyzer element] can be then used to monitor and analyze the buffered signals at runtime. Fast buffering and processing time in EventIDE (down to 1ms) allows instant detection of signal characteristics and, subsequently, various forms of signal-based feedback control in experiments.


== Practical Use ==

# Add a new OpenEEG Signal element to any event in your experiment (the element is global and works from the start to the end of experiment).
# Select the added element to browse its properties in the Property panel.
# Enter the system name of the serial port connected to your EEG hardware, e.g. 'COM1', 'COM2', etc.
# Adjust the parameters of the serial port transmission, if necessary.
# Select the channels for acquisition and buffering within EventIDE via the '''Selected channels''' property.
# Once the channels are selected, you can access them with by of the signal processing elements.

== Notes ==

* In order to use OpenEEG element, you should have EEG hardware supporting the [openeeg.sourceforge.net|OpenEEG protocol]. The hardware must be connected to your computer and be operational both at run-time and design-time (when the acquisition channels are selected).
Meta Keywords:
Meta Description:
Change Comment:
EventIDE Wiki

Navigation¶

OpenEEG Signal Element
