nivlink.preprocessing.align_to_aoi¶

nivlink.preprocessing.align_to_aoi(epochs, info, screenidx)[source]¶

Align eyetracking data to areas of interest. Please see notes.

Parameters:	epochs : array, shape (n_trials, n_times, n_dim) Epoched eyetracking timeseries data. Last dimension must be (xdim, ydim). info : instance of ScreenInfo Eyetracking acquisition information. screenidx : array, shape (n_trials, 1) Mapping of trial to screen index.
Returns:	aligned : array, shape (n_trials, n_times) Eyetracking timeseries aligned to areas of interest.

Notes

The alignment step makes two critical assumptions during processing:

1. Eyetracking positions are rounded down to the nearest pixel.
2. Eyetracking positions outside (xdim, ydim) are set to NaN.