MLXBackend.rigid_transform#

MLXBackend.rigid_transform(arr, rotation_matrix, arr_mask=None, translation=None, use_geometric_center=False, out=None, out_mask=None, order=3, **kwargs)[source]#

Performs a rigid transformation.

Parameters:
arrBackendArray

The input array to be rotated.

arr_maskBackendArray, optional

The mask of arr that will be equivalently rotated.

rotation_matrixBackendArray

The rotation matrix to apply (d, d).

translationBackendArray

The translation to apply (d,).

use_geometric_centerbool, optional

Whether rotation should be performed over the center of mass.

outBackendArray, optional

Location into which the rotation of arr is written.

out_maskBackendArray, optional

Location into which the rotation of arr_mask is written.

orderint, optional

Interpolation order, one is linear and three is cubic. Specific meaning depends on backend.

kwargsdict, optional

Keyword arguments relevant to particular backend implementations.