{ "__type": "IngestedDoc", "__tag": 4010, "_content": { "Notes": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Potential ellipses in the image are characterized by their major and minor axis lengths. For any pair of nonzero pixels in the image that are at least half of " }, { "__type": "ParamRef", "__tag": 4071, "name": "min_size" }, { "__type": "Text", "__tag": 4046, "value": " apart, an accumulator keeps track of the minor axis lengths of potential ellipses formed with all the other nonzero pixels. If any bin (with " }, { "__type": "InlineRole", "__tag": 4003, "value": "bin_size = accuracy * accuracy", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": ") in the histogram of those accumulated minor axis lengths is above " }, { "__type": "ParamRef", "__tag": 4071, "name": "threshold" }, { "__type": "Text", "__tag": 4046, "value": ", the corresponding ellipse is added to the results." } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "A higher " }, { "__type": "ParamRef", "__tag": 4071, "name": "accuracy" }, { "__type": "Text", "__tag": 4046, "value": " will therefore lead to more ellipses being found in the image, at the cost of a less precise estimation of the minor axis length." } ] } ], "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": "result", "annotation": "ndarray with fields [(accumulator, yc, xc, a, b, orientation)].", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Where " }, { "__type": "InlineCode", "__tag": 4051, "value": "(yc, xc)" }, { "__type": "Text", "__tag": 4046, "value": " is the center, " }, { "__type": "InlineCode", "__tag": 4051, "value": "(a, b)" }, { "__type": "Text", "__tag": 4046, "value": " the major and minor axes, respectively. The " }, { "__type": "InlineRole", "__tag": 4003, "value": "orientation", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " value follows the " }, { "__type": "CrossRef", "__tag": 4002, "value": "skimage.draw.ellipse_perimeter", "reference": { "__type": "RefInfo", "__tag": 4000, "module": "skimage", "version": "*", "kind": "api", "path": "skimage.draw.draw:ellipse_perimeter" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " convention." } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Perform an elliptical Hough transform." } ] } ], "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 with nonzero values representing edges." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "threshold", "annotation": "int, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Accumulator threshold value. A lower value will return more ellipses." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "accuracy", "annotation": "double, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Bin size on the minor axis used in the accumulator. A higher value will return more ellipses, but lead to a less precise estimation of the minor axis lengths." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "min_size", "annotation": "int, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Minimal major axis length." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "max_size", "annotation": "int, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Maximal minor axis length. If None, the value is set to half of the smaller image dimension." } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Extended Summary": { "__type": "Section", "__tag": 4015, "children": [], "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/transform/hough_transform.py", "item_line": 126, "item_type": "function", "aliases": [ "skimage.transform.hough_ellipse" ], "example_section_data": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Code", "__tag": 4050, "value": "from skimage.transform import hough_ellipse\nfrom skimage.draw import ellipse_perimeter\nimg = np.zeros((25, 25), dtype=np.uint8)\nrr, cc = ellipse_perimeter(10, 10, 6, 8)\nimg[cc, rr] = 1\nresult = hough_ellipse(img, threshold=8)\nresult.tolist()\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": "threshold", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "4" }, { "__type": "SigParam", "__tag": 4030, "name": "accuracy", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "1" }, { "__type": "SigParam", "__tag": 4030, "name": "min_size", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "4" }, { "__type": "SigParam", "__tag": 4030, "name": "max_size", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "None" } ], "return_annotation": { "__type": "Empty", "__tag": 4031 }, "target_name": "hough_ellipse" }, "references": [ ".. [1] Xie, Yonghong, and Qiang Ji. \"A new efficient ellipse detection", " method.\" Pattern Recognition, 2002. Proceedings. 16th International", " Conference on. Vol. 2. IEEE, 2002" ], "qa": "skimage.transform.hough_transform:hough_ellipse", "arbitrary": [], "local_refs": [ "accuracy", "image", "max_size", "min_size", "result", "threshold" ] }