{ "__type": "IngestedDoc", "__tag": 4010, "_content": { "Notes": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The grayscale dilation of an image input by a structuring element s defined over a domain E is given by:" } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "(input+s)(x) = max {input(y) + s(x-y), for y in E}" } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "In particular, for structuring elements defined as s(y) = 0 for y in E, the grayscale dilation computes the maximum of the input image inside a sliding window defined by E." } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Grayscale dilation " }, { "__type": "FootnoteReference", "__tag": 4066, "label": "1" }, { "__type": "Text", "__tag": 4046, "value": " is a " }, { "__type": "Emphasis", "__tag": 4047, "children": [ { "__type": "Text", "__tag": 4046, "value": "mathematical morphology" } ] }, { "__type": "Text", "__tag": 4046, "value": " operation " }, { "__type": "FootnoteReference", "__tag": 4066, "label": "2" }, { "__type": "Text", "__tag": 4046, "value": "." } ] }, { "__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": "grey_dilation", "reference": { "__type": "RefInfo", "__tag": 4000, "module": null, "version": null, "kind": "local", "path": "grey_dilation" }, "kind": "local" }, { "__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": "grey_dilation", "annotation": "ndarray", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Grayscale dilation of " }, { "__type": "ParamRef", "__tag": 4071, "name": "input" }, { "__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": "Calculate a greyscale dilation, using either a structuring element, or a footprint corresponding to a flat structuring element." } ] } ], "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": "Array over which the grayscale dilation is to be computed." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "size", "annotation": "tuple of ints", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Shape of a flat and full structuring element used for the grayscale dilation. Optional if " }, { "__type": "ParamRef", "__tag": 4071, "name": "footprint" }, { "__type": "Text", "__tag": 4046, "value": " or " }, { "__type": "ParamRef", "__tag": 4071, "name": "structure" }, { "__type": "Text", "__tag": 4046, "value": " is provided." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "footprint", "annotation": "array of ints, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Positions of non-infinite elements of a flat structuring element used for the grayscale dilation. Non-zero values give the set of neighbors of the center over which the maximum is chosen." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "structure", "annotation": "array of ints, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Structuring element used for the grayscale dilation. " }, { "__type": "ParamRef", "__tag": 4071, "name": "structure" }, { "__type": "Text", "__tag": 4046, "value": " may be a non-flat structuring element. The " }, { "__type": "ParamRef", "__tag": 4071, "name": "structure" }, { "__type": "Text", "__tag": 4046, "value": " array applies an additive offset for each pixel in the neighborhood." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "output", "annotation": "array, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "An array used for storing the output of the dilation may be provided." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "mode", "annotation": "{'reflect','constant','nearest','mirror', 'wrap'}, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The " }, { "__type": "ParamRef", "__tag": 4071, "name": "mode" }, { "__type": "Text", "__tag": 4046, "value": " parameter determines how the array borders are handled, where " }, { "__type": "ParamRef", "__tag": 4071, "name": "cval" }, { "__type": "Text", "__tag": 4046, "value": " is the value when mode is equal to 'constant'. Default is 'reflect'" } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "cval", "annotation": "scalar, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Value to fill past edges of input if " }, { "__type": "ParamRef", "__tag": 4071, "name": "mode" }, { "__type": "Text", "__tag": 4046, "value": " is 'constant'. Default is 0.0." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "origin", "annotation": "scalar, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The " }, { "__type": "ParamRef", "__tag": 4071, "name": "origin" }, { "__type": "Text", "__tag": 4046, "value": " parameter controls the placement of the filter. Default 0" } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "axes", "annotation": "tuple of int or None", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The axes over which to apply the filter. If None, " }, { "__type": "ParamRef", "__tag": 4071, "name": "input" }, { "__type": "Text", "__tag": 4046, "value": " is filtered along all axes. If an " }, { "__type": "ParamRef", "__tag": 4071, "name": "origin" }, { "__type": "Text", "__tag": 4046, "value": " tuple is provided, its length must match the number of axes." } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Extended Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Grayscale dilation is a mathematical morphology operation. For the simple case of a full and flat structuring element, it can be viewed as a maximum filter over a sliding window." } ] } ], "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/ndimage/_morphology.py", "item_line": 1292, "item_type": "function", "aliases": [ "scipy.ndimage.grey_dilation" ], "example_section_data": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Code", "__tag": 4050, "value": "from scipy import ndimage\nimport numpy as np\na = np.zeros((7,7), dtype=int)\na[2:5, 2:5] = 1\na[4,4] = 2; a[2,3] = 3\na\nndimage.grey_dilation(a, size=(3,3))\nndimage.grey_dilation(a, footprint=np.ones((3,3)))\ns = ndimage.generate_binary_structure(2,1)\n", "execution_status": "success" }, { "__type": "Code", "__tag": 4050, "value": "s\n", "execution_status": "failure" }, { "__type": "Code", "__tag": 4050, "value": "ndimage.grey_dilation(a, footprint=s)\nndimage.grey_dilation(a, size=(3,3), structure=np.ones((3,3)))\n", "execution_status": "success" } ], "title": [], "level": 0, "target": null }, "see_also": [ { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "binary_dilation", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.ndimage._morphology:binary_dilation" }, "kind": "module" }, "descriptions": [], "type": "func" }, { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "generate_binary_structure", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.ndimage._morphology:generate_binary_structure" }, "kind": "module" }, "descriptions": [], "type": "func" }, { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "grey_closing", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.ndimage._morphology:grey_closing" }, "kind": "module" }, "descriptions": [], "type": "func" }, { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "grey_erosion", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.ndimage._morphology:grey_erosion" }, "kind": "module" }, "descriptions": [], "type": "func" }, { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "grey_opening", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.ndimage._morphology:grey_opening" }, "kind": "module" }, "descriptions": [], "type": "func" }, { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "maximum_filter", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.ndimage._filters:maximum_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": "size", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "None" }, { "__type": "SigParam", "__tag": 4030, "name": "footprint", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "None" }, { "__type": "SigParam", "__tag": 4030, "name": "structure", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "None" }, { "__type": "SigParam", "__tag": 4030, "name": "output", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "None" }, { "__type": "SigParam", "__tag": 4030, "name": "mode", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "reflect" }, { "__type": "SigParam", "__tag": 4030, "name": "cval", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "0.0" }, { "__type": "SigParam", "__tag": 4030, "name": "origin", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "0" }, { "__type": "SigParam", "__tag": 4030, "name": "axes", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "KEYWORD_ONLY", "default": "None" } ], "return_annotation": { "__type": "Empty", "__tag": 4031 }, "target_name": "grey_dilation" }, "references": [ ".. [1] https://en.wikipedia.org/wiki/Dilation_%28morphology%29", ".. [2] https://en.wikipedia.org/wiki/Mathematical_morphology" ], "qa": "scipy.ndimage._morphology:grey_dilation", "arbitrary": [], "local_refs": [ "axes", "cval", "footprint", "grey_dilation", "input", "mode", "origin", "output", "size", "structure" ] }