{ "__type": "IngestedDoc", "__tag": 4010, "_content": { "Notes": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Strong", "__tag": 4048, "children": [ { "__type": "Text", "__tag": 4046, "value": "Array API Standard Support" } ] } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "CrossRef", "__tag": 4002, "value": "from_euler", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.spatial.transform._rotation:Rotation.from_euler" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " has experimental support for Python Array API Standard compatible backends in addition to NumPy. Please consider testing these features by setting an environment variable " }, { "__type": "InlineCode", "__tag": 4051, "value": "SCIPY_ARRAY_API=1" }, { "__type": "Text", "__tag": 4046, "value": " and providing CuPy, PyTorch, JAX, or Dask arrays as array arguments. The following combinations of backend and device (or other capability) are supported." } ] }, { "__type": "Code", "__tag": 4050, "value": "==================== ==================== ====================\nLibrary CPU GPU\n==================== ==================== ====================\nNumPy ✅ n/a \nCuPy n/a ✅ \nPyTorch ✅ ✅ \nJAX ✅ ✅ \nDask ⛔ n/a \n==================== ==================== ====================", "execution_status": null }, { "__type": "Blockquote", "__tag": 4059, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "See " }, { "__type": "InlineRole", "__tag": 4003, "value": "dev-arrayapi", "domain": null, "role": "ref", "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " for more information." } ] } ] } ], "title": [], "level": 0, "target": null }, "Warns": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Raises": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Yields": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Methods": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Returns": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Parameters", "__tag": 4026, "children": [ { "__type": "DocParam", "__tag": 4016, "name": "rotation", "annotation": "`Rotation` instance", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Object containing the rotation represented by the sequence of rotations around given axes with given angles." } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Initialize from Euler angles." } ] } ], "title": [], "level": 0, "target": null }, "Receives": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Warnings": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Attributes": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Parameters": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Parameters", "__tag": 4026, "children": [ { "__type": "DocParam", "__tag": 4016, "name": "seq", "annotation": "string", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Specifies sequence of axes for rotations. Up to 3 characters belonging to the set {'X', 'Y', 'Z'} for intrinsic rotations, or {'x', 'y', 'z'} for extrinsic rotations. Extrinsic and intrinsic rotations cannot be mixed in one function call." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "angles", "annotation": "float or array_like, shape (..., [1 or 2 or 3])", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Euler angles specified in radians (" }, { "__type": "ParamRef", "__tag": 4071, "name": "degrees" }, { "__type": "Text", "__tag": 4046, "value": " is False) or degrees (" }, { "__type": "ParamRef", "__tag": 4071, "name": "degrees" }, { "__type": "Text", "__tag": 4046, "value": " is True). Each character in " }, { "__type": "ParamRef", "__tag": 4071, "name": "seq" }, { "__type": "Text", "__tag": 4046, "value": " defines one axis around which " }, { "__type": "ParamRef", "__tag": 4071, "name": "angles" }, { "__type": "Text", "__tag": 4046, "value": " turns. The resulting rotation has the shape np.atleast_1d(angles).shape[:-1]. Dimensionless angles are thus only valid for single character " }, { "__type": "ParamRef", "__tag": 4071, "name": "seq" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "degrees", "annotation": "bool, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If True, then the given angles are assumed to be in degrees. Default is False." } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Extended Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Rotations in 3-D can be represented by a sequence of 3 rotations around a sequence of axes. In theory, any three axes spanning the 3-D Euclidean space are enough. In practice, the axes of rotation are chosen to be the basis vectors." } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The three rotations can either be in a global frame of reference (extrinsic) or in a body centred frame of reference (intrinsic), which is attached to, and moves with, the object under rotation " }, { "__type": "FootnoteReference", "__tag": 4066, "label": "1" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ], "title": [], "level": 0, "target": null }, "Other Parameters": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null } }, "_ordered_sections": [ "Summary", "Extended Summary", "Parameters", "Attributes", "Methods", "Returns", "Yields", "Receives", "Other Parameters", "Raises", "Warns", "Warnings", "Notes" ], "item_file": "/scipy/spatial/transform/_rotation.py", "item_line": 677, "item_type": "staticmethod", "aliases": [ "scipy.spatial.transform.Rotation.from_euler" ], "example_section_data": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Code", "__tag": 4050, "value": "from scipy.spatial.transform import Rotation as R\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\nInitialize a single rotation along a single axis:\n\n" }, { "__type": "Code", "__tag": 4050, "value": "r = R.from_euler('x', 90, degrees=True)\nr.as_quat().shape\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\nInitialize a single rotation with a given axis sequence:\n\n" }, { "__type": "Code", "__tag": 4050, "value": "r = R.from_euler('zyx', [90, 45, 30], degrees=True)\nr.as_quat().shape\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\nInitialize a stack with a single rotation around a single axis:\n\n" }, { "__type": "Code", "__tag": 4050, "value": "r = R.from_euler('x', [[90]], degrees=True)\nr.as_quat().shape\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\nInitialize a stack with a single rotation with an axis sequence:\n\n" }, { "__type": "Code", "__tag": 4050, "value": "r = R.from_euler('zyx', [[90, 45, 30]], degrees=True)\nr.as_quat().shape\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\nInitialize multiple elementary rotations in one object:\n\n" }, { "__type": "Code", "__tag": 4050, "value": "r = R.from_euler('x', [[90], [45], [30]], degrees=True)\nr.as_quat().shape\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\nInitialize multiple rotations in one object:\n\n" }, { "__type": "Code", "__tag": 4050, "value": "r = R.from_euler('zyx', [[90, 45, 30], [35, 45, 90]], degrees=True)\nr.as_quat().shape\n", "execution_status": "success" } ], "title": [], "level": 0, "target": null }, "see_also": [], "signature": { "__type": "SignatureNode", "__tag": 4029, "kind": "function", "parameters": [ { "__type": "SigParam", "__tag": 4030, "name": "seq", "annotation": "str", "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "angles", "annotation": "ArrayLike", "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "degrees", "annotation": "bool", "kind": "POSITIONAL_OR_KEYWORD", "default": "False" } ], "return_annotation": "Rotation", "target_name": "from_euler" }, "references": [ ".. [1] https://en.wikipedia.org/wiki/Euler_angles#Definition_by_intrinsic_rotations" ], "qa": "scipy.spatial.transform._rotation:Rotation.from_euler", "arbitrary": [], "local_refs": [ "angles", "degrees", "rotation", "seq" ] }