{ "__type": "IngestedDoc", "__tag": 4010, "_content": { "Notes": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "This function operates on the following ideas:" } ] }, { "__type": "BulletList", "__tag": 4053, "ordered": true, "start": 1, "children": [ { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Make a first pass over the image's last dimension and flag candidates for local maxima by comparing pixels in only one direction. If the pixels aren't connected in the last dimension all pixels are flagged as candidates instead." } ] } ] } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "For each candidate:" } ] }, { "__type": "BulletList", "__tag": 4053, "ordered": true, "start": 1, "children": [ { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Perform a flood-fill to find all connected pixels that have the same gray value and are part of the plateau." } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Consider the connected neighborhood of a plateau: if no bordering sample has a higher gray level, mark the plateau as a definite local maximum." } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Warns": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Parameters", "__tag": 4026, "children": [ { "__type": "DocParam", "__tag": 4016, "name": "", "annotation": "UserWarning", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If " }, { "__type": "ParamRef", "__tag": 4071, "name": "allow_borders" }, { "__type": "Text", "__tag": 4046, "value": " is false and any dimension of the given " }, { "__type": "ParamRef", "__tag": 4071, "name": "image" }, { "__type": "Text", "__tag": 4046, "value": " is shorter than 3 samples, maxima can't exist and a warning is shown." } ] } ] } ] } ], "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": "maxima", "annotation": "ndarray or tuple[ndarray]", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If " }, { "__type": "ParamRef", "__tag": 4071, "name": "indices" }, { "__type": "Text", "__tag": 4046, "value": " is false, a boolean array with the same shape as " }, { "__type": "ParamRef", "__tag": 4071, "name": "image" }, { "__type": "Text", "__tag": 4046, "value": " is returned with " }, { "__type": "InlineCode", "__tag": 4051, "value": "True" }, { "__type": "Text", "__tag": 4046, "value": " indicating the position of local maxima (" }, { "__type": "InlineCode", "__tag": 4051, "value": "False" }, { "__type": "Text", "__tag": 4046, "value": " otherwise). If " }, { "__type": "ParamRef", "__tag": 4071, "name": "indices" }, { "__type": "Text", "__tag": 4046, "value": " is true, a tuple of one-dimensional arrays containing the coordinates (indices) of all found maxima." } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Find local maxima of n-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": "image", "annotation": "ndarray", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "An n-dimensional array." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "footprint", "annotation": "ndarray, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The footprint (structuring element) used to determine the neighborhood of each evaluated pixel (" }, { "__type": "InlineCode", "__tag": 4051, "value": "True" }, { "__type": "Text", "__tag": 4046, "value": " denotes a connected pixel). It must be a boolean array and have the same number of dimensions as " }, { "__type": "ParamRef", "__tag": 4071, "name": "image" }, { "__type": "Text", "__tag": 4046, "value": ". If neither " }, { "__type": "ParamRef", "__tag": 4071, "name": "footprint" }, { "__type": "Text", "__tag": 4046, "value": " nor " }, { "__type": "ParamRef", "__tag": 4071, "name": "connectivity" }, { "__type": "Text", "__tag": 4046, "value": " are given, all adjacent pixels are considered as part of the neighborhood." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "connectivity", "annotation": "int, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "A number used to determine the neighborhood of each evaluated pixel. Adjacent pixels whose squared distance from the center is less than or equal to " }, { "__type": "ParamRef", "__tag": 4071, "name": "connectivity" }, { "__type": "Text", "__tag": 4046, "value": " are considered neighbors. Ignored if " }, { "__type": "ParamRef", "__tag": 4071, "name": "footprint" }, { "__type": "Text", "__tag": 4046, "value": " is not None." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "indices", "annotation": "bool, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If True, the output will be a tuple of one-dimensional arrays representing the indices of local maxima in each dimension. If False, the output will be a boolean array with the same shape as " }, { "__type": "ParamRef", "__tag": 4071, "name": "image" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "allow_borders", "annotation": "bool, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If true, plateaus that touch the image border are valid maxima." } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Extended Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The local maxima are defined as connected sets of pixels with equal gray level (plateaus) strictly greater than the gray levels of all pixels in the neighborhood." } ] } ], "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/extrema.py", "item_line": 275, "item_type": "function", "aliases": [ "skimage.morphology.local_maxima" ], "example_section_data": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Code", "__tag": 4050, "value": "from skimage.morphology import local_maxima\nimage = np.zeros((4, 7), dtype=int)\nimage[1:3, 1:3] = 1\nimage[3, 0] = 1\nimage[1:3, 4:6] = 2\nimage[3, 6] = 3\nimage\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\nFind local maxima by comparing to all neighboring pixels (maximal\nconnectivity):\n\n" }, { "__type": "Code", "__tag": 4050, "value": "local_maxima(image)\nlocal_maxima(image, indices=True)\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\nFind local maxima without comparing to diagonal pixels (connectivity 1):\n\n" }, { "__type": "Code", "__tag": 4050, "value": "local_maxima(image, connectivity=1)\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\nand exclude maxima that border the image edge:\n\n" }, { "__type": "Code", "__tag": 4050, "value": "local_maxima(image, connectivity=1, allow_borders=False)\n", "execution_status": "success" } ], "title": [], "level": 0, "target": null }, "see_also": [ { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "skimage.morphology.h_maxima", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "skimage.morphology.extrema:h_maxima" }, "kind": "module" }, "descriptions": [], "type": null }, { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "skimage.morphology.h_minima", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "skimage.morphology.extrema:h_minima" }, "kind": "module" }, "descriptions": [], "type": null }, { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "skimage.morphology.local_minima", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "skimage.morphology.extrema:local_minima" }, "kind": "module" }, "descriptions": [], "type": null } ], "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": "connectivity", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "None" }, { "__type": "SigParam", "__tag": 4030, "name": "indices", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "False" }, { "__type": "SigParam", "__tag": 4030, "name": "allow_borders", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "True" } ], "return_annotation": { "__type": "Empty", "__tag": 4031 }, "target_name": "local_maxima" }, "references": null, "qa": "skimage.morphology.extrema:local_maxima", "arbitrary": [], "local_refs": [ "allow_borders", "connectivity", "footprint", "image", "indices", "maxima" ] }