API Documentation

This page presents the high-level public Python API grouped by theme. For low-level (C++ binding) symbols see Core API Documentation.

Coordinates & Axes

Fundamental 1D axis helpers used by grid and interpolator objects.

Axis(*args, **kwargs)	Create a coordinate axis for variable values.
TemporalAxis(*args, **kwargs)	Temporal axis for datetime64 or timedelta64 values.

CF Metadata Helpers

Identify axis meaning from CF-compliant unit strings.

cf.AxisLatitudeUnit()	Container for valid latitude axis units in CF conventions.
cf.AxisLongitudeUnit()	Container for valid longitude axis units in CF conventions.
cf.AxisTimeUnit()	Container for valid time axis units in CF conventions.
cf.AxisUnit([iterable])	Base class for managing valid CF convention units for coordinate axes.

Spatial Index

Spatial search structures and unstructured data interpolation.

RTree3D([spheroid, dtype])	Spatial index for 3D point data with interpolation methods.
RTree3DFloat32(*args, **kwargs)	Spatial index for 3D point data with interpolation methods.
RTree3DFloat64(*args, **kwargs)	Spatial index for 3D point data with interpolation methods.
inverse_distance_weighting(tree, coordinates)	Inverse Distance Weighting interpolation.
kriging(tree, coordinates[, config, k, ...])	Kriging interpolation.
query(tree, coordinates[, config, k, ...])	Query nearest neighbors.
radial_basis_function(tree, coordinates[, ...])	Radial Basis Function interpolation.
window_function(tree, coordinates[, config, ...])	Window function interpolation.

Geohash

Encode geographic coordinates into compact base32 strings and work with the resulting discrete spatial grid.

geohash.GeoHash(*args, **kwargs)	Geohash: Base32 string encoding a rectangular geographic area.
geohash.area(hash, spheroid)	Calculate the area covered by geohash codes.
geohash.bounding_boxes(-> object  -> object)	Overloaded function.
geohash.decode(hash, round)	Decode geohash strings into geographic coordinates.
geohash.encode(lon[, shape, writable, ...])	Encode geographic coordinates into geohash strings.
geohash.transform(hash[, precision])	Transform geohash codes between different precision levels.
geohash.to_xarray(hashes, data)	Get the XArray grid representing the GeoHash grid.

Binning & Histograms

One and two dimensional statistical accumulation utilities.

Binning1D(x[, range, dtype])	Create a 1D binning for grouping values into bins on a vector.
Binning1DFloat32(*args, **kwargs)	Create a 1D binning for grouping values into bins on a vector.
Binning1DFloat64(*args, **kwargs)	Create a 1D binning for grouping values into bins on a vector.
Binning2D(x, y[, spheroid, dtype])	Create a 2D binning for grouping values into bins on a grid.
Binning2DFloat32(*args, **kwargs)	Create a 2D binning for grouping values into bins on a grid.
Binning2DFloat64(*args, **kwargs)	Create a 2D binning for grouping values into bins on a grid.
Histogram2D(x, y[, compression, dtype])	Create a 2D histogram for binning continuous values into a grid using TDigest.
Histogram2DFloat32(*args, **kwargs)	Create a 2D histogram for binning continuous values into a grid using TDigest.
Histogram2DFloat64(*args, **kwargs)	Create a 2D histogram for binning continuous values into a grid using TDigest.

Filling Undefined Values

Functions for filling missing values in grids.

fill.fft_inpaint(grid[, config, ...])	Fill missing values using FFT-based inpainting.
fill.gauss_seidel(grid[, config, ...])	Fill missing values using Gauss-Seidel relaxation.
fill.loess(data[, config, nx, ny, ...])	Fill missing values using LOESS (locally weighted regression).
fill.multigrid(grid[, config, ...])	Fill missing values using multigrid method.

Interpolators

Scalar field interpolation functions over Cartesian grids.

univariate(...)	Univariate interpolation.
bivariate(...)	Bivariate interpolation.
trivariate(...)	Trivariate interpolation.
quadrivariate(...)	Quadrivariate interpolation.

Univariate Statistics

Streaming descriptive statistics of 1D sample streams.

DescriptiveStatistics(values[, weights, ...])

Univariate descriptive statistics.

Orbit Interpolation

Work with repeating satellite orbits and derived passes/swaths.

orbit.calculate_orbit(height, lon_nadir, ...)	Calculate the orbit at the given height.
orbit.calculate_pass(pass_number, orbit, *)	Get the properties of a swath of an half-orbit.
orbit.calculate_swath(half_orbit, *[, ...])	Get the properties of a swath of an half-orbit.
orbit.EquatorCoordinates(longitude, time)	Represent coordinates of the satellite at the equator.
orbit.Orbit(height, latitude, longitude, ...)	Represent properties of the orbit.
orbit.Pass(lon_nadir, lat_nadir, time, x_al, ...)	Represent a pass of an orbit.
orbit.Swath(lon_nadir, lat_nadir, time, ...)	Represent a swath of an orbital pass.

Xarray Backends

Helpers for constructing interpolators directly from xarray.DataArray objects.

backends.xarray.Grid2D(data_array)	Build a Grid2D from Xarray data.
backends.xarray.Grid3D(data_array)	Build a Grid3D from Xarray data.
backends.xarray.Grid4D(data_array)	Build a Grid4D from Xarray data.
backends.xarray.RegularGridInterpolator(array)	Interpolate on a regular grid in arbitrary dimensions.