Platforms:
Windows 7 / 10 only
Required Python Version:
Python 3.6 +
Supported Models:
Gazepoint GP3
To use your Gazepoint GP3 during an experiment you must first start the Gazepoint Control software on the computer running PsychoPy®.
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:
The BinocularEyeSampleEvent event represents the eye position and eye attribute data collected from one frame or reading of an eye tracker device that is recording both eyes of a participant.
Event Type ID: EventConstants.BINOCULAR_EYE_SAMPLE
Event Type String: ‘BINOCULAR_EYE_SAMPLE’
time of event, in sec.msec format, using psychopy timebase.
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.
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.
The uncalibrated x position of the left eye in a device specific coordinate space. Uses Gazepoint LPCX field.
The uncalibrated y position of the left eye in a device specific coordinate space. Uses Gazepoint LPCY field.
Left eye pupil diameter. (in camera pixels??). Uses Gazepoint LPD field.
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.
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.
The uncalibrated x position of the right eye in a device specific coordinate space. Uses Gazepoint RPCX field.
The uncalibrated y position of the right eye in a device specific coordinate space. Uses Gazepoint RPCY field.
Right eye pupil diameter. (in camera pixels??). Uses Gazepoint RPD field.
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.
A FixationStartEvent is generated when the beginning of an eye fixation ( in very general terms, a period of relatively stable eye position ) is detected by the eye trackers sample parsing algorithms.
Event Type ID: EventConstants.FIXATION_START
Event Type String: ‘FIXATION_START’
time of event, in sec.msec format, using psychopy timebase.
Eye that generated the event. Either EyeTrackerConstants.LEFT_EYE or EyeTrackerConstants.RIGHT_EYE.
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.
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.
A FixationEndEvent is generated when the end of an eye fixation ( in very general terms, a period of relatively stable eye position ) is detected by the eye trackers sample parsing algorithms.
Event Type ID: EventConstants.FIXATION_END
Event Type String: ‘FIXATION_END’
time of event, in sec.msec format, using psychopy timebase.
Eye that generated the event. Either EyeTrackerConstants.LEFT_EYE or EyeTrackerConstants.RIGHT_EYE.
Average calibrated horizontal eye position during the fixation, specified in Display Units. Uses Gazepoint FPOGX field.
Average calibrated vertical eye position during the fixation, specified in Display Units. Uses Gazepoint FPOGY field.
Duration of the fixation in sec.msec format. Uses Gazepoint FPOGD field.
eyetracker.hw.gazepoint.gp3.EyeTracker:
# Indicates if the device should actually be loaded at experiment runtime.
enable: True
# The variable name of the device that will be used to access the ioHub Device class
# during experiment run-time, via the devices.[name] attribute of the ioHub
# connection or experiment runtime class.
name: tracker
# Should eye tracker events be saved to the ioHub DataStore file when the device
# is recording data ?
save_events: True
# Should eye tracker events be sent to the Experiment process when the device
# is recording data ?
stream_events: True
# How many eye events (including samples) should be saved in the ioHub event buffer before
# old eye events start being replaced by new events. When the event buffer reaches
# the maximum event length of the buffer defined here, older events will start to be dropped.
event_buffer_length: 1024
# The GP3 implementation of the common eye tracker interface supports the
# BinocularEyeSampleEvent event type.
monitor_event_types: [ BinocularEyeSampleEvent, FixationStartEvent, FixationEndEvent]
device_timer:
interval: 0.005
calibration:
# target_duration is the number of sec.msec that a calibration point should
# be displayed before moving onto the next point.
# (Sets the GP3 CALIBRATE_TIMEOUT)
target_duration: 1.25
# target_delay specifies the target animation duration in sec.msec.
# (Sets the GP3 CALIBRATE_DELAY)
target_delay: 0.5
# The model name of the device.
model_name: GP3
# The serial number of the GP3 device.
serial_number:
# manufacturer_name is used to store the name of the maker of the eye tracking
# device. This is for informational purposes only.
manufacturer_name: GazePoint
Last Updated: January, 2021