pymovements.Gaze.measure_samples

Gaze.measure_samples(method: str | Callable[[...], Expr], **kwargs: Any) → DataFrame

Calculate eye movement measure on samples.

If :py:class:Gaze has :py:attr:trial_columns, measures will be grouped by trials.

Parameters:

• method (str | Callable[..., polars.Expr]) – Measure to be calculated.

• **kwargs (Any) – Keyword arguments to be passed to the respective measure function.

Returns:

Measure results.

Return type:

polars.DataFrame

Examples

Let’s initialize an example Gaze first: >>> gaze = Gaze( … samples=polars.DataFrame({ … ‘pixel’: [[312, 448], [317, 405], [None, 399], [320, None], [None, None]], … }), … )

You can calculate measures, for example the null ratio like this: >>> gaze.measure_samples(‘null_ratio’, column=’pixel’) shape: (1, 1) ┌────────────┐ │ null_ratio │ │ — │ │ f64 │ ╞════════════╡ │ 0.6 │ └────────────┘