BCI2000 Glossary - Revision history

Wengelhardt at 21:44, 22 April 2025

2025-04-22T21:44:20Z

← Older revision		Revision as of 21:44, 22 April 2025
Line 1:		Line 1:
	A glossary of terms specific to BCI2000.		A glossary of terms specific to BCI2000.

	==~~Data Types~~==		==BCI2000 ''.dat'' file==
	All of BCI2000 data is contained in one of 3 types: parameters, signals, or states.		All of BCI2000 data is contained in one of 3 types: parameters, signals, or states.
	[[File:SignalsStatesParameters.png\|center\|500px]]		[[File:SignalsStatesParameters.png\|center\|500px]]
Line 8:		Line 8:
	#'''States''': Secondary data streams. These should be any data that changes throughout the run. This includes behavioral data (mouse, keyboard, task responses), task behavior (stimuli, other task data), and physiological data (eye-tracking, motion tracking). These are aligned to the main data stream (signal) in the data file.		#'''States''': Secondary data streams. These should be any data that changes throughout the run. This includes behavioral data (mouse, keyboard, task responses), task behavior (stimuli, other task data), and physiological data (eye-tracking, motion tracking). These are aligned to the main data stream (signal) in the data file.

	BCI2000 data ~~is stored in a .dat~~ file~~, which contains~~ ''only'' parameters, states, and signals.		The BCI2000 data file ''only'' contains parameters, states, and signals. For extensive technical documentation on the file format, [[Technical Reference:BCI2000 File Format\|refer to this reference page]].

	==Modules==		==Modules==

Wengelhardt at 21:29, 22 April 2025

2025-04-22T21:29:36Z

← Older revision		Revision as of 21:29, 22 April 2025
Line 4:		Line 4:
	All of BCI2000 data is contained in one of 3 types: parameters, signals, or states.		All of BCI2000 data is contained in one of 3 types: parameters, signals, or states.
	[[File:SignalsStatesParameters.png\|center\|500px]]		[[File:SignalsStatesParameters.png\|center\|500px]]
	#'''Parameters''': Configuration settings. These are set at the beginning of an experiment, and constant throughout the run. In analysis, they can be used to completely replicate the set-up of the experiment.		#'''[[Parameters]]''': Configuration settings. These are set at the beginning of an experiment, and constant throughout the run. In analysis, they can be used to completely replicate the set-up of the experiment.
	#'''Signal''': The main data stream, usually the neurophysiological data from the amplifier.		#'''Signal''': The main data stream, usually the neurophysiological data from the amplifier.
	#'''States''': Secondary data streams. These should be any data that changes throughout the run. This includes behavioral data (mouse, keyboard, task responses), task behavior (stimuli, other task data), and physiological data (eye-tracking, motion tracking). These are aligned to the main data stream (signal) in the data file.		#'''States''': Secondary data streams. These should be any data that changes throughout the run. This includes behavioral data (mouse, keyboard, task responses), task behavior (stimuli, other task data), and physiological data (eye-tracking, motion tracking). These are aligned to the main data stream (signal) in the data file.

Wengelhardt at 20:00, 16 April 2025

2025-04-16T20:00:17Z

← Older revision		Revision as of 20:00, 16 April 2025
Line 21:		Line 21:
	Combining these two BCI2000 elements, we are given the following figure:		Combining these two BCI2000 elements, we are given the following figure:
	[[File:ModulesSigStParam.png\|center\|600px]]		[[File:ModulesSigStParam.png\|center\|600px]]


			==Filters==
			BCI2000 Modules are made up of individual filters. These filters create a pipeline (or [[Programming Reference:Filter Chain\|filter chain]]), where each filter's output is the next filter's input.
			[[File:Filters.png\|center\|300px]]

			Although this design is true for all 3 core modules (Source, Processing, Application), this is most commonly used in the Signal Processing module. This extends BCI2000's modularity, as you can mix and match filters according to your specific desire.


	==Control Signal==		==Control Signal==
Line 28:		Line 36:
	One of [[Technical Reference:Core Modules\|Data Acquisition, Signal Processing, and User Application Module]].		One of [[Technical Reference:Core Modules\|Data Acquisition, Signal Processing, and User Application Module]].
	These are called core modules because they are involved in on-line processing, as opposed to the [[User Reference:Operator Module\|Operator Module]], which controls operation, and passively displays data sent by core modules, but is not actively involved in processing.		These are called core modules because they are involved in on-line processing, as opposed to the [[User Reference:Operator Module\|Operator Module]], which controls operation, and passively displays data sent by core modules, but is not actively involved in processing.

	~~==Filter==~~
	A software component that is part of the BCI2000 processing pipe, or [[Programming Reference:Filter Chain\|filter chain]]. Once per [[#Sample_Block\|sample block]], filters are called to act on data in a sequential fashion. A filter maintains its own [[#Parameter\|parameters]], and enables the user to configure its behavior from the [[#Operator_Module\|operator module]].

	==Module==		==Module==

Wengelhardt at 19:20, 16 April 2025

2025-04-16T19:20:36Z

← Older revision		Revision as of 19:20, 16 April 2025
Line 18:		Line 18:
	#'''Operator''': Provides user interaction and communication between modules. Since this never needs to be changed, new users don't need to worry about this.		#'''Operator''': Provides user interaction and communication between modules. Since this never needs to be changed, new users don't need to worry about this.
	This design maximizes modularity. Any module can be swapped out (e.g., changing the task, changing the amplifier) and the rest of the pipeline will stay the same.		This design maximizes modularity. Any module can be swapped out (e.g., changing the task, changing the amplifier) and the rest of the pipeline will stay the same.

			Combining these two BCI2000 elements, we are given the following figure:
			[[File:ModulesSigStParam.png\|center\|600px]]

	==Control Signal==		==Control Signal==

Wengelhardt at 18:44, 16 April 2025

2025-04-16T18:44:03Z

← Older revision		Revision as of 18:44, 16 April 2025
Line 12:		Line 12:
	==Modules==		==Modules==
	BCI2000 ''always'' runs 4 executables, called modules. The first is ''always'' the Operator module. The other 3 ''must be'' one each of a Signal Source module, a Signal Processing module, and an Application module.		BCI2000 ''always'' runs 4 executables, called modules. The first is ''always'' the Operator module. The other 3 ''must be'' one each of a Signal Source module, a Signal Processing module, and an Application module.
			[[File:Modules.png\|center\|500px]]
	#'''Signal Source''': The module that acquires the data. This connects to the hardware, buffers the data, saves it to the data file and sends it to the signal processing module.		#'''Signal Source''': The module that acquires the data. This connects to the hardware, buffers the data, saves it to the data file and sends it to the signal processing module.
	#'''Signal Processing''': Conducts any signal processing on the raw data and transmits it to the application module.		#'''Signal Processing''': Conducts any signal processing on the raw data and transmits it to the application module.
	#'''Application''': Runs any task and provides any output to the user, such as stimulation.		#'''Application''': Runs any task and provides any output to the user, such as stimulation.
	#'''Operator''': Provides user interaction and communication between modules. Since this never needs to be changed, new users don't need to worry about this.		#'''Operator''': Provides user interaction and communication between modules. Since this never needs to be changed, new users don't need to worry about this.

	This design maximizes modularity. Any module can be swapped out (e.g., changing the task, changing the amplifier) and the rest of the pipeline will stay the same.		This design maximizes modularity. Any module can be swapped out (e.g., changing the task, changing the amplifier) and the rest of the pipeline will stay the same.

Wengelhardt at 16:25, 16 April 2025

2025-04-16T16:25:57Z

← Older revision		Revision as of 16:25, 16 April 2025
Line 1:		Line 1:
	A glossary of terms specific to BCI2000.		A glossary of terms specific to BCI2000.

			==Data Types==
			All of BCI2000 data is contained in one of 3 types: parameters, signals, or states.
			[[File:SignalsStatesParameters.png\|center\|500px]]
			#'''Parameters''': Configuration settings. These are set at the beginning of an experiment, and constant throughout the run. In analysis, they can be used to completely replicate the set-up of the experiment.
			#'''Signal''': The main data stream, usually the neurophysiological data from the amplifier.
			#'''States''': Secondary data streams. These should be any data that changes throughout the run. This includes behavioral data (mouse, keyboard, task responses), task behavior (stimuli, other task data), and physiological data (eye-tracking, motion tracking). These are aligned to the main data stream (signal) in the data file.

			BCI2000 data is stored in a .dat file, which contains ''only'' parameters, states, and signals.

			==Modules==
			BCI2000 ''always'' runs 4 executables, called modules. The first is ''always'' the Operator module. The other 3 ''must be'' one each of a Signal Source module, a Signal Processing module, and an Application module.
			#'''Signal Source''': The module that acquires the data. This connects to the hardware, buffers the data, saves it to the data file and sends it to the signal processing module.
			#'''Signal Processing''': Conducts any signal processing on the raw data and transmits it to the application module.
			#'''Application''': Runs any task and provides any output to the user, such as stimulation.
			#'''Operator''': Provides user interaction and communication between modules. Since this never needs to be changed, new users don't need to worry about this.

			This design maximizes modularity. Any module can be swapped out (e.g., changing the task, changing the amplifier) and the rest of the pipeline will stay the same.

	==Control Signal==		==Control Signal==

Mellinger: /* State */

2023-04-18T15:40:32Z

State

← Older revision		Revision as of 15:40, 18 April 2023
Line 42:		Line 42:
	==State==		==State==
	A system-wide variable similar to what in other data acquisition applications is often called "event marker." State variables reflect important events during real-time system operation, and are saved to the data file along with each sample.		A system-wide variable similar to what in other data acquisition applications is often called "event marker." State variables reflect important events during real-time system operation, and are saved to the data file along with each sample.
			Depending on how states are used, they come in three flavors:
			* Plain state variables may be used to annotate information to signal data, e.g. by the SignalProcessing module,
			* Stream state variables are used by source modules to store additional information synchronously with the input signal, e.g. the state of digital inputs,
			* Event state variables are used to asynchronously log event marker information, e.g. a keypress, or presentation of a stimulus.

	==State Vector==		==State Vector==

Mellinger: /* Filter */

2008-09-04T12:41:57Z

Filter

← Older revision		Revision as of 12:41, 4 September 2008
Line 9:		Line 9:

	==Filter==		==Filter==
	A software component that is part of the BCI2000 processing pipe, or [[Programming Reference:Filter Chain\|filter chain]]. Once per [[#Sample_Block\|sample block]], filters are called to act on data in a sequential fashion. A filter maintains its own [[#Parameter\|parameters]], ~~allowing~~ the user to configure its behavior ~~using~~ the [[#~~Operator~~\|operator module]].		A software component that is part of the BCI2000 processing pipe, or [[Programming Reference:Filter Chain\|filter chain]]. Once per [[#Sample_Block\|sample block]], filters are called to act on data in a sequential fashion. A filter maintains its own [[#Parameter\|parameters]], and enables the user to configure its behavior from the [[#Operator_Module\|operator module]].

	==Module==		==Module==

Mellinger: /* Filter */

2008-09-04T12:41:08Z

Filter

← Older revision		Revision as of 12:41, 4 September 2008
Line 9:		Line 9:

	==Filter==		==Filter==
	A software component that is part of the [[~~Technical~~ Reference:Filter Chain\|~~BCI2000 processing pipe~~]]. Once per [[#Sample_Block\|sample block]], filters are called to act on data in a sequential fashion~~, governed by~~ [[#Parameter\|parameters]].		A software component that is part of the BCI2000 processing pipe, or [[Programming Reference:Filter Chain\|filter chain]]. Once per [[#Sample_Block\|sample block]], filters are called to act on data in a sequential fashion. A filter maintains its own [[#Parameter\|parameters]], allowing the user to configure its behavior using the [[#Operator\|operator module]].

	==Module==		==Module==

Mellinger at 12:38, 4 September 2008

2008-09-04T12:38:18Z

← Older revision		Revision as of 12:38, 4 September 2008
Line 7:		Line 7:
	One of [[Technical Reference:Core Modules\|Data Acquisition, Signal Processing, and User Application Module]].		One of [[Technical Reference:Core Modules\|Data Acquisition, Signal Processing, and User Application Module]].
	These are called core modules because they are involved in on-line processing, as opposed to the [[User Reference:Operator Module\|Operator Module]], which controls operation, and passively displays data sent by core modules, but is not actively involved in processing.		These are called core modules because they are involved in on-line processing, as opposed to the [[User Reference:Operator Module\|Operator Module]], which controls operation, and passively displays data sent by core modules, but is not actively involved in processing.

			==Filter==
			A software component that is part of the [[Technical Reference:Filter Chain\|BCI2000 processing pipe]]. Once per [[#Sample_Block\|sample block]], filters are called to act on data in a sequential fashion, governed by [[#Parameter\|parameters]].

	==Module==		==Module==