API reference

API reference#

Exact contracts of the public objects: parameters, defaults, shapes, units, conventions and restrictions. Concepts are in Explanation, complete workflows in the examples.

Page

Module

Contents

Array functions and settings

bartorch

Fourier and non-uniform Fourier transforms, density compensation, k-space windows, wavelet transforms, thresholding, array functions, runtime settings

BART commands as functions

bartorch.tools

BART’s commands as functions — simulation, sampling, calibration, preprocessing, registration, metrics and low-rank completion — and corrections and rigid motion estimation outside the reconstruction

Linear operators

bartorch.linop

Linear operators, operator algebra and MRI encoding operators

Nonlinear operators

bartorch.nlop

Nonlinear operators, MRI and signal models, Gauss-Newton methods

Optimization

bartorch.optim

Iterative solvers, iteration blocks and data scaling

Regularization and denoising

bartorch.priors

Regularization terms, plug-and-play priors and BART’s denoisers

Reconstruction pipelines

bartorch.apps

BART reconstruction pipelines assembled from operators and solvers

Learning

bartorch.learning

Unrolled iterations and real/complex channel conversions

Interoperability

bartorch.interop

DeepInverse physics adapter

File I/O

bartorch.io

CFL files

Command line

bartorch.cli

The bartorch command line