dcmri documentation

A python toolbox for dynamic contrast MRI

Note

dcmri is under construction. At this stage, the API may still change and features may be deprecated without warning.

Mission

To simplify the analysis of dynamic-contrast MRI (DC-MRI) data, and the development and distribution of methods.

Features

• A tissue bank with an intuitive user interface to analyse data from different tissues.

• A library of examples applying these methods in real-world questions.

• Building blocks to simplify the creation and testing of new methods:

  • signal models for common MRI sequences;

  • basic pharmacokinetic building blocks such as multi-compartment models; and

  • functions to generate signals for specific tissue types.

• A library of real data, synthetic data and synthetic images to simplify testing or comparison of methods.

• A library of utilities such as common input functions and constants, and functions for performing convolutions and data sampling.

• A user guide with background on basic concepts, physics and mathematical derivations.

Getting started

dcmri offers methods for a range of application areas including vascular-interstitial tissues (brain, cancer, prostate, muscle, …) but also atypical tissues such as liver and kidney, and whole-body models to analyse vascular signals.

To get started, have look at the user guide or the list of examples, or find a suitable method in the reference guide and dive straight in.

Citing

When you use dcmri, please cite:

Ebony Gunwhy, Eve Shalom and Steven Sourbron. dcmri: an open-source python package for dynamic contrast MRI. European Society of Magnetic Resonance in Medicine and Biology (Barcelona, Spain), pp 491, Oct 2024.

Contributing

dcmri is open to any type of contributions, but at this stage we are particularly interested in contributions of example applications. Please see the contributor guide for more detail.

License

dcmri is distributed under the Apache 2.0 license - a permissive, free license that allows users to use, modify, and distribute the software without restrictions.