{ "__type": "IngestedDoc", "__tag": 4010, "_content": { "Notes": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "This is faster than " }, { "__type": "CrossRef", "__tag": 4002, "value": "medfilt", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.signal._signaltools:medfilt" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " when the input dtype is " }, { "__type": "InlineCode", "__tag": 4051, "value": "uint8" }, { "__type": "Text", "__tag": 4046, "value": ", " }, { "__type": "InlineCode", "__tag": 4051, "value": "float32" }, { "__type": "Text", "__tag": 4046, "value": ", or " }, { "__type": "InlineCode", "__tag": 4051, "value": "float64" }, { "__type": "Text", "__tag": 4046, "value": "; for other types, this falls back to " }, { "__type": "CrossRef", "__tag": 4002, "value": "medfilt", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.signal._signaltools:medfilt" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": ". In some situations, " }, { "__type": "CrossRef", "__tag": 4002, "value": "scipy.ndimage.median_filter", "reference": { "__type": "RefInfo", "__tag": 4000, "module": "scipy", "version": "*", "kind": "api", "path": "scipy.ndimage._filters:median_filter" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " may be faster than this function." } ] }, { "__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": "medfilt2d", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.signal._signaltools:medfilt2d" }, "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 ⛔ \nDask ⚠️ computes graph 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": "out", "annotation": "ndarray", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "An array the same size as input containing the median filtered result." } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Median filter a 2-dimensional array." } ] } ], "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": "input", "annotation": "array_like", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "A 2-dimensional input array." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "kernel_size", "annotation": "array_like, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "A scalar or a list of length 2, giving the size of the median filter window in each dimension. Elements of " }, { "__type": "ParamRef", "__tag": 4071, "name": "kernel_size" }, { "__type": "Text", "__tag": 4046, "value": " should be odd. If " }, { "__type": "ParamRef", "__tag": 4071, "name": "kernel_size" }, { "__type": "Text", "__tag": 4046, "value": " is a scalar, then this scalar is used as the size in each dimension. Default is a kernel of size (3, 3)." } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Extended Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Apply a median filter to the " }, { "__type": "ParamRef", "__tag": 4071, "name": "input" }, { "__type": "Text", "__tag": 4046, "value": " array using a local window-size given by " }, { "__type": "ParamRef", "__tag": 4071, "name": "kernel_size" }, { "__type": "Text", "__tag": 4046, "value": " (must be odd). The array is zero-padded automatically." } ] } ], "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/signal/_signaltools.py", "item_line": 1932, "item_type": "function", "aliases": [ "scipy.signal.medfilt2d" ], "example_section_data": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Code", "__tag": 4050, "value": "import numpy as np\nfrom scipy import signal\nx = np.arange(25).reshape(5, 5)\nx\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\n# Replaces i,j with the median out of 5*5 window\n\n" }, { "__type": "Code", "__tag": 4050, "value": "signal.medfilt2d(x, kernel_size=5)\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\n# Replaces i,j with the median out of default 3*3 window\n\n" }, { "__type": "Code", "__tag": 4050, "value": "signal.medfilt2d(x)\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\n# Replaces i,j with the median out of default 5*3 window\n\n" }, { "__type": "Code", "__tag": 4050, "value": "signal.medfilt2d(x, kernel_size=[5,3])\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\n# Replaces i,j with the median out of default 3*5 window\n\n" }, { "__type": "Code", "__tag": 4050, "value": "signal.medfilt2d(x, kernel_size=[3,5])\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\n# As seen in the examples,\n# kernel numbers must be odd and not exceed original array dim" } ], "title": [], "level": 0, "target": null }, "see_also": [ { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "scipy.ndimage.median_filter", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.ndimage._filters:median_filter" }, "kind": "module" }, "descriptions": [], "type": "func" } ], "signature": { "__type": "SignatureNode", "__tag": 4029, "kind": "function", "parameters": [ { "__type": "SigParam", "__tag": 4030, "name": "input", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "kernel_size", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "3" } ], "return_annotation": { "__type": "Empty", "__tag": 4031 }, "target_name": "medfilt2d" }, "references": null, "qa": "scipy.signal._signaltools:medfilt2d", "arbitrary": [], "local_refs": [ "input", "kernel_size", "out" ] }