MNE-CPP Wiki - User contributions [en]

Setup EEG amplifier plugins in MNE Scan

2016-11-11T17:33:19Z

ViktorKL: /* Save to a FIFF file */

== Available amplifier plugins in MNE Scan ==
Following driver setup tutorials are offered for MNE Scan:

[[EEGoSports]],
[[TMSI Refa]],
[[gUSBAmp]] and
[[BrainAmp]]

== Save to a FIFF file ==

Every acquisition plugin provides the possibility of saving the acquired data stream to a FIFF file. For that purpose two icons can be seen in the status bar of an acquisition plugin:

By clicking the database button, [[File:Database.png|20px|link=]], all storage information of the FIFF file can be set. In addition, an electrode layout file (.elc) can be deposited to the stream. The settings are saved at once and the window can be closed.

[[File:AdjustDatabase.jpg|center|900px|thumb| GUI of the FIFF file storage settings]]

After the acquisition has been started, the record icon, [[File:Record.png|20px|link=]], can be clicked which will initialize the recording. After that it will blink continuously in order to signalize its record status. By clicking on it again, the recording will stop and the FIFF file is saved to the desired location with all its settings.

== Structure of an acquisition plugin ==

The acquisition plugins of MNE Scan have similiar structure and therefore can be explained on the basis of the gUSBamp EEG driver example. The following flow sheet describes the structure of this acquisition plugin.

[[File:Structure_gUSBampAcquisition.png|center|900px|thumb| Flow sheet of the gUSBamp acquisition plugin]]

On the left side the border of MNE Scan can be seen, whereas on the right side the border to the actual device, in this case the gUSBamp amplifier, is depicted. In between, according to their hierarchical order, the three classes are shown as the interface between program and device:

# '''gUSBamp''': regulates the communication between MNE Scan and the driver and acts as the main-class.
# '''gUSBampproducer''': controls the data acquisition and manages the interface between driver and gUSBamp
# '''gUSBampdriver''': actual driver which provides data acquisition and controls the communication between the project and the device

However, gUSBampdriver is the actual class, communicating and exchanging data with the device. The gUSBamp and gUSBampproducer classes can be seen as a way, how to integrate the gUSBampdriver class properly into the project.

When establishing a new plugin to the plugin-box like shown in the [[gUSBAmp]] example, all three classes are initialized one after another by calling the constructors. During this process, all default parameter are generated. After that, the main thread returns to the program and the driver plugin is waiting for the start command or further changing instructions of the parameter by the GUI.

By starting the acquisition, one class invokes the next. At the end, the "gUSBampdriver" class initializes the device with the new parameters and sets the device status to "run". After that, "gUSBamp" and "gUSBampproducer" class are each starting an internal thread which call repetitively for new data packages from the subordinate class and returning them to the overlying class until the data packages reach the MNE Scan environment. This is achieved with so called ring buffers and leads to a continuous data stream.

When stopping the acquisition, both threads are interrupted by putting the "is_running" parameter to false and the "gUSBampdriver" class puts the device into standby mode.

Setup EEG amplifier plugins in MNE Scan

2016-11-11T16:01:40Z

ViktorKL:

== Available amplifier plugins in MNE Scan ==
Following driver setup tutorials are offered for MNE Scan:

[[EEGoSports]],
[[TMSI Refa]],
[[gUSBAmp]] and
[[BrainAmp]]

== Save to a FIFF file ==

Every acquisition plugin provides the possibility of saving the acquired data stream to a FIFF file. For that purpose two icons can be seen in the status bar of an acquisition plugin:

By clicking the database button, [[File:Database.png|20px|link=]], all storage information of the FIFF file can be set. In addition, an electrode layout file (.elc) can be deposited to the stream. The settings are saved at once and the window can be closed.

[[File:AdjustDatabase.jpg|center|900px|thumb| GUI of the FIFF file storage settings]]

After the acquisition has been started, the record icon, [[File:Record.png|20px|link=]], can be clicked which will initialize the recording. After that it will blink continuously in order to show its record status. By clicking on it again, the recording will stop and the FIFF file is saved to the desired location with all the settings.

== Structure of an acquisition plugin ==

The acquisition plugins of MNE Scan have similiar structure and therefore can be explained on the basis of the gUSBamp EEG driver example. The following flow sheet describes the structure of this acquisition plugin.

[[File:Structure_gUSBampAcquisition.png|center|900px|thumb| Flow sheet of the gUSBamp acquisition plugin]]

On the left side the border of MNE Scan can be seen, whereas on the right side the border to the actual device, in this case the gUSBamp amplifier, is depicted. In between, according to their hierarchical order, the three classes are shown as the interface between program and device:

# '''gUSBamp''': regulates the communication between MNE Scan and the driver and acts as the main-class.
# '''gUSBampproducer''': controls the data acquisition and manages the interface between driver and gUSBamp
# '''gUSBampdriver''': actual driver which provides data acquisition and controls the communication between the project and the device

However, gUSBampdriver is the actual class, communicating and exchanging data with the device. The gUSBamp and gUSBampproducer classes can be seen as a way, how to integrate the gUSBampdriver class properly into the project.

When establishing a new plugin to the plugin-box like shown in the [[gUSBAmp]] example, all three classes are initialized one after another by calling the constructors. During this process, all default parameter are generated. After that, the main thread returns to the program and the driver plugin is waiting for the start command or further changing instructions of the parameter by the GUI.

By starting the acquisition, one class invokes the next. At the end, the "gUSBampdriver" class initializes the device with the new parameters and sets the device status to "run". After that, "gUSBamp" and "gUSBampproducer" class are each starting an internal thread which call repetitively for new data packages from the subordinate class and returning them to the overlying class until the data packages reach the MNE Scan environment. This is achieved with so called ring buffers and leads to a continuous data stream.

When stopping the acquisition, both threads are interrupted by putting the "is_running" parameter to false and the "gUSBampdriver" class puts the device into standby mode.

File:AdjustDatabase.jpg

2016-11-11T15:52:26Z

ViktorKL: GUI for setting the database of the storage location for an acquired FIFF file

GUI for setting the database of the storage location for an acquired FIFF file

File:Record.png

2016-11-11T15:45:34Z

ViktorKL: Record button, for running the recording

Record button, for running the recording

File:Database.png

2016-11-11T15:44:57Z

ViktorKL: database icon for adjusting the storage location of the recorded FIFF-file

database icon for adjusting the storage location of the recorded FIFF-file

BrainAmp

2016-11-11T15:31:03Z

ViktorKL:

== Abstract ==

This article describes the installation and usage of the BrainAMP EEG driver plugin for the MNE Scan project.

== Building the BrainAMP EEG plugin ==

In order to build the BrainAMP driver, at first, the header file "BrainAmpIoCtl.h" from the BrainAMP SDK has to be included into the mne-cpp project. These files can be found in the device's attached software library. They have to be copied to the BrainAMP driver repository which is to be found under:

''' %\mne-cpp\applications\mne_scan\plugins\brainamp '''

In a second step, the plugin's source code has to be reintegrated into the mne-cpp project. Therefore, in the file :

''' %\mne-cpp\applications\mne_scan\plugins\plugins.pro '''

the plugin's project "brainamp" has to be restored by deleting the "#" in front of the name in the Sensor section. After this is done, the MNE Scan project can be rebuilt.

== Running the BrainAMP EEG plugin ==

For running the BrainAMP EEG plugin, the according driver has to be installed to the operating system. The files can also be found on the device attached software, as well as a documentation which will guide the whole process. After that, the BrainAMP EEG plugin can be used in the MNE Scan environment, like shown in the following figure.

[[File:BrainAMP_GUI.jpg|center| The GUI of the gUSBamp EEG plugin.]]

Delivered sample frequency and block size can be set on the plugin's surface. Please mind the depicted information. After the settings are done, the acquisition can be started with the green "run" button.

File:BrainAMP GUI.jpg

2016-11-11T15:23:27Z

ViktorKL: the GUI of the BrainAMP aquisition plugin

the GUI of the BrainAMP aquisition plugin

BrainAmp

2016-11-11T15:22:23Z

ViktorKL:

BrainAmp

2016-11-11T15:21:53Z

ViktorKL: Created page with "== Abstract == This article describes the installation and usage of the BrainAMP EEG driver plugin for the MNE Scan project. == Building the BrainAMP EEG plugin == In order..."

GUSBAmp

2016-11-11T15:05:09Z

2016-11-10T13:22:01Z

ViktorKL: The GUI of the gUSBamp EEG plugin.

The GUI of the gUSBamp EEG plugin.

GUSBAmp

ViktorKL:

== Abstract ==

This article describes the installation and usage of the EEGoSports SDK for the MNE-Scan project.

== Building the EEGoSports Driver plugin ==

In order to build the EEGoSports driver plugin, the "eemagine" folder from the SDK has to be added to the EEGoSports folder in the mne-cpp repository in a first step. This location can be found in the mne-cpp repository under:

'''%\mne-cpp\applications\mne_scan\plugins\eegosports\'''

The "eemagine" folder includes another folder called "sdk" which holds the necessary header and source files like: amplifier.h, buffer.h, channel.h, exceptions.h, factory.h, stream.h, version.h, wrapper.cpp and wrapper.h.

In a second step, the eegosports subproject has to be reintegrated into the mne-cpp project. This can be achieved by removing its comment status in the plugins' project file. This file can be found under following path:

''' %\mne-cpp\applications\mne_scan\plugins.pro '''

In order to reintegrate the eegosports subproject into mne-cpp, its comment status has to be removed in this file. This can be achieved by removing the # sign in front of the eegosports project in the Sensors category.

Now, the whole mne-cpp can be rebuilt as normal. MNE Scan then will contain the EEGoSports driver plugin in its Sensor plugin section.

== Running the EEGoSports Driver plugin ==

For a correct recognition of the EEGoSports device, the operating system compatible driver has to be installed with the delivered software. Furthermore the two files "eego-SDK.lib" and "eego-SDK.dll" from the driver's library have to be copied to the location:

''' %\mne-cpp\bin '''

In a last step, the license files which are delivered with the device have to be copied to

''' C:\Users\''Username''\Documents\Eego '''.

The license files should be named like "EE225-020032-000001".

After that, the device can be connected to the computer and be switched on and MNE Scan can be started. It is now possible to use the EEGoSports Driver plugin in the MNE Scan environment. By drag&drop the plugin can be added to the plugin box like in the following example with the SSVEP-BCI plugin.

2016-11-03T11:06:44Z

2016-10-27T13:01:26Z

ViktorKL: /* Adjusting the SSVEP-BCI */

Setup SSVEP BCI example

2016-10-27T13:00:39Z

ViktorKL: /* Adjusting the SSVEP-BCI */