Skip to main content

Quality assurance tools for MRI geometric distortion

Project description

mri_distortion_toolkit

codecov tests docs

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
    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 A "https://acrf-image-x-institute.github.io/mri_distortion_toolkit/code_docs.html#MRI_DistortionQA.MarkerAnalysis.MarkerVolume"
    click B "https://acrf-image-x-institute.github.io/mri_distortion_toolkit/code_docs.html#MRI_DistortionQA.MarkerAnalysis.MatchedMarkerVolumes"
    click C "https://acrf-image-x-institute.github.io/mri_distortion_toolkit/code_docs.html#MRI_DistortionQA.FieldCalculation.ConvertMatchedMarkersToBz"
    click D "https://acrf-image-x-institute.github.io/mri_distortion_toolkit/code_docs.html#MRI_DistortionQA.FieldAnalysis.SphericalHarmonicFit"
    click E "https://acrf-image-x-institute.github.io/mri_distortion_toolkit/code_docs.html#MRI_DistortionQA.Reports.MRI_QA_Reporter"

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.9.0.tar.gz (50.2 kB view details)

Uploaded Source

Built Distribution

mri_distortion_toolkit-0.9.0-py3-none-any.whl (53.9 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for mri_distortion_toolkit-0.9.0.tar.gz
Algorithm Hash digest
SHA256 b8d6c3ff58189c7d945986777dbb4444ee7936bd93d10dd49fce5c713bcb8c89
MD5 d2eb7d0bddca72bb53ec265d0f3b6139
BLAKE2b-256 8b83ba443c949c9ba4f95a875a24191d38d690de4968888a3f2fc693dfc76054

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mri_distortion_toolkit-0.9.0-py3-none-any.whl
Algorithm Hash digest
SHA256 11815ef80834ee48a2fe334655c23b55776f2e5addafff731675cfbceb7a8fb9
MD5 787704f89744f86a6fcb25adba171658
BLAKE2b-256 9d7c1e884140331c9e4979354634a4855a7ddb4ab8674d40b34c1d4cd8505b67

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