Skip to main content

Quality assurance tools for MRI geometric distortion

Project description

mri_distortion_toolkit

codecov tests docsPyPI version

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

For the measurement of such distortions, see here.

The workflow steps are below, but all steps have well defined input/output so you can use any part of this code independently from the other parts. For a tutorial on each step, click on the diagram below. For an example of our automated reporting template see here

flowchart LR
subgraph AA[Phantom Design]
end
    A[Marker <br>Extraction]--->B[Marker <br>Matching]
    B[Marker <br>Matching]--->C[Field <br> Calculation] & E[Automated <br>reporting]
    C[Field <br> Calculation]-->D[Spherical Harmonic <br>Analysis]
    D[Spherical Harmonic <br>Analysis]-->E[Automated <br>reporting];
    D[Spherical Harmonic <br>Analysis]-->F[Distortion Correction]
	

    click AA "https://acrf-image-x-institute.github.io/mri_distortion_toolkit/phantom_notes.html"
    click A "https://acrf-image-x-institute.github.io/mri_distortion_toolkit/marker_extraction.html"
    click B "https://acrf-image-x-institute.github.io/mri_distortion_toolkit/marker_matching.html"
    click C "https://acrf-image-x-institute.github.io/mri_distortion_toolkit/field_calculation.html"
    click D "https://acrf-image-x-institute.github.io/mri_distortion_toolkit/fit_spherical_harmonics.html"
    click E "https://acrf-image-x-institute.github.io/mri_distortion_toolkit/reporting.html"

Setup/Build/Install

pip install mri_distortion_toolkit

Usage

Detailed documentation is here.

Directory Structure

  • docsrc markdown/rst source documentation
  • tests test cases
  • MRI_DistortionQA source code
  • examples source code for the worked examples

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mri_distortion_toolkit-0.12.0.tar.gz (59.2 kB view details)

Uploaded Source

Built Distribution

mri_distortion_toolkit-0.12.0-py3-none-any.whl (63.2 kB view details)

Uploaded Python 3

File details

Details for the file mri_distortion_toolkit-0.12.0.tar.gz.

File metadata

File hashes

Hashes for mri_distortion_toolkit-0.12.0.tar.gz
Algorithm Hash digest
SHA256 176b081c053c68f8e0d054af88e5b507bd72757411c70c729c7acce63c2d842f
MD5 a1b644c30c2acf907d6eda8b0335ad99
BLAKE2b-256 616ab61f9327722864a94cb0276942958175ba4e599341f8435dd2832e7ab92e

See more details on using hashes here.

File details

Details for the file mri_distortion_toolkit-0.12.0-py3-none-any.whl.

File metadata

File hashes

Hashes for mri_distortion_toolkit-0.12.0-py3-none-any.whl
Algorithm Hash digest
SHA256 62c586cce5fb8e0bc912c78c1d45905e40c9c05fcb6aa763f6f969ac4675994b
MD5 5908f73cb9979db89922fca0bdfba820
BLAKE2b-256 7ccdb4d67699d2dcd04bcce0919f6e3d8f6a666ca9f168c769ee580c19ae40c1

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page