Skip to content

MRIReco.jl

Magnetic Resonance Imaging Reconstruction in Julia

MRIReco.jl

MRIReco.jl is a framework for MRI image reconstruction written in Julia. It provides data types for raw data and for k-space data prepared for reconstruction, encoding operators, and direct as well as iterative reconstruction methods, including parallel imaging and compressed sensing. Further packages read and write raw data files, generate sampling patterns, estimate coil sensitivities and simulate data.

Packages ​

MRIReco.jl consists of several packages that are developed in the same repository and registered individually. The last column lists the packages of this repository that each package depends on. MRIReco re-exports its dependencies MRIBase and MRIOperators, so their names are available after using MRIReco; the other packages are independent of MRIReco and are installed and loaded separately.

PackagePurposeDepends on
MRIRecoImage reconstructionMRIBase, MRIOperators
MRIBaseData types for raw data, acquisition data and trajectories—
MRIOperatorsEncoding operatorsMRIBase
MRIFilesReading and writing raw data filesMRIBase
MRISamplingUndersampling patternsMRIBase
MRICoilSensitivitiesCoil sensitivity estimation and coil compressionMRIBase
MRISimulationSimulation of MRI dataMRIBase, MRIOperators

How the Documentation Is Organized ​

  • Getting Started shows how to install the packages and run a first reconstruction.

  • The tutorials walk through complete reconstructions step by step.

  • The how-to guides show how to solve specific tasks, grouped by package.

  • The explanations describe the design of the packages and the concepts behind them.

  • The reference lists the API of each package.

Citing MRIReco.jl ​

If you use MRIReco.jl in your work, please cite

T. Knopp and M. Grosser, "MRIReco.jl: An MRI reconstruction framework written in Julia", Magnetic Resonance in Medicine 86, 1633–1646 (2021), doi:10.1002/mrm.28792.

A BibTeX entry is in MRIReco.bib.

Getting Help ​

Questions are welcome in GitHub Discussions, and bugs can be reported as issues. To contribute changes, see the contributing guide.