{ "__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": [ { "__type": "Parameters", "__tag": 4026, "children": [ { "__type": "DocParam", "__tag": 4016, "name": "d", "annotation": "float or array of floats", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The distances to the nearest neighbors. If " }, { "__type": "InlineCode", "__tag": 4051, "value": "x" }, { "__type": "Text", "__tag": 4046, "value": " has shape " }, { "__type": "InlineCode", "__tag": 4051, "value": "tuple+(self.m,)" }, { "__type": "Text", "__tag": 4046, "value": ", then " }, { "__type": "InlineCode", "__tag": 4051, "value": "d" }, { "__type": "Text", "__tag": 4046, "value": " has shape " }, { "__type": "InlineCode", "__tag": 4051, "value": "tuple+(k,)" }, { "__type": "Text", "__tag": 4046, "value": ". When k == 1, the last dimension of the output is squeezed. Missing neighbors are indicated with infinite distances. Hits are sorted by distance (nearest first)." } ] }, { "__type": "Admonition", "__tag": 4056, "kind": "versionchanged", "base_type": "neutral", "children": [ { "__type": "AdmonitionTitle", "__tag": 4055, "children": [ { "__type": "Text", "__tag": 4046, "value": "versionchanged 1.9.0" } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Previously if " }, { "__type": "InlineCode", "__tag": 4051, "value": "k=None" }, { "__type": "Text", "__tag": 4046, "value": ", then " }, { "__type": "CrossRef", "__tag": 4002, "value": "d", "reference": { "__type": "RefInfo", "__tag": 4000, "module": null, "version": null, "kind": "local", "path": "d" }, "kind": "local" }, { "__type": "Text", "__tag": 4046, "value": " was an object array of shape " }, { "__type": "InlineCode", "__tag": 4051, "value": "tuple" }, { "__type": "Text", "__tag": 4046, "value": ", containing lists of distances. This behavior has been removed, use " }, { "__type": "CrossRef", "__tag": 4002, "value": "query_ball_point", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.spatial._kdtree:KDTree.query_ball_point" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " instead." } ] } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "i", "annotation": "integer or array of integers", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The index of each neighbor in " }, { "__type": "InlineCode", "__tag": 4051, "value": "self.data" }, { "__type": "Text", "__tag": 4046, "value": ". " }, { "__type": "InlineCode", "__tag": 4051, "value": "i" }, { "__type": "Text", "__tag": 4046, "value": " is the same shape as d. Missing neighbors are indicated with " }, { "__type": "InlineCode", "__tag": 4051, "value": "self.n" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Query the kd-tree for nearest neighbors." } ] } ], "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": "x", "annotation": "array_like, last dimension self.m", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "An array of points to query." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "k", "annotation": "int or Sequence[int], optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Either the number of nearest neighbors to return, or a list of the k-th nearest neighbors to return, starting from 1." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "eps", "annotation": "nonnegative float, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Return approximate nearest neighbors; the kth returned value is guaranteed to be no further than (1+eps) times the distance to the real kth nearest neighbor." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "p", "annotation": "float, 1<=p<=infinity, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Which Minkowski p-norm to use. 1 is the sum-of-absolute-values distance (\"Manhattan\" distance). 2 is the usual Euclidean distance. infinity is the maximum-coordinate-difference distance. A large, finite p may cause a ValueError if overflow can occur." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "distance_upper_bound", "annotation": "nonnegative float, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Return only neighbors within this distance. This is used to prune tree searches, so if you are doing a series of nearest-neighbor queries, it may help to supply the distance to the nearest neighbor of the most recent point." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "workers", "annotation": "int, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Number of workers to use for parallel processing. If -1 is given all CPU threads are used. Default: 1." } ] }, { "__type": "Admonition", "__tag": 4056, "kind": "versionadded", "base_type": "neutral", "children": [ { "__type": "AdmonitionTitle", "__tag": 4055, "children": [ { "__type": "Text", "__tag": 4046, "value": "versionadded 1.6.0" } ] } ] } ] } ] } ], "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", "Attributes", "Methods", "Returns", "Yields", "Receives", "Other Parameters", "Raises", "Warns", "Warnings", "Notes" ], "item_file": "/scipy/spatial/_kdtree.py", "item_line": 369, "item_type": "function", "aliases": [ "scipy.spatial.KDTree.query" ], "example_section_data": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Code", "__tag": 4050, "value": "import numpy as np\nfrom scipy.spatial import KDTree\nx, y = np.mgrid[0:5, 2:8]\ntree = KDTree(np.c_[x.ravel(), y.ravel()])\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\nTo query the nearest neighbours and return squeezed result, use\n\n" }, { "__type": "Code", "__tag": 4050, "value": "dd, ii = tree.query([[0, 0], [2.2, 2.9]], k=1)\n", "execution_status": "success" }, { "__type": "Code", "__tag": 4050, "value": "print(dd, ii, sep='\\n')\n", "execution_status": "failure" }, { "__type": "Text", "__tag": 4046, "value": "\nTo query the nearest neighbours and return unsqueezed result, use\n\n" }, { "__type": "Code", "__tag": 4050, "value": "dd, ii = tree.query([[0, 0], [2.2, 2.9]], k=[1])\n", "execution_status": "success" }, { "__type": "Code", "__tag": 4050, "value": "print(dd, ii, sep='\\n')\n", "execution_status": "failure" }, { "__type": "Text", "__tag": 4046, "value": "\nTo query the second nearest neighbours and return unsqueezed result,\nuse\n\n" }, { "__type": "Code", "__tag": 4050, "value": "dd, ii = tree.query([[0, 0], [2.2, 2.9]], k=[2])\n", "execution_status": "success" }, { "__type": "Code", "__tag": 4050, "value": "print(dd, ii, sep='\\n')\n", "execution_status": "failure" }, { "__type": "Text", "__tag": 4046, "value": "\nTo query the first and second nearest neighbours, use\n\n" }, { "__type": "Code", "__tag": 4050, "value": "dd, ii = tree.query([[0, 0], [2.2, 2.9]], k=2)\n", "execution_status": "success" }, { "__type": "Code", "__tag": 4050, "value": "print(dd, ii, sep='\\n')\n", "execution_status": "failure" }, { "__type": "Text", "__tag": 4046, "value": "\nor, be more specific\n\n" }, { "__type": "Code", "__tag": 4050, "value": "dd, ii = tree.query([[0, 0], [2.2, 2.9]], k=[1, 2])\n", "execution_status": "success" }, { "__type": "Code", "__tag": 4050, "value": "print(dd, ii, sep='\\n')\n", "execution_status": "failure" } ], "title": [], "level": 0, "target": null }, "see_also": [], "signature": { "__type": "SignatureNode", "__tag": 4029, "kind": "function", "parameters": [ { "__type": "SigParam", "__tag": 4030, "name": "self", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "x", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "k", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "1" }, { "__type": "SigParam", "__tag": 4030, "name": "eps", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "0.0" }, { "__type": "SigParam", "__tag": 4030, "name": "p", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "2.0" }, { "__type": "SigParam", "__tag": 4030, "name": "distance_upper_bound", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "inf" }, { "__type": "SigParam", "__tag": 4030, "name": "workers", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "1" } ], "return_annotation": { "__type": "Empty", "__tag": 4031 }, "target_name": "query" }, "references": null, "qa": "scipy.spatial._kdtree:KDTree.query", "arbitrary": [], "local_refs": [ "d", "distance_upper_bound", "eps", "i", "k", "p", "workers", "x" ] }