EyeLoop 开源项目使用教程

EyeLoop 开源项目使用教程

eyeloop EyeLoop is a Python 3-based eye-tracker tailored specifically to dynamic, closed-loop experiments on consumer-grade hardware. 项目地址: https://gitcode.com/gh_mirrors/ey/eyeloop

1. 项目的目录结构及介绍

EyeLoop 项目的目录结构如下：

eyeloop/
├── examples/
├── eyeloop/
├── misc/
├── tests/
├── .gitignore
├── .travis.yml
├── CODE_OF_CONDUCT.md
├── LICENSE
├── MANIFEST.in
├── README.md
├── conftest.py
├── requirements.txt
├── requirements_examples.txt
├── requirements_testing.txt
├── setup.py
└── tox.ini

目录结构介绍

• examples/: 包含示例代码和实验设计。
• eyeloop/: 核心代码目录，包含 EyeLoop 引擎和模块的实现。
• misc/: 包含一些杂项文件和工具。
• tests/: 包含单元测试代码和测试报告。
• .gitignore: Git 忽略文件配置。
• .travis.yml: Travis CI 配置文件。
• CODE_OF_CONDUCT.md: 项目行为准则。
• LICENSE: 项目许可证文件。
• MANIFEST.in: 打包配置文件。
• README.md: 项目介绍和使用说明。
• conftest.py: 测试配置文件。
• requirements.txt: 项目依赖文件。
• requirements_examples.txt: 示例代码的依赖文件。
• requirements_testing.txt: 测试代码的依赖文件。
• setup.py: 项目安装脚本。
• tox.ini: Tox 配置文件，用于自动化测试。

2. 项目的启动文件介绍

EyeLoop 项目的启动文件是 eyeloop 命令行工具。通过该工具可以启动 EyeLoop 引擎并进行眼动追踪实验。

启动命令

eyeloop

启动参数

• --importer: 指定导入器模块，如 cv 或 vimba。
• --video: 指定视频文件路径，用于离线眼动追踪。
• --model: 指定瞳孔模型，如 ellipsoid 或 circular。
• --extractors: 指定自定义提取器模块路径。

示例

eyeloop --importer cv --video path/to/video.mp4 --model ellipsoid

3. 项目的配置文件介绍

EyeLoop 项目的配置文件主要包括以下几个：

requirements.txt

该文件列出了项目运行所需的所有 Python 依赖包。

numpy
opencv-python
...

setup.py

该文件是项目的安装脚本，用于配置项目的元数据和依赖关系。

from setuptools import setup, find_packages

setup(
    name='eyeloop',
    version='0.1',
    packages=find_packages(),
    install_requires=[
        'numpy',
        'opencv-python',
        # 其他依赖
    ],
    entry_points={
        'console_scripts': [
            'eyeloop=eyeloop.main:main',
        ],
    },
)

tox.ini

该文件是 Tox 的配置文件，用于自动化测试。

[tox]
envlist = py36, py37, py38

[testenv]
deps =
    -rrequirements_testing.txt
commands =
    pytest

通过这些配置文件，用户可以轻松地安装和配置 EyeLoop 项目，并进行眼动追踪实验。

eyeloop EyeLoop is a Python 3-based eye-tracker tailored specifically to dynamic, closed-loop experiments on consumer-grade hardware. 项目地址: https://gitcode.com/gh_mirrors/ey/eyeloop