Contributions:EyetrackerLoggerTobiiPro - Revision history

Mellinger: /* Usage and Calibration */

2026-04-01T16:04:34Z

Usage and Calibration

← Older revision		Revision as of 16:04, 1 April 2026
Line 37:		Line 37:
	When you start the source module, ensure that the <code>--LogEyetrackerTobiiPro=1</code> command line parameter is set.		When you start the source module, ensure that the <code>--LogEyetrackerTobiiPro=1</code> command line parameter is set.

	'''NOTE:''' If the eyetracker is connected via ethernet, and is detected by the calibration utility but not by BCI2000, you probably need to use the calibration utility in order to install an additional library ("Network Runtime") into your system.		'''NOTE:''' If the eyetracker is connected via ethernet, and is detected by the calibration utility but not by BCI2000, you probably need to use the calibration utility in order to install an additional library ("Tobii Network Runtime") into your system.

	==Coordinate System==		==Coordinate System==

2026-04-01T16:04:23Z

Usage and Calibration

← Older revision		Revision as of 16:04, 1 April 2026
Line 37:		Line 37:
	When you start the source module, ensure that the <code>--LogEyetrackerTobiiPro=1</code> command line parameter is set.		When you start the source module, ensure that the <code>--LogEyetrackerTobiiPro=1</code> command line parameter is set.

	'''NOTE:''' If the eyetracker is connected via ethernet and is detected by the calibration utility but not by BCI2000, you probably need to use the calibration utility in order to install an additional library ("Network Runtime") into your system.		'''NOTE:''' If the eyetracker is connected via ethernet, and is detected by the calibration utility but not by BCI2000, you probably need to use the calibration utility in order to install an additional library ("Network Runtime") into your system.

	==Coordinate System==		==Coordinate System==

2026-04-01T16:03:54Z

Usage and Calibration

← Older revision		Revision as of 16:03, 1 April 2026
Line 36:		Line 36:
	Quit the calibration utility before starting BCI2000.		Quit the calibration utility before starting BCI2000.
	When you start the source module, ensure that the <code>--LogEyetrackerTobiiPro=1</code> command line parameter is set.		When you start the source module, ensure that the <code>--LogEyetrackerTobiiPro=1</code> command line parameter is set.

			'''NOTE:''' If the eyetracker is connected via ethernet and is detected by the calibration utility but not by BCI2000, you probably need to use the calibration utility in order to install an additional library ("Network Runtime") into your system.

	==Coordinate System==		==Coordinate System==

2026-04-01T15:55:52Z

Version History

← Older revision		Revision as of 15:55, 1 April 2026
Line 13:		Line 13:
	*2021-03-19: Updated Tobii Pro SDK to v1.8.0.21 by Alexander Belsten (belsten@neurotechcenter.org)		*2021-03-19: Updated Tobii Pro SDK to v1.8.0.21 by Alexander Belsten (belsten@neurotechcenter.org)
	*2023-11-24: Make resolution adjustable through parameters by Jürgen Mellinger (mellinger@neurotechcenter.org)		*2023-11-24: Make resolution adjustable through parameters by Jürgen Mellinger (mellinger@neurotechcenter.org)
			*2026-04-01: Add recording of eye openness by Jürgen Mellinger (mellinger@neurotechcenter.org)

	===Source Code Revisions===		===Source Code Revisions===

2026-04-01T15:51:31Z

State Variables

← Older revision		Revision as of 15:51, 1 April 2026
Line 200:		Line 200:

	These values are only recorded with eyetracker hardware that supports eye openness (Tobii Pro Fusion, Tobii Pro Spectrum).		These values are only recorded with eyetracker hardware that supports eye openness (Tobii Pro Fusion, Tobii Pro Spectrum).

			===EyetrackerLeftEyeOpennessValidity, EyetrackerRightEyeOpennessValidity===
			This state will be equal to four if the eye tracker is unable to obtain eye openness, otherwise it will be zero. <tt>EyetrackerLoggerTobiiPro</tt> will ignore any eye data that is not valid but will report a validity value for that data point nevertheless.
			When eye openness data are being ignored, the respective state variables will keep their previous values.

	==State variables in legacy files==		==State variables in legacy files==

2026-04-01T15:48:38Z

EyetrackerLeftEyeOpenness, EyetrackerRightEyeOpenness

← Older revision		Revision as of 15:48, 1 April 2026
Line 199:		Line 199:
	Multiply by the value of the [[#PupilResolution\|'''PupilResolution''']] parameter to obtain the physical diameter of the eye openness circle.		Multiply by the value of the [[#PupilResolution\|'''PupilResolution''']] parameter to obtain the physical diameter of the eye openness circle.

	These values are only recorded with eyetracker hardware that supports it (Tobii Pro Fusion, Tobii Pro Spectrum).		These values are only recorded with eyetracker hardware that supports eye openness (Tobii Pro Fusion, Tobii Pro Spectrum).

	==State variables in legacy files==		==State variables in legacy files==

2026-04-01T15:48:16Z

State Variables

← Older revision		Revision as of 15:48, 1 April 2026
Line 196:		Line 196:

	===EyetrackerLeftEyeOpenness, EyetrackerRightEyeOpenness===		===EyetrackerLeftEyeOpenness, EyetrackerRightEyeOpenness===
	The diameter of the largest circle that fits between the upper and lower eyelid.		The diameter of the largest circle that fits between the upper and lower eyelid, as estimated by the eyetracker.
			Multiply by the value of the [[#PupilResolution\|'''PupilResolution''']] parameter to obtain the physical diameter of the eye openness circle.

	~~This is~~ only recorded with eyetracker hardware that supports it (Tobii Pro Fusion, Tobii Pro Spectrum).		These values are only recorded with eyetracker hardware that supports it (Tobii Pro Fusion, Tobii Pro Spectrum).

	==State variables in legacy files==		==State variables in legacy files==

2026-04-01T15:46:34Z

EyetrackerLeftEyeValidity, EyetrackerRightEyeValidity

← Older revision		Revision as of 15:46, 1 April 2026
Line 194:		Line 194:
	time stamp and validity value for that data point nevertheless.		time stamp and validity value for that data point nevertheless.
	When eye data are being ignored, all respective state variables will keep their previous values.		When eye data are being ignored, all respective state variables will keep their previous values.

			===EyetrackerLeftEyeOpenness, EyetrackerRightEyeOpenness===
			The diameter of the largest circle that fits between the upper and lower eyelid.

			This is only recorded with eyetracker hardware that supports it (Tobii Pro Fusion, Tobii Pro Spectrum).

	==State variables in legacy files==		==State variables in legacy files==

2026-04-01T15:42:16Z

PupilResolution

← Older revision		Revision as of 15:42, 1 April 2026
Line 88:		Line 88:
	The physical value corresponding to one step in pupil size state variables.		The physical value corresponding to one step in pupil size state variables.
	Must be given in meters, with optional SI prefix. Default is ''0.01mm''.		Must be given in meters, with optional SI prefix. Default is ''0.01mm''.
			If ''EyeOpenness'' is being recorded (see below), the ''PupilResolution'' applies to that as well.

	===Descriptive Parameters===		===Descriptive Parameters===

2025-07-01T13:16:59Z

Synopsis

← Older revision		Revision as of 13:16, 1 July 2025
Line 1:		Line 1:
	==Synopsis==		==Synopsis==
	~~A filter~~ that records state information from ''Tobii Eyetrackers'' using the Tobii Pro SDK into state variables.		An extension that records state information from ''Tobii Eyetrackers'' using the Tobii Pro SDK into state variables.

	==Location==		==Location==