1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
|
#####
Tobii
#####
**Platforms:**
* Windows 7 / 10
* Linux
* macOS
**Required Python Version:**
* Python 3.6 +
**Supported Models:**
Tobii Pro eye tracker models that can use the tobii_research Python package.
For a complete list please visit
`Tobii support <http://developer.tobiipro.com/tobiiprosdk/supportedeyetrackers.html>`_.
Additional Software Requirements
#################################
To use the ioHub interface for Tobii, the Tobi Pro SDK must be installed
in your Python environment. If a recent standalone installation of |PsychoPy|,
this package should already be included.
To install tobii-research type::
pip install tobii-research
EyeTracker Class
################
.. autoclass:: psychopy.iohub.devices.eyetracker.hw.tobii.EyeTracker()
:members: runSetupProcedure, setRecordingState, enableEventReporting, isRecordingEnabled, getEvents, clearEvents, getLastSample, getLastGazePosition, getPosition, getConfiguration
Supported Event Types
#####################
tobii_research provides real-time access to binocular sample data.
The following fields of the ioHub BinocularEyeSample event are supported:
.. autoclass:: psychopy.iohub.devices.eyetracker.BinocularEyeSampleEvent
.. attribute:: time
time of event, in sec.msec format, using psychopy timebase.
.. attribute:: left_gaze_x
The horizontal position of the left eye on the computer screen,
in Display Coordinate Type Units. Calibration must be done prior
to reading (meaningful) gaze data.
Uses tobii_research gaze data 'left_gaze_point_on_display_area'[0] field.
.. attribute:: left_gaze_y
The vertical position of the left eye on the computer screen,
in Display Coordinate Type Units. Calibration must be done prior
to reading (meaningful) gaze data.
Uses tobii_research gaze data 'left_gaze_point_on_display_area'[1] field.
.. attribute:: left_eye_cam_x
The left x eye position in the eye trackers 3D coordinate space.
Uses tobii_research gaze data 'left_gaze_origin_in_trackbox_coordinate_system'[0] field.
.. attribute:: left_eye_cam_y
The left y eye position in the eye trackers 3D coordinate space.
Uses tobii_research gaze data 'left_gaze_origin_in_trackbox_coordinate_system'[1] field.
.. attribute:: left_eye_cam_z
The left z eye position in the eye trackers 3D coordinate space.
Uses tobii_research gaze data 'left_gaze_origin_in_trackbox_coordinate_system'[2] field.
.. attribute:: left_pupil_measure_1
Left eye pupil diameter in mm.
Uses tobii_research gaze data 'left_pupil_diameter' field.
.. attribute:: right_gaze_x
The horizontal position of the right eye on the computer screen,
in Display Coordinate Type Units. Calibration must be done prior
to reading (meaningful) gaze data.
Uses tobii_research gaze data 'right_gaze_point_on_display_area'[0] field.
.. attribute:: right_gaze_y
The vertical position of the right eye on the computer screen,
in Display Coordinate Type Units. Calibration must be done prior
to reading (meaningful) gaze data.
Uses tobii_research gaze data 'right_gaze_point_on_display_area'[1] field.
.. attribute:: right_eye_cam_x
The right x eye position in the eye trackers 3D coordinate space.
Uses tobii_research gaze data 'right_gaze_origin_in_trackbox_coordinate_system'[0] field.
.. attribute:: right_eye_cam_y
The right y eye position in the eye trackers 3D coordinate space.
Uses tobii_research gaze data 'right_gaze_origin_in_trackbox_coordinate_system'[1] field.
.. attribute:: right_eye_cam_z
The right z eye position in the eye trackers 3D coordinate space.
Uses tobii_research gaze data 'right_gaze_origin_in_trackbox_coordinate_system'[2] field.
.. attribute:: right_pupil_measure_1
Right eye pupil diameter in mm.
Uses tobii_research gaze data 'right_pupil_diameter' field.
.. attribute:: status
Indicates if eye sample contains 'valid' data for left and right eyes.
0 = Eye sample is OK.
2 = Right eye data is likely invalid.
20 = Left eye data is likely invalid.
22 = Eye sample is likely invalid.
Default Device Settings
#######################
.. literalinclude:: ../default_yaml_configs/default_tobii_eyetracker.yaml
:language: yaml
**Last Updated:** January, 2021
|
