User Reference:P3SpellerTask - Revision history

Mellinger: /* TargetDefinitions */

2024-08-23T10:47:42Z

TargetDefinitions

← Older revision		Revision as of 10:47, 23 August 2024
Line 143:		Line 143:
	The third column is labeled '''Size'''. It allows to specify an individual size for the matrix element, relative to the size of the other matrix elements.		The third column is labeled '''Size'''. It allows to specify an individual size for the matrix element, relative to the size of the other matrix elements.

	The fourth and fifth columns, labeled '''Icon File''' and '''Sound''', respectively, contain the path to an icon file to be displayed, and a sound to be played, when the matrix element is selected. For icon files, ~~Windows BMP format is~~ accepted. Sounds are given as a path to a ~~Windows WAV~~ file, or as a text enclosed in single quotes. ~~When~~ a text is given, it will be spoken using the system's Text-To-Speech engine.		The fourth and fifth columns, labeled '''Icon File''' and '''Sound''', respectively, contain the path to an icon file to be displayed, and a sound to be played, when the matrix element is selected. For icon files, common image formats are accepted. Sounds are given as a path to a sound file, or as a text enclosed in single quotes. On Windows, when a text is given, it will be spoken using the system's Text-To-Speech engine.
	{{FilePath}}		{{FilePath}}

Pbrunner at 19:49, 19 January 2016

2016-01-19T19:49:32Z

← Older revision		Revision as of 19:49, 19 January 2016
Line 35:		Line 35:
	[[Image:P3SpellerScreenElements.PNG\|center\|frame\|Figure 2: Elements of the user's screen. ''Text To Spell'' indicates the pre-defined text. The speller will analyze evoked responses, and will append the selected text to ''Text Result''.]]		[[Image:P3SpellerScreenElements.PNG\|center\|frame\|Figure 2: Elements of the user's screen. ''Text To Spell'' indicates the pre-defined text. The speller will analyze evoked responses, and will append the selected text to ''Text Result''.]]

	In addition to the text characters, it is possible to display icons (bitmaps) in the P3Speller matrix. This can be achieved by entering the appropriate file name for the icon in column 4 of the desired cell in the ''TargetDefinition'' parameter. The icon will be flashed (highlighted) using a number of methods (see the description of the ''IconHighlightMode'' parameter below).		In addition to the text characters, it is possible to display icons (bitmaps) in the P3Speller matrix. This can be achieved by entering the appropriate file name for the icon in column 4 of the desired cell in the ''TargetDefinition'' parameter. The icon will be flashed (highlighted) using a number of methods (see the description of the ''IconHighlightMode'' parameter below).Alternatively, an additional version of the icon may be displayed during stimulus presentation by entering the file name in an appropriately-labeled column. Although the sixth column has the correct label by default, any column except the first five may be used provided the column label is '''Intensified Icon'''. If an intensified icon is specified, it will be displayed as the highlighted version of the icon instead of using the ''IconHighlightMode'' parameter.

	As new characters are added to the right, the ''Text Result'' area gets filled; once there is no space left, the text is scrolled to the left in order to accommodate for additional characters.		As new characters are added to the right, the ''Text Result'' area gets filled; once there is no space left, the text is scrolled to the left in order to accommodate for additional characters.
Line 133:		Line 133:

	====TargetDefinitions====		====TargetDefinitions====
	A ~~5-column~~ matrix defining elements of the speller matrix.		A matrix defining elements of the speller matrix.
	Each row corresponds to a single matrix element; matrix elements are enumerated row-wise, beginning with the top left matrix element.		Each row corresponds to a single matrix element; matrix elements are enumerated row-wise, beginning with the top left matrix element.

Line 145:		Line 145:
	The fourth and fifth columns, labeled '''Icon File''' and '''Sound''', respectively, contain the path to an icon file to be displayed, and a sound to be played, when the matrix element is selected. For icon files, Windows BMP format is accepted. Sounds are given as a path to a Windows WAV file, or as a text enclosed in single quotes. When a text is given, it will be spoken using the system's Text-To-Speech engine.		The fourth and fifth columns, labeled '''Icon File''' and '''Sound''', respectively, contain the path to an icon file to be displayed, and a sound to be played, when the matrix element is selected. For icon files, Windows BMP format is accepted. Sounds are given as a path to a Windows WAV file, or as a text enclosed in single quotes. When a text is given, it will be spoken using the system's Text-To-Speech engine.
	{{FilePath}}		{{FilePath}}

			The sixth column is labeled '''Intensified Icon''' by default, and may contain the path to an additional icon file to be displayed as the highlighted version of an icon. Except for the first five columns, any column may be used for this purpose as long as it is labeled appropriately. Neither the text string nor the icon will be visible underneath the intensified icon during presentation.

	=====Speller Commands=====		=====Speller Commands=====
Line 208:		Line 210:
	*3 Invert: invert color/brightness values during stimulus presentation,		*3 Invert: invert color/brightness values during stimulus presentation,
	*4 Dim: decrease brightness during presentation.		*4 Dim: decrease brightness during presentation.

			This value won’t be used if an intensified icon is specified.

	====IconHighlightFactor====		====IconHighlightFactor====

Mellinger: /* Parameters */

2012-04-04T08:59:23Z

Parameters

← Older revision		Revision as of 08:59, 4 April 2012
Line 124:		Line 124:

	==Parameters==		==Parameters==
	{{~~ApplicationBaseParams~~}}		{{ApplicationWindowParams}}
	{{StimulusTaskParams}}		{{StimulusTaskParams}}

Mellinger: /* SelectedTarget, SelectedRow, SelectedColumn */

2012-04-04T08:58:04Z

SelectedTarget, SelectedRow, SelectedColumn

← Older revision		Revision as of 08:58, 4 April 2012
Line 264:		Line 264:
	Upon classification, these states are set to the selected target's ID, and its associated row and column, respectively.		Upon classification, these states are set to the selected target's ID, and its associated row and column, respectively.
	A target's ID matches its row number in the ''TargetDefinitions'' matrix.		A target's ID matches its row number in the ''TargetDefinitions'' matrix.
			===SpellerMenu===
			This state contains the one-based index of the current speller menu. It may be set to a different value in order to switch between menus.

	==Timeline==		==Timeline==

Mellinger: /* NumberOfSequences */

2011-05-31T14:40:19Z

NumberOfSequences

← Older revision		Revision as of 14:40, 31 May 2011
Line 129:		Line 129:
	====NumberOfSequences====		====NumberOfSequences====
	The number of intensification sequences performed prior to each classification (selection of matrix elements).		The number of intensification sequences performed prior to each classification (selection of matrix elements).
	For an NxM speller matrix, a single intensification ~~sequences~~ comprises N+M intensifications, one for each row, and one for each column.		For an NxM speller matrix, a single intensification sequence comprises N+M intensifications, one for each row, and one for each column.
	Usually, this parameter is set to the same value as the P3TemporalFilter's [[User Reference:P3TemporalFilter#EpochsToAverage\|EpochsToAverage]] parameter.		Usually, this parameter is set to the same value as the P3TemporalFilter's [[User Reference:P3TemporalFilter#EpochsToAverage\|EpochsToAverage]] parameter.

Mellinger: /* Pause and Sleep */

2011-02-01T13:17:58Z

Pause and Sleep

← Older revision		Revision as of 13:17, 1 February 2011
Line 104:		Line 104:

	The <PAUSE> speller command pauses the ''P3SpellerTask'': While the system is paused, the matrix will continue to flash but target selections shall be ignored until the user resumes system operation, which is achieved by selecting <PAUSE> again.		The <PAUSE> speller command pauses the ''P3SpellerTask'': While the system is paused, the matrix will continue to flash but target selections shall be ignored until the user resumes system operation, which is achieved by selecting <PAUSE> again.
	~~Data recording is also suspended while the system is paused.~~
	The "goal text" line of the status bar indicates that the system is paused.		The "goal text" line of the status bar indicates that the system is paused.
			Data recording continues while the system is paused.

	For a matrix having N entries, one of which is <PAUSE>, the chance to erroneously resume system operation while paused is 1/N per selection. On average, this will happen after N selections in paused state. A second speller command, <SLEEP>, is provided as a safer option. Once in sleep state, the system will resume only after receiving two consecutive <SLEEP> selections, which requires N^2 selections on average to occur by chance.		For a matrix having N entries, one of which is <PAUSE>, the chance to erroneously resume system operation while paused is 1/N per selection. On average, this will happen after N selections in paused state. A second speller command, <SLEEP>, is provided as a safer option. Once in sleep state, the system will resume only after receiving two consecutive <SLEEP> selections, which requires N^2 selections on average to occur by chance.
	When in sleep mode, the "goal text" line of the status bar will instruct the user to select the <SLEEP> command twice to restart.		When in sleep mode, the "goal text" line of the status bar will instruct the user to select the <SLEEP> command twice to restart.
			Data recording is also suspended while the system is sleeping.

	===Text Window===		===Text Window===

Swinden: Fixed anchor link

2009-11-03T14:55:39Z

Fixed anchor link

← Older revision		Revision as of 14:55, 3 November 2009
Line 97:		Line 97:
	In this mode, mouse clicks into matrix elements are registered during sequence presentation, and force selection of the respective matrix element.		In this mode, mouse clicks into matrix elements are registered during sequence presentation, and force selection of the respective matrix element.

	''Please note that the [[DisplayResults]] parameter needs to be turned on in order to be able to select sub matrices.''		''Please note that the [[#DisplayResults\|DisplayResults]] parameter needs to be turned on in order to be able to select sub matrices.''

	===Pause and Sleep===		===Pause and Sleep===

Swinden: Added DisplayResults dependency

2009-11-03T14:51:51Z

Added DisplayResults dependency

← Older revision		Revision as of 14:51, 3 November 2009
Line 96:		Line 96:
	In order to test matrix menu configurations, the ''P3SpellerTask'' may be put into a [[#TestMode\|test mode]].		In order to test matrix menu configurations, the ''P3SpellerTask'' may be put into a [[#TestMode\|test mode]].
	In this mode, mouse clicks into matrix elements are registered during sequence presentation, and force selection of the respective matrix element.		In this mode, mouse clicks into matrix elements are registered during sequence presentation, and force selection of the respective matrix element.

			''Please note that the [[DisplayResults]] parameter needs to be turned on in order to be able to select sub matrices.''

	===Pause and Sleep===		===Pause and Sleep===

Mellinger: /* DestinationAddress */

2009-06-05T13:44:43Z

DestinationAddress

← Older revision		Revision as of 13:44, 5 June 2009
Line 234:		Line 234:
	====DestinationAddress====		====DestinationAddress====
	A network address to receive speller output, given in IP:port format, e.g. <tt>localhost:3582</tt>.		A network address to receive speller output, given in IP:port format, e.g. <tt>localhost:3582</tt>.
	To this address, a UDP socket is opened, and written into such that an external application may connect and receive information about selected matrix elements.		To this address, a UDP socket is opened, and written into, such that an external application may connect and receive information about selected matrix elements.
	For each selection, the speller will write whatever is contained in the selected matrix element's ''Enter'' field, preceded with <tt>P3Speller_Output</tt> and a space character, and followed with a <tt>\r\n</tt> sequence (i.e., an MSDOS style line ending). E.g., the output will be <tt>P3Speller_Output A\r\n</tt> when a matrix element is selected that enters the letter "A", and <tt>P3Speller_Output <BS>\r\n</tt> for a matrix element corresponding to the backspace command.		For each selection, the speller will write whatever is contained in the selected matrix element's ''Enter'' field, preceded with <tt>P3Speller_Output</tt> and a space character, and followed with a <tt>\r\n</tt> sequence (i.e., an MSDOS style line ending). E.g., the output will be <tt>P3Speller_Output A\r\n</tt> when a matrix element is selected that enters the letter "A", and <tt>P3Speller_Output <BS>\r\n</tt> for a matrix element corresponding to the backspace command.

Mellinger: /* TextToSpell */

2009-06-05T13:43:56Z

TextToSpell

← Older revision		Revision as of 13:43, 5 June 2009
Line 222:		Line 222:
	This text is displayed in the status bar, above the actually spelled text.		This text is displayed in the status bar, above the actually spelled text.
	From the difference between ''TextToSpell'', and the actually spelled text, the speller automatically derives which matrix element the user will need to select next.		From the difference between ''TextToSpell'', and the actually spelled text, the speller automatically derives which matrix element the user will need to select next.
	This information is then used to set [[#StimulusType\|StimulusType]] state.		This information is then used to set the [[#StimulusType\|StimulusType]] state.

	====TextResult====		====TextResult====