center_origin

pymovements.gaze.transforms.center_origin(*, screen_resolution: tuple[int, int], n_components: int, origin: str = 'upper left', pixel_column: str = 'pixel', output_column: str | None = None) → pl.Expr

Center pixel data.

Pixel data will have the coordinates (0, 0) afterwards.

Parameters:

• screen_resolution (tuple[int, int]) – Pixel screen resolution as tuple (width, height).

• n_components (int) – Number of components in input column.

• origin (str) – The location of the pixel origin. Supported values: center, upper left. (default: upper left)

• pixel_column (str) – Name of the input column with pixel data. (default: ‘pixel’)

• output_column (str | None) – Name of the output column with centered pixel data. (default: None)

Returns:

The respective polars expression.

Return type:

pl.Expr