All Methods and Classes

This is an alphabetical list of all public transformers and functions in the eyefeatures library.

eyefeatures.data.utils.get_labels

Get label column names (columns ending with _label).

eyefeatures.data.utils.get_meta

Get meta column names (columns starting with meta\_).

eyefeatures.data.utils.get_pk

Get primary key column names (columns starting with group\_).

eyefeatures.data.utils.list_datasets

List available dataset names in the collection directory.

eyefeatures.data.utils.load_dataset

Load a collection dataset by name.

eyefeatures.features.dist.calc_dfr_dist

Calculates Discrete Frechet distance between paths p and q.

eyefeatures.features.dist.calc_dtw_dist

Calculates Dynamic Time Warp distance between paths p and q.

eyefeatures.features.dist.calc_euc_dist

Calculates Euclidean distance between paths p and q.

eyefeatures.features.dist.calc_eye_dist

Calculates EyeDist distance between paths p and q.

eyefeatures.features.dist.calc_hau_dist

Calculates Hausdorff distance between paths p and q

eyefeatures.features.dist.calc_man_dist

Calculates Mannan distance between paths p and q.

eyefeatures.features.dist.calc_mm_features

Calculates MultiMatch features between paths p and q.

eyefeatures.features.dist.calc_scan_match_dist

Calculates ScanMatch distance between paths p and q.

eyefeatures.features.dist.calc_tde_dist

Calculates Time Delay Embedding distance between paths p and q.

eyefeatures.features.dist.DFDist

Calculates Discrete Frechet distance between given and expected scanpaths.

eyefeatures.features.dist.DistanceTransformer

Base Transformer for distance-based features.

eyefeatures.features.dist.DTWDist

Calculates Dynamic Time Warp distance between given and expected scanpaths.

eyefeatures.features.dist.EucDist

Calculates Euclidean distance between given and expected scanpaths.

eyefeatures.features.dist.EyeAnalysisDist

Calculates Eye Analysis distance between given and expected scanpaths.

eyefeatures.features.dist.get_expected_path

Estimates expected path by a given method.

eyefeatures.features.dist.HauDist

Calculates Hausdorff distance between given and expected scanpaths.

eyefeatures.features.dist.MannanDist

Calculates Mannan distance between given and expected scanpaths.

eyefeatures.features.dist.MultiMatchDist

Calculates MultiMatch distance between given and expected scanpaths.

eyefeatures.features.dist.ScanMatchDist

Calculates ScanMatch distance between given and expected scanpaths.

eyefeatures.features.dist.SimpleDistances

Calculates simple distances using given methods.

eyefeatures.features.dist.TDEDist

Calculates Time Delay Embedding distance between given and expected scanpaths.

eyefeatures.features.extractor.Extractor

Meta Transformer that encapsulates the logic of feature extraction, providing fit/transform API.

eyefeatures.features.feature_maps.calculate_topological_features

Calculate topological features (persistence curve

eyefeatures.features.feature_maps.get_gaf

Calculates Gramian Angular Field for (x,y) coordinates.

eyefeatures.features.feature_maps.get_gafs

Batch Gramian Angular Fields for 2D DL: one (2, H, W) image per group, resized to shape.

eyefeatures.features.feature_maps.get_heatmap

Get heatmap from scanpath (given coordinates are scaled and sorted in time) using Gaussian KDE.

eyefeatures.features.feature_maps.get_heatmaps

Get heatmaps from scanpaths (given coordinates are scaled and

eyefeatures.features.feature_maps.get_hilbert_curve

Map scanpath to points on 1D Hilbert curve.

eyefeatures.features.feature_maps.get_hilbert_curve_enc

Map scanpath to values on Hilbert curve and encode to single feature vector.

eyefeatures.features.feature_maps.get_mtf

Calculates Markov Transition Field for (x,y) coordinates.

eyefeatures.features.feature_maps.get_mtfs

Batch Markov Transition Fields for 2D DL: one (2, H, W) image per group, resized to shape.

eyefeatures.features.feature_maps.get_pca

Computes PCA compression.

eyefeatures.features.feature_maps.get_rqa

Calculates recurrence quantification analysis matrix based

eyefeatures.features.feature_maps.hilbert_huang_transform

Perform Hilbert-Huang transform on a given data sequence.

eyefeatures.features.feature_maps.lower_star_filtration

Compute the Lower Star filtration for a time series.

eyefeatures.features.feature_maps.persistence_curve

Compute the persistence curve for a persistence diagram at time t.

eyefeatures.features.feature_maps.persistence_entropy_curve

Compute the persistence entropy curve for a persistence diagram at time t.

eyefeatures.features.feature_maps.vietoris_rips_filtration

Compute the Vietoris-Rips filtration for a point cloud.

eyefeatures.features.feature_maps.xy2h

Mapping of 2D space to 1D using Hilbert curve.

eyefeatures.features.measures.CorrelationDimension

Correlation Dimension.

eyefeatures.features.measures.FractalDimension

Fractal Dimension.

eyefeatures.features.measures.FuzzyEntropy

Fuzzy Entropy.

eyefeatures.features.measures.GriddedDistributionEntropy

Gridded Distribution Entropy.

eyefeatures.features.measures.HHTFeatures

Hilbert-Huang Transform (HHT) Features.

eyefeatures.features.measures.HurstExponent

Approximates Hurst Exponent using R/S analysis.

eyefeatures.features.measures.IncrementalEntropy

Incremental Entropy.

eyefeatures.features.measures.LyapunovExponent

Lyapunov Exponent.

eyefeatures.features.measures.MeasureTransformer

Base Transformer class for measures.

eyefeatures.features.measures.PhaseEntropy

Phase Entropy.

eyefeatures.features.measures.RQAMeasures

Calculates REC, DET, LAM and CORM measures.

eyefeatures.features.measures.SaccadeUnlikelihood

Saccade Unlikelihood.

eyefeatures.features.measures.SampleEntropy

Sample Entropy.

eyefeatures.features.measures.ShannonEntropy

Shannon Entropy.

eyefeatures.features.measures.SpectralEntropy

Spectral Entropy.

eyefeatures.features.pairwise.compute_rv_coefficient

Calculate the RV coefficient between two cross-product matrices.

eyefeatures.features.pairwise.dimensionality_reduction_order

Reorder matrix using Multi-Dimensional Scaling (MDS).

eyefeatures.features.pairwise.get_center_matrix

Calculates centering matrix Theta.

eyefeatures.features.pairwise.get_compromise_matrix

Compute the compromise matrix from a list of distance matrices.

eyefeatures.features.pairwise.get_cross_product_matrix

Calculates cross-product matrix.

eyefeatures.features.pairwise.get_dist_matrix

Computes pairwise distance matrix given distance metric.

eyefeatures.features.pairwise.get_sim_matrix

Computes similarity matrix given non-trivial metric.

eyefeatures.features.pairwise.hierarchical_clustering_order

Reorder matrix using hierarchical clustering.

eyefeatures.features.pairwise.optimal_leaf_ordering_clustering

Reorder matrix using optimal leaf ordering.

eyefeatures.features.pairwise.restore_matrix

Estimates A assuming 'matrix' equals \(A^T A\).

eyefeatures.features.pairwise.spectral_order

Reorder matrix using spectral reordering.

eyefeatures.features.shift.IndividualNormalization

Normalization of features based on slices, produced by grouping with primary key.

eyefeatures.features.stats.FixationFeatures

Fixation Features Transformer.

eyefeatures.features.stats.MicroSaccadeFeatures

Micro Saccade Features.

eyefeatures.features.stats.RegressionFeatures

Regression Features Transformer.

eyefeatures.features.stats.SaccadeFeatures

Saccade Features Transformer.

eyefeatures.features.stats.StatsTransformer

Base class for statistical features.

eyefeatures.preprocessing.aoi_extraction.AOIExtractor

Extractor of areas of interest.

eyefeatures.preprocessing.aoi_extraction.AOIMatcher

Matches AOI in the dataset.

eyefeatures.preprocessing.aoi_extraction.GradientBased

Defines the AOI for each fixation using a gradient-based algorithm.

eyefeatures.preprocessing.aoi_extraction.OverlapClustering

Defines the AOI for each fixation using the overlapping clustering algorithm.

eyefeatures.preprocessing.aoi_extraction.ShapeBased

Defines AOI using the specified shapes.

eyefeatures.preprocessing.aoi_extraction.ThresholdBased

Defines the AOI for each fixation using density maximum and Kmeans.

eyefeatures.preprocessing.blinks_extraction.detect_blinks_eo

Method detects blinks based on Eye Openness (EO) signal.

eyefeatures.preprocessing.blinks_extraction.detect_blinks_pupil_missing

Method detects blinks based on size of pupil and missing recordings (NaN) in its data.

eyefeatures.preprocessing.blinks_extraction.detect_blinks_pupil_vt

Method detects blinks based on pupil sizes and change of pupil sizes.

eyefeatures.preprocessing.fixation_extraction.IDT

Dispersion Threshold Identification.

eyefeatures.preprocessing.fixation_extraction.IHMM

Hidden Markov Model Identification.

eyefeatures.preprocessing.fixation_extraction.IVT

Velocity Threshold Identification.

eyefeatures.preprocessing.smoothing.FIRFilter

FIR filter.

eyefeatures.preprocessing.smoothing.IIRFilter

IIR filter.

eyefeatures.preprocessing.smoothing.SavGolFilter

Savitzky-Golay filter.

eyefeatures.preprocessing.smoothing.WienerFilter

Wiener filter.

eyefeatures.utils.ColumnDropper

Transformer that drops specified columns.

eyefeatures.visualization.dynamic_visualization.scanpath_animation

Function for tracker animation.

eyefeatures.visualization.dynamic_visualization.tracker_animation

Function for tracker animation.

eyefeatures.visualization.static_visualization.aoi_visualization

eyefeatures.visualization.static_visualization.baseline_visualization

eyefeatures.visualization.static_visualization.get_visualizations

Get visualizations.

eyefeatures.visualization.static_visualization.saccade_visualization

eyefeatures.visualization.static_visualization.scanpath_visualization

Function for scanpath and/or aoi visualization.

eyefeatures.visualization.static_visualization.Visualization