API Reference

API Reference#

Public API grouped by subpackage.

Calibration Helpers#

pygrog.utils.coil_compression(kspace_data, ...)

Coil compression using principal component analysis on k-space data.

pygrog.utils.nlinv(y[, cal_width, ndim, ...])

Estimate coil sensitivity maps using NLINV.

GROG#

pygrog.calib.GrogInterpolator(shape, coords)

Data-driven GROG interpolator.

Gadgets#

pygrog.gadgets.SubspaceGadget(base_op, ...)

Low-rank temporal/contrast subspace wrapper for sparse/gridded operators.

pygrog.gadgets.OffResonanceGadget(...[, ...])

Low-rank B0/R2* off-resonance correction wrapper for sparse/gridded operators.

pygrog.gadgets.with_subspace(base_op, ...[, ...])

Wrap a SparseFFT or MaskedFFT operator with subspace projection.

pygrog.gadgets.with_offresonance(*args, **kwargs)

Decorator-style constructor for off-resonance-wrapped operators.

Operators#

pygrog.operator.SparseFFT([grid_shape, ...])

Sparse FFT / IFFT operator with coil combination.

pygrog.operator.MaskedFFT([grid_shape, ...])

Masked FFT / IFFT operator for gridded k-space data.

Interoperability#

pygrog.interop.GrogLinop(op)

Wrap a pygrog SparseFFT-like operator as a sigpy.linop.Linop.

pygrog.interop.GrogLinearOp(op)

Wrap a pygrog operator as an mrpro.operators.LinearOperator.

pygrog.interop.GrogLinearPhysics(op[, ...])

Wrap a pygrog operator as a deepinv.physics.LinearPhysics.