Setup EEG amplifier plugins in MNE Scan - Revision history

LorenzE at 16:36, 25 January 2019

2019-01-25T16:36:34Z

LorenzE: /* Available amplifier plugins in MNE Scan */

2019-01-25T16:36:22Z

‎Available amplifier plugins in MNE Scan

ViktorKL: /* Save to a FIFF file */

2016-11-11T17:33:19Z

‎Save to a FIFF file

ViktorKL at 16:01, 11 November 2016

2016-11-11T16:01:40Z

ViktorKL at 11:47, 11 November 2016

2016-11-11T11:47:31Z

ViktorKL at 11:38, 11 November 2016

2016-11-11T11:38:39Z

ViktorKL at 03:10, 11 November 2016

2016-11-11T03:10:39Z

ViktorKL at 03:01, 11 November 2016

2016-11-11T03:01:46Z

ViktorKL: /* Available amplifier plugins in MNE Scan */

2016-11-11T01:32:18Z

‎Available amplifier plugins in MNE Scan

ViktorKL: /* Available amplifier plugins in MNE Scan */

2016-11-10T15:04:27Z

‎Available amplifier plugins in MNE Scan

@@ Line 5: / Line 5: @@
 [[TMSI Refa]],
 [[gUSBAmp]],
-[[NAtus]]  and
+[[Natus]]  and
 [[BrainAmp]]

@@ Line 4: / Line 4: @@
 [[EEGoSports]],
 [[TMSI Refa]],
-[[gUSBAmp]] and
+[[gUSBAmp]],
 [[BrainAmp]]

@@ Line 15: / Line 15: @@
 [[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.
+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 ==

@@ Line 6: / Line 6: @@
 [[gUSBAmp]] and
 [[BrainAmp]]
 == Structure of an acquisition plugin ==

← Older revision		Revision as of 11:47, 11 November 2016
Line 24:		Line 24:

	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.		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.

@@ Line 9: / Line 9: @@
 == 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 the 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 main classes are depicted as the interface between program and device:
+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.
@@ Line 21: / Line 21: @@
 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. 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.
+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.

← Older revision		Revision as of 03:10, 11 November 2016
Line 21:		Line 21:
	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.		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.	+	When establishing a new plugin to the plugin-box like shown in the [[gUSBAmp]] example, all three classes are initialized one after another. 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.

@@ Line 1: / Line 1: @@
 == Available amplifier plugins in MNE Scan ==
-Following driver tutorials are offered for MNE Scan:
+Following driver setup tutorials are offered for MNE Scan:
 [[EEGoSports]],