# Source code for psychopy.iohub.devices.eyetracker.eye_events

"""ioHub Common Eye Tracker Interface"""
# Part of the psychopy.iohub library.
# Copyright (C) 2012-2016 iSolver Software Solutions
# Distributed under the terms of the GNU General Public License (GPL).

from .. import DeviceEvent
from ...constants import EventConstants
from . import EyeTrackerDevice
import numpy as np

##################### Eye Tracker Sample Stream Types ####################
#

class EyeTrackerEvent(DeviceEvent):
PARENT_DEVICE = EyeTrackerDevice

[docs]class MonocularEyeSampleEvent(EyeTrackerEvent):
"""A MonocularEyeSampleEvent represents the eye position and eye attribute
data collected from one frame or reading of an eye tracker device that is
recoding from only one eye, or is recording from both eyes and averaging
the binocular data.

Event Type ID: EventConstants.MONOCULAR_EYE_SAMPLE

Event Type String: 'MONOCULAR_EYE_SAMPLE'
"""
_newDataTypes = [
# The eye type that the sample is from. Valid values are:
('eye', 'u1'),
#   EyeTrackerConstants.LEFT_EYE
#   EyeTrackerConstants.RIGHT_EYE
#   EyeTrackerConstants.BINOCULAR
#   EyeTrackerConstants.BINOCULAR_AVERAGED
#   EyeTrackerConstants.SIMULATED_MONOCULAR
#   EyeTrackerConstants.SIMULATED_BINOCULAR

# The calibrated horizontal eye position on the calibration plane.
('gaze_x', 'f4'),
# This value is specified in Display Coordinate Type Units.

# The calibrated vertical eye position on the calibration plane.
('gaze_y', 'f4'),
# This value is specified in Display Coordinate Type Units.

# The calculated point of gaze in depth. Generally  This can only be
('gaze_z', 'f4'),
# provided if binocular reporting is being performed.

# The x eye position in an eye trackers 3D coordinate space.
('eye_cam_x', 'f4'),
# Generally this field is only available by systems that are also
# calculating eye data using a 3D model of eye position relative to
# the eye camera(s) for example.

# The y eye position in an eye trackers 3D coordinate space.
('eye_cam_y', 'f4'),
# Generally this field is only available by systems that are also
# calculating eye data using a 3D model of eye position relative to
# the eye camera(s) for example.

# The z eye position in an eye trackers 3D coordinate space.
('eye_cam_z', 'f4'),
# Generally this field is only available by systems that are also
# calculating eye data using a 3D model of eye position relative to
# the eye camera(s) for example.

# The horizontal angle of eye the relative to the head.
('angle_x', 'f4'),

# The vertical angle of eye the relative to the head.
('angle_y', 'f4'),

# The non-calibrated x position of the calculated eye 'center'
('raw_x', 'f4'),
# on the camera sensor image,
# factoring in any corneal reflection adjustments.
# This is typically reported in some arbitrary unit space that
# often has sub-pixel resolution due to image processing techniques
# being applied.

# The non-calibrated y position of the calculated eye 'center'
('raw_y', 'f4'),
# on the camera sensor image,
# factoring in any corneal reflection adjustments.
# This is typically reported in some arbitrary unit space that
# often has sub-pixel resolution due to image processing techniques
# being applied.

# A measure related to pupil size or diameter. Attribute
('pupil_measure1', 'f4'),
# pupil_measure1_type defines what type the measure represents.

# Several possible pupil_measure types available:
('pupil_measure1_type', 'u1'),
#       EyeTrackerConstants.PUPIL_AREA
#       EyeTrackerConstants.PUPIL_DIAMETER
#       EyeTrackerConstants.PUPIL_WIDTH
#       EyeTrackerConstants.PUPIL_HEIGHT
#       EyeTrackerConstants.PUPIL_MAJOR_AXIS
#       EyeTrackerConstants.PUPIL_MINOR_AXIS

# A measure related to pupil size or diameter. Attribute
('pupil_measure2', 'f4'),
# pupil_measure2_type defines what type the measure represents.

# Several possible pupil_measure types are available:
('pupil_measure2_type', 'u1'),
#       EyeTrackerConstants.PUPIL_AREA
#       EyeTrackerConstants.PUPIL_DIAMETER
#       EyeTrackerConstants.PUPIL_WIDTH
#       EyeTrackerConstants.PUPIL_HEIGHT
#       EyeTrackerConstants.PUPIL_MAJOR_AXIS
#       EyeTrackerConstants.PUPIL_MINOR_AXIS

('ppd_x', 'f4'),     # Horizontal pixels per visual degree for this eye position
# as reported by the eye tracker.

('ppd_y', 'f4'),     # Vertical pixels per visual degree for this eye position
# as reported by the eye tracker.

# Horizontal velocity of the eye at the time of the sample;
('velocity_x', 'f4'),
# as reported by the eye tracker.

# Vertical velocity of the eye at the time of the sample;
('velocity_y', 'f4'),
# as reported by the eye tracker.

('velocity_xy', 'f4'),  # 2D Velocity of the eye at the time of the sample;
# as reported by the eye tracker.

# An available status word for the eye tracker sample.
('status', 'u1')
# Meaning is completely tracker dependent.
]
EVENT_TYPE_ID = EventConstants.MONOCULAR_EYE_SAMPLE
EVENT_TYPE_STRING = 'MONOCULAR_EYE_SAMPLE'
IOHUB_DATA_TABLE = EVENT_TYPE_STRING

__slots__ = [e[0] for e in _newDataTypes]

def __init__(self, *args, **kwargs):
#: The eye type that the sample is from. Valid values are:
#:
#: EventConstants.LEFT_EYE
#: EventConstants.RIGHT_EYE
#: EventConstants.SIMULATED_MONOCULAR
#: EventConstants.MONOCULAR
self.eye = None

#: The calibrated horizontal eye position on the calibration plane.
#: This value is specified in Display Coordinate Type Units.
self.gaze_x = None

#: The calibrated vertical eye position on the calibration plane.
#: This value is specified in Display Coordinate Type Units.
self.gaze_y = None

#: The calculated point of gaze in depth. Generally this can only be
#: provided if binocular reporting is being performed.
self.gaze_z = None

#: The x eye position in an eye trackers 3D coordinate space.
#: Generally this field is only available by systems that are also
#: calculating eye data using a 3D model of eye position relative to
#: the eye camera(s) for example.
self.eye_cam_x = None

#: The y eye position in an eye trackers 3D coordinate space.
#: Generally this field is only available by systems that are also
#: calculating eye data using a 3D model of eye position relative to
#: the eye camera(s) for example.
self.eye_cam_y = None

#: The z eye position in an eye trackers 3D coordinate space.
#: Generally this field is only available by systems that are also
#: calculating eye data using a 3D model of eye position relative to
#: the eye camera(s) for example.
self.eye_cam_z = None

#: The horizontal angle of eye the relative to the head.
self.angle_x = None

#: The vertical angle of eye the relative to the head.
self.angle_y = None

#: The non-calibrated x position of the calculated eye 'center'
#: on the camera sensor image, factoring in any corneal reflection
#: or other low level adjustments.
#: This is typically reported in some arbitrary unit space that
#: often has sub-pixel resolution due to image processing techniques
#: being applied.
self.raw_x = None

#: The non-calibrated y position of the calculated eye 'center'
#: on the camera sensor image, factoring in any corneal reflection
#: or other low level adjustments.
#: This is typically reported in some arbitrary unit space that
#: often has sub-pixel resolution due to image processing techniques
#: being applied.
self.raw_y = None

#: A measure related to pupil size or diameter. The attribute
#: pupil_measure1_type defines what type the measure represents.
self.pupil_measure1 = None

#: The type of pupil size or shape information provided in the pupil_measure1
#: attribute. Several possible pupil_measure types available:
#:
#: * EyeTrackerConstants.PUPIL_AREA
#: * EyeTrackerConstants.PUPIL_DIAMETER
#: * EyeTrackerConstants.PUPIL_AREA_MM
#: * EyeTrackerConstants.PUPIL_DIAMETER_MM
#: * EyeTrackerConstants.PUPIL_WIDTH
#: * EyeTrackerConstants.PUPIL_HEIGHT
#: * EyeTrackerConstants.PUPIL_WIDTH_MM
#: * EyeTrackerConstants.PUPIL_HEIGHT_MM
#: * EyeTrackerConstants.PUPIL_MAJOR_AXIS
#: * EyeTrackerConstants.PUPIL_MINOR_AXIS
self.pupil_measure1_type = None

#: A second measure related to pupil size or diameter. The attribute
#: pupil_measure2_type defines what type the measure represents.
self.pupil_measure2 = None

#: The type of pupil size or shape information provided in the pupil_measure2
#: attribute. Several possible pupil_measure types available:
#:
#: * EyeTrackerConstants.PUPIL_AREA
#: * EyeTrackerConstants.PUPIL_DIAMETER
#: * EyeTrackerConstants.PUPIL_AREA_MM
#: * EyeTrackerConstants.PUPIL_DIAMETER_MM
#: * EyeTrackerConstants.PUPIL_WIDTH
#: * EyeTrackerConstants.PUPIL_HEIGHT
#: * EyeTrackerConstants.PUPIL_WIDTH_MM
#: * EyeTrackerConstants.PUPIL_HEIGHT_MM
#: * EyeTrackerConstants.PUPIL_MAJOR_AXIS
#: * EyeTrackerConstants.PUPIL_MINOR_AXIS
self.pupil_measure2_type = None

#: Horizontal pixels per visual degree for this eye position
#: as reported by the eye tracker.
self.ppd_x = None

#: Vertical pixels per visual degree for this eye position
#: as reported by the eye tracker.
self.ppd_y = None

#: Horizontal velocity of the eye at the time of the sample;
#: as reported by the eye tracker.
self.velocity_x = None

#: Vertical velocity of the eye at the time of the sample;
#: as reported by the eye tracker.
self.velocity_y = None

#: 2D Velocity of the eye at the time of the sample;
#: as reported by the eye tracker.
self.velocity_xy = None

#: An available status byte for the eye tracker sample.
#: Meaning is completely tracker dependent.
self.status = None

DeviceEvent.__init__(self, *args, **kwargs)

class EyeSampleEvent(EyeTrackerEvent):
"""A EyeSampleEvent reports minimal data regarding an eye sample,
containing a subset of the full MonocularEyeSampleEvent fields. Support for
this event type is optional. If requested but not supported, no events of
this type will be returned.

Both EyeSampleEvents and MonocularEyeSampleEvent /
BinocularEyeSampleEvents can be requested from the eye tracker,
although doing so is redundant and therefore not suggested. ;)

If binocular eye data is available from the device sample, left and right
eye data will be combined to provide a single x,y position and pupil size.
How the binocular eye data is combined into a EyeSampleEvent is
determined by each eye tracker interface.

Please refer to the implementation specific documentation for the
eye tracker of interest for more details.

Event Type ID: EventConstants.EYE_SAMPLE

Event Type String: 'EYE_SAMPLE'

"""
_newDataTypes = [
('x', np.float32),  # The horizontal eye position. Unit type used is
# implementation specific.

('y', np.float32),  # The vertical eye position. Unit type used is
# implementation specific.

('pupil', np.float32),  # Pupil size or diameter.
# Unit type used is implementation specific.

('frame', np.uint64),  # Device frame number for the sample.

('status', np.uint32)  # Status of the eye tracker sample.
]

EVENT_TYPE_ID = EventConstants.EYE_SAMPLE
EVENT_TYPE_STRING = 'EYE_SAMPLE'
IOHUB_DATA_TABLE = EVENT_TYPE_STRING

__slots__ = [e[0] for e in _newDataTypes]

def __init__(self, *args, **kwargs):
#: The horizontal eye position.
self.x = None

#: The vertical eye position.
self.y = None

#: Pupil size or diameter.
self.pupil = None

#: Device frame number for the sample.
self.frame = None

#: An available status byte for the eye tracker sample.
#: Meaning is completely tracker dependent.
self.status = None

DeviceEvent.__init__(self, *args, **kwargs)

[docs]class BinocularEyeSampleEvent(EyeTrackerEvent):
"""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'
"""
_newDataTypes = [
('left_gaze_x', 'f4'),
('left_gaze_y', 'f4'),
('left_gaze_z', 'f4'),
('left_eye_cam_x', 'f4'),
('left_eye_cam_y', 'f4'),
('left_eye_cam_z', 'f4'),
('left_angle_x', 'f4'),
('left_angle_y', 'f4'),
('left_raw_x', 'f4'),
('left_raw_y', 'f4'),
('left_pupil_measure1', 'f4'),
('left_pupil_measure1_type', 'u1'),
('left_pupil_measure2', 'f4'),
('left_pupil_measure2_type', 'u1'),
('left_ppd_x', 'f4'),
('left_ppd_y', 'f4'),
('left_velocity_x', 'f4'),
('left_velocity_y', 'f4'),
('left_velocity_xy', 'f4'),
('right_gaze_x', 'f4'),
('right_gaze_y', 'f4'),
('right_gaze_z', 'f4'),
('right_eye_cam_x', 'f4'),
('right_eye_cam_y', 'f4'),
('right_eye_cam_z', 'f4'),
('right_angle_x', 'f4'),
('right_angle_y', 'f4'),
('right_raw_x', 'f4'),
('right_raw_y', 'f4'),
('right_pupil_measure1', 'f4'),
('right_pupil_measure1_type', 'u1'),
('right_pupil_measure2', 'f4'),
('right_pupil_measure2_type', 'u1'),
('right_ppd_x', 'f4'),
('right_ppd_y', 'f4'),
('right_velocity_x', 'f4'),
('right_velocity_y', 'f4'),
('right_velocity_xy', 'f4'),
('status', 'u1')
]

EVENT_TYPE_ID = EventConstants.BINOCULAR_EYE_SAMPLE
EVENT_TYPE_STRING = 'BINOCULAR_EYE_SAMPLE'
IOHUB_DATA_TABLE = EVENT_TYPE_STRING

__slots__ = [e[0] for e in _newDataTypes]

def __init__(self, *args, **kwargs):

#: The calibrated horizontal left eye position on the calibration plane.
#: This value is specified in Display Coordinate Type Units.
self.left_gaze_x = None

#: The calibrated vertical left eye position on the calibration plane.
#: This value is specified in Display Coordinate Type Units.
self.left_gaze_y = None

#: The calculated point of gaze in depth. Generally this can only be
#: provided if binocular reporting is being performed.
self.left_gaze_z = None

#: The x left eye position in an eye trackers 3D coordinate space.
#: Generally this field is only available by systems that are also
#: calculating eye data using a 3D model of eye position relative to
#: the eye camera(s) for example.
self.left_eye_cam_x = None

#: The y left eye position in an eye trackers 3D coordinate space.
#: Generally this field is only available by systems that are also
#: calculating eye data using a 3D model of eye position relative to
#: the eye camera(s) for example.
self.left_eye_cam_y = None

#: The z left eye position in an eye trackers 3D coordinate space.
#: Generally this field is only available by systems that are also
#: calculating eye data using a 3D model of eye position relative to
#: the eye camera(s) for example.
self.left_eye_cam_z = None

#: The horizontal angle of left eye the relative to the head.
self.left_angle_x = None

#: The vertical angle of left eye the relative to the head.
self.left_angle_y = None

#: The non-calibrated x position of the calculated left eye 'center'
#: on the camera sensor image,
#: factoring in any corneal reflection adjustments.
#: This is typically reported in some arbitrary unit space that
#: often has sub-pixel resolution due to image processing techniques
#: being applied.
self.left_raw_x = None

#: The non-calibrated y position of the calculated left eye 'center'
#: on the camera sensor image,
#: factoring in any corneal reflection adjustments.
#: This is typically reported in some arbitrary unit space that
#: often has sub-pixel resolution due to image processing techniques
#: being applied.
self.left_raw_y = None

#: A measure related to left pupil size or diameter. The attribute
#: pupil_measure1_type defines what type the measure represents.
self.left_pupil_measure1 = None

#: The type of left pupil size or shape information provided in the pupil_measure1
#: attribute. Several possible pupil_measure types available:
#:
#: * EyeTrackerConstants.PUPIL_AREA
#: * EyeTrackerConstants.PUPIL_DIAMETER
#: * EyeTrackerConstants.PUPIL_AREA_MM
#: * EyeTrackerConstants.PUPIL_DIAMETER_MM
#: * EyeTrackerConstants.PUPIL_WIDTH
#: * EyeTrackerConstants.PUPIL_HEIGHT
#: * EyeTrackerConstants.PUPIL_WIDTH_MM
#: * EyeTrackerConstants.PUPIL_HEIGHT_MM
#: * EyeTrackerConstants.PUPIL_MAJOR_AXIS
#: * EyeTrackerConstants.PUPIL_MINOR_AXIS
self.left_pupil_measure1_type = None

#: A second measure related to left pupil size or diameter. The attribute
#: pupil_measure2_type defines what type the measure represents.
self.left_pupil_measure2 = None

#: The type of left pupil size or shape information provided in the pupil_measure2
#: attribute. Several possible pupil_measure types available:
#: attribute. Several possible pupil_measure types available:
#:
#: * EyeTrackerConstants.PUPIL_AREA
#: * EyeTrackerConstants.PUPIL_DIAMETER
#: * EyeTrackerConstants.PUPIL_AREA_MM
#: * EyeTrackerConstants.PUPIL_DIAMETER_MM
#: * EyeTrackerConstants.PUPIL_WIDTH
#: * EyeTrackerConstants.PUPIL_HEIGHT
#: * EyeTrackerConstants.PUPIL_WIDTH_MM
#: * EyeTrackerConstants.PUPIL_HEIGHT_MM
#: * EyeTrackerConstants.PUPIL_MAJOR_AXIS
#: * EyeTrackerConstants.PUPIL_MINOR_AXIS
self.left_pupil_measure2_type = None

#: Horizontal pixels per visual degree for this left eye position
#: as reported by the eye tracker.
self.left_ppd_x = None

#: Vertical pixels per visual degree for this left eye position
#: as reported by the eye tracker.
self.left_ppd_y = None

#: Horizontal velocity of the left eye at the time of the sample;
#: as reported by the eye tracker.
self.left_velocity_x = None

#: Vertical velocity of the left eye at the time of the sample;
#: as reported by the eye tracker.
self.left_velocity_y = None

#: 2D Velocity of the left eye at the time of the sample;
#: as reported by the eye tracker.
self.left_velocity_xy = None

#: The calibrated horizontal right eye position on the calibration plane.
#: This value is specified in Display Coordinate Type Units.
self.right_gaze_x = None

#: The calibrated vertical right eye position on the calibration plane.
#: This value is specified in Display Coordinate Type Units.
self.right_gaze_y = None

#: The calculated point of gaze in depth. Generally this can only be
#: provided if binocular reporting is being performed.
self.right_gaze_z = None

#: The x right eye position in an eye trackers 3D coordinate space.
#: Generally this field is only available by systems that are also
#: calculating eye data using a 3D model of eye position relative to
#: the eye camera(s) for example.
self.right_eye_cam_x = None

#: The y right eye position in an eye trackers 3D coordinate space.
#: Generally this field is only available by systems that are also
#: calculating eye data using a 3D model of eye position relative to
#: the eye camera(s) for example.
self.right_eye_cam_y = None

#: The z right eye position in an eye trackers 3D coordinate space.
#: Generally this field is only available by systems that are also
#: calculating eye data using a 3D model of eye position relative to
#: the eye camera(s) for example.
self.right_eye_cam_z = None

#: The horizontal angle of right eye the relative to the head.
self.right_angle_x = None

#: The vertical angle of right eye the relative to the head.
self.right_angle_y = None

#: The non-calibrated x position of the calculated right eye 'center'
#: on the camera sensor image,
#: factoring in any corneal reflection adjustments.
#: This is typically reported in some arbitrary unit space that
#: often has sub-pixel resolution due to image processing techniques
#: being applied.
self.right_raw_x = None

#: The non-calibrated y position of the calculated right eye 'center'
#: on the camera sensor image,
#: factoring in any corneal reflection adjustments.
#: This is typically reported in some arbitrary unit space that
#: often has sub-pixel resolution due to image processing techniques
#: being applied.
self.right_raw_y = None

#: A measure related to right pupil size or diameter. The attribute
#: pupil_measure1_type defines what type the measure represents.
self.right_pupil_measure1 = None

#: The type of right pupil size or shape information provided in the pupil_measure1
#: attribute. Several possible pupil_measure types available:
#: attribute. Several possible pupil_measure types available:
#:
#: * EyeTrackerConstants.PUPIL_AREA
#: * EyeTrackerConstants.PUPIL_DIAMETER
#: * EyeTrackerConstants.PUPIL_AREA_MM
#: * EyeTrackerConstants.PUPIL_DIAMETER_MM
#: * EyeTrackerConstants.PUPIL_WIDTH
#: * EyeTrackerConstants.PUPIL_HEIGHT
#: * EyeTrackerConstants.PUPIL_WIDTH_MM
#: * EyeTrackerConstants.PUPIL_HEIGHT_MM
#: * EyeTrackerConstants.PUPIL_MAJOR_AXIS
#: * EyeTrackerConstants.PUPIL_MINOR_AXIS
self.right_pupil_measure1_type = None

#: A second measure related to right pupil size or diameter. The attribute
#: pupil_measure2_type defines what type the measure represents.
self.right_pupil_measure2 = None

#: The type of right pupil size or shape information provided in the pupil_measure2
#: attribute. Several possible pupil_measure types available:
#: attribute. Several possible pupil_measure types available:
#:
#: * EyeTrackerConstants.PUPIL_AREA
#: * EyeTrackerConstants.PUPIL_DIAMETER
#: * EyeTrackerConstants.PUPIL_AREA_MM
#: * EyeTrackerConstants.PUPIL_DIAMETER_MM
#: * EyeTrackerConstants.PUPIL_WIDTH
#: * EyeTrackerConstants.PUPIL_HEIGHT
#: * EyeTrackerConstants.PUPIL_WIDTH_MM
#: * EyeTrackerConstants.PUPIL_HEIGHT_MM
#: * EyeTrackerConstants.PUPIL_MAJOR_AXIS
#: * EyeTrackerConstants.PUPIL_MINOR_AXIS
self.right_pupil_measure2_type = None

#: Horizontal pixels per visual degree for this right eye position
#: as reported by the eye tracker.
self.right_ppd_x = None

#: Vertical pixels per visual degree for this right eye position
#: as reported by the eye tracker.
self.right_ppd_y = None

#: Horizontal velocity of the right eye at the time of the sample;
#: as reported by the eye tracker.
self.right_velocity_x = None

#: Vertical velocity of the right eye at the time of the sample;
#: as reported by the eye tracker.
self.right_velocity_y = None

#: 2D Velocity of the right eye at the time of the sample;
#: as reported by the eye tracker.
self.right_velocity_xy = None

#: An available status byte for the eye tracker sample.
#: Meaning is completely tracker dependent.
self.status = None

DeviceEvent.__init__(self, *args, **kwargs)

#
################### Fixation Event Types ##########################
#

[docs]class FixationStartEvent(EyeTrackerEvent):
"""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'

"""
_newDataTypes = [
# The eye type that the fixation is from. Valid values are:
('eye', 'u1'),
#   EyeTrackerConstants.LEFT_EYE
#   EyeTrackerConstants.RIGHT_EYE
#   EyeTrackerConstants.BINOCULAR_AVERAGED
#   EyeTrackerConstants.SIMULATED_MONOCULAR

# The calibrated horizontal eye position on the calibration plane.
('gaze_x', 'f4'),
# This value is specified in Display Coordinate Type Units.

# The calibrated vertical eye position on the calibration plane.
('gaze_y', 'f4'),
# This value is specified in Display Coordinate Type Units.

# The calculated point of gaze in depth. Generally  This can only be
('gaze_z', 'f4'),
# provided if binocular reporting is being performed.

# The horizontal angle of eye the relative to the head.
('angle_x', 'f4'),

# The vertical angle of eye the relative to the head.
('angle_y', 'f4'),

# The non-calibrated x position of the calculated eye 'center'
('raw_x', 'f4'),
# on the camera sensor image,
# factoring in any corneal reflection adjustments.
# This is typically reported in some arbitrary unit space that
# often has sub-pixel resolution due to image processing techniques
# being applied.

# The non-calibrated y position of the calculated eye 'center'
('raw_y', 'f4'),
# on the camera sensor image,
# factoring in any corneal reflection adjustments.
# This is typically reported in some arbitrary unit space that
# often has sub-pixel resolution due to image processing techniques
# being applied.

# A measure related to pupil size or diameter. Attribute
('pupil_measure1', 'f4'),
# pupil_measure1_type defines what type the measure represents.

# Several possible pupil_measure types available:
('pupil_measure1_type', 'u1'),
#       EyeTrackerConstants.PUPIL_AREA
#       EyeTrackerConstants.PUPIL_DIAMETER
#       EyeTrackerConstants.PUPIL_WIDTH
#       EyeTrackerConstants.PUPIL_HEIGHT
#       EyeTrackerConstants.PUPIL_MAJOR_AXIS
#       EyeTrackerConstants.PUPIL_MINOR_AXIS

# A measure related to pupil size or diameter. Attribute
('pupil_measure2', 'f4'),
# pupil_measure2_type defines what type the measure represents.

# Several possible pupil_measure types are available:
('pupil_measure2_type', 'u1'),
#       EyeTrackerConstants.PUPIL_AREA
#       EyeTrackerConstants.PUPIL_DIAMETER
#       EyeTrackerConstants.PUPIL_WIDTH
#       EyeTrackerConstants.PUPIL_HEIGHT
#       EyeTrackerConstants.PUPIL_MAJOR_AXIS
#       EyeTrackerConstants.PUPIL_MINOR_AXIS

('ppd_x', 'f4'),     # Horizontal pixels per visual degree for this eye position
# as reported by the eye tracker.

('ppd_y', 'f4'),     # Vertical pixels per visual degree for this eye position
# as reported by the eye tracker.

# Horizontal velocity of the eye at the time of the fixation start
# sample;
('velocity_x', 'f4'),
# as reported by the eye tracker.

# Vertical velocity of the eye at the time of the fixation start
# sample;
('velocity_y', 'f4'),
# as reported by the eye tracker.

# 2D Velocity of the eye at the time of the fixation start sample;
('velocity_xy', 'f4'),
# as reported by the eye tracker.

# An available status word for the eye tracker fixation start event.
('status', 'u1')
# Meaning is completely tracker dependent.
]

EVENT_TYPE_ID = EventConstants.FIXATION_START
EVENT_TYPE_STRING = EventConstants.getName(EVENT_TYPE_ID)
IOHUB_DATA_TABLE = EVENT_TYPE_STRING

__slots__ = [e[0] for e in _newDataTypes]

def __init__(self, *args, **kwargs):

#: The eye type that the event is from. Valid values are:
#: EyeTrackerConstants.LEFT_EYE
#: EyeTrackerConstants.RIGHT_EYE
#: EyeTrackerConstants.MONOCULAR
#: EyeTrackerConstants.SIMULATED_MONOCULAR
self.eye = None

#: The calibrated horizontal eye position at the start of the eye event
#: on the calibration plane.
#: This value is specified in Display Coordinate Type Units.
self.gaze_x = None

#: The calibrated vertical eye position at the start of the eye event on the calibration plane.
#: This value is specified in Display Coordinate Type Units.
self.gaze_y = None

#: The calculated point of gaze in depth at the start of the eye event. Generally this can only be
#: provided if binocular reporting is being performed.
self.gaze_z = None

#: The horizontal angle of eye the relative to the head at the start of the eye event.
self.angle_x = None

#: The vertical angle of eye the relative to the head at the start of the eye event.
self.angle_y = None

#: The non-calibrated x position of the calculated eye 'center'
#: on the camera sensor image at the start of the eye event,
#: factoring in any corneal reflection adjustments.
#: This is typically reported in some arbitrary unit space that
#: often has sub-pixel resolution due to image processing techniques
#: being applied.
self.raw_x = None

#: The non-calibrated y position of the calculated eye 'center'
#: on the camera sensor image at the start of the eye event,
#: factoring in any corneal reflection adjustments.
#: This is typically reported in some arbitrary unit space that
#: often has sub-pixel resolution due to image processing techniques
#: being applied.
self.raw_y = None

#: A measure related to pupil size or diameter at the start of the eye event.
#: The attribute pupil_measure1_type defines what type the measure represents.
self.pupil_measure1 = None

#: The type of pupil size or shape information provided in the pupil_measure1
#: attribute. Several possible pupil_measure types available:
#:
#: * EyeTrackerConstants.PUPIL_AREA
#: * EyeTrackerConstants.PUPIL_DIAMETER
#: * EyeTrackerConstants.PUPIL_AREA_MM
#: * EyeTrackerConstants.PUPIL_DIAMETER_MM
#: * EyeTrackerConstants.PUPIL_WIDTH
#: * EyeTrackerConstants.PUPIL_HEIGHT
#: * EyeTrackerConstants.PUPIL_WIDTH_MM
#: * EyeTrackerConstants.PUPIL_HEIGHT_MM
#: * EyeTrackerConstants.PUPIL_MAJOR_AXIS
#: * EyeTrackerConstants.PUPIL_MINOR_AXIS
self.pupil_measure1_type = None

#: A second measure related to pupil size or diameter at the start of the eye event.
#: The attribute pupil_measure2_type defines what type the measure represents.
self.pupil_measure2 = None

#: The type of pupil size or shape information provided in the pupil_measure2
#: attribute. Several possible pupil_measure types available:
#:
#: * EyeTrackerConstants.PUPIL_AREA
#: * EyeTrackerConstants.PUPIL_DIAMETER
#: * EyeTrackerConstants.PUPIL_AREA_MM
#: * EyeTrackerConstants.PUPIL_DIAMETER_MM
#: * EyeTrackerConstants.PUPIL_WIDTH
#: * EyeTrackerConstants.PUPIL_HEIGHT
#: * EyeTrackerConstants.PUPIL_WIDTH_MM
#: * EyeTrackerConstants.PUPIL_HEIGHT_MM
#: * EyeTrackerConstants.PUPIL_MAJOR_AXIS
#: * EyeTrackerConstants.PUPIL_MINOR_AXIS
self.pupil_measure2_type = None

#: Horizontal pixels per visual degree for this eye position at the start of the eye event
#: as reported by the eye tracker.
self.ppd_x = None

#: Vertical pixels per visual degree for this eye position at the start of the eye event
#: as reported by the eye tracker.
self.ppd_y = None

#: Horizontal velocity of the eye at the start of the eye event;
#: as reported by the eye tracker.
self.velocity_x = None

#: Vertical velocity of the eye at the start of the eye event;
#: as reported by the eye tracker.
self.velocity_y = None

#: 2D Velocity of the eye at the start of the eye event;
#: as reported by the eye tracker.
self.velocity_xy = None

#: An available status byte for the eye tracker event.
#: Meaning or use is completely tracker dependent.
self.status = None

DeviceEvent.__init__(self, *args, **kwargs)

[docs]class FixationEndEvent(EyeTrackerEvent):
"""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'

"""
_newDataTypes = [
('eye', 'u1'),
('duration', 'f4'),
('start_gaze_x', 'f4'),
('start_gaze_y', 'f4'),
('start_gaze_z', 'f4'),
('start_angle_x', 'f4'),
('start_angle_y', 'f4'),
('start_raw_x', 'f4'),
('start_raw_y', 'f4'),
('start_pupil_measure1', 'f4'),
('start_pupil_measure1_type', 'u1'),
('start_pupil_measure2', 'f4'),
('start_pupil_measure2_type', 'u1'),
('start_ppd_x', 'f4'),
('start_ppd_y', 'f4'),
('start_velocity_x', 'f4'),
('start_velocity_y', 'f4'),
('start_velocity_xy', 'f4'),
('end_gaze_x', 'f4'),
('end_gaze_y', 'f4'),
('end_gaze_z', 'f4'),
('end_angle_x', 'f4'),
('end_angle_y', 'f4'),
('end_raw_x', 'f4'),
('end_raw_y', 'f4'),
('end_pupil_measure1', 'f4'),
('end_pupil_measure1_type', 'u1'),
('end_pupil_measure2', 'f4'),
('end_pupil_measure2_type', 'u1'),
('end_ppd_x', 'f4'),
('end_ppd_y', 'f4'),
('end_velocity_x', 'f4'),
('end_velocity_y', 'f4'),
('end_velocity_xy', 'f4'),
('average_gaze_x', 'f4'),
('average_gaze_y', 'f4'),
('average_gaze_z', 'f4'),
('average_angle_x', 'f4'),
('average_angle_y', 'f4'),
('average_raw_x', 'f4'),
('average_raw_y', 'f4'),
('average_pupil_measure1', 'f4'),
('average_pupil_measure1_type', 'u1'),
('average_pupil_measure2', 'f4'),
('average_pupil_measure2_type', 'u1'),
('average_ppd_x', 'f4'),
('average_ppd_y', 'f4'),
('average_velocity_x', 'f4'),
('average_velocity_y', 'f4'),
('average_velocity_xy', 'f4'),
('peak_velocity_x', 'f4'),
('peak_velocity_y', 'f4'),
('peak_velocity_xy', 'f4'),
('status', 'u1')
]

EVENT_TYPE_ID = EventConstants.FIXATION_END
EVENT_TYPE_STRING = EventConstants.getName(EVENT_TYPE_ID)
IOHUB_DATA_TABLE = EVENT_TYPE_STRING

__slots__ = [e[0] for e in _newDataTypes]

def __init__(self, *args, **kwargs):

#: The eye type that the event is from. Valid values are:
#: The eye type that the sample is from. Valid values are:
#:
#: EventConstants.LEFT_EYE
#: EventConstants.RIGHT_EYE
#: EventConstants.SIMULATED_MONOCULAR
#: EventConstants.MONOCULAR
self.eye = None

#: The calculated duration of the Eye event in sec.msec-usec
#: format.
self.duration = None

#: The calibrated horizontal eye position at the start of the eye event
#: on the calibration plane.
#: This value is specified in Display Coordinate Type Units.
self.start_gaze_x = None

#: The calibrated vertical eye position at the start of the eye event on the calibration plane.
#: This value is specified in Display Coordinate Type Units.
self.start_gaze_y = None

#: The calculated point of gaze in depth at the start of the eye event. Generally this can only be
#: provided if binocular reporting is being performed.
self.start_gaze_z = None

#: The horizontal angle of eye the relative to the head at the start of the eye event.
self.start_angle_x = None

#: The vertical angle of eye the relative to the head at the start of the eye event.
self.start_angle_y = None

#: The non-calibrated x position of the calculated eye 'center'
#: on the camera sensor image at the start of the eye event,
#: factoring in any corneal reflection adjustments.
#: This is typically reported in some arbitrary unit space that
#: often has sub-pixel resolution due to image processing techniques
#: being applied.
self.start_raw_x = None

#: The non-calibrated y position of the calculated eye 'center'
#: on the camera sensor image at the start of the eye event,
#: factoring in any corneal reflection adjustments.
#: This is typically reported in some arbitrary unit space that
#: often has sub-pixel resolution due to image processing techniques
#: being applied.
self.start_raw_y = None

#: A measure related to pupil size or diameter at the start of the eye event.
#: The attribute pupil_measure1_type defines what type the measure represents.
self.start_pupil_measure1 = None

#: The type of pupil size or shape information provided in the pupil_measure1
#: attribute. Several possible pupil_measure types available:
#:
#: * EyeTrackerConstants.PUPIL_AREA
#: * EyeTrackerConstants.PUPIL_DIAMETER
#: * EyeTrackerConstants.PUPIL_AREA_MM
#: * EyeTrackerConstants.PUPIL_DIAMETER_MM
#: * EyeTrackerConstants.PUPIL_WIDTH
#: * EyeTrackerConstants.PUPIL_HEIGHT
#: * EyeTrackerConstants.PUPIL_WIDTH_MM
#: * EyeTrackerConstants.PUPIL_HEIGHT_MM
#: * EyeTrackerConstants.PUPIL_MAJOR_AXIS
#: * EyeTrackerConstants.PUPIL_MINOR_AXIS
self.start_pupil_measure1_type = None

#: A second measure related to pupil size or diameter at the start of the eye event.
#: The attribute pupil_measure2_type defines what type the measure represents.
self.start_pupil_measure2 = None

#: The type of pupil size or shape information provided in the pupil_measure2
#: attribute. Several possible pupil_measure types available:
#:
#: * EyeTrackerConstants.PUPIL_AREA
#: * EyeTrackerConstants.PUPIL_DIAMETER
#: * EyeTrackerConstants.PUPIL_AREA_MM
#: * EyeTrackerConstants.PUPIL_DIAMETER_MM
#: * EyeTrackerConstants.PUPIL_WIDTH
#: * EyeTrackerConstants.PUPIL_HEIGHT
#: * EyeTrackerConstants.PUPIL_WIDTH_MM
#: * EyeTrackerConstants.PUPIL_HEIGHT_MM
#: * EyeTrackerConstants.PUPIL_MAJOR_AXIS
#: * EyeTrackerConstants.PUPIL_MINOR_AXIS
self.start_pupil_measure2_type = None

#: Horizontal pixels per visual degree for this eye position at the start of the eye event
#: as reported by the eye tracker.
self.start_ppd_x = None

#: Vertical pixels per visual degree for this eye position at the start of the eye event
#: as reported by the eye tracker.
self.start_ppd_y = None

#: Horizontal velocity of the eye at the start of the eye event;
#: as reported by the eye tracker.
self.start_velocity_x = None

#: Vertical velocity of the eye at the start of the eye event;
#: as reported by the eye tracker.
self.start_velocity_y = None

#: 2D Velocity of the eye at the start of the eye event;
#: as reported by the eye tracker.
self.start_velocity_xy = None

#: The calibrated horizontal eye position at the end of the eye event
#: on the calibration plane.
#: This value is specified in Display Coordinate Type Units.
self.end_gaze_x = None

#: The calibrated vertical eye position at the end of the eye event on the calibration plane.
#: This value is specified in Display Coordinate Type Units.
self.end_gaze_y = None

#: The calculated point of gaze in depth at the end of the eye event. Generally this can only be
#: provided if binocular reporting is being performed.
self.end_gaze_z = None

#: The horizontal angle of eye the relative to the head at the end of the eye event.
self.end_angle_x = None

#: The vertical angle of eye the relative to the head at the end of the eye event.
self.end_angle_y = None

#: The non-calibrated x position of the calculated eye 'center'
#: on the camera sensor image at the end of the eye event,
#: factoring in any corneal reflection adjustments.
#: This is typically reported in some arbitrary unit space that
#: often has sub-pixel resolution due to image processing techniques
#: being applied.
self.end_raw_x = None

#: The non-calibrated y position of the calculated eye 'center'
#: on the camera sensor image at the end of the eye event,
#: factoring in any corneal reflection adjustments.
#: This is typically reported in some arbitrary unit space that
#: often has sub-pixel resolution due to image processing techniques
#: being applied.
self.end_raw_y = None

#: A measure related to pupil size or diameter at the end of the eye event.
#: The attribute pupil_measure1_type defines what type the measure represents.
self.end_pupil_measure1 = None

#: The type of pupil size or shape information provided in the pupil_measure1
#: attribute. Several possible pupil_measure types available:
#:
#: * EyeTrackerConstants.PUPIL_AREA
#: * EyeTrackerConstants.PUPIL_DIAMETER
#: * EyeTrackerConstants.PUPIL_AREA_MM
#: * EyeTrackerConstants.PUPIL_DIAMETER_MM
#: * EyeTrackerConstants.PUPIL_WIDTH
#: * EyeTrackerConstants.PUPIL_HEIGHT
#: * EyeTrackerConstants.PUPIL_WIDTH_MM
#: * EyeTrackerConstants.PUPIL_HEIGHT_MM
#: * EyeTrackerConstants.PUPIL_MAJOR_AXIS
#: * EyeTrackerConstants.PUPIL_MINOR_AXIS
self.end_pupil_measure1_type = None

#: A second measure related to pupil size or diameter at the end of the eye event.
#: The attribute pupil_measure2_type defines what type the measure represents.
self.end_pupil_measure2 = None

#: The type of pupil size or shape information provided in the pupil_measure2
#: attribute. Several possible pupil_measure types available:
#:
#: * EyeTrackerConstants.PUPIL_AREA
#: * EyeTrackerConstants.PUPIL_DIAMETER
#: * EyeTrackerConstants.PUPIL_AREA_MM
#: * EyeTrackerConstants.PUPIL_DIAMETER_MM
#: * EyeTrackerConstants.PUPIL_WIDTH
#: * EyeTrackerConstants.PUPIL_HEIGHT
#: * EyeTrackerConstants.PUPIL_WIDTH_MM
#: * EyeTrackerConstants.PUPIL_HEIGHT_MM
#: * EyeTrackerConstants.PUPIL_MAJOR_AXIS
#: * EyeTrackerConstants.PUPIL_MINOR_AXIS
self.end_pupil_measure2_type = None

#: Horizontal pixels per visual degree for this eye position at the end of the eye event
#: as reported by the eye tracker.
self.end_ppd_x = None

#: Vertical pixels per visual degree for this eye position at the end of the eye event
#: as reported by the eye tracker.
self.end_ppd_y = None

#: Horizontal velocity of the eye at the end of the eye event;
#: as reported by the eye tracker.
self.end_velocity_x = None

#: Vertical velocity of the eye at the end of the eye event;
#: as reported by the eye tracker.
self.end_velocity_y = None

#: 2D Velocity of the eye at the end of the eye event;
#: as reported by the eye tracker.
self.end_velocity_xy = None

#: Average calibrated horizontal eye position during the eye event
#: on the calibration plane.
#: This value is specified in Display Coordinate Type Units.
self.average_gaze_x = None

#: Average calibrated vertical eye position during the eye event on the calibration plane.
#: This value is specified in Display Coordinate Type Units.
self.average_gaze_y = None

#: Average calculated point of gaze in depth during the eye event. Generally this can only be
#: provided if binocular reporting is being performed.
self.average_gaze_z = None

#: Average horizontal angle of eye the relative to the head during the eye event.
self.average_angle_x = None

#: Average vertical angle of eye the relative to the head during the eye event.
self.average_angle_y = None

#: Average non-calibrated x position of the calculated eye 'center'
#: on the camera sensor image during the eye event,
#: factoring in any corneal reflection adjustments.
#: This is typically reported in some arbitrary unit space that
#: often has sub-pixel resolution due to image processing techniques
#: being applied.
self.average_raw_x = None

#: The average non-calibrated y position of the calculated eye 'center'
#: on the camera sensor image during the eye event,
#: factoring in any corneal reflection adjustments.
#: This is typically reported in some arbitrary unit space that
#: often has sub-pixel resolution due to image processing techniques
#: being applied.
self.average_raw_y = None

#: A measure related to average pupil size or diameter during the eye event.
#: The attribute pupil_measure1_type defines what type the measure represents.
self.average_pupil_measure1 = None

#: The type of pupil size or shape information provided in the pupil_measure1
#: attribute. Several possible pupil_measure types available:
#:
#: * EyeTrackerConstants.PUPIL_AREA
#: * EyeTrackerConstants.PUPIL_DIAMETER
#: * EyeTrackerConstants.PUPIL_AREA_MM
#: * EyeTrackerConstants.PUPIL_DIAMETER_MM
#: * EyeTrackerConstants.PUPIL_WIDTH
#: * EyeTrackerConstants.PUPIL_HEIGHT
#: * EyeTrackerConstants.PUPIL_WIDTH_MM
#: * EyeTrackerConstants.PUPIL_HEIGHT_MM
#: * EyeTrackerConstants.PUPIL_MAJOR_AXIS
#: * EyeTrackerConstants.PUPIL_MINOR_AXIS
self.average_pupil_measure1_type = None

#: A second measure related to average pupil size or diameter during the eye event.
#: The attribute pupil_measure2_type defines what type the measure represents.
self.average_pupil_measure2 = None

#: The type of pupil size or shape information provided in the pupil_measure2
#: attribute. Several possible pupil_measure types available:
#:
#: * EyeTrackerConstants.PUPIL_AREA
#: * EyeTrackerConstants.PUPIL_DIAMETER
#: * EyeTrackerConstants.PUPIL_AREA_MM
#: * EyeTrackerConstants.PUPIL_DIAMETER_MM
#: * EyeTrackerConstants.PUPIL_WIDTH
#: * EyeTrackerConstants.PUPIL_HEIGHT
#: * EyeTrackerConstants.PUPIL_WIDTH_MM
#: * EyeTrackerConstants.PUPIL_HEIGHT_MM
#: * EyeTrackerConstants.PUPIL_MAJOR_AXIS
#: * EyeTrackerConstants.PUPIL_MINOR_AXIS
self.average_pupil_measure2_type = None

#: Average Horizontal pixels per visual degree for this eye position during the eye event
#: as reported by the eye tracker.
self.average_ppd_x = None

#: Average Vertical pixels per visual degree for this eye position during the eye event
#: as reported by the eye tracker.
self.average_ppd_y = None

#: Average Horizontal velocity of the eye during the eye event;
#: as reported by the eye tracker.
self.average_velocity_x = None

#: Average Vertical velocity of the eye during the eye event;
#: as reported by the eye tracker.
self.average_velocity_y = None

#: Average 2D Velocity of the eye at the during the eye event;
#: as reported by the eye tracker.
self.average_velocity_xy = None

#: Peak Horizontal velocity of the eye during the eye event;
#: as reported by the eye tracker.
self.peak_velocity_x = None

#: Peak Vertical velocity of the eye during the eye event;
#: as reported by the eye tracker.
self.peak_velocity_y = None

#: Peak 2D Velocity of the eye at the during the eye event;
#: as reported by the eye tracker.
self.peak_velocity_xy = None

#: An available status byte for the eye tracker event.
#: Meaning or use is completely tracker dependent.
self.status = None

DeviceEvent.__init__(self, *args, **kwargs)

################### Saccade Event Types ##########################
#

EVENT_TYPE_STRING = EventConstants.getName(EVENT_TYPE_ID)
IOHUB_DATA_TABLE = EVENT_TYPE_STRING
__slots__ = []

def __init__(self, *args, **kwargs):
FixationStartEvent.__init__(self, *args, **kwargs)

_newDataTypes = [
('eye', 'u1'),
('duration', 'f4'),
('amplitude_x', 'f4'),
('amplitude_y', 'f4'),
('angle', 'f4'),
('start_gaze_x', 'f4'),
('start_gaze_y', 'f4'),
('start_gaze_z', 'f4'),
('start_angle_x', 'f4'),
('start_angle_y', 'f4'),
('start_raw_x', 'f4'),
('start_raw_y', 'f4'),
('start_pupil_measure1', 'f4'),
('start_pupil_measure1_type', 'u1'),
('start_pupil_measure2', 'f4'),
('start_pupil_measure2_type', 'f4'),
('start_ppd_x', 'f4'),
('start_ppd_y', 'f4'),
('start_velocity_x', 'f4'),
('start_velocity_y', 'f4'),
('start_velocity_xy', 'f4'),
('end_gaze_x', 'f4'),
('end_gaze_y', 'f4'),
('end_gaze_z', 'f4'),
('end_angle_x', 'f4'),
('end_angle_y', 'f4'),
('end_raw_x', 'f4'),
('end_raw_y', 'f4'),
('end_pupil_measure1', 'f4'),
('end_pupil_measure1_type', 'u1'),
('end_pupil_measure2', 'f4'),
('end_pupil_measure2_type', 'u1'),
('end_ppd_x', 'f4'),
('end_ppd_y', 'f4'),
('end_velocity_x', 'f4'),
('end_velocity_y', 'f4'),
('end_velocity_xy', 'f4'),
('average_velocity_x', 'f4'),
('average_velocity_y', 'f4'),
('average_velocity_xy', 'f4'),
('peak_velocity_x', 'f4'),
('peak_velocity_y', 'f4'),
('peak_velocity_xy', 'f4'),
('status', 'u1')
]

EVENT_TYPE_STRING = EventConstants.getName(EVENT_TYPE_ID)
IOHUB_DATA_TABLE = EVENT_TYPE_STRING

__slots__ = [e[0] for e in _newDataTypes]

def __init__(self, *args, **kwargs):

#: The eye type that the event is from. Valid values are:
#: EyeTrackerConstants.LEFT_EYE
#: EyeTrackerConstants.RIGHT_EYE
#: EyeTrackerConstants.MONOCULAR
#: EyeTrackerConstants.SIMULATED_MONOCULAR
self.eye = None

#: The calculated duration of the Eye event in sec.msec-usec
#: format.
self.duration = None

#: The amplitude of the Saccade in the horizonatal direction.
#: Usually specified in visual degrees.
self.amplitude_x

#: The amplitude of the Saccade in the vertical direction.
#: Usually specified in visual degrees.
self.amplitude_y

#: The angle of the Saccade based on the start and end gaze positions.
#: Usually specified in degrees.
self.angle

#: The calibrated horizontal eye position at the start of the eye event
#: on the calibration plane.
#: This value is specified in Display Coordinate Type Units.
self.start_gaze_x = None

#: The calibrated vertical eye position at the start of the eye event on the calibration plane.
#: This value is specified in Display Coordinate Type Units.
self.start_gaze_y = None

#: The calculated point of gaze in depth at the start of the eye event. Generally this can only be
#: provided if binocular reporting is being performed.
self.start_gaze_z = None

#: The horizontal angle of eye the relative to the head at the start of the eye event.
self.start_angle_x = None

#: The vertical angle of eye the relative to the head at the start of the eye event.
self.start_angle_y = None

#: The non-calibrated x position of the calculated eye 'center'
#: on the camera sensor image at the start of the eye event,
#: factoring in any corneal reflection adjustments.
#: This is typically reported in some arbitrary unit space that
#: often has sub-pixel resolution due to image processing techniques
#: being applied.
self.start_raw_x = None

#: The non-calibrated y position of the calculated eye 'center'
#: on the camera sensor image at the start of the eye event,
#: factoring in any corneal reflection adjustments.
#: This is typically reported in some arbitrary unit space that
#: often has sub-pixel resolution due to image processing techniques
#: being applied.
self.start_raw_y = None

#: A measure related to pupil size or diameter at the start of the eye event.
#: The attribute pupil_measure1_type defines what type the measure represents.
self.start_pupil_measure1 = None

#: The type of pupil size or shape information provided in the pupil_measure1
#: attribute. Several possible pupil_measure types available:
#:
#: * EyeTrackerConstants.PUPIL_AREA
#: * EyeTrackerConstants.PUPIL_DIAMETER
#: * EyeTrackerConstants.PUPIL_AREA_MM
#: * EyeTrackerConstants.PUPIL_DIAMETER_MM
#: * EyeTrackerConstants.PUPIL_WIDTH
#: * EyeTrackerConstants.PUPIL_HEIGHT
#: * EyeTrackerConstants.PUPIL_WIDTH_MM
#: * EyeTrackerConstants.PUPIL_HEIGHT_MM
#: * EyeTrackerConstants.PUPIL_MAJOR_AXIS
#: * EyeTrackerConstants.PUPIL_MINOR_AXIS
self.start_pupil_measure1_type = None

#: A second measure related to pupil size or diameter at the start of the eye event.
#: The attribute pupil_measure2_type defines what type the measure represents.
self.start_pupil_measure2 = None

#: The type of pupil size or shape information provided in the pupil_measure2
#: attribute. Several possible pupil_measure types available:
#:
#: * EyeTrackerConstants.PUPIL_AREA
#: * EyeTrackerConstants.PUPIL_DIAMETER
#: * EyeTrackerConstants.PUPIL_AREA_MM
#: * EyeTrackerConstants.PUPIL_DIAMETER_MM
#: * EyeTrackerConstants.PUPIL_WIDTH
#: * EyeTrackerConstants.PUPIL_HEIGHT
#: * EyeTrackerConstants.PUPIL_WIDTH_MM
#: * EyeTrackerConstants.PUPIL_HEIGHT_MM
#: * EyeTrackerConstants.PUPIL_MAJOR_AXIS
#: * EyeTrackerConstants.PUPIL_MINOR_AXIS
self.start_pupil_measure2_type = None

#: Horizontal pixels per visual degree for this eye position at the start of the eye event
#: as reported by the eye tracker.
self.start_ppd_x = None

#: Vertical pixels per visual degree for this eye position at the start of the eye event
#: as reported by the eye tracker.
self.start_ppd_y = None

#: Horizontal velocity of the eye at the start of the eye event;
#: as reported by the eye tracker.
self.start_velocity_x = None

#: Vertical velocity of the eye at the start of the eye event;
#: as reported by the eye tracker.
self.start_velocity_y = None

#: The calibrated horizontal eye position at the end of the eye event
#: on the calibration plane.
#: This value is specified in Display Coordinate Type Units.
self.end_gaze_x = None

#: The calibrated vertical eye position at the end of the eye event on the calibration plane.
#: This value is specified in Display Coordinate Type Units.
self.end_gaze_y = None

#: The calculated point of gaze in depth at the end of the eye event. Generally this can only be
#: provided if binocular reporting is being performed.
self.end_gaze_z = None

#: The horizontal angle of eye the relative to the head at the end of the eye event.
self.end_angle_x = None

#: The vertical angle of eye the relative to the head at the end of the eye event.
self.end_angle_y = None

#: The non-calibrated x position of the calculated eye 'center'
#: on the camera sensor image at the end of the eye event,
#: factoring in any corneal reflection adjustments.
#: This is typically reported in some arbitrary unit space that
#: often has sub-pixel resolution due to image processing techniques
#: being applied.
self.end_raw_x = None

#: The non-calibrated y position of the calculated eye 'center'
#: on the camera sensor image at the end of the eye event,
#: factoring in any corneal reflection adjustments.
#: This is typically reported in some arbitrary unit space that
#: often has sub-pixel resolution due to image processing techniques
#: being applied.
self.end_raw_y = None

#: A measure related to pupil size or diameter at the end of the eye event.
#: The attribute pupil_measure1_type defines what type the measure represents.
self.end_pupil_measure1 = None

#: The type of pupil size or shape information provided in the pupil_measure1
#: attribute. Several possible pupil_measure types available:
#:
#: * EyeTrackerConstants.PUPIL_AREA
#: * EyeTrackerConstants.PUPIL_DIAMETER
#: * EyeTrackerConstants.PUPIL_AREA_MM
#: * EyeTrackerConstants.PUPIL_DIAMETER_MM
#: * EyeTrackerConstants.PUPIL_WIDTH
#: * EyeTrackerConstants.PUPIL_HEIGHT
#: * EyeTrackerConstants.PUPIL_WIDTH_MM
#: * EyeTrackerConstants.PUPIL_HEIGHT_MM
#: * EyeTrackerConstants.PUPIL_MAJOR_AXIS
#: * EyeTrackerConstants.PUPIL_MINOR_AXIS
self.end_pupil_measure1_type = None

#: A second measure related to pupil size or diameter at the end of the eye event.
#: The attribute pupil_measure2_type defines what type the measure represents.
self.end_pupil_measure2 = None

#: The type of pupil size or shape information provided in the pupil_measure2
#: attribute. Several possible pupil_measure types available:
#:
#: * EyeTrackerConstants.PUPIL_AREA
#: * EyeTrackerConstants.PUPIL_DIAMETER
#: * EyeTrackerConstants.PUPIL_AREA_MM
#: * EyeTrackerConstants.PUPIL_DIAMETER_MM
#: * EyeTrackerConstants.PUPIL_WIDTH
#: * EyeTrackerConstants.PUPIL_HEIGHT
#: * EyeTrackerConstants.PUPIL_WIDTH_MM
#: * EyeTrackerConstants.PUPIL_HEIGHT_MM
#: * EyeTrackerConstants.PUPIL_MAJOR_AXIS
#: * EyeTrackerConstants.PUPIL_MINOR_AXIS
self.end_pupil_measure2_type = None

#: Horizontal pixels per visual degree for this eye position at the end of the eye event
#: as reported by the eye tracker.
self.end_ppd_x = None

#: Vertical pixels per visual degree for this eye position at the end of the eye event
#: as reported by the eye tracker.
self.end_ppd_y = None

#: Horizontal velocity of the eye at the end of the eye event;
#: as reported by the eye tracker.
self.end_velocity_x = None

#: Vertical velocity of the eye at the end of the eye event;
#: as reported by the eye tracker.
self.end_velocity_y = None

#: 2D Velocity of the eye at the end of the eye event;
#: as reported by the eye tracker.
self.end_velocity_xy = None

#: Average Horizontal velocity of the eye during the eye event;
#: as reported by the eye tracker.
self.average_velocity_x = None

#: Average Vertical velocity of the eye during the eye event;
#: as reported by the eye tracker.
self.average_velocity_y = None

#: Average 2D Velocity of the eye at the during the eye event;
#: as reported by the eye tracker.
self.average_velocity_xy = None

#: Peak Horizontal velocity of the eye during the eye event;
#: as reported by the eye tracker.
self.peak_velocity_x = None

#: Peak Vertical velocity of the eye during the eye event;
#: as reported by the eye tracker.
self.peak_velocity_y = None

#: Peak 2D Velocity of the eye at the during the eye event;
#: as reported by the eye tracker.
self.peak_velocity_xy = None

#: An available status byte for the eye tracker event.
#: Meaning or use is completely tracker dependent.
self.status = None

DeviceEvent.__init__(self, *args, **kwargs)

################### Blink Event Types ##########################
#
_newDataTypes = [
# The eye type that the fixation is from. Valid values are:
('eye', 'u1'),
#   EyeTrackerConstants.LEFT_EYE
#   EyeTrackerConstants.RIGHT_EYE
#   EyeTrackerConstants.BINOCULAR_AVERAGED
#   EyeTrackerConstants.SIMULATED_MONOCULAR

# An available status byte for the eye tracker blink start event.
('status', 'u1')
# Meaning is completely tracker dependent.
]
__slots__ = [e[0] for e in _newDataTypes]

EVENT_TYPE_STRING = EventConstants.getName(EVENT_TYPE_ID)
IOHUB_DATA_TABLE = EVENT_TYPE_STRING

def __init__(self, *args, **kwargs):

#: The eye type that the event is from. Valid values are:
#: EyeTrackerConstants.LEFT_EYE
#: EyeTrackerConstants.RIGHT_EYE
#: EyeTrackerConstants.MONOCULAR
#: EyeTrackerConstants.SIMULATED_MONOCULAR
self.eye = None

#: An available status byte for the eye tracker event.
#: Meaning or use is completely tracker dependent.
self.status = None

DeviceEvent.__init__(self, *args, **kwargs)

_newDataTypes = [
# The eye type that the fixation is from. Valid values are:
('eye', 'u1'),
#   EyeTrackerConstants.LEFT_EYE
#   EyeTrackerConstants.RIGHT_EYE
#   EyeTrackerConstants.BINOCULAR_AVERAGED
#   EyeTrackerConstants.SIMULATED_MONOCULAR

('duration', 'f4'),  # The duration of the blink event.

# An available status byte for the eye tracker blink start event.
('status', 'u1')
# Meaning is completely tracker dependent.
]

EVENT_TYPE_STRING = EventConstants.getName(EVENT_TYPE_ID)
IOHUB_DATA_TABLE = EVENT_TYPE_STRING

__slots__ = [e[0] for e in _newDataTypes]

def __init__(self, *args, **kwargs):

#: The eye type that the event is from. Valid values are:
#: EyeTrackerConstants.LEFT_EYE
#: EyeTrackerConstants.RIGHT_EYE
#: EyeTrackerConstants.MONOCULAR
#: EyeTrackerConstants.SIMULATED_MONOCULAR
self.eye = None

#: The calculated duration of the Eye event in sec.msec-usec
#: format.
self.duration = None

#: An available status byte for the eye tracker event.
#: Meaning or use is completely tracker dependent.
self.status = None

DeviceEvent.__init__(self, *args, **kwargs)