EyePy 使用教程

1. 项目目录结构及介绍

EyePy 是一个基于 Python 的开源项目，用于实现摄像头 based 的眼睛追踪功能。项目目录结构如下：

EyePy/
├── .gitattributes
├── .gitignore
├── .python-version
├── LICENSE
├── README.md
├── __init__.py
├── calibration.py
├── demo.py
├── gaze_estimator.py
├── pyproject.toml
├── requirements.txt
├── uv.lock
└── virtual_cam.py

• .gitattributes: 指定如何对待不同的文件类型。
• .gitignore: 指定在 Git 仓库中哪些文件和目录应该被忽略。
• .python-version: 指定项目所需的 Python 版本。
• LICENSE: 项目使用的 MIT 许可证文件。
• README.md: 项目说明文件，包含项目信息和安装指南。
• __init__.py: 初始化 Python 包。
• calibration.py: 校准相关功能的实现。
• demo.py: 演示如何使用 EyePy 的示例脚本。
• gaze_estimator.py: 实现 gaze 估计的核心算法。
• pyproject.toml: 包含项目元数据和依赖关系。
• requirements.txt: 项目依赖的第三方库列表。
• uv.lock: 存储项目的统一配置。
• virtual_cam.py: 虚拟摄像头脚本的实现。

2. 项目的启动文件介绍

项目的启动文件主要是 demo.py。这个脚本演示了如何使用 EyePy 来实现眼睛追踪功能。运行该文件将启动摄像头，并显示处理后的视频流，其中包含了眼睛追踪的结果。

python demo.py [OPTIONS]

可用的选项包括：

• --filter: 滤波方法（kalman, kde, none），默认为 none。
• --camera: 使用的摄像头索引，默认为 0。
• --calibration: 校准方法（9p, 5p, lissajous），默认为 9p。
• --background: 背景图片的路径，默认为 None。
• --confidence: KDE 轮廓的置信区间（0 到 1），默认为 0.5。

3. 项目的配置文件介绍

项目的配置主要通过代码中的参数进行调整。在 demo.py 和 virtual_cam.py 文件中，可以找到相关配置参数。

例如，在 demo.py 中，你可以设置摄像头索引、校准方法和滤波方法等参数。而在 virtual_cam.py 中，也可以调整相应的设置以适配不同的使用场景。

EyePy 使用 requirements.txt 文件来管理依赖的第三方库。在安装项目时，可以使用以下命令安装所有依赖：

pip install -r requirements.txt

确保根据项目需求调整这些配置，以获得最佳的运行效果。