Screen

class pymovements.Screen(width_px: int | None = None, height_px: int | None = None, width_cm: float | None = None, height_cm: float | None = None, distance_cm: float | None = None, origin: str | None = None)

Screen class for holding screen properties.

width_px

Screen width in pixels. (default: None)

Type:

int | None

height_px

Screen height in pixels. (default: None)

Type:

int | None

width_cm

Screen width in centimeters. (default: None)

Type:

float | None

height_cm

Screen height in centimeters. (default: None)

Type:

float | None

distance_cm

Eye-to-screen distance in centimeters. If None, a distance_column must be provided in the DatasetDefinition or Gaze, which contains the eye-to-screen distance for each sample in millimeters. (default: None)

Type:

float | None

origin

Specifies the screen location of the origin of the pixel coordinate system. (default: None)

Type:

str | None

Examples

>>> screen = Screen(
...     width_px=1280,
...     height_px=1024,
...     width_cm=38.0,
...     height_cm=30.0,
...     distance_cm=68.0,
...     origin='upper left',
... )
>>> print(screen)
Screen(width_px=1280, height_px=1024, width_cm=38.0,
height_cm=30.0, distance_cm=68.0, origin='upper left')

We can also access the screen boundaries in degrees of visual angle. This only works if the distance_cm attribute is specified.

>>> screen.x_min_dva
-15.59...
>>> screen.x_max_dva
15.59...
>>> screen.y_min_dva
-12.42...
>>> screen.y_max_dva
12.42...

Methods

__init__([width_px, height_px, width_cm, ...])
pix2deg(arr)	Convert pixel screen coordinates to degrees of visual angle.
to_dict(*[, exclude_none])	Convert the Screen instance into a dictionary.

Attributes

distance_cm
height_cm
height_px
origin
width_cm
width_px
x_max_dva	Maximum screen x-coordinate in degrees of visual angle.
x_min_dva	Minimum screen x-coordinate in degrees of visual angle.
y_max_dva	Maximum screen y-coordinate in degrees of visual angle.
y_min_dva	Minimum screen y-coordinate in degrees of visual angle.