set_experimental_setup#

pypillometry.set_experimental_setup(**kwargs)#

Pipeline step for set_experimental_setup() (d | pp.set_experimental_setup(...)).

Set or update the experimental setup geometry (in-place).

Creates a new ExperimentalSetup or updates the existing one with the provided parameters (parameters that are not given are taken from the existing setup). All parameters are passed through to the ExperimentalSetup constructor.

Parameters:

**kwargs (dict) –

Any parameters accepted by ExperimentalSetup:

  • screen_resolution: tuple (width, height) in pixels

  • physical_screen_size: tuple (width, height) with units

  • eye_to_screen_center: distance from the eye to the screen center

  • screen_offset: tuple (delta_x, delta_y) - offset of screen center from eye

  • screen_pitch: tilt angle (alpha_tilt)

  • screen_yaw: tilt angle (beta_tilt)

  • camera_offset: tuple (x, y, z) in eye-centric frame

  • camera_spherical: tuple (theta, phi, r)

  • ipd: inter-pupillary distance

Return type:

EyeData

Returns:

the object itself (always modified in-place)

Examples

>>> import pypillometry as pp
>>> d = pp.get_example_data("rlmw_002_short")
>>> d = d.set_experimental_setup(
...     screen_resolution=(1920, 1080),
...     physical_screen_size=("52 cm", "29 cm"),
...     eye_to_screen_center="65 cm",
... )