API Reference

API Reference#

This page provides an auto-generated summary of Xoak’s API.

Xarray NDPointIndex tree adapters#

The following classes may be used with xarray.indexes.NDPointIndex, they can be passed as tree_adapter_cls option value via xarray.Dataset.set_xindex() or xarray.DataArray.set_xindex().

S2PointTreeAdapter(points, options)

pys2index.S2PointIndex adapter for NDPointIndex.

SklearnBallTreeAdapter(points, options)

sklearn.neighbors.BallTree adapter for NDPointIndex.

SklearnGeoBallTreeAdapter(points, options)

sklearn.neighbors.BallTree adapter for NDPointIndex, using the 'haversine' metric.

SklearnKDTreeAdapter(points, options)

sklearn.neighbors.KDTree adapter for NDPointIndex.

Dataset.xoak#

Warning

This API is deprecated and will be removed in a future version of Xoak.

This accessor extends xarray.Dataset with all the methods and properties listed below. Proper use of this accessor should be like:

>>> import xarray as xr         # first import xarray
>>> import xoak                 # import xoak (the 'xoak' accessor is registered)
>>> ds = xr.Dataset()           # create or load an xarray Dataset
>>> ds.xoak.<meth_or_prop>      # access to the methods and properties listed below

Properties

Dataset.xoak.index

Returns the underlying index object(s), or None if no index has been set yet.

Methods

Dataset.xoak.set_index(coords, index_type[, ...])

Create an index tree from a subset of coordinates of the DataArray / Dataset.

Dataset.xoak.sel([indexers])

Selection based on a ball tree index.

DataArray.xoak#

Warning

This API is deprecated and will be removed in a future version of Xoak.

The accessor above is also registered for xarray.DataArray.

Properties

DataArray.xoak.index

Returns the underlying index object(s), or None if no index has been set yet.

Methods

DataArray.xoak.set_index(coords, index_type)

Create an index tree from a subset of coordinates of the DataArray / Dataset.

DataArray.xoak.sel([indexers])

Selection based on a ball tree index.
Contents