inverse_truncated

hcipy.util.inverse_truncated(M, rcond=1e-15, svd=None)

Invert M truncating the number of modes.

Modes are given by a singular value decomposition of the input matrix. If svd is given, it is used instead. Modes are ordered in descending order by their singular values. All modes with a singular value lower than rcond times the maximum singular value, will be ignored.

Parameters

Mndarray

The matrix to invert. This matrix must be two-dimensional.

rcondscalar

The relative condition number of the highest-order mode that must be used for inversion.

svdSVD object

A precalculated singular value decomposition object. This will be used if supplied, to avoid recalculation of an SVD.

Returns

ndarray

The inverted matrix.