API

This is the MRpro Application Programming Interface (API) documentation. It is designed to assist developers and researchers in understanding and utilizing the core functionalities of MRpro effectively. Each module includes detailed descriptions and function signatures to guide you through their usage. This documentation is generated from the docstrings, which are also available in your IDE.

Navigate through the sections below for more information about each module and its capabilities.

mrpro.algorithms

Algorithms for reconstructions, optimization, density and sensitivity map estimation, etc.

mrpro.data

Data containers, loading and saving data.

mrpro.operators

Linear operators (such as FourierOp), functionals/loss functions, and qMRI signal models.

mrpro.phantoms

Numerical Phantoms

mrpro.utils

Functions for tensor shaping, unit conversion, typing, etc.