User Tutorial:StimulusPresentation - Revision history

Swiftj: /* Demo Script Location */

2022-10-05T21:17:40Z

Demo Script Location

← Older revision		Revision as of 21:17, 5 October 2022
Line 7:		Line 7:

	==Demo Script Location==		==Demo Script Location==
	The Stimulus Presentation MATLAB demo script can be found in the root directory of your BCI2000 folder in /tools/matlab/StimulusPresentationScript_Demo.m		The Stimulus Presentation MATLAB demo script can be found in the root directory of your BCI2000 folder in /tools/matlab/StimulusPresentationScript_Demo.m.

	A parallel version of this script implemented in Python ~~is coming soon!~~		A parallel version of this script implemented in Python can be found in the root directory of your BCI2000 folder in /tools/python/StimulusPresentationScript_Demo.py.

	==Video==		==Video==

Swiftj: /* Tutorial */

2022-07-07T19:16:32Z

Tutorial

← Older revision		Revision as of 19:16, 7 July 2022
Line 96:		Line 96:

	<li>		<li>
	Create a structure with details about the stimuli that will be presented. In this example, we are simply using all of the images in the /prog/images folder. Stimuli can also be .wav files or .mp4 files.		Create a structure with details about the stimuli that will be presented. In this example, we are simply using all of the .bmp images in the /prog/images folder. Stimuli can also be .wav files or *.mp4 files.
	<pre>		<pre>
	%% Get task images		%% Get task images

Swiftj: /* Tutorial */

2022-07-06T20:38:48Z

Tutorial

← Older revision		Revision as of 20:38, 6 July 2022
Line 228:		Line 228:

	<li>		<li>
	Present images in a random sequence		Present images in a random sequence. The Sequence parameter specifies which Stimulus Codes (corresponding to the columns of the Stimuli matrix) will be presented and the order in which they will be presented. This section creates a sequence that starts with the Stimulus Code for the instructions, then alternates the Stimulus Codes for the image and variable duration fixation cross stimuli. Note that the Sequence is also stored in the param structure as a string.
	<pre>		<pre>
	%% Sequence		%% Sequence
Line 257:		Line 257:

	<li>		<li>
	~~Additional parameters~~ can be stored		This script includes examples of various other stimuli that can be stored in the BCI2000 parameter file. The below example shows how the Sampling Rate parameter could be stored according to the value set in the "settings" section.
	<pre>		<pre>
	%%		%%
Line 271:		Line 271:

	<li>		<li>
	~~Write parameters~~ to parameter file		The last section of this script uses the "convert_bciprm" function to write the param structure to a BCI2000 parameter file. As stated above, this parameter file can be loaded in the BCI2000 configuration window to load the stored parameters and run the experiment.
	<pre>		<pre>
	%% write the param struct to a bci2000 parameter file		%% write the param struct to a bci2000 parameter file

Swiftj: /* Tutorial */

2022-07-06T20:33:40Z

Tutorial

← Older revision		Revision as of 20:33, 6 July 2022
Line 106:		Line 106:
	Initialize the Stimuli matrix. A good practice is to separate your stimuli into "banks" for easy evaluation later. Set n_stimuli to the total number of columns needed in the stimuli matrix (i.e., if there are 10 stimuli, but you have them separated into two banks (task 1-5, and rest 11-15), n_stimuli should be set to 15). In this example there are 103 unique stimuli, but they are separated into a total of 301 columns in the Stimuli matrix The column number of the stimulus in the stimuli matrix corresponds to that stimulus' Stimulus Code. The Stimulus Code is a BCI2000 state that reflects which stimuli were actually presented throughout the experiment, sampled at the same rate as the signal source. Details about each stimulus are stored in the rows. You must include the first 3 rows in the order shown, regardless of whether or not you will present e.g. a caption. Replace the 'audio' row label with 'av' to include *.mp4 files. These rows can be expanded to include additional information about each stimulus, such as an image's mean luminance (this can be useful for analyzing the data later). Each cell needs to be initialized as an empty string for BCI2000 to recognize the Stimuli parameter. The current row labels are described below:		Initialize the Stimuli matrix. A good practice is to separate your stimuli into "banks" for easy evaluation later. Set n_stimuli to the total number of columns needed in the stimuli matrix (i.e., if there are 10 stimuli, but you have them separated into two banks (task 1-5, and rest 11-15), n_stimuli should be set to 15). In this example there are 103 unique stimuli, but they are separated into a total of 301 columns in the Stimuli matrix The column number of the stimulus in the stimuli matrix corresponds to that stimulus' Stimulus Code. The Stimulus Code is a BCI2000 state that reflects which stimuli were actually presented throughout the experiment, sampled at the same rate as the signal source. Details about each stimulus are stored in the rows. You must include the first 3 rows in the order shown, regardless of whether or not you will present e.g. a caption. Replace the 'audio' row label with 'av' to include *.mp4 files. These rows can be expanded to include additional information about each stimulus, such as an image's mean luminance (this can be useful for analyzing the data later). Each cell needs to be initialized as an empty string for BCI2000 to recognize the Stimuli parameter. The current row labels are described below:
	* caption - text written to the screen by BCI2000		* caption - text written to the screen by BCI2000
	* icon - a .bmp or .png image file		* icon - the path to a .bmp or .png image file
	* audio - a *.wav audio file		* audio - the path to a *.wav audio file
	* StimulusDuration - the duration of each individual stimulus		* StimulusDuration - the duration of each individual stimulus
	* AudioVolume - the volume of audio files. Enter a '0' if there are no audio stimuli, as this field must be filled with a value 0-100		* AudioVolume - the volume of audio files. Enter a '0' if there are no audio stimuli, as this field must be filled with a value 0-100
Line 149:		Line 149:

	<li>		<li>
	~~Create~~ image stimuli		Populate the Stimuli matrix with details about the task (image) stimuli in columns 1-50. Note that there needs to be at least an empty string for each row.
	<pre>		<pre>
	%% Study images 1-50		%% Study images 1-50
Line 166:		Line 166:

	<li>		<li>
	Create variable duration ~~fixation cross~~		Create fixation cross stimuli to act as the 'rest' data. In this example, we create a variable duration rest period by sampling from a distribution of stimulus durations ranging from 0.5-1.5 s. Because BCI2000 presents stimuli for entire processing blocks (block size, e.g., 50 ms) we ensure that the rest period duration options are divisible by BCI2000 block size. Note that the value entered for the 'StimulusDuration' row of each stimulus is a string with the letter 's' (seconds) appended to the end.
	<pre>		<pre>
	%% inter-stimulus interval (fixation cross) 101-150		%% inter-stimulus interval (fixation cross) 101-150
Line 192:		Line 192:

	<li>		<li>
	~~Instructions~~		Populate the Stimuli matrix with the instructions. These instructions are captions specified in the "settings" section. Instuctions could alternately be an image of text. Note that captions do not wrap to the second line.
	<pre>		<pre>
	%% Instructions 201-202		%% Instructions 201-202
Line 212:		Line 212:

	<li>		<li>
	~~Sync~~ pulse		Include a Stimulus Code for a sync pulse. This could be used to e.g. trigger an output TTL to synchronize recording from a device not connected to BCI2000.
	<pre>		<pre>
	%% Sync pulse 301		%% Sync pulse 301

Swiftj: /* Tutorial */

2022-07-06T20:13:34Z

Tutorial

← Older revision		Revision as of 20:13, 6 July 2022
Line 104:		Line 104:

	<li>		<li>
	Initialize the Stimuli matrix. A good practice is to separate your stimuli into "banks" for easy evaluation later. Set n_stimuli to the total number of columns needed in the stimuli matrix (i.e., if there are 10 stimuli, but you have them separated into two banks (task 1-5, and rest 11-15), n_stimuli should be set to 15). The column number of the stimulus in the stimuli matrix corresponds to that stimulus' Stimulus Code. The Stimulus Code is a BCI2000 state that reflects which stimuli were actually presented throughout the experiment, sampled at the same rate as the signal source. Details about each stimulus are stored in the rows. You must include the first 3 rows in the order shown, regardless of whether or not you will present e.g. a caption. Replace the 'audio' row label with 'av' to include *.mp4 files. These rows can be expanded to include additional information about each stimulus, such as an image's mean luminance (this can be useful for analyzing the data later). Each cell needs to be initialized as an empty string for BCI2000 to recognize the Stimuli parameter. The current row labels are described below:		Initialize the Stimuli matrix. A good practice is to separate your stimuli into "banks" for easy evaluation later. Set n_stimuli to the total number of columns needed in the stimuli matrix (i.e., if there are 10 stimuli, but you have them separated into two banks (task 1-5, and rest 11-15), n_stimuli should be set to 15). In this example there are 103 unique stimuli, but they are separated into a total of 301 columns in the Stimuli matrix The column number of the stimulus in the stimuli matrix corresponds to that stimulus' Stimulus Code. The Stimulus Code is a BCI2000 state that reflects which stimuli were actually presented throughout the experiment, sampled at the same rate as the signal source. Details about each stimulus are stored in the rows. You must include the first 3 rows in the order shown, regardless of whether or not you will present e.g. a caption. Replace the 'audio' row label with 'av' to include *.mp4 files. These rows can be expanded to include additional information about each stimulus, such as an image's mean luminance (this can be useful for analyzing the data later). Each cell needs to be initialized as an empty string for BCI2000 to recognize the Stimuli parameter. The current row labels are described below:
	* caption		* caption - text written to the screen by BCI2000
	* icon		* icon - a .bmp or .png image file
	* audio		* audio - a *.wav audio file
	* StimulusDuration		* StimulusDuration - the duration of each individual stimulus
	* AudioVolume		* AudioVolume - the volume of audio files. Enter a '0' if there are no audio stimuli, as this field must be filled with a value 0-100
	* Category		* Category - additional information about the category of a stimulus can be stored, such as whether a stimulus code corresponds to an instruction
	* EarlyOffsetExpression		* EarlyOffsetExpression - an expression that will cause BCI2000 to end the current stimulus before StimulusDuration elapses, e.g. KeyDown == 32 (when the subject/experimenter presses the space key)

	<pre>		<pre>

Swiftj: /* Tutorial */

2022-07-06T20:08:08Z

Tutorial

← Older revision		Revision as of 20:08, 6 July 2022
Line 104:		Line 104:

	<li>		<li>
	Initialize the Stimuli matrix. A good practice is to separate your stimuli into "banks" for easy evaluation later. Set n_stimuli to the total number of columns needed in the stimuli matrix (i.e., if there are 10 stimuli, but you have them separated into two banks (task 1-5, and rest 11-15), n_stimuli should be set to 15). The column number of the stimulus in the stimuli matrix corresponds to that stimulus' Stimulus Code. The Stimulus Code reflects which stimuli were actually presented throughout the experiment, sampled at the same rate as the signal source. Details about each stimulus are stored in the rows. You must include the first 3 rows in the order shown, regardless of whether or not you will present e.g. a caption. These rows can be expanded to include additional information about each stimulus, such as an image's mean luminance (this can be useful for analyzing the data later). Each cell needs to be initialized as an empty string for BCI2000 to recognize the Stimuli parameter.		Initialize the Stimuli matrix. A good practice is to separate your stimuli into "banks" for easy evaluation later. Set n_stimuli to the total number of columns needed in the stimuli matrix (i.e., if there are 10 stimuli, but you have them separated into two banks (task 1-5, and rest 11-15), n_stimuli should be set to 15). The column number of the stimulus in the stimuli matrix corresponds to that stimulus' Stimulus Code. The Stimulus Code is a BCI2000 state that reflects which stimuli were actually presented throughout the experiment, sampled at the same rate as the signal source. Details about each stimulus are stored in the rows. You must include the first 3 rows in the order shown, regardless of whether or not you will present e.g. a caption. Replace the 'audio' row label with 'av' to include *.mp4 files. These rows can be expanded to include additional information about each stimulus, such as an image's mean luminance (this can be useful for analyzing the data later). Each cell needs to be initialized as an empty string for BCI2000 to recognize the Stimuli parameter. The current row labels are described below:
			* caption
			* icon
			* audio
			* StimulusDuration
			* AudioVolume
			* Category
			* EarlyOffsetExpression

	<pre>		<pre>
	%% Set up the different stimuli so they are represented by unique stimulus codes, separated into banks for easy evaluation later		%% Set up the different stimuli so they are represented by unique stimulus codes, separated into banks for easy evaluation later

Swiftj: /* Tutorial */

2022-07-06T20:02:26Z

Tutorial

← Older revision		Revision as of 20:02, 6 July 2022
Line 104:		Line 104:

	<li>		<li>
	Initialize the ~~stimuli~~ matrix. A good practice is to separate your stimuli into "banks" for easy evaluation later. Set n_stimuli to the total number of columns needed in the stimuli matrix (i.e., if there are 10 stimuli, but you have them separated into two banks (task 1-5, and rest 11-15), n_stimuli should be set to 15). The column number of the stimulus in the stimuli matrix corresponds to that stimulus' Stimulus Code. The Stimulus Code reflects which stimuli were actually presented throughout the experiment, sampled at the same rate as the signal source. Details about each stimulus are stored in the rows. You must include the first 3 rows in the order shown, regardless of whether or not you will present e.g. a caption		Initialize the Stimuli matrix. A good practice is to separate your stimuli into "banks" for easy evaluation later. Set n_stimuli to the total number of columns needed in the stimuli matrix (i.e., if there are 10 stimuli, but you have them separated into two banks (task 1-5, and rest 11-15), n_stimuli should be set to 15). The column number of the stimulus in the stimuli matrix corresponds to that stimulus' Stimulus Code. The Stimulus Code reflects which stimuli were actually presented throughout the experiment, sampled at the same rate as the signal source. Details about each stimulus are stored in the rows. You must include the first 3 rows in the order shown, regardless of whether or not you will present e.g. a caption. These rows can be expanded to include additional information about each stimulus, such as an image's mean luminance (this can be useful for analyzing the data later). Each cell needs to be initialized as an empty string for BCI2000 to recognize the Stimuli parameter.
	<pre>		<pre>
	%% Set up the different stimuli so they are represented by unique stimulus codes, separated into banks for easy evaluation later		%% Set up the different stimuli so they are represented by unique stimulus codes, separated into banks for easy evaluation later

Swiftj: /* Tutorial */

2022-07-06T19:59:06Z

Tutorial

← Older revision		Revision as of 19:59, 6 July 2022
Line 104:		Line 104:

	<li>		<li>
	Initialize the stimuli matrix.		Initialize the stimuli matrix. A good practice is to separate your stimuli into "banks" for easy evaluation later. Set n_stimuli to the total number of columns needed in the stimuli matrix (i.e., if there are 10 stimuli, but you have them separated into two banks (task 1-5, and rest 11-15), n_stimuli should be set to 15). The column number of the stimulus in the stimuli matrix corresponds to that stimulus' Stimulus Code. The Stimulus Code reflects which stimuli were actually presented throughout the experiment, sampled at the same rate as the signal source. Details about each stimulus are stored in the rows. You must include the first 3 rows in the order shown, regardless of whether or not you will present e.g. a caption
	<pre>		<pre>
	%% Set up the different stimuli so they are represented by unique stimulus codes, separated into banks for easy evaluation later		%% Set up the different stimuli so they are represented by unique stimulus codes, separated into banks for easy evaluation later

Swiftj: /* Tutorial */

2022-07-05T22:01:56Z

Tutorial

← Older revision		Revision as of 22:01, 5 July 2022
Line 59:		Line 59:

	<li>		<li>
	~~Settings~~		Set various parameters to be stored in the parameter file. Most of these are standard parameters for BCI2000 stimulus presentation. Here the save path settings.parm_filename stores the location where the parameter file is written.
	<pre>		<pre>
	%% Settings		%% Settings
Line 96:		Line 96:

	<li>		<li>
	~~Get task~~ images		Create a structure with details about the stimuli that will be presented. In this example, we are simply using all of the images in the /prog/images folder. Stimuli can also be .wav files or .mp4 files.
	<pre>		<pre>
	%% Get task images		%% Get task images
Line 104:		Line 104:

	<li>		<li>
	Initialize stimuli		Initialize the stimuli matrix.
	<pre>		<pre>
	%% Set up the different stimuli so they are represented by unique stimulus codes, separated into banks for easy evaluation later		%% Set up the different stimuli so they are represented by unique stimulus codes, separated into banks for easy evaluation later

Swiftj: /* See Also */

2022-07-05T21:11:42Z

← Older revision		Revision as of 21:11, 5 July 2022
Line 280:		Line 280:

	==See Also==		==See Also==
	* [[~~Programming Reference~~:~~BCI2000Remote Class]]~~		* [[User_Reference:StimulusPresentationTask]]
	* [[User Reference:Operator Module Scripting]]

	[[Category:Tutorial]]		[[Category:Tutorial]]