首页
/ PyGaze 开源项目使用教程

PyGaze 开源项目使用教程

2024-08-22 12:36:39作者:段琳惟

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

PyGaze 是一个用于眼动追踪的开源库。以下是其主要的目录结构和介绍:

  • pygaze/: 主库文件夹,包含所有核心功能和模块。

    • init.py: 初始化文件,定义了库的基本信息和导入路径。
    • display/: 与显示相关的模块。
    • eyetracker/: 眼动追踪设备接口模块。
    • logfiles/: 日志文件处理模块。
    • screen/: 屏幕处理模块。
    • settings/: 配置文件和设置模块。
    • tests/: 测试脚本和单元测试。
  • examples/: 示例脚本,展示了如何使用 PyGaze 进行眼动追踪实验。

    • example_experiment.py: 一个简单的眼动追踪实验示例。
  • docs/: 文档文件夹,包含项目的详细文档和使用说明。

2. 项目的启动文件介绍

PyGaze 的启动文件主要是 example_experiment.py,位于 examples/ 目录下。这个文件是一个示例脚本,展示了如何设置和运行一个基本的眼动追踪实验。

from pygaze import libscreen
from pygaze import libtime
from pygaze import liblog
from pygaze import libeyetracker

# 初始化显示
disp = libscreen.Display()

# 初始化日志
log = liblog.Logfile()
log.write(logtxt="Starting experiment", timestamp=True)

# 初始化眼动追踪设备
tracker = libeyetracker.EyeTracker(disp)

# 运行实验
# ...

# 结束实验
log.write(logtxt="Ending experiment", timestamp=True)
disp.close()
tracker.close()

3. 项目的配置文件介绍

PyGaze 的配置文件主要位于 pygaze/settings/ 目录下。这些文件定义了库的各种默认设置和参数。

  • defaults.py: 包含所有默认设置,如屏幕分辨率、眼动追踪设备的参数等。
  • settings.py: 用户自定义设置文件,可以覆盖默认设置。

例如,defaults.py 中的一些关键设置:

# 屏幕分辨率
SCREEN_WIDTH = 1920
SCREEN_HEIGHT = 1080

# 眼动追踪设备参数
EYETRACKER_TYPE = 'eyelink'
EYETRACKER_SAMPLE_RATE = 500

用户可以在 settings.py 中修改这些设置以适应特定的实验需求。

from pygaze.settings import defaults

# 覆盖默认设置
defaults.SCREEN_WIDTH = 1600
defaults.SCREEN_HEIGHT = 900
defaults.EYETRACKER_TYPE = 'smi'

通过这些配置文件,用户可以灵活地调整 PyGaze 的行为和参数,以满足不同的实验需求。

登录后查看全文
热门项目推荐
相关项目推荐