{ "__type": "IngestedDoc", "__tag": 4010, "_content": { "Notes": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The algorithm used is described in " }, { "__type": "FootnoteReference", "__tag": 4066, "label": "1" }, { "__type": "Text", "__tag": 4046, "value": ". The general idea is that the kd-tree is a binary tree, each of whose nodes represents an axis-aligned hyperrectangle. Each node specifies an axis and splits the set of points based on whether their coordinate along that axis is greater than or less than a particular value." } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "During construction, the axis and splitting point are chosen by the \"sliding midpoint\" rule, which ensures that the cells do not all become long and thin." } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The tree can be queried for the r closest neighbors of any given point (optionally returning only those within some maximum distance of the point). It can also be queried, with a substantial gain in efficiency, for the r approximate closest neighbors." } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "For large dimensions (20 is already large) do not expect this to run significantly faster than brute force. High-dimensional nearest-neighbor queries are a substantial open problem in computer science." } ] } ], "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": "kd-tree for quick nearest-neighbor lookup" } ] } ], "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": "data", "annotation": "ndarray, shape (n,m)", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The n data points of dimension m to be indexed. This array is not copied unless this is necessary to produce a contiguous array of doubles. The data are also copied if the kd-tree is built with " }, { "__type": "InlineCode", "__tag": 4051, "value": "copy_data=True" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "leafsize", "annotation": "positive int", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The number of points at which the algorithm switches over to brute-force." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "m", "annotation": "int", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The dimension of a single data-point." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "n", "annotation": "int", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The number of data points." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "maxes", "annotation": "ndarray, shape (m,)", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The maximum value in each dimension of the n data points." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "mins", "annotation": "ndarray, shape (m,)", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The minimum value in each dimension of the n data points." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "tree", "annotation": "object, class cKDTreeNode", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "This attribute exposes a Python view of the root node in the cKDTree object. A full Python view of the kd-tree is created dynamically on the first access. This attribute allows you to create your own query functions in Python." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "size", "annotation": "int", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The number of nodes in the tree." } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Parameters": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Parameters", "__tag": 4026, "children": [ { "__type": "DocParam", "__tag": 4016, "name": "data", "annotation": "array_like, shape (n,m)", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The n data points of dimension m to be indexed. This array is not copied unless this is necessary to produce a contiguous array of doubles, and so modifying this data will result in bogus results. The data are also copied if the kd-tree is built with copy_data=True." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "leafsize", "annotation": "positive int, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The number of points at which the algorithm switches over to brute-force. Default: 16." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "compact_nodes", "annotation": "bool, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If True, the kd-tree is built to shrink the hyperrectangles to the actual data range. This usually gives a more compact tree that is robust against degenerated input data and gives faster queries at the expense of longer build time. Default: True." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "copy_data", "annotation": "bool, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If True the data is always copied to protect the kd-tree against data corruption. Default: False." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "balanced_tree", "annotation": "bool, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If True, the median is used to split the hyperrectangles instead of the midpoint. This usually gives a more compact tree and faster queries at the expense of longer build time. Default: True." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "boxsize", "annotation": "array_like or scalar, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Apply an m-d toroidal topology to the KDTree. The topology is generated by " }, { "__type": "InlineMath", "__tag": 4057, "value": "x_i + n_i L_i" }, { "__type": "Text", "__tag": 4046, "value": " where " }, { "__type": "InlineMath", "__tag": 4057, "value": "n_i" }, { "__type": "Text", "__tag": 4046, "value": " are integers and " }, { "__type": "InlineMath", "__tag": 4057, "value": "L_i" }, { "__type": "Text", "__tag": 4046, "value": " is the boxsize along i-th dimension. The input data shall be wrapped into " }, { "__type": "InlineMath", "__tag": 4057, "value": "[0, L_i)" }, { "__type": "Text", "__tag": 4046, "value": ". A ValueError is raised if any of the data is outside of this bound." } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Extended Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "This class provides an index into a set of k-dimensional points which can be used to rapidly look up the nearest neighbors of any point." } ] }, { "__type": "Admonition", "__tag": 4056, "kind": "note", "base_type": "note", "children": [ { "__type": "AdmonitionTitle", "__tag": 4055, "children": [ { "__type": "Text", "__tag": 4046, "value": "note " } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "CrossRef", "__tag": 4002, "value": "cKDTree", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.spatial._ckdtree:cKDTree" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " is functionally identical to " }, { "__type": "CrossRef", "__tag": 4002, "value": "KDTree", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.spatial._kdtree:KDTree" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": ". Prior to SciPy v1.6.0, " }, { "__type": "CrossRef", "__tag": 4002, "value": "cKDTree", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.spatial._ckdtree:cKDTree" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " had better performance and slightly different functionality but now the two names exist only for backward-compatibility reasons. If compatibility with SciPy < 1.6 is not a concern, prefer " }, { "__type": "CrossRef", "__tag": 4002, "value": "KDTree", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.spatial._kdtree:KDTree" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] } ], "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/_ckdtree.cpython-314-x86_64-linux-gnu.so", "item_line": null, "item_type": "class", "aliases": [ "scipy.spatial.cKDTree" ], "example_section_data": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "see_also": [], "signature": { "__type": "SignatureNode", "__tag": 4029, "kind": "function", "parameters": [ { "__type": "SigParam", "__tag": 4030, "name": "data", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "leafsize", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "16" }, { "__type": "SigParam", "__tag": 4030, "name": "compact_nodes", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "True" }, { "__type": "SigParam", "__tag": 4030, "name": "copy_data", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "False" }, { "__type": "SigParam", "__tag": 4030, "name": "balanced_tree", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "True" }, { "__type": "SigParam", "__tag": 4030, "name": "boxsize", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "None" } ], "return_annotation": { "__type": "Empty", "__tag": 4031 }, "target_name": "cKDTree" }, "references": [ ".. [1] S. Maneewongvatana and D.E. Mount, \"Analysis of approximate", " nearest neighbor searching with clustered point sets,\"", " Arxiv e-print, 1999, https://arxiv.org/pdf/cs.CG/9901013" ], "qa": "scipy.spatial._ckdtree:cKDTree", "arbitrary": [], "local_refs": [ "balanced_tree", "boxsize", "compact_nodes", "copy_data", "data", "leafsize", "m", "maxes", "mins", "n", "size", "tree" ] }