Skip to main content

Tools related to Intravoxel Incoherent Motion (IVIM) modeling of diffusion MRI data

Project description

ivim - An end-to-end python package for intravoxel incoherent motion (IVIM) analysis of diffusion MRI data

tests passing codecov Documentation Status

The ivim python package provides functionality for the main steps associated with IVIM analysis of diffusion MRI data including:

  • Methods for IVIM parameter estimation / model fitting
  • Simulation of MRI data based on IVIM models
  • Optimization of b-values
  • Preprocessing, both basic operations like extracting image data with a specific b-value or averaging of diffusion encoding directions, and specific methods like correction for signal drift

The file formats used are the ones used by FSL, i.e. .nii.gz for image data, .bval for b-values and .bvec for diffusion encoding directions. File with ending .cval is also used for c-values in analogy to .bval for b-values to describe flow encoding.

Dependencies

The ivim python package relies heavly on numpy for numerical operations, uses nibabel for reading and writing nifti file, and uses scipy for some specific minimization/optimization tasks. A python version >= 3.10 is required.

How to install

The suggested way to install is to first prepare an environment suitable for the ivim package using e.g. venv with a compatible python version (>= 3.10):

python3 -m venv .ivim

Activate the environment:

source .ivim/bin/activate 

To install the package, run:

python3 -m pip install ivim

References

The following work describe some of the algorithms implemented in the package.

  1. Jalnefjord et al. Comparison of methods for estimation of the intravoxel incoherent motion (IVIM) diffusion coefficient (D) and perfusion fraction (f). Magnetic Resonance Materials in Physics, Biology and Medicine 2018; 31(6):715-723. https://doi.org/10.1007/s10334-018-0697-5

  2. Gustafsson et al. Impact of prior distributions and central tendency measures on Bayesian intravoxel incoherent motion model fitting. Magnetic Resonance in Medicine 2018; 79(3):1674-1683. https://doi.org/10.1002/mrm.26783

  3. Jalnefjord et al. Optimization of b‐value schemes for estimation of the diffusion coefficient and the perfusion fraction with segmented intravoxel incoherent motion model fitting. Magnetic Resonance in Medicine 2019; 82(4):1541-1552. https://doi.org/10.1002/mrm.27826

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

ivim_mri-1.0.0.tar.gz (352.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ivim_mri-1.0.0-py3-none-any.whl (34.9 kB view details)

Uploaded Python 3

File details

Details for the file ivim_mri-1.0.0.tar.gz.

File metadata

  • Download URL: ivim_mri-1.0.0.tar.gz
  • Upload date:
  • Size: 352.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.10

File hashes

Hashes for ivim_mri-1.0.0.tar.gz
Algorithm Hash digest
SHA256 dcfa024a2e02bba7a543d37b38d10b45be04fc36d5cdf9872ce340810141278e
MD5 6874d76c445da82b41ee98d7fa080f79
BLAKE2b-256 1e4f5b9f783343085faa382a021b0ee655b9292976f0f33a3588445d0a412886

See more details on using hashes here.

File details

Details for the file ivim_mri-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: ivim_mri-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 34.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.10

File hashes

Hashes for ivim_mri-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 bc6661ca21a18f09dd37f69803d5aea6ee23789023974865cf6f29387bb9204f
MD5 5daec9c1a9ebfd56ebdb5751afa9e46f
BLAKE2b-256 1621509bc320d102a8d81e44d33ae7a975cac9cc7c6d234b25b65a605a381b13

See more details on using hashes here.

Supported by

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