field_svd¶
-
hcipy.field.field_svd(f, full_matrices=True, compute_uv=True)¶ Calculate the singular value decomposition for a tensor field of order 2.
- Parameters
- fField
The tensor field for which to calculate the singular value decompositions.
- full_matricesboolean
If True, matrices in U and Vh will have shapes (M,M) and (N,N) respectively. Otherwise their shapes are (M,K), (K,N) respectively, where K=min(M,N).
- compute_uvboolean
Whether to compute matrices U and Vh in addition to the singular values.
- Returns
- UField
The unitary matrices. Only returned if compute_uv is True.
- SField
The singular values, sorted in descending order.
- VhField
The unitary matrices. Only returned if compute_uv is True.