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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
|
##########
Gazepoint
##########
**Platforms:**
* Windows 7 / 10 only
**Required Python Version:**
* Python 3.6 +
**Supported Models:**
* Gazepoint GP3
Additional Software Requirements
#################################
To use your Gazepoint GP3 during an experiment you must first start the
Gazepoint Control software on the computer running |PsychoPy|.
EyeTracker Class
################
.. autoclass:: psychopy.iohub.devices.eyetracker.hw.gazepoint.gp3.EyeTracker()
:members: runSetupProcedure, setRecordingState, enableEventReporting, isRecordingEnabled, getEvents, clearEvents, getLastSample, getLastGazePosition, getPosition, trackerTime, trackerSec, getConfiguration
Supported Event Types
#####################
The Gazepoint GP3 provides real-time access to binocular sample data.
iohub creates a BinocularEyeSampleEvent for each sample received from the GP3.
The following fields of the 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 Gazepoint LPOGX 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 Gazepoint LPOGY field.
.. attribute:: left_raw_x
The uncalibrated x position of the left eye in a device specific
coordinate space.
Uses Gazepoint LPCX field.
.. attribute:: left_raw_y
The uncalibrated y position of the left eye in a device specific
coordinate space.
Uses Gazepoint LPCY field.
.. attribute:: left_pupil_measure_1
Left eye pupil diameter. (in camera pixels??).
Uses Gazepoint LPD 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 Gazepoint RPOGX 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 Gazepoint RPOGY field.
.. attribute:: right_raw_x
The uncalibrated x position of the right eye in a device specific
coordinate space.
Uses Gazepoint RPCX field.
.. attribute:: right_raw_y
The uncalibrated y position of the right eye in a device specific
coordinate space.
Uses Gazepoint RPCY field.
.. attribute:: right_pupil_measure_1
Right eye pupil diameter. (in camera pixels??).
Uses Gazepoint RPD 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.
iohub also creates basic start and end fixation events by using Gazepoint
FPOG* fields. Identical / duplicate fixation events are created for
the left and right eye.
.. autoclass:: psychopy.iohub.devices.eyetracker.FixationStartEvent
.. attribute:: time
time of event, in sec.msec format, using psychopy timebase.
.. attribute:: eye
Eye that generated the event. Either EyeTrackerConstants.LEFT_EYE
or EyeTrackerConstants.RIGHT_EYE.
.. attribute:: gaze_x
The calibrated horizontal eye position on the computer screen
at the start of the fixation. Units are same as Display.
Calibration must be done prior to reading (meaningful) gaze data.
Uses Gazepoint FPOGX field.
.. attribute:: gaze_y
The calibrated horizontal eye position on the computer screen
at the start of the fixation. Units are same as Display.
Calibration must be done prior to reading (meaningful) gaze data.
Uses Gazepoint FPOGY field.
.. autoclass:: psychopy.iohub.devices.eyetracker.FixationEndEvent
.. attribute:: time
time of event, in sec.msec format, using psychopy timebase.
.. attribute:: eye
Eye that generated the event. Either EyeTrackerConstants.LEFT_EYE
or EyeTrackerConstants.RIGHT_EYE.
.. attribute:: average_gaze_x
Average calibrated horizontal eye position during the fixation,
specified in Display Units.
Uses Gazepoint FPOGX field.
.. attribute:: average_gaze_y
Average calibrated vertical eye position during the fixation,
specified in Display Units.
Uses Gazepoint FPOGY field.
.. attribute:: duration
Duration of the fixation in sec.msec format.
Uses Gazepoint FPOGD field.
Default Device Settings
#######################
.. literalinclude:: ../default_yaml_configs/default_gp3_eyetracker.yaml
:language: yaml
**Last Updated:** January, 2021
|
