{ "__type": "IngestedDoc", "__tag": 4010, "_content": { "Notes": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Admonition", "__tag": 4056, "kind": "versionchanged", "base_type": "neutral", "children": [ { "__type": "AdmonitionTitle", "__tag": 4055, "children": [ { "__type": "Text", "__tag": 4046, "value": "versionchanged 0.18" } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The default value of " }, { "__type": "ParamRef", "__tag": 4071, "name": "threshold_rel" }, { "__type": "Text", "__tag": 4046, "value": " has changed to None, which corresponds to letting " }, { "__type": "CrossRef", "__tag": 4002, "value": "skimage.feature.peak_local_max", "reference": { "__type": "RefInfo", "__tag": 4000, "module": "skimage", "version": "*", "kind": "api", "path": "skimage.feature.peak:peak_local_max" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " decide on the default. This is equivalent to " }, { "__type": "InlineRole", "__tag": 4003, "value": "threshold_rel=0", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The " }, { "__type": "ParamRef", "__tag": 4071, "name": "num_peaks" }, { "__type": "Text", "__tag": 4046, "value": " limit is applied before suppression of connected peaks. To limit the number of peaks after suppression, set " }, { "__type": "InlineRole", "__tag": 4003, "value": "num_peaks=np.inf", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " and post-process the output of this function." } ] } ], "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": "output", "annotation": "ndarray or ndarray of bools", "desc": [ { "__type": "BulletList", "__tag": 4053, "ordered": false, "start": 1, "children": [ { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If " }, { "__type": "InlineRole", "__tag": 4003, "value": "indices = True", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": "(row, column, ...) coordinates of peaks." } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If " }, { "__type": "InlineRole", "__tag": 4003, "value": "indices = False", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": "Boolean array shaped like " }, { "__type": "ParamRef", "__tag": 4071, "name": "image" }, { "__type": "Text", "__tag": 4046, "value": ", with peaks represented by True values." } ] } ] } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Find peaks in corner measure response 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 of shape (M, N)", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Input image." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "min_distance", "annotation": "int, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The minimal allowed distance separating peaks." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "*", "annotation": "*", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "See " }, { "__type": "InlineRole", "__tag": 4003, "value": "skimage.feature.peak_local_max", "domain": "py", "role": "meth", "inventory": null }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "p_norm", "annotation": "float", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Which Minkowski p-norm to use. Should be in the range [1, inf]. A finite large p may cause a ValueError if overflow can occur. " }, { "__type": "InlineCode", "__tag": 4051, "value": "inf" }, { "__type": "Text", "__tag": 4046, "value": " corresponds to the Chebyshev distance and 2 to the Euclidean distance." } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Extended Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "This differs from " }, { "__type": "CrossRef", "__tag": 4002, "value": "skimage.feature.peak_local_max", "reference": { "__type": "RefInfo", "__tag": 4000, "module": "skimage", "version": "*", "kind": "api", "path": "skimage.feature.peak:peak_local_max" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " in that it suppresses multiple connected peaks with the same accumulator value." } ] } ], "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/feature/corner.py", "item_line": 1125, "item_type": "function", "aliases": [ "skimage.feature.corner_peaks" ], "example_section_data": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Code", "__tag": 4050, "value": "from skimage.feature import peak_local_max\nresponse = np.zeros((5, 5))\nresponse[2:4, 2:4] = 1\nresponse\npeak_local_max(response)\ncorner_peaks(response)\n", "execution_status": "success" } ], "title": [], "level": 0, "target": null }, "see_also": [ { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "skimage.feature.peak_local_max", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "skimage.feature.peak:peak_local_max" }, "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": "min_distance", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "1" }, { "__type": "SigParam", "__tag": 4030, "name": "threshold_abs", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "None" }, { "__type": "SigParam", "__tag": 4030, "name": "threshold_rel", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "None" }, { "__type": "SigParam", "__tag": 4030, "name": "exclude_border", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "True" }, { "__type": "SigParam", "__tag": 4030, "name": "indices", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "True" }, { "__type": "SigParam", "__tag": 4030, "name": "num_peaks", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "inf" }, { "__type": "SigParam", "__tag": 4030, "name": "footprint", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "None" }, { "__type": "SigParam", "__tag": 4030, "name": "labels", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "None" }, { "__type": "SigParam", "__tag": 4030, "name": "num_peaks_per_label", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "KEYWORD_ONLY", "default": "inf" }, { "__type": "SigParam", "__tag": 4030, "name": "p_norm", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "KEYWORD_ONLY", "default": "inf" } ], "return_annotation": { "__type": "Empty", "__tag": 4031 }, "target_name": "corner_peaks" }, "references": null, "qa": "skimage.feature.corner:corner_peaks", "arbitrary": [], "local_refs": [ "*", "image", "min_distance", "output", "p_norm" ] }