Package index • eyesim

Density and sampling

Functions for computing density maps, sampling, and density matrix.

eye_density(): eye_density
get_density(): get_density
sample_density(): sample_density
eye_density(<fixation_group>): Compute a density map for a fixation group.
gen_density(): This function creates a density object from the provided x, y, and z matrices. The density object is a list containing the x, y, and z values with a class attribute set to "density" and "list".
as.data.frame(<eye_density>): Convert an eye_density object to a data.frame.

Spatial operations

Functions for manipulating spatial coordinates and transformations.

coords(): extract coordinates
rescale(): rescale
center(): Center Eye-Movements in a New Coordinate System
normalize(): Normalize Eye-Movements to Unit Range
match_scale(): Match Scaling Parameters for Fixation Data

Fixation operations

Functions for working with fixation sequences.

fixation_group(): Create a Fixation Group Object
fixation_entropy(): Compute Fixation Entropy
fixation_entropy(<default>) fixation_entropy(<eye_density>) fixation_entropy(<density>) fixation_entropy(<eye_density_multiscale>) fixation_entropy(<fixation_group>): Entropy of fixation patterns
fixation_revisits(): Revisitation of previously fixated locations
fixation_revisits(<eye_table>): Revisits for every episode of an eye_table
revisit_summary(): Summarise revisits for one episode
visual_angle_to_px() px_to_visual_angle(): Convert between visual angle and screen pixels
c(<fixation_group>): Concatenate Fixation Groups
rep_fixations(): rep_fixations
sample_fixations(): sample_fixations
fixation_similarity(): Fixation Similarity
template_sample(): Sample density maps with coordinates derived from fixation groups.

Similarity

Functions for computing similarity between objects.

similarity(): Compute Similarity Between Two Objects
multi_match(): Compute MultiMatch Metrics for Scanpath Similarity
scanpath_similarity(): Scanpath Similarity
similarity(<scanpath>): Compute Similarity Between Scanpaths
template_similarity(): template_similarity
template_similarity_cv(): Cross-Fitted Template Similarity
sample_density_time(): Sample density maps at fixation locations over time
repetitive_similarity(): Repetitive Similarity Analysis for Density Maps
install_multimatch(): Install Python multimatch_gaze Package

GazeWeave

Cross-fitted probabilistic replay and registered temporal transport.

gaze_weave_cv(): Cross-fitted GazeWeave analysis
gaze_replay_cv(): Cross-fitted directional GazeWeave Replay analysis
gaze_replay_spec(): Specify the directional GazeWeave replay model
fit_gaze_replay_model(): Fit a directional GazeWeave replay model on training trials
gaze_replay_align(): Align recall gaze to an encoding path with a fitted Replay model
gaze_replay_align_episode(): Align recall gaze to a mixture of encoding presentations
gaze_calibration_control(): Calibration controls for GazeWeave revision 2026.10
gaze_transport_cv(): Nested-calibrated exhaustive-candidate Transport
gaze_transport_spec(): Specify edge-normalized GazeWeave Transport
gaze_transport_align(): Align gaze paths with edge-normalized Transport
gaze_transport_result(): Extract one auditable Transport result
gaze_gaussian_mixture(): Declare a multiscale Gaussian spatial model for GazeWeave
gaze_order_neighbours(): Declare fixed-neighbour ordinal chronology for Transport
gaze_warp_none(): Declare no geometric registration for GazeWeave
gaze_warp_contraction(): Declare cross-fitted contraction registration for GazeWeave
gaze_screen(): Declare screen geometry for GazeWeave
tidy(<gaze_replay_fit>): Tidy GazeWeave Replay results
tidy(<gaze_transport_fit>): Tidy a fitted Transport analysis
autoplot(<gaze_replay_alignment>): Plot a GazeWeave Replay alignment
autoplot(<gaze_replay_fit>): Plot a fitted GazeWeave Replay analysis
autoplot(<gaze_transport_alignment>): Plot a Transport pair alignment
autoplot(<gaze_transport_fit>): Plot one fitted Transport result

GazeWeave comparators

Fair comparator court for GazeWeave (nested cross-validated baselines).

gaze_baseline_spec(): Specify the fair GazeWeave comparator court
gaze_baseline_cv(): Nested cross-validated comparator court for GazeWeave
gaze_baseline_availability(): Report comparator availability
tidy(<gaze_baseline_fit>): Tidy GazeWeave comparator results

Latent transforms

Domain-adaptation transforms for use with template_similarity().

latent_pca_transform() contract_transform() affine_transform() coral_transform() cca_transform(): Latent-space transforms for template-based similarity

Scanpath

Functions for creating and adding scanpaths.

scanpath(): Construct a Scanpath of a Fixation Group of Related Objects
add_scanpath(): Add Scanpath to Dataset
add_scanpath(<data.frame>): Add Scanpath to a Data Frame
add_scanpath(<eye_table>): Add Scanpath to an Eye Table
scanpath(<fixation_group>): Create a Scanpath for a Fixation Group
calcangle(): Calculate the Angle Between Two Vectors
cart2pol(): Convert Cartesian Coordinates to Polar Coordinates
template_multireg(): Template Multiple Regression
template_regression(): Template Regression

Eye Table

Functions for working with eye tables.

as_eye_table(): Reapply the 'eye_table' Class to an Object
eye_table(): Construct an Eye-Movement Data Frame
simulate_eye_table(): Generate a Simulated Eye-Movement Data Frame
`[`(<eye_table>): Subset an 'eye_table' Object

Plotting

Scanpath and density plots, and the shared eyesim plot theme.

plot(<fixation_group>): Plot a fixation_group object
plot(<eye_density>): Plot Eye Density
anim_scanpath(): Animate a Fixation Scanpath with gganimate
theme_eyesim() theme_eyesim_spatial(): eyesim ggplot2 theme
eyesim_colours(): eyesim plot colours
scale_fill_eyesim_density() scale_colour_eyesim_time(): eyesim colour scales
element_text_wrap(): Wrapping text element

Density by Groups

Functions for density operations by groups.

density_by(): Calculate Eye Density by Groups
suggest_sigma(): Suggest Kernel Bandwidth for Density Estimation
sample_density(): sample_density

Data

Example datasets included with the package.

wynn_study: Study-phase fixations from Wynn et al.
wynn_test: Test-phase fixations from Wynn et al.