xoak.index.sklearn_adapters.SklearnKDTreeAdapter

class xoak.index.sklearn_adapters.SklearnKDTreeAdapter(**kwargs)[source]

Xoak index adapter for sklearn.neighbors.KDTree.

This index adapter is registered in xoak under the name sklearn_kdtree. You can use it in xarray.Dataset.xoak.set_index() by simply providing its name for the index_type argument. Alternatively, you can access it via the index registry, i.e.,

>>> import xoak
>>> ireg = xoak.IndexRegistry()
>>> ireg.sklearn_kdtree
__init__(**kwargs)[source]

Methods

__init__(**kwargs)

build(points)

Build the index from a set of points/samples and their coordinate labels.

query(kdtree, points)

Query points/samples,