{ "__type": "IngestedDoc", "__tag": 4010, "_content": { "Notes": { "__type": "Section", "__tag": 4015, "children": [], "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": [], "title": [], "level": 0, "target": null }, "Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Oriented FAST and rotated BRIEF feature detector and binary descriptor extractor." } ] } ], "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": [ { "__type": "Parameters", "__tag": 4026, "children": [ { "__type": "DocParam", "__tag": 4016, "name": "keypoints", "annotation": "ndarray of shape (N, 2)", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Keypoint coordinates as " }, { "__type": "InlineCode", "__tag": 4051, "value": "(row, col)" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "scales", "annotation": "ndarray of shape (N,)", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Corresponding scales." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "orientations", "annotation": "ndarray of shape (N,)", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Corresponding orientations in radians." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "responses", "annotation": "ndarray of shape (N,)", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Corresponding Harris corner responses." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "descriptors", "annotation": "ndarray of shape (Q, `descriptor_size`) and dtype bool", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "2D array of binary descriptors of size " }, { "__type": "InlineRole", "__tag": 4003, "value": "descriptor_size", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " for Q keypoints after filtering out border keypoints with value at an index " }, { "__type": "InlineCode", "__tag": 4051, "value": "(i, j)" }, { "__type": "Text", "__tag": 4046, "value": " either being " }, { "__type": "InlineCode", "__tag": 4051, "value": "True" }, { "__type": "Text", "__tag": 4046, "value": " or " }, { "__type": "InlineCode", "__tag": 4051, "value": "False" }, { "__type": "Text", "__tag": 4046, "value": " representing the outcome of the intensity comparison for i-th keypoint on j-th decision pixel-pair. It is " }, { "__type": "InlineCode", "__tag": 4051, "value": "Q == np.sum(mask)" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Parameters": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Parameters", "__tag": 4026, "children": [ { "__type": "DocParam", "__tag": 4016, "name": "n_keypoints", "annotation": "int, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Number of keypoints to be returned. The function will return the best " }, { "__type": "ParamRef", "__tag": 4071, "name": "n_keypoints" }, { "__type": "Text", "__tag": 4046, "value": " according to the Harris corner response if more than " }, { "__type": "ParamRef", "__tag": 4071, "name": "n_keypoints" }, { "__type": "Text", "__tag": 4046, "value": " are detected. If not, then all the detected keypoints are returned." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "fast_n", "annotation": "int, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The " }, { "__type": "InlineRole", "__tag": 4003, "value": "n", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " parameter in " }, { "__type": "CrossRef", "__tag": 4002, "value": "skimage.feature.corner_fast", "reference": { "__type": "RefInfo", "__tag": 4000, "module": "skimage", "version": "*", "kind": "api", "path": "skimage.feature.corner:corner_fast" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": ". Minimum number of consecutive pixels out of 16 pixels on the circle that should all be either brighter or darker w.r.t test-pixel. A point c on the circle is darker w.r.t test pixel p if " }, { "__type": "InlineCode", "__tag": 4051, "value": "Ic < Ip - threshold" }, { "__type": "Text", "__tag": 4046, "value": " and brighter if " }, { "__type": "InlineCode", "__tag": 4051, "value": "Ic > Ip + threshold" }, { "__type": "Text", "__tag": 4046, "value": ". Also stands for the n in " }, { "__type": "InlineCode", "__tag": 4051, "value": "FAST-n" }, { "__type": "Text", "__tag": 4046, "value": " corner detector." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "fast_threshold", "annotation": "float, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The " }, { "__type": "CrossRef", "__tag": 4002, "value": "threshold", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "skimage.filters.rank.generic:threshold" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " parameter in " }, { "__type": "InlineCode", "__tag": 4051, "value": "feature.corner_fast" }, { "__type": "Text", "__tag": 4046, "value": ". Threshold used to decide whether the pixels on the circle are brighter, darker or similar w.r.t. the test pixel. Decrease the threshold when more corners are desired and vice-versa." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "harris_k", "annotation": "float, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The " }, { "__type": "InlineRole", "__tag": 4003, "value": "k", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " parameter in " }, { "__type": "CrossRef", "__tag": 4002, "value": "skimage.feature.corner_harris", "reference": { "__type": "RefInfo", "__tag": 4000, "module": "skimage", "version": "*", "kind": "api", "path": "skimage.feature.corner:corner_harris" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": ". Sensitivity factor to separate corners from edges, typically in range " }, { "__type": "InlineCode", "__tag": 4051, "value": "[0, 0.2]" }, { "__type": "Text", "__tag": 4046, "value": ". Small values of " }, { "__type": "InlineRole", "__tag": 4003, "value": "k", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " result in detection of sharp corners." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "downscale", "annotation": "float, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Downscale factor for the image pyramid. Default value 1.2 is chosen so that there are more dense scales which enable robust scale invariance for a subsequent feature description." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "n_scales", "annotation": "int, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Maximum number of scales from the bottom of the image pyramid to extract the features from." } ] } ] } ] } ], "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/feature/orb.py", "item_line": 25, "item_type": "class", "aliases": [ "skimage.feature.ORB" ], "example_section_data": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Code", "__tag": 4050, "value": "from skimage.feature import ORB, match_descriptors\nimg1 = np.zeros((100, 100))\nimg2 = np.zeros_like(img1)\nrng = np.random.default_rng(19481137) # do not copy this value\nsquare = rng.random((20, 20))\nimg1[40:60, 40:60] = square\nimg2[53:73, 53:73] = square\ndetector_extractor1 = ORB(n_keypoints=5)\ndetector_extractor2 = ORB(n_keypoints=5)\ndetector_extractor1.detect_and_extract(img1)\ndetector_extractor2.detect_and_extract(img2)\nmatches = match_descriptors(detector_extractor1.descriptors,\n detector_extractor2.descriptors)\nmatches\ndetector_extractor1.keypoints[matches[:, 0]]\ndetector_extractor2.keypoints[matches[:, 1]]\n", "execution_status": "success" } ], "title": [], "level": 0, "target": null }, "see_also": [], "signature": { "__type": "SignatureNode", "__tag": 4029, "kind": "function", "parameters": [ { "__type": "SigParam", "__tag": 4030, "name": "downscale", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "1.2" }, { "__type": "SigParam", "__tag": 4030, "name": "n_scales", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "8" }, { "__type": "SigParam", "__tag": 4030, "name": "n_keypoints", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "500" }, { "__type": "SigParam", "__tag": 4030, "name": "fast_n", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "9" }, { "__type": "SigParam", "__tag": 4030, "name": "fast_threshold", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "0.08" }, { "__type": "SigParam", "__tag": 4030, "name": "harris_k", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "0.04" } ], "return_annotation": { "__type": "Empty", "__tag": 4031 }, "target_name": "ORB" }, "references": [ ".. [1] Ethan Rublee, Vincent Rabaud, Kurt Konolige and Gary Bradski", " \"ORB: An efficient alternative to SIFT and SURF\"", " http://www.vision.cs.chubu.ac.jp/CV-R/pdf/Rublee_iccv2011.pdf" ], "qa": "skimage.feature.orb:ORB", "arbitrary": [], "local_refs": [ "descriptors", "downscale", "fast_n", "fast_threshold", "harris_k", "keypoints", "n_keypoints", "n_scales", "orientations", "responses", "scales" ] }