https://github.com/Image-X-Institute/mri_distortion_toolkit

Characterisation and reporting of geometric distortion in MRI
https://github.com/Image-X-Institute/mri_distortion_toolkit

magnetic-resonance-imaging mri mri-distortion mri-qa reporting spherical-harmonics

Last synced: 19 days ago
JSON representation

Characterisation and reporting of geometric distortion in MRI

• Host: GitHub
• URL: https://github.com/Image-X-Institute/mri_distortion_toolkit
• Owner: Image-X-Institute
• License: gpl-3.0
• Created: 2022-05-10T00:49:34.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-02-24T02:44:03.000Z (about 1 year ago)
• Last Synced: 2024-11-24T09:10:34.587Z (6 months ago)
• Topics: magnetic-resonance-imaging, mri, mri-distortion, mri-qa, reporting, spherical-harmonics
• Language: HTML
• Homepage: https://image-x-institute.github.io/mri_distortion_toolkit/
• Size: 26.1 MB
• Stars: 9
• Watchers: 0
• Forks: 3
• Open Issues: 15
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-medphys - mri_distortion_toolkit -  Library enabling measurement, characterization, correction, and reporting of geometric distortion in Magnetic Resonance Imaging [](https://badge.fury.io/py/mri_distortion_toolkit) (Libraries)

README

        
# mri_distortion_toolkit  

[![codecov](https://codecov.io/gh/Image-X-Institute/mri_distortion_toolkit/graph/badge.svg?token=3MCT7S6KVK)](https://codecov.io/gh/Image-X-Institute/mri_distortion_toolkit)![](docsrc/__resources/interrogate.svg)  ![tests](https://github.com/ACRF-Image-X-Institute/MRI_DistortionQA/actions/workflows/run_tests.yml/badge.svg) ![docs](https://github.com/ACRF-Image-X-Institute/MRI_DistortionQA/actions/workflows/build_docs.yml/badge.svg)[![PyPI version](https://badge.fury.io/py/mri_distortion_toolkit.svg)](https://badge.fury.io/py/mri_distortion_toolkit)

This code enables characterization, reporting, and correction of geometric distortion in Magnetic Resonance Imaging.

The workflow steps are below. All steps have well defined input/output so you can use any part of this code independently from the other parts. For an example of our automated reporting template see [here](https://image-x-institute.github.io/mri_distortion_toolkit/_static/MR_QA_report_20_05_2022.html)

![](docsrc/__resources/Brendan_Phantom.png)

## Setup/Build/Install

```bash

pip install mri_distortion_toolkit

``` 

## Usage

Detailed documentation is [here](https://image-x-institute.github.io/mri_distortion_toolkit/). 

## Directory Structure

- *docsrc* markdown/rst source documentation

- *tests* test cases

- *mri_distortion_toolkit* source code 

- *examples* source code for the [worked examples](https://image-x-institute.github.io/mri_distortion_toolkit/examples.html)