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
Returns the underlying index object(s), or |
Methods
|
Create an index tree from a subset of coordinates of the DataArray / Dataset. |
|
Selection based on a ball tree index. |
DataArray.xoak¶
The accessor above is also registered for xarray.DataArray
.
Properties
Returns the underlying index object(s), or |
Methods
|
Create an index tree from a subset of coordinates of the DataArray / Dataset. |
|
Selection based on a ball tree index. |
Indexes¶
|
Base class for reusing a custom index to select data in |
|
A registry of all indexes adapters that can be used to select data with xoak. |
Xoak’s built-in index adapters
|
Xoak index adapter for |
|
Xoak index adapter for |
|
Xoak index adapter for |
|
Xoak index adapter for |
|
Xoak index adapter for |