{ "__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_rotvec", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.spatial.transform._rotation:Rotation.from_rotvec" }, "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 rotations represented by input rotation vectors." } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Initialize from rotation vectors." } ] } ], "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": "rotvec", "annotation": "array_like, shape (..., 3)", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "A single vector or an ND array of vectors, where the last dimension contains the rotation vectors." } ] } ] }, { "__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 magnitudes are assumed to be in degrees. Default is False." } ] }, { "__type": "Admonition", "__tag": 4056, "kind": "versionadded", "base_type": "neutral", "children": [ { "__type": "AdmonitionTitle", "__tag": 4055, "children": [ { "__type": "Text", "__tag": 4046, "value": "versionadded 1.7.0" } ] } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Extended Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "A rotation vector is a 3 dimensional vector which is co-directional to the axis of rotation and whose norm gives the angle of 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": 603, "item_type": "staticmethod", "aliases": [ "scipy.spatial.transform.Rotation.from_rotvec" ], "example_section_data": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Code", "__tag": 4050, "value": "from scipy.spatial.transform import Rotation as R\nimport numpy as np\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\nInitialize a single rotation:\n\n" }, { "__type": "Code", "__tag": 4050, "value": "r = R.from_rotvec(np.pi/2 * np.array([0, 0, 1]))\n", "execution_status": "success" }, { "__type": "Code", "__tag": 4050, "value": "r.as_rotvec()\n", "execution_status": "failure" }, { "__type": "Code", "__tag": 4050, "value": "r.as_rotvec().shape\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\nInitialize a rotation in degrees, and view it in degrees:\n\n" }, { "__type": "Code", "__tag": 4050, "value": "r = R.from_rotvec(45 * np.array([0, 1, 0]), degrees=True)\nr.as_rotvec(degrees=True)\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_rotvec([\n[0, 0, np.pi/2],\n[np.pi/2, 0, 0]])\n", "execution_status": "success" }, { "__type": "Code", "__tag": 4050, "value": "r.as_rotvec()\n", "execution_status": "failure" }, { "__type": "Code", "__tag": 4050, "value": "r.as_rotvec().shape\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\nIt is also possible to have a stack of a single rotation:\n\n" }, { "__type": "Code", "__tag": 4050, "value": "r = R.from_rotvec([[0, 0, np.pi/2]])\nr.as_rotvec().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": "rotvec", "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_rotvec" }, "references": [ ".. [1] https://en.wikipedia.org/wiki/Axis%E2%80%93angle_representation#Rotation_vector" ], "qa": "scipy.spatial.transform._rotation:Rotation.from_rotvec", "arbitrary": [], "local_refs": [ "degrees", "rotation", "rotvec" ] }