`scipy.spatial.transform._rotation:Rotation.as_mrp`

source: /scipy/spatial/transform/_rotation.py :1424

Signature

def as_mrp ( self ) → Array

Summary

Represent as Modified Rodrigues Parameters (MRPs).

Extended Summary

MRPs are a 3 dimensional vector co-directional to the axis of rotation and whose magnitude is equal to tan(theta / 4), where theta is the angle of rotation (in radians) ^[1].

MRPs have a singularity at 360 degrees which can be avoided by ensuring the angle of rotation does not exceed 180 degrees, i.e. switching the direction of the rotation when it is past 180 degrees. This function will always return MRPs corresponding to a rotation of less than or equal to 180 degrees.

Returns

mrps : ndarray, shape (..., 3): Shape depends on shape of inputs used for initialization.

Notes

Array API Standard Support

as_mrp has experimental support for Python Array API Standard compatible backends in addition to NumPy. Please consider testing these features by setting an environment variable SCIPY_ARRAY_API=1 and providing CuPy, PyTorch, JAX, or Dask arrays as array arguments. The following combinations of backend and device (or other capability) are supported.

====================  ====================  ====================
Library               CPU                   GPU
====================  ====================  ====================
NumPy                 ✅                     n/a                 
CuPy                  n/a                   ✅                   
PyTorch               ✅                     ✅                   
JAX                   ✅                     ✅                   
Dask                  ⛔                     n/a                 
====================  ====================  ====================

See dev-arrayapi for more information.

Examples

from scipy.spatial.transform import Rotation as R
import numpy as np

✓

Represent a single rotation:

r = R.from_rotvec([0, 0, np.pi])

✓

r.as_mrp()

✗

r.as_mrp().shape

✓

Represent a stack with a single rotation:

r = R.from_euler('xyz', [[180, 0, 0]], degrees=True)

✓

r.as_mrp()

✗

r.as_mrp().shape

✓

Represent multiple rotations:

r = R.from_rotvec([[np.pi/2, 0, 0], [0, 0, np.pi/2]])

✓

r.as_mrp()

✗

r.as_mrp().shape

✓

Aliases

scipy.spatial.transform.Rotation.as_mrp