Skip to content

hickst/qmtools

Repository files navigation

QMTools - Quality Metrics Tools

This is a public code repository of the Translational Bioimaging Resource–MRI core group at the University of Arizona.

Authors: Tom Hicks and Dianne Patterson

About: This project provides several programs to visualize, compare, and review the image quality metrics (IQMs) produced by the MRIQC program. MRIQC extracts no-reference IQMs from structural (T1w and T2w) and functional (BOLD) MRI data.

Using QMTools via Docker (or Apptainer)

The easiest way to use the QMTools is via the publicly available Docker container or an Apptainer container derived from the Docker image. With this approach, the QMTools, located in the container, are called by auxiliary Bash scripts to process data from input and output directories which the scripts make available to the container. Scripts, examples, and documentation which support and simplify this process are available in the QMTools Support project on GitHub. Since this approach requires only Docker or Apptainer and the bash shell to be installed on your local computer, it has a minimal "footprint".

Note: For documentation on the individual tools and how to use the tools via Docker, please see the QMTools Support project.

Installing with Conda

You can also install the main QMTools project (not the Support project) locally on your computer and run the tools from there. Using Miniconda, you can easily set up an isolated environment to run the QMTools without interfering with other local software.

Installing with a Python Virtual Environment

More knowledgable users can install the main QMTools project (not the Support project) locally using a Python virtual environment.

Related Links

The source code for the QMTools Support project in GitHub.

The QMTools project was inspired by a 2019 Neurohackademy project available here.

The Swagger UI for the MRIQC web API. Scroll down to the Models section, which documents the database schema (structure and field names) that can be queried with QMFetcher.

The source code for the MRIQC web API, which provides the API that QMFetcher uses to query the MRIQC database.

Some old Discussions and Jupyter notebooks which utilize the same MRIQC web API that this project uses.

References

  • Esteban O, Blair RW, Nielson DM, Varada JC, Marrett S, Thomas AG et al. (2019). Crowdsourced MRI quality metrics and expert quality annotations for training of humans and machines. Sci Data 6: 30.

  • Esteban O, Birman D, Schaer M, Koyejo OO, Poldrack RA, Gorgolewski KJ (2017). MRIQC: Advancing the automatic prediction of image quality in MRI from unseen sites. PLoS ONE 12: 9.

License

This software is licensed under Apache License Version 2.0.

Copyright (c) The University of Arizona, 2021. All rights reserved.

About

Create graphical reports for the MRIQC image quality metrics.

Resources

License

Stars

Watchers

Forks

Packages

No packages published