pymovements.gaze.GazeDataFrame.measure_samples#

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

Calculate eye movement measure for gaze data samples.

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

Parameters:

method (str | Callable[..., pl.Expr]) – Measure to be calculated.
**kwargs (Any) – Keyword arguments to be passed to the respective measure function.

Returns:

Measure results.

Return type:

pl.DataFrame

Examples

Let’s initialize an example GazeDataFrame first: >>> gaze = pm.gaze.from_numpy( … distance=np.concatenate([np.zeros(40), np.full(10, np.nan), np.ones(50)]), … )

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