{ "__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": "out", "annotation": "ndarray (Ni..., Nj..., Nk...)", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The output array. The shape of " }, { "__type": "CrossRef", "__tag": 4002, "value": "out", "reference": { "__type": "RefInfo", "__tag": 4000, "module": null, "version": null, "kind": "local", "path": "out" }, "kind": "local" }, { "__type": "Text", "__tag": 4046, "value": " is identical to the shape of " }, { "__type": "ParamRef", "__tag": 4071, "name": "arr" }, { "__type": "Text", "__tag": 4046, "value": ", except along the " }, { "__type": "ParamRef", "__tag": 4071, "name": "axis" }, { "__type": "Text", "__tag": 4046, "value": " dimension. This axis is removed, and replaced with new dimensions equal to the shape of the return value of " }, { "__type": "ParamRef", "__tag": 4071, "name": "func1d" }, { "__type": "Text", "__tag": 4046, "value": ". So if " }, { "__type": "ParamRef", "__tag": 4071, "name": "func1d" }, { "__type": "Text", "__tag": 4046, "value": " returns a scalar " }, { "__type": "CrossRef", "__tag": 4002, "value": "out", "reference": { "__type": "RefInfo", "__tag": 4000, "module": null, "version": null, "kind": "local", "path": "out" }, "kind": "local" }, { "__type": "Text", "__tag": 4046, "value": " will have one fewer dimensions than " }, { "__type": "ParamRef", "__tag": 4071, "name": "arr" }, { "__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": "Apply a function to 1-D slices along the given axis." } ] } ], "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": "func1d", "annotation": "function (M,) -> (Nj...)", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "This function should accept 1-D arrays. It is applied to 1-D slices of " }, { "__type": "ParamRef", "__tag": 4071, "name": "arr" }, { "__type": "Text", "__tag": 4046, "value": " along the specified axis." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "axis", "annotation": "integer", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Axis along which " }, { "__type": "ParamRef", "__tag": 4071, "name": "arr" }, { "__type": "Text", "__tag": 4046, "value": " is sliced." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "arr", "annotation": "ndarray (Ni..., M, Nk...)", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Input array." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "args", "annotation": "any", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Additional arguments to " }, { "__type": "ParamRef", "__tag": 4071, "name": "func1d" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "kwargs", "annotation": "any", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Additional named arguments to " }, { "__type": "ParamRef", "__tag": 4071, "name": "func1d" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Extended Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Execute " }, { "__type": "InlineRole", "__tag": 4003, "value": "func1d(a, *args, **kwargs)", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " where " }, { "__type": "ParamRef", "__tag": 4071, "name": "func1d" }, { "__type": "Text", "__tag": 4046, "value": " operates on 1-D arrays and " }, { "__type": "InlineRole", "__tag": 4003, "value": "a", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " is a 1-D slice of " }, { "__type": "ParamRef", "__tag": 4071, "name": "arr" }, { "__type": "Text", "__tag": 4046, "value": " along " }, { "__type": "ParamRef", "__tag": 4071, "name": "axis" }, { "__type": "Text", "__tag": 4046, "value": "." } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "This is equivalent to (but faster than) the following use of " }, { "__type": "CrossRef", "__tag": 4002, "value": "ndindex", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "numpy:ndindex" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " and " }, { "__type": "InlineRole", "__tag": 4003, "value": "s_", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": ", which sets each of " }, { "__type": "InlineCode", "__tag": 4051, "value": "ii" }, { "__type": "Text", "__tag": 4046, "value": ", " }, { "__type": "InlineCode", "__tag": 4051, "value": "jj" }, { "__type": "Text", "__tag": 4046, "value": ", and " }, { "__type": "InlineCode", "__tag": 4051, "value": "kk" }, { "__type": "Text", "__tag": 4046, "value": " to a tuple of indices " } ] }, { "__type": "Code", "__tag": 4050, "value": "Ni, Nk = a.shape[:axis], a.shape[axis+1:]\nfor ii in ndindex(Ni):\n for kk in ndindex(Nk):\n f = func1d(arr[ii + s_[:,] + kk])\n Nj = f.shape\n for jj in ndindex(Nj):\n out[ii + jj + kk] = f[jj]", "execution_status": null }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Equivalently, eliminating the inner loop, this can be expressed as " } ] }, { "__type": "Code", "__tag": 4050, "value": "Ni, Nk = a.shape[:axis], a.shape[axis+1:]\nfor ii in ndindex(Ni):\n for kk in ndindex(Nk):\n out[ii + s_[...,] + kk] = func1d(arr[ii + s_[:,] + kk])", "execution_status": null } ], "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": "/numpy/ma/extras.py", "item_line": 350, "item_type": "function", "aliases": [ "numpy.ma.apply_along_axis" ], "example_section_data": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Code", "__tag": 4050, "value": "import numpy as np\ndef my_func(a):\n \"\"\"Average first and last element of a 1-D array\"\"\"\n return (a[0] + a[-1]) * 0.5\nb = np.array([[1,2,3], [4,5,6], [7,8,9]])\nnp.apply_along_axis(my_func, 0, b)\n", "execution_status": "success" }, { "__type": "Code", "__tag": 4050, "value": "np.apply_along_axis(my_func, 1, b)\n", "execution_status": "failure" }, { "__type": "Text", "__tag": 4046, "value": "\nFor a function that returns a 1D array, the number of dimensions in\n`outarr` is the same as `arr`.\n\n" }, { "__type": "Code", "__tag": 4050, "value": "b = np.array([[8,1,7], [4,3,9], [5,2,6]])\nnp.apply_along_axis(sorted, 1, b)\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\nFor a function that returns a higher dimensional array, those dimensions\nare inserted in place of the `axis` dimension.\n\n" }, { "__type": "Code", "__tag": 4050, "value": "b = np.array([[1,2,3], [4,5,6], [7,8,9]])\n", "execution_status": "success" }, { "__type": "Code", "__tag": 4050, "value": "np.apply_along_axis(np.diag, -1, b)\n", "execution_status": "failure" } ], "title": [], "level": 0, "target": null }, "see_also": [ { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "apply_over_axes", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "numpy:apply_over_axes" }, "kind": "module" }, "descriptions": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Apply a function repeatedly over multiple axes." } ] } ], "type": null } ], "signature": { "__type": "SignatureNode", "__tag": 4029, "kind": "function", "parameters": [ { "__type": "SigParam", "__tag": 4030, "name": "func1d", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "axis", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "arr", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "args", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "VAR_POSITIONAL", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "kwargs", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "VAR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } } ], "return_annotation": { "__type": "Empty", "__tag": 4031 }, "target_name": "apply_along_axis" }, "references": null, "qa": "numpy.ma.extras:apply_along_axis", "arbitrary": [], "local_refs": [ "args", "arr", "axis", "func1d", "kwargs", "out" ] }