EyeTracker#

class pymovements.EyeTracker(sampling_rate: float | None = None, left: bool | None = None, right: bool | None = None, model: str | None = None, version: str | None = None, vendor: str | None = None, mount: str | None = None)[source]#

EyeTracker class for holding eyetracker properties.

sampling_rate#

Sample rate of recording (in Hz). (default: None)

Type:

float | None

left#

Whether the left eye is tracked. (default: None)

Type:

bool | None

right#

Whether the right eye is tracked. (default: None)

Type:

bool | None

model#

Eye tracker model (e.g. ‘EyeLink II’, ‘Tobii Pro Spectrum’). (default: None)

Type:

str | None

version#

Eye tracker software version number. (default: None)

Type:

str | None

vendor#

Eye tracker vendor (e.g. ‘EyeLink’, ‘Tobii’). (default: None)

Type:

str | None

mount#

The mounting setup of the eye tracker (e.g. ‘Desktop / Monocular / Remote’). (default: None)

Type:

str | None

Examples

>>> eyetracker = EyeTracker(
...     sampling_rate = 1000.0,
...     left = False,
...     right = True,
...     model = 'EyeLink 1000 Plus',
...     version = '1.5.3',
...     vendor = 'EyeLink',
...     mount = 'Arm Mount / Monocular / Remote',
... )
>>> print(eyetracker)
EyeTracker(sampling_rate=1000.0, left=False, right=True, model='EyeLink 1000 Plus',
version='1.5.3', vendor='EyeLink', mount='Arm Mount / Monocular / Remote')

Methods

__init__([sampling_rate, left, right, ...])

to_dict(*[, exclude_none])

Convert the EyeTracker instance into a dictionary.

Attributes

left

model

mount

right

sampling_rate

vendor

version