API Reference

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

Dataset.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

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.

Indexes

IndexAdapter(**kwargs)

Base class for reusing a custom index to select data in xarray.DataArray or xarray.Dataset objects with xoak.

IndexRegistry([use_default])

A registry of all indexes adapters that can be used to select data with xoak.

Xoak’s built-in index adapters

ScipyKDTreeAdapter(**kwargs)

Xoak index adapter for scipy.spatial.cKDTree.

SklearnKDTreeAdapter(**kwargs)

Xoak index adapter for sklearn.neighbors.KDTree.

SklearnBallTreeAdapter(**kwargs)

Xoak index adapter for sklearn.neighbors.BallTree.

SklearnGeoBallTreeAdapter(**kwargs)

Xoak index adapter for sklearn.neighbors.BallTree, using the ‘haversine’ metric.

S2PointIndexAdapter(**kwargs)

Xoak index adapter for pys2index.S2PointIndex.