bids/validator

BIDS-Validator 镜像文档

概述

BIDS-Validator 是一款用于验证脑成像数据集是否符合脑成像数据结构（BIDS）标准的工具。BIDS 标准旨在规范脑成像数据的组织格式，便于数据共享、分析和再利用。该工具支持多种使用场景，包括浏览器界面、命令行、Docker 容器及 Python 库，适用于神经影像学研究中数据集的标准化检查。

核心功能与特性

• 多环境支持：可在浏览器（Chrome/Firefox）、Node.js 环境、Docker 容器及 Python 应用中运行
• 全面验证：检查数据集目录结构、文件名格式、元数据（JSON/TSV）及 NIfTI 文件合规性
• 灵活配置：支持忽略警告、排除 NIfTI 头文件检查等自定义选项
• 排除机制：通过 .bidsignore 文件指定无需验证的文件或目录
• 多语言接口：提供 JavaScript API、Python 库及命令行工具

使用场景

• 神经影像学研究数据集创建后的标准化检查
• 数据共享前验证数据集是否符合 BIDS 标准
• 科研项目中集成自动化数据格式校验流程
• 教学中演示 BIDS 标准的实践应用

使用方法

Docker 镜像使用

前提条件

• 已安装 Docker 环境

基本命令

通过以下命令运行 Docker 镜像验证数据集：

bash
docker run -ti --rm -v /本地数据集路径:/data:ro bids/validator /data

参数说明：

• -ti：交互式终端模式
• --rm：容器退出后自动删除
• -v /本地数据集路径:/data:ro：将本地数据集目录挂载到容器内的 /data 目录（只读模式）
• bids/validator：Docker 镜像名称
• /data：容器内待验证的数据集路径（需与挂载路径一致）

示例

验证本地 /home/user/bids_data 目录下的数据集：

bash
docker run -ti --rm -v /home/user/bids_data:/data:ro bids/validator /data

其他使用方式

命令行模式

1. 安装 Node.js（至少 v10.11.0）及 npm（至少 v7）
2. 执行 npm install -g bids-validator 安装
3. 运行 bids-validator /本地数据集路径 开始验证

Python 库

1. 安装 Python 及 pip
2. 执行 pip install bids_validator 安装
3. 在 Python 中使用：

python
from bids_validator import BIDSValidator
validator = BIDSValidator()
# 检查单个文件是否符合 BIDS 标准
is_valid = validator.is_bids('path/to/bids/file.nii.gz')
print(is_valid)  # True 或 False

浏览器模式

访问 http://bids-standard.github.io/bids-validator/%EF%BC%8C%E9%80%89%E6%8B%A9%E6%9C%AC%E5%9C%B0%E6%95%B0%E6%8D%AE%E9%9B%86%E6%96%87%E4%BB%B6%E5%A4%B9%E8%BF%9B%E8%A1%8C%E9%AA%8C%E8%AF%81%EF%BC%88%E4%BB%85%E6%94%AF%E6%8C%81 Chrome 和 Firefox）。

配置选项

验证时可通过配置参数自定义行为，主要选项包括：

• ignoreWarnings：是否忽略警告信息（默认 false）
• ignoreNiftiHeaders：是否忽略 NIfTI 文件头检查（默认 false）

Docker 中使用配置：

bash
docker run -ti --rm -v /本地数据集路径:/data:ro bids/validator /data --ignoreWarnings

.bidsignore 文件

通过在数据集根目录创建 .bidsignore 文件，可排除无需验证的文件或目录，格式类似 .gitignore。例如：

# 排除临时文件
*~
# 排除特定目录
derivatives/

支持环境

• Node.js：最新长期支持（LTS）版本
• 浏览器：最新版 Chrome 或 Firefox
• Python：兼容 Python 3.6+
• Docker：兼容所有支持 Docker 的操作系统（Linux、macOS、Windows）

问题反馈

使用中遇到的问题可通过 https://github.com/bids-standard/bids-validator/issues 提交。