{
  "__type": "IngestedDoc",
  "__tag": 4010,
  "_content": {
    "Notes": {
      "__type": "Section",
      "__tag": 4015,
      "children": [],
      "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": "mean",
              "annotation": "`RigidTransform` instance",
              "desc": [
                {
                  "__type": "Paragraph",
                  "__tag": 4045,
                  "children": [
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": "Single transform containing the mean of the transforms in the current instance."
                    }
                  ]
                }
              ]
            }
          ]
        }
      ],
      "title": [],
      "level": 0,
      "target": null
    },
    "Summary": {
      "__type": "Section",
      "__tag": 4015,
      "children": [
        {
          "__type": "Paragraph",
          "__tag": 4045,
          "children": [
            {
              "__type": "Text",
              "__tag": 4046,
              "value": "Get the mean of the transforms."
            }
          ]
        }
      ],
      "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": "weights",
              "annotation": "array_like shape (..., N), optional",
              "desc": [
                {
                  "__type": "Paragraph",
                  "__tag": 4045,
                  "children": [
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": "Weights describing the relative importance of the transforms. If None (default), then all values in "
                    },
                    {
                      "__type": "ParamRef",
                      "__tag": 4071,
                      "name": "weights"
                    },
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": " are assumed to be equal. If given, the shape of "
                    },
                    {
                      "__type": "ParamRef",
                      "__tag": 4071,
                      "name": "weights"
                    },
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": " must be broadcastable to the transform shape. Weights must be non-negative."
                    }
                  ]
                }
              ]
            },
            {
              "__type": "DocParam",
              "__tag": 4016,
              "name": "axis",
              "annotation": "None, int, or tuple of ints, optional",
              "desc": [
                {
                  "__type": "Paragraph",
                  "__tag": 4045,
                  "children": [
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": "Axis or axes along which the means are computed. The default is to compute the mean of all transforms."
                    }
                  ]
                }
              ]
            }
          ]
        }
      ],
      "title": [],
      "level": 0,
      "target": null
    },
    "Extended Summary": {
      "__type": "Section",
      "__tag": 4015,
      "children": [
        {
          "__type": "Paragraph",
          "__tag": 4045,
          "children": [
            {
              "__type": "Text",
              "__tag": 4046,
              "value": "The mean of a set of transforms is the same as the mean of its rotation and translation components."
            }
          ]
        },
        {
          "__type": "Paragraph",
          "__tag": 4045,
          "children": [
            {
              "__type": "Text",
              "__tag": 4046,
              "value": "The mean used for the rotation component is the chordal L2 mean (also called the projected or induced arithmetic mean) "
            },
            {
              "__type": "FootnoteReference",
              "__tag": 4066,
              "label": "1"
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": ". If "
            },
            {
              "__type": "InlineCode",
              "__tag": 4051,
              "value": "A"
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": " is a set of rotation matrices, then the mean "
            },
            {
              "__type": "InlineCode",
              "__tag": 4051,
              "value": "M"
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": " is the rotation matrix that minimizes the following loss function:"
            }
          ]
        },
        {
          "__type": "Math",
          "__tag": 4058,
          "value": "L(M) = \\sum_{i = 1}^{n} w_i \\lVert \\mathbf{A}_i -\n\\mathbf{M} \\rVert^2 ,"
        },
        {
          "__type": "Paragraph",
          "__tag": 4045,
          "children": [
            {
              "__type": "Text",
              "__tag": 4046,
              "value": "where "
            },
            {
              "__type": "InlineMath",
              "__tag": 4057,
              "value": "w_i"
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": "'s are the "
            },
            {
              "__type": "ParamRef",
              "__tag": 4071,
              "name": "weights"
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": " corresponding to each matrix."
            }
          ]
        }
      ],
      "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/_rigid_transform.py",
  "item_line": 1034,
  "item_type": "function",
  "aliases": [
    "scipy.spatial.transform.RigidTransform.mean"
  ],
  "example_section_data": {
    "__type": "Section",
    "__tag": 4015,
    "children": [
      {
        "__type": "Code",
        "__tag": 4050,
        "value": "import numpy as np\nfrom scipy.spatial.transform import RigidTransform as Tf\nfrom scipy.spatial.transform import Rotation as R\nrng = np.random.default_rng(seed=123)\n",
        "execution_status": "success",
        "out": ""
      },
      {
        "__type": "Text",
        "__tag": 4046,
        "value": "\nThe mean of a set of transforms is the same as the mean of the\ntranslation and rotation components:\n\n"
      },
      {
        "__type": "Code",
        "__tag": 4050,
        "value": "t = rng.random((4, 3))\nr = R.random(4, rng=rng)\ntf = Tf.from_components(t, r)\n",
        "execution_status": "success",
        "out": ""
      },
      {
        "__type": "Code",
        "__tag": 4050,
        "value": "tf.mean().as_matrix()\nTf.from_components(t.mean(axis=0), r.mean()).as_matrix()\n",
        "execution_status": "failure",
        "out": "array([[ 0.61593, -0.74508,  0.25588,  0.66999],\n       [-0.59354, -0.65247, -0.47117,  0.25482],\n       [ 0.51801,  0.13834, -0.84411,  0.52429],\n       [ 0.     ,  0.     ,  0.     ,  1.     ]])\n"
      }
    ],
    "title": [],
    "level": 0,
    "target": null
  },
  "see_also": [],
  "signature": {
    "__type": "SignatureNode",
    "__tag": 4029,
    "kind": "function",
    "parameters": [
      {
        "__type": "SigParam",
        "__tag": 4030,
        "name": "self",
        "annotation": {
          "__type": "Empty",
          "__tag": 4031
        },
        "kind": "POSITIONAL_OR_KEYWORD",
        "default": {
          "__type": "Empty",
          "__tag": 4031
        }
      },
      {
        "__type": "SigParam",
        "__tag": 4030,
        "name": "weights",
        "annotation": "ArrayLike | None",
        "kind": "POSITIONAL_OR_KEYWORD",
        "default": "None"
      },
      {
        "__type": "SigParam",
        "__tag": 4030,
        "name": "axis",
        "annotation": "None | int | tuple[int, ...]",
        "kind": "POSITIONAL_OR_KEYWORD",
        "default": "None"
      }
    ],
    "return_annotation": "RigidTransform",
    "target_name": "mean"
  },
  "references": [
    ".. [1] Hartley, Richard, et al.,",
    "        \"Rotation Averaging\", International Journal of Computer Vision",
    "        103, 2013, pp. 267-305."
  ],
  "qa": "scipy.spatial.transform._rigid_transform:RigidTransform.mean",
  "arbitrary": [],
  "local_refs": [
    "axis",
    "mean",
    "weights"
  ]
}