跳转到主要内容

BIDS应用,用于执行验证之外的最小质量控制

项目描述

miniQC

PyPI - Version PyPI - Python Version GHCR - Available Tags


miniQC是一个BIDS应用,用于执行验证之外的最小质量控制。它的目标是快速检测数据损坏,而不是数据集一致性或图像质量。

目录

安装

pip install miniqc

用法

miniqc是一个BIDS-App,因此可以按以下方式运行

miniqc /path/to/dataset /output participant

由于miniqc目前不会根据分析级别生成任何输出或修改其行为,因此输出目录和分析级别是可选的。

此工具旨在作为CLI应用程序,不提供公共API。

示例

$ miniqc tests/data/bids_dataset
[
  [
    "sub-01/anat/sub-01_acq-truncated_T2w.nii.gz",
    "FailedCheck",
    "Expected 477 bytes; found 352"
  ],
  [
    "sub-01/anat/sub-01_acq-dangling_T2w.nii.gz",
    "FileNotFoundError",
    "[Errno 2] No such file or directory: 'tests/data/bids_dataset/sub-01/anat/sub-01_acq-dangling_T2w.nii.gz'"
  ]
]

也可以使用单个文件

$ miniqc tests/data/bids_dataset/sub-01/anat/sub-01_acq-truncated_T2w.nii.gz
[
  [
    "/git/miniqc/tests/data/bids_dataset/sub-01/anat/sub-01_acq-truncated_T2w.nii.gz",
    "FailedCheck",
    "Expected 477 bytes; found 352"
  ]
]

输出

此工具的输出是一个长度为3的数组数组。每个子数组包含失败的文件(相对于数据集根目录)、错误类型和更详细的错误消息。

测试

已安装hatch项目管理工具

hatch run test:cov

或者,只需运行pytest,尽管您需要安装依赖项。

许可

miniqc在MIT许可条款下分发。

项目详情


下载文件

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

源代码分发

miniqc-23.1.1.tar.gz (10.7 kB 查看哈希值)

上传时间 源代码

构建分发

miniqc-23.1.1-py3-none-any.whl (6.5 kB 查看哈希值)

上传时间 Python 3