Python EyeLinkParser

Sebastiaan Mathôt 和贡献者
版权所有 2016-2023
http://www.cogsci.nl/smathot

关于

python-eyelinkparser 模块提供了解析 EyeLink 数据文件的框架，这些文件是以 .asc 格式存储的，即使用 edf2asc 将 .edf 文件转换后得到的格式。此模块主要用于个人使用，并且文档不是很好。

安装

pip install eyelinkparser

预期格式

解析器假定是单目记录。

预期消息

默认情况下，解析器假定特定消息被发送到日志文件。如果您使用不同的消息，您需要在 _eyelinkparser.EyeLinkParser 中覆盖函数。这在此处未进行解释，但您可以通过查看源代码来了解其工作方式。

试验开始

start_trial [trialid]

试验结束

end_trial
stop_trial

变量

var [name] [value]

连续数据期的开始

start_phase [name]
phase [name]

连续数据期的结束

end_phase [name]
stop_phase [name]

函数参考

eyelinkparser.EyeLinkParser(folder='data', ext=('.asc', '.edf', '.tar.xz'), downsample=None, maxtracelen=None, traceprocessor=None, phasefilter=None, phasemap={}, trialphase=None, edf2asc_binary='edf2asc', multiprocess=False, asc_encoding=None, pupil_size=True, gaze_pos=True, time_trace=True)

主要的解析器类。通常不是直接创建，而是通过 eyelinkparser.parse() 函数创建，该函数接受与 EyeLinkParser 构造函数相同的键（即下面的键）。

参数

• folder: str, 可选

  包含 .edf 或 .asc 数据文件或以 .tar.xz 归档压缩的文件的文件夹。

• ext: str 或 tuple, 可选

  数据文件的允许文件扩展名或扩展名的元组。

• downsample: int 或 None, 可选

  指示是否应对轨迹（如果有）进行下采样。例如，值为10表示信号变为原来的十分之一。下采样创建了一个简单的轨迹处理器，因此不能与轨迹处理器参数结合使用。

• maxtracelen: int 或 None，可选

  轨迹的最大长度。超过长度的轨迹将被截断，并发出 UserWarning。此长度指的是下采样/处理后的轨迹。

• traceprocessor: 可调用或 None，可选

  一个在轨迹写入 SeriesColumn 之前应用于每个轨迹的函数。这可以用来应用最好在原始信号上进行的操作序列，例如首先校正闪烁，然后下采样信号。

  该函数必须接受两个参数：首先是一个轨迹标签，它是 'pupil'、'xcoor'、'ycoor' 或 'time'。这允许函数区分不同的信号类型；其次，是轨迹本身。

  有关应用眨眼校正和下采样的便利函数，请参阅 eyelinkparser.defaulttraceprocessor。

• trialphase: str 或 None，可选

  指示当试验开始时应该自动启动的相名称，或者当没有试验应该自动启动时使用 None。这对于处理由单个长时期组成的试验或在日志文件中没有写入 start_phase 消息的情况非常有用。

• phasefilter: 可调用或 None，可选

  一个接收相名称作为参数的函数，并返回一个布尔值，指示是否应保留该相。

• phasemap: dict，可选

  一个字典，其键是重命名为关联值的相名称。这主要用于合并后续的轨迹，在这种情况下，键是第一个轨迹，值是第二个轨迹。

• edf2asc_binary: str，可选

  edf2asc 可执行文件名称，如果可用，可以用于自动将 .edf 文件转换为 .asc。如果不可用，解析器只能解析 .asc 文件。

• multiprocess: bool 或 int，可选

  指示是否应在不同的进程中处理每个文件。这可以显著加快解析速度。如果不为 False，则应是一个整数，表示进程数。

• asc_encoding: str 或 None，可选

  指示 .asc 文件的字符编码，或使用系统默认值 None。

• pupil_size: bool，可选

  指示是否应存储瞳孔大小轨迹。如果启用，瞳孔大小将存储为 ptrace_[phase] 列。

• gaze_pos: bool，可选

  指示是否应存储水平和垂直注视位置轨迹。如果启用，注视位置将存储为 xtrace_[phase] 和 ytrace_[phase] 列。

• time_trace: bool，可选

  指示是否应存储时间戳轨迹，这些轨迹指示对应瞳孔和注视位置轨迹的时间戳。如果启用，时间戳将存储为 ptrace_[phase] 列。

示例

import eyelinkparser as ep
dm = ep.parse(defaulttraceprocessor=ep.defaulttraceprocessor(
    blinkreconstruct=True, downsample=True, mode='advanced'))

教程

有关使用 EyeLinkParser 的教程，请参阅

• https://pydatamatrix.eu/eyelinkparser/

许可证

python-eyelinkparser 依照 GNU 通用公共许可证 v3 许可。