{ "__type": "IngestedDoc", "__tag": 4010, "_content": { "Notes": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Note that unlike higher level Procrustes analyses of spatial data, this function only uses orthogonal transformations like rotations and reflections, and it does not use scaling or translation." } ] }, { "__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": "orthogonal_procrustes", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.linalg._procrustes:orthogonal_procrustes" }, "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 ⚠️ no JIT ⚠️ no JIT \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": [ { "__type": "Parameters", "__tag": 4026, "children": [ { "__type": "DocParam", "__tag": 4016, "name": "", "annotation": "ValueError", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If the input array shapes don't match or if check_finite is True and the arrays contain Inf or NaN." } ] } ] } ] } ], "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": "R", "annotation": "(N, N) ndarray", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The matrix solution of the orthogonal Procrustes problem. Minimizes the Frobenius norm of " }, { "__type": "InlineCode", "__tag": 4051, "value": "(A @ R) - B" }, { "__type": "Text", "__tag": 4046, "value": ", subject to " }, { "__type": "InlineCode", "__tag": 4051, "value": "R.conj().T @ R = I" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "scale", "annotation": "float", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Sum of the singular values of " }, { "__type": "InlineCode", "__tag": 4051, "value": "A.conj().T @ B" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Compute the matrix solution of the orthogonal (or unitary) Procrustes problem." } ] } ], "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": "A", "annotation": "(M, N) array_like", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Matrix to be mapped." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "B", "annotation": "(M, N) array_like", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Target matrix." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "check_finite", "annotation": "bool, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Whether to check that the input matrices contain only finite numbers. Disabling may give a performance gain, but may result in problems (crashes, non-termination) if the inputs do contain infinities or NaNs." } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Extended Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Given matrices " }, { "__type": "ParamRef", "__tag": 4071, "name": "A" }, { "__type": "Text", "__tag": 4046, "value": " and " }, { "__type": "ParamRef", "__tag": 4071, "name": "B" }, { "__type": "Text", "__tag": 4046, "value": " of the same shape, find an orthogonal (or unitary in the case of complex input) matrix " }, { "__type": "CrossRef", "__tag": 4002, "value": "R", "reference": { "__type": "RefInfo", "__tag": 4000, "module": null, "version": null, "kind": "local", "path": "R" }, "kind": "local" }, { "__type": "Text", "__tag": 4046, "value": " that most closely maps " }, { "__type": "ParamRef", "__tag": 4071, "name": "A" }, { "__type": "Text", "__tag": 4046, "value": " to " }, { "__type": "ParamRef", "__tag": 4071, "name": "B" }, { "__type": "Text", "__tag": 4046, "value": " using the algorithm given in " }, { "__type": "FootnoteReference", "__tag": 4066, "label": "1" }, { "__type": "Text", "__tag": 4046, "value": "." } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The documentation is written assuming array arguments are of specified \"core\" shapes. However, array argument(s) of this function may have additional \"batch\" dimensions prepended to the core shape. In this case, the array is treated as a batch of lower-dimensional slices; see " }, { "__type": "InlineRole", "__tag": 4003, "value": "linalg_batch", "domain": null, "role": "ref", "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " for details. Note that calls with zero-size batches are unsupported and will raise a " }, { "__type": "InlineCode", "__tag": 4051, "value": "ValueError" }, { "__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/linalg/_procrustes.py", "item_line": 14, "item_type": "function", "aliases": [ "scipy.linalg.orthogonal_procrustes" ], "example_section_data": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Code", "__tag": 4050, "value": "import numpy as np\nfrom scipy.linalg import orthogonal_procrustes\nA = np.array([[ 2, 0, 1], [-2, 0, 0]])\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\nFlip the order of columns and check for the anti-diagonal mapping\n\n" }, { "__type": "Code", "__tag": 4050, "value": "R, sca = orthogonal_procrustes(A, np.fliplr(A))\n", "execution_status": "success" }, { "__type": "Code", "__tag": 4050, "value": "R\nsca\n", "execution_status": "failure" }, { "__type": "Text", "__tag": 4046, "value": "\nAs an example of the unitary Procrustes problem, generate a\nrandom complex matrix ``A``, a random unitary matrix ``Q``,\nand their product ``B``.\n\n" }, { "__type": "Code", "__tag": 4050, "value": "shape = (4, 4)\nrng = np.random.default_rng(589234981235)\nA = rng.random(shape) + rng.random(shape)*1j\nQ = rng.random(shape) + rng.random(shape)*1j\nQ, _ = np.linalg.qr(Q)\nB = A @ Q\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\n`orthogonal_procrustes` recovers the unitary matrix ``Q``\nfrom ``A`` and ``B``.\n\n" }, { "__type": "Code", "__tag": 4050, "value": "R, _ = orthogonal_procrustes(A, B)\nnp.allclose(R, Q)\n", "execution_status": "success" } ], "title": [], "level": 0, "target": null }, "see_also": [], "signature": { "__type": "SignatureNode", "__tag": 4029, "kind": "function", "parameters": [ { "__type": "SigParam", "__tag": 4030, "name": "A", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "B", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "check_finite", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "True" } ], "return_annotation": { "__type": "Empty", "__tag": 4031 }, "target_name": "orthogonal_procrustes" }, "references": [ ".. [1] Peter H. Schonemann, \"A generalized solution of the orthogonal", " Procrustes problem\", Psychometrica -- Vol. 31, No. 1, March, 1966.", " :doi:`10.1007/BF02289451`" ], "qa": "scipy.linalg._procrustes:orthogonal_procrustes", "arbitrary": [], "local_refs": [ "A", "B", "R", "check_finite", "scale" ] }