API Documentation#

Geographic indexers#

Axis(self, values[, epsilon, is_circle])

A coordinate axis is a Variable that specifies one of the coordinates of a variable's values.

AxisInt64(self, values)

A coordinate axis is a Variable that specifies one of the coordinates of a variable's values.

RTree([system, dtype, ndims])

R*Tree spatial index for geodetic scalar values.

TemporalAxis(self, values)

Time axis

geohash#

GeoHash

Handle GeoHash encoded in base 32.

geohash.bounding_boxes(*args, **kwargs)

Overloaded function.

geohash.decode(hash[, round])

Decode hashes into a geographic points.

geohash.encode(lon, lat[, precision])

Encode coordinates into geohash with the given precision.

geohash.int64.decode(hash[, precision, round])

Decode hash into a geographic points with the given precision.

geohash.int64.encode(lon, lat[, precision])

Encode coordinates into geohash with the given precision.

geohash.int64.neighbors(hash[, precision])

Returns all neighbors hash clockwise from north around northwest at the given precision.

geohash.transform(hash[, precision])

Transforms the given codes from one precision to another.

geohash.where(hash)

Returns the start and end indexes of the different GeoHash boxes.

Binning#

Binning1D(x[, dtype])

Group a number of more or less continuous values into a smaller number of "bins" located on a vector.

Binning2D(x, y[, wgs, dtype])

Group a number of more or less continuous values into a smaller number of "bins" located on a grid.

Histogram2D(x, y[, bin_counts, dtype])

Group a number of more or less continuous values into a smaller number of "bins" located on a grid.

Cartesian Grids#

grid.Grid2D(*args[, increasing_axes])

2D Cartesian Grid.

grid.Grid3D(*args[, increasing_axes])

3D Cartesian Grid.

grid.Grid4D(*args[, increasing_axes])

4D Cartesian Grid.

Climate and Forecast#

Axis identification from CF attribute values.

cf.AxisLatitudeUnit()

Units known to the axis defining the latitude.

cf.AxisLongitudeUnit()

Units known to the axis defining the longitude.

cf.AxisTimeUnit()

Units known to the axis defining the time.

cf.AxisUnit([iterable])

Units management for axes.

Geodetic systems#

geodetic.Box([min_corner, max_corner])

Defines a box made of two describing points in a spherical coordinates system in degrees.

geodetic.coordinate_distances(lon1, lat1, ...)

Returns the distance between the given coordinates.

geodetic.Coordinates([system])

World Geodetic Coordinates System.

geodetic.Crossover(self, half_orbit_1, ...)

Calculate the crossover between two half-orbits.

geodetic.LineString(self, lon, lat)

A linestring (named so by OGC) is a collection of points.

geodetic.MultiPolygon([polygons])

The multi-polygon contains a list of polygons.

geodetic.normalize_longitudes(lon[, min_lon])

Normalizes longitudes to the range [min_lon, min_lon + 360).

geodetic.Point([lon, lat])

Handle a point in an equatorial spherical coordinate system in degrees.

geodetic.Polygon(outer[, inners])

The polygon contains an outer ring and zero or more inner rings.

geodetic.RTree

geodetic.Spheroid([parameters])

World Geodetic System (WGS).

Cartesian interpolators#

bicubic(mesh, x, y[, z, u, nx, ny, ...])

Bicubic gridded interpolator.

bivariate(grid2d, x, y[, interpolator, ...])

Interpolate the values provided on the defined bivariate function.

trivariate(grid3d, x, y, z[, interpolator, ...])

Interpolate the values provided on the defined trivariate function.

quadrivariate(grid4d, x, y, z, u[, ...])

Interpolate the values provided on the defined quadrivariate function.

Fill undefined values#

fill.loess(mesh[, nx, ny, value_type, ...])

Filter values using a locally weighted regression function or LOESS.

fill.gauss_seidel(mesh[, first_guess, ...])

Replaces all undefined values (NaN) in a grid using the Gauss-Seidel method by relaxation.

Univariate statistics#

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

Univariate descriptive statistics.

StreamingHistogram(values[, weights, axis, ...])

Streaming histogram.

Orbit Interpolation#

calculate_orbit(height, lon_nadir, ...[, ...])

Calculate the orbit at the given height.

calculate_pass(pass_number, orbit, *[, bbox])

Get the properties of a swath of an half-orbit.

calculate_swath(half_orbit, *[, ...])

Get the properties of a swath of an half-orbit.

EquatorCoordinates(longitude, time)

Coordinates of the satellite at the equator.

Orbit(height, latitude, longitude, ...)

Properties of the orbit.

Pass(lon_nadir, lat_nadir, time, x_al, ...)

Class representing a pass of an orbit.

Swath(lon_nadir, lat_nadir, time, x_al, ...)

Class representing a pass of an orbit.

Xarray#

Construction of Cartesian interpolators from xarray.DataArray

backends.xarray.Grid2D(data_array[, ...])

Builds a Grid2D from the Xarray data provided.

backends.xarray.Grid3D(data_array[, ...])

Builds a Grid3D from the Xarray data provided.

backends.xarray.Grid4D(data_array[, ...])

Builds a Grid4D from the Xarray data provided.

backends.xarray.RegularGridInterpolator(array)

Interpolation on a regular grid in arbitrary dimensions.