{ "__type": "IngestedDoc", "__tag": 4010, "_content": { "Notes": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The footprint can also be a provided as a sequence of 2-tuples where the first element of each 2-tuple is a footprint ndarray and the second element is an integer describing the number of times it should be iterated. For example " }, { "__type": "InlineCode", "__tag": 4051, "value": "footprint=[(np.ones((9, 1)), 1), (np.ones((1, 9)), 1)]" }, { "__type": "Text", "__tag": 4046, "value": " would apply a 9x1 footprint followed by a 1x9 footprint resulting in a net effect that is the same as " }, { "__type": "InlineCode", "__tag": 4051, "value": "footprint=np.ones((9, 9))" }, { "__type": "Text", "__tag": 4046, "value": ", but with lower computational cost. Most of the builtin footprints such as " }, { "__type": "CrossRef", "__tag": 4002, "value": "skimage.morphology.disk", "reference": { "__type": "RefInfo", "__tag": 4000, "module": "skimage", "version": "*", "kind": "api", "path": "skimage.morphology.footprints:disk" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " provide an option to automatically generate a footprint sequence of this type." } ] } ], "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": "closing", "annotation": "array, same shape and type as `image`", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The result of the morphological closing." } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Return grayscale morphological closing of an image." } ] } ], "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": "image", "annotation": "ndarray", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Image array." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "footprint", "annotation": "ndarray or tuple, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The neighborhood expressed as a 2-D array of 1's and 0's. If None, use a cross-shaped footprint (connectivity=1). The footprint can also be provided as a sequence of smaller footprints as described in the notes below." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "out", "annotation": "ndarray, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The array to store the result of the morphology. If None, a new array will be allocated." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "mode", "annotation": "str, 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. Valid modes are: 'reflect', 'constant', 'nearest', 'mirror', 'wrap', 'max', 'min', or 'ignore'. If 'ignore', pixels outside the image domain are assumed to be the maximum for the image's dtype in the erosion, and minimum in the dilation, which causes them to not influence the result. 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": "Admonition", "__tag": 4056, "kind": "versionadded", "base_type": "neutral", "children": [ { "__type": "AdmonitionTitle", "__tag": 4055, "children": [ { "__type": "Text", "__tag": 4046, "value": "versionadded 0.23" } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "ParamRef", "__tag": 4071, "name": "mode" }, { "__type": "Text", "__tag": 4046, "value": " and " }, { "__type": "ParamRef", "__tag": 4071, "name": "cval" }, { "__type": "Text", "__tag": 4046, "value": " were added in 0.23." } ] } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Extended Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The morphological closing of an image is defined as a dilation followed by an erosion. Closing can remove small dark spots (i.e. \"pepper\") and connect small bright cracks. This tends to \"close\" up (dark) gaps between (bright) features." } ] } ], "title": [], "level": 0, "target": null }, "Other Parameters": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null } }, "_ordered_sections": [ "Summary", "Extended Summary", "Parameters", "Returns", "Yields", "Receives", "Raises", "Warns", "Other Parameters", "Attributes", "Methods", "Notes", "Warnings" ], "item_file": "/dev/scikit-image/src/skimage/morphology/gray.py", "item_line": 413, "item_type": "function", "aliases": [ "skimage.morphology.closing" ], "example_section_data": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Code", "__tag": 4050, "value": "import numpy as np\nfrom skimage.morphology import footprint_rectangle\nbroken_line = np.array([[0, 0, 0, 0, 0],\n [0, 0, 0, 0, 0],\n [1, 1, 0, 1, 1],\n [0, 0, 0, 0, 0],\n [0, 0, 0, 0, 0]], dtype=np.uint8)\nclosing(broken_line, footprint_rectangle((3, 3)))\n", "execution_status": "success" } ], "title": [], "level": 0, "target": null }, "see_also": [], "signature": { "__type": "SignatureNode", "__tag": 4029, "kind": "function", "parameters": [ { "__type": "SigParam", "__tag": 4030, "name": "image", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "footprint", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "None" }, { "__type": "SigParam", "__tag": 4030, "name": "out", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "None" }, { "__type": "SigParam", "__tag": 4030, "name": "mode", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "KEYWORD_ONLY", "default": "reflect" }, { "__type": "SigParam", "__tag": 4030, "name": "cval", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "KEYWORD_ONLY", "default": "0.0" } ], "return_annotation": { "__type": "Empty", "__tag": 4031 }, "target_name": "closing" }, "references": null, "qa": "skimage.morphology.gray:closing", "arbitrary": [], "local_refs": [ "closing", "cval", "footprint", "image", "mode", "out" ] }