Metadata-Version: 2.3
Name: eyefeatures
Version: 0.3.0
Summary: Preprocessing, visualization, statistical analysis, feature engineering, and machine learning of eye movement data.
License: MIT License
         
         Copyright (c) 2024 SCILA
         
         Permission is hereby granted, free of charge, to any person obtaining a copy
         of this software and associated documentation files (the "Software"), to deal
         in the Software without restriction, including without limitation the rights
         to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
         copies of the Software, and to permit persons to whom the Software is
         furnished to do so, subject to the following conditions:
         
         The above copyright notice and this permission notice shall be included in all
         copies or substantial portions of the Software.
         
         THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
         IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
         FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
         AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
         LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
         OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
         SOFTWARE.
Author: Kondaurov Zakhar
Requires-Python: >=3.12,<3.13
Classifier: License :: Other/Proprietary License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: EMD-signal (==1.6.4)
Requires-Dist: gudhi (==3.10.1)
Requires-Dist: matplotlib (==3.8.4)
Requires-Dist: numba (==0.60.0)
Requires-Dist: numpy (==1.26.0)
Requires-Dist: pandas (==2.2.2)
Requires-Dist: scikit-learn (==1.5.1)
Requires-Dist: scikit_multilearn (==0.2.0)
Requires-Dist: scipy (==1.14.1)
Requires-Dist: tqdm (==4.66.4)
Description-Content-Type: text/markdown

## Package Description

[EyeFeatures](https://github.com/hse-scila/EyeFeatures) is an open-source Python package for analyzing eye movement
data in any visual task. Its capabilities encompass preprocessing, visualization,
statistical analysis, feature engineering and machine learning. Its unique feature
is its architecture and versatility. Accepting data in .csv format containing gaze
position coordinates, the package allows filtration of raw data to remove noise and
detecting fixations and saccades with different algorithms. Having fixations any
standard descriptive statistical eye movement features (such as totalFD, meanFD etc.)
can be computed, including AOI-wise features. AOIs can be predefined or assigned
automatically. More complex features, such as chaos measures, topological features,
density maps, scanpath similarities for various distance metrics can be computed as well.
The package allows to account for the panel structure of the data, calculating shift
features relative to group averages. The visualization module allows output a variety
of visualization options, including static and dynamic scanpath plots. The architecture of
the package allows seamless embedding of its
preprocessing and feature extraction classes in Sklearn pipelines. Moreover, it provides
datasets and models for deep learning with Pytorch.

## Documentation

Documentation for the latest version can be found [here](https://eyefeatures-docs.readthedocs.io/en/latest/).

## Tutorials

You can find notebooks with tutorials devoted to different parts of the library in this repository
in [tutorials](https://github.com/hse-scila/EyeFeatures/tree/main/tutorials) folder.

## Coming soon

Extensive table with references to all methods is coming soon.

