API Reference#

Reference API for MRI-NUFFT.

MRI-NUFFT public API is organized in modules [1], and the top level mrinufft only exposes a handfull of utilities functions, that had nowhere else to go.

Tip

From the top level you likely only need get_operator(), the entry point to create NUFFT operator following the NUFFT operator interface

Here are the different modules that are the public API of MRI-NUFFT:

mrinufft

Base module.

mrinufft.operators

Collection of operators applying the NUFFT used in a MRI context.

mrinufft.trajectories

Collection of trajectories and tools used for non-Cartesian MRI.

mrinufft.display

Display functions for trajectories.

mrinufft.density

Density compensation methods.

mrinufft.io

Input/Output module for trajectories and data.

mrinufft.extras

Extra utilities for non Cartesian MRI.