deepmi/fsqcdocker

fsqc toolbox 技术文档

1. 镜像概述与主要用途

概述

fsqc toolbox 是一个针对结构MRI（磁共振成像）数据的质量控制工具集，专注于为FastSurfer或FreeSurfer处理后的结构MRI数据提供质量保证（QA）与质量控制（QC）解决方案。

主要用途

提供标准化的脚本与工具，用于评估FastSurfer或FreeSurfer处理流程输出的结构MRI数据质量，辅助科研人员、影像分析师验证数据处理结果的可靠性，确保下游分析（如形态测量、结构分析等）的准确性。

2. 核心功能与特性

核心功能

• 对FastSurfer或FreeSurfer处理后的结构MRI数据进行自动化质量评估与控制
• 生成标准化质量报告，量化数据质量指标（如分割精度、图像伪影等）

关键特性

• 技术基础：基于经典工具集的优化与扩展，是对 https://surfer.nmr.mgh.harvard.edu/fswiki/QATools 的修订、功能扩展及Python语言迁移实现，提升易用性与跨平台兼容性
• 功能整合：集成 https://github.com/poldracklab/mriqc 的额外质量评估功能，增强多维度质量分析能力
• 算法增强：融合 https://github.com/Deep-MI/lapy 与 https://github.com/Deep-MI/brainprint 工具集的核心代码，优化结构MRI数据的形态学质量评估维度

3. 使用场景与适用范围

适用场景

• 科研机构：在神经影像学研究中，作为FastSurfer/FreeSurfer处理流水线的质量控制环节，确保入组数据质量一致性
• 临床影像分析：辅助医院影像科或临床研究团队评估结构MRI数据后处理结果的可靠性，筛选合格数据用于临床研究
• 算法开发验证：作为MRI数据处理算法（如分割、配准算法）优化与验证的辅助工具，量化评估算法输出质量

适用范围

• 数据类型：仅支持FastSurfer或FreeSurfer处理生成的结构MRI数据（需符合上述工具的标准输出格式）
• 环境依赖：需运行于支持Docker的Linux/macOS/Windows系统，或直接部署于Python环境（需满足依赖库要求）

4. 使用方法与配置说明

4.1 前置要求

• 已安装Docker Engine（推荐版本20.10+）
• 待分析数据需为FastSurfer或FreeSurfer处理后的完整输出目录（包含标准解剖结构分割、表面重建等结果文件）
• 本地需预留足够存储空间用于挂载输入数据与输出报告（建议≥10GB，具体取决于数据量）

4.2 Docker部署示例

4.2.1 基础运行命令

通过以下命令启动容器，挂载输入数据目录与输出报告目录，执行质量控制分析：

bash
docker run --rm \
  -v /本地输入数据路径:/input \  # 本地FastSurfer/FreeSurfer输出目录挂载至容器内/input
  -v /本地输出报告路径:/output \  # 容器内生成的质量报告挂载至本地/output
  fsqc/toolbox:latest \  # 镜像名称（实际名称以项目Docker仓库为准）
  --input /input \  # 指定容器内输入数据路径（需与挂载路径一致）
  --output /output  # 指定容器内输出报告路径（需与挂载路径一致）

4.2.2 自定义参数示例

如需调整分析参数（如报告格式、评估指标阈值等），可通过命令行参数或配置文件指定（具体参数请参考项目文档）：

bash
docker run --rm \
  -v /本地输入数据路径:/input \
  -v /本地输出报告路径:/output \
  -v /本地配置文件路径:/config \  # 挂载自定义配置文件（如JSON格式）
  fsqc/toolbox:latest \
  --input /input \
  --output /output \
  --config /config/custom_config.json \  # 加载自定义配置
  --report-format html,pdf \  # 指定报告输出格式（HTML与PDF）
  --overwrite  # 覆盖已存在的输出报告

4.3 配置参数说明

由于工具参数较多，详细配置请参考项目官方文档：

• 完整参数列表：https://github.com/Deep-MI/fsqc
• Docker专项配置：https://github.com/Deep-MI/fsqc/blob/stable/docker/Docker.md（包含环境变量、高级挂载配置、批量处理脚本示例等）

4.4 输出说明

默认输出内容位于 /output 目录（对应本地挂载路径），包含：

• 质量评估报告（HTML/PDF格式，含可视化图表与量化指标）
• 原始评估数据（CSV/JSON格式，便于下游统计分析）
• 日志文件（记录分析过程与潜在异常，用于故障排查）

5. 参考资料

• 项目主页：https://github.com/Deep-MI/fsqc
• Docker使用指南：https://github.com/Deep-MI/fsqc/blob/stable/docker/Docker.md
• 依赖工具集：https://surfer.nmr.mgh.harvard.edu/fswiki/QATools、https://github.com/poldracklab/mriqc、https://github.com/Deep-MI/lapy、https://github.com/Deep-MI/brainprint