Contributions:EyetrackerLoggerSimulator - Revision history

Mellinger: /* Coordinate System */

2025-07-01T13:30:12Z

Coordinate System

← Older revision		Revision as of 13:30, 1 July 2025
Line 34:		Line 34:
	*''EyeDist'': Z coordinate of eye.		*''EyeDist'': Z coordinate of eye.

	To preserve physical resolution and stay within the range of nonnegative integers, X, Y, and Z coordinates are multiplied a resolution factor, and added to an offset.		To preserve physical resolution and stay within the range of nonnegative integers, X, Y, and Z coordinates are multiplied by a resolution factor, and added to an offset.

	==Parameters==		==Parameters==

Mellinger: /* Coordinate System */

2024-02-29T15:45:34Z

Coordinate System

← Older revision		Revision as of 15:45, 29 February 2024
Line 34:		Line 34:
	*''EyeDist'': Z coordinate of eye.		*''EyeDist'': Z coordinate of eye.

	To preserve physical resolution, X, Y, and Z coordinates are ~~first~~ multiplied ~~by 32767~~, and ~~then subtracted with 32767 before being saved as integer values~~.		To preserve physical resolution and stay within the range of nonnegative integers, X, Y, and Z coordinates are multiplied a resolution factor, and added to an offset.

	==Parameters==		==Parameters==

Mellinger: /* EyetrackerExpressions */

2024-02-29T15:43:16Z

EyetrackerExpressions

← Older revision		Revision as of 15:43, 29 February 2024
Line 52:		Line 52:
	====EyetrackerExpressions====		====EyetrackerExpressions====
	A matrix with rows ''Left'' and ''Right'', and columns for coordinates applying to each eye.		A matrix with rows ''Left'' and ''Right'', and columns for coordinates applying to each eye.
	Each matrix element holds an expression (possibly empty) that may refer to variables defined in the ''EyetrackerInitialization'' expression. In addition, the variable ''t'' holds the time elapsed since the beginning of the current run, in ~~seconds~~.		Each matrix element holds an expression (possibly empty) that may refer to variables defined in the ''EyetrackerInitialization'' expression. In addition, the variable ''t'' holds the time elapsed since the beginning of the current run, in terms of the number of steps (see the ''EyetrackerFrequency'' parameter for how to modify update speed).

	To match the range of an actual eyetracker, expressions in ''EyetrackerExpressions'' should evaluate to a range of [-1, 1].		To match the range of an actual eyetracker, expressions in ''EyetrackerExpressions'' should evaluate to a range of [0, <screen width in mm>] x [0, <screen height in mm>].
	<!--		<!--
	====GazeResolution====		====GazeResolution====

Mellinger: /* EyetrackerExpressions */

2024-02-26T17:04:20Z

EyetrackerExpressions

← Older revision		Revision as of 17:04, 26 February 2024
Line 55:		Line 55:

	To match the range of an actual eyetracker, expressions in ''EyetrackerExpressions'' should evaluate to a range of [-1, 1].		To match the range of an actual eyetracker, expressions in ''EyetrackerExpressions'' should evaluate to a range of [-1, 1].

	<!--		<!--
	====GazeResolution====		====GazeResolution====

Mellinger: /* User configurable Parameters */

2024-02-26T17:03:53Z

User configurable Parameters

← Older revision		Revision as of 17:03, 26 February 2024
Line 38:		Line 38:
	==Parameters==		==Parameters==
	===User configurable Parameters===		===User configurable Parameters===
	The eye tracker is configured in the Source tab within the ~~EyetrackerLogger~~ section.		The eye tracker is configured in the Source tab within the EyetrackerLoggerSimulator section.

	====~~LogEyetrackerTobiiPro~~====		====LogEyetrackerSimulator====
	Set to 0 to disable the eye tracker logger.		Set to 0 to disable the simulated eye tracker logger.

			====EyetrackerUpdateRate====
			The update rate for simulated eyetracker data, with physical unit, e.g. ''1Hz''.

			====EyetrackerInitialization====
			An expression that is evaluated at initialization time. This may be used to define initial values of variables, or constants.
			Note that the variable ''t'' is always defined, and contains the amount of time elapsed since the beginning of the current run, in seconds.

			====EyetrackerExpressions====
			A matrix with rows ''Left'' and ''Right'', and columns for coordinates applying to each eye.
			Each matrix element holds an expression (possibly empty) that may refer to variables defined in the ''EyetrackerInitialization'' expression. In addition, the variable ''t'' holds the time elapsed since the beginning of the current run, in seconds.

			To match the range of an actual eyetracker, expressions in ''EyetrackerExpressions'' should evaluate to a range of [-1, 1].

	<!--		<!--

Mellinger: Created page with "==Synopsis== An extension that records data from a simulated eye tracker into event states. ==Location== http://{{SERVERNAME}}/svn/trunk/src/contrib/Extensions/EyetrackerLoggerSimulator ==Versioning== ===Authors=== Jürgen Mellinger (mellinger@neurotechcenter.org) ===Version History=== 2021-12-02: initial version ===Source Code Revisions=== Initial development: 6455 Tested under: 6455 Known to compile under: 7762 *Broken since: -- ==Functional Description== Uses..."

2024-02-26T16:53:48Z

Created page with "==Synopsis== An extension that records data from a simulated eye tracker into event states. ==Location== http://{{SERVERNAME}}/svn/trunk/src/contrib/Extensions/EyetrackerLoggerSimulator ==Versioning== ===Authors=== Jürgen Mellinger (mellinger@neurotechcenter.org) ===Version History=== *2021-12-02: initial version ===Source Code Revisions=== *Initial development: 6455 *Tested under: 6455 *Known to compile under: 7762 *Broken since: -- ==Functional Description== Uses..."

New page

==Synopsis==
An extension that records data from a simulated eye tracker into event states.

==Location==
http://{{SERVERNAME}}/svn/trunk/src/contrib/Extensions/EyetrackerLoggerSimulator

==Versioning==
===Authors===
Jürgen Mellinger (mellinger@neurotechcenter.org)

===Version History===
*2021-12-02: initial version

===Source Code Revisions===
*Initial development: 6455
*Tested under: 6455
*Known to compile under: 7762
*Broken since: --

==Functional Description==
Uses user-defined expressions to compute gaze and eye position, updated in regular intervals.
Simulated data are recorded into event states.

==Integration into BCI2000==
Compile the extension into your source module by enabling contributed extensions in your CMake configuration, and setting <tt>EXTENSIONS_EYETRACKERLOGGERSIMULATED=On</tt>.
Once the extension is built into the source module, enable it by starting the source module with the <code>--LogEyetrackerSimulator=1</code> command line argument.

==Coordinate System==
A simulated eye position and gaze is be expressed by 5 coordinate values,
*''GazeX'': X coordinate of gaze position,
*''GazeY'': Y coordinate of gaze position,
*''EyePosX'': X coordinate of eye,
*''EyePosY'': Y coordinate of eye,
*''EyeDist'': Z coordinate of eye.

To preserve physical resolution, X, Y, and Z coordinates are first multiplied by 32767, and then subtracted with 32767 before being saved as integer values.

==Parameters==
===User configurable Parameters===
The eye tracker is configured in the Source tab within the EyetrackerLogger section.

====LogEyetrackerTobiiPro====
Set to 0 to disable the eye tracker logger.



==State Variables==
===EyetrackerTime===
Time stamp of eye data compatible
with the [[User_Reference:DataIOFilter#SourceTime|SourceTime data time stamp]].

===EyetrackerLeftEyeGazeX, EyetrackerLeftEyeGazeY, EyetrackerRightEyeGazeX, EyetrackerRightEyeGazeY===
Screen position where the simulated subject is looking at. Point (0,0) corresponds to the top left of the screen. Multiply each value by the unit given in the '''GazeResolution''' parameter in order to obtain the physical location relative to the screen's top left.

===EyetrackerLeftEyePosX, EyetrackerLeftEyePosY, EyetrackerLeftEyeDist, EyetrackerRightEyePosX, EyetrackerRightEyePosY, EyetrackerRightEyeDist===
Simulated eye position.




==See also==
[[User Reference:Logging Input]], [[Contributions:Extensions]], [[Contributions:EyetrackerLogger]]

[[Category:Contributions]][[Category:Extension]]