跳转到主要内容

使用deepMReye解码眼动以处理fMRI时间序列数据的bids应用程序

项目描述

System tests Test and coverage codecov Documentation Status License PyPI version PyPI - Python Version https://github.com/psf/black Sourcery All Contributors paper doi zenodo DOI

bidsMReye

使用deepMReye (1) 从眼球MR信号解码注视位置的BIDS应用程序。

用于预处理后的BIDS衍生产品(例如fMRIprep输出)。无需眼动数据。

默认情况下,bidsMReye使用预训练版本deepMReye,该版本在5个数据集上进行了训练,包括引导注视(2)、平滑跟踪(345)和自由观看(6)。其他预训练版本是可选的。建议进行专门模型训练。

管道自动提取眼球体素。在没有眼动追踪数据的情况下,这也可以用于其他多变量模式分析。解码的注视位置可以计算眼动。

还会进行一些基本的质量控制和异常值检测

  • 针对每次运行

  • 在组级别

有关更多信息,请参阅用户推荐。如果您有其他问题,请联系开发团队。

安装

最好使用Docker镜像,因为已知deepmreye在Apple M1等苹果系统上存在安装问题。

Docker

构建

docker build --tag cpplab/bidsmreye:latest --file docker/Dockerfile .

拉取

拉取最新Docker镜像

docker pull cpplab/bidsmreye:latest

Python包

如果您想,也可以从pypi获取该包。

pip install bidsmreye

Conda安装

尚未测试

要封装bidsMReye在虚拟环境中,请使用以下命令安装

conda create --name bidsmreye python=3.10
conda activate bidsmreye
conda install pip
pip install bidsmreye

tensorflow依赖支持CPU和GPU指令。

请注意,您可能需要首先安装cudnn

conda install -c conda-forge cudnn

开发安装

克隆此存储库。

git clone git://github.com/cpp-lln-lab/bidsmreye

然后安装包

cd bidsMReye
make install_dev

用法

需求

bidsmreye需要您的输入fmri数据

  • 至少进行预处理(至少重排),
  • 文件名和结构符合BIDS衍生产数据集。

有两个bids应用可用于生成这些类型的预处理数据

显然,您的fmri数据必须包含参与者的眼睛,以便bidsmreye能够运行。

CLI

键入以下内容以获取更多信息

bidsmreye --help

准备数据

prepapre表示bidsmreye将从fMRI图像中提取来自眼睛的数据。

如果您的数据不在MNI空间中,bidsmreye还将数据注册到MNI。

bidsmreye bids_dir output_dir participant prepare

计算眼动

generalize使用提取的时间序列,使用deepmreye的默认预训练模型来预测眼动。

这还将生成解码眼动的质量控制报告。

bidsmreye bids_dir output_dir participant generalize

一次性完成所有操作

all执行“准备”然后“泛化”。

bidsmreye bids_dir output_dir participant all

组级别摘要

bidsmreye bids_dir output_dir group qc

演示

请查阅文档

贡献者 ✨

感谢这些可爱的人们(emoji key)

Pauline Cabee
Pauline Cabee

💻 🤔 🚇
Remi Gau
Remi Gau

💻 🤔 ⚠️ 🚧
Ying Yang
Ying Yang

🐛 📓

此项目遵循all-contributors规范。欢迎任何类型的贡献!

如果您训练deepMReye,或者您有眼动追踪训练标签和提取的眼球体素,请考虑将其共享到预训练模型池中。

项目详情


下载文件

下载适用于您的平台的文件。如果您不确定选择哪个,请了解更多关于安装包的信息。

源分发

bidsmreye-0.5.0.tar.gz (9.0 MB 查看哈希值)

上传时间 源代码

构建发行版

bidsmreye-0.5.0-py3-none-any.whl (47.8 kB 查看哈希值)

上传时间 Python 3

支持者