Core API Documentation

Low-level classes & functions implemented in the compiled extension module (pyinterp.core). Most users should start with the high-level API Documentation overview.

Axes

Core axis primitives.

core.Axis(self, values[, epsilon, is_circle])	A coordinate axis is a Variable that specifies one of the coordinates of a variable's values.
core.AxisInt64(self, values)	A coordinate axis is a Variable that specifies one of the coordinates of a variable's values.
core.TemporalAxis(self, values)	Time axis

NumPy Datetime Utilities

Vectorized helpers for working with numpy.datetime64 values.

core.dateutils.date(array)	Return the date part of the dates.
core.dateutils.datetime(array)	Return the data as an array of native Python datetime objects.
core.dateutils.timedelta_since_january(array)	Return the number the timedelta since the first January.
core.dateutils.isocalendar(array)	Return the ISO calendar of dates.
core.dateutils.time(array)	Return the time part of the dates.
core.dateutils.weekday(array)	Return the weekday of the dates; Sunday is 0 .

Bicubic & Spline Routines

Internal bicubic spline interpolation kernels.

core.bicubic_float32(*args, **kwargs)	Overloaded function.
core.bicubic_float64(*args, **kwargs)	Overloaded function.
core.spline_float32(*args, **kwargs)	Overloaded function.
core.spline_float64(*args, **kwargs)	Overloaded function.

Binning

Core accumulation structures by dtype.

core.Binning1DFloat64(self, x)	Group a number of more or less continuous values into a smaller number of "bins" located on a vector.
core.Binning1DFloat32(self, x)	Group a number of more or less continuous values into a smaller number of "bins" located on a vector.
core.Binning2DFloat64(self, x, y[, wgs])	Group a number of more or less continuous values into a smaller number of "bins" located on a grid.
core.Binning2DFloat32(self, x, y[, wgs])	Group a number of more or less continuous values into a smaller number of "bins" located on a grid.
core.Histogram2DFloat64(self, x, y[, bins])	Group a number of more or less continuous values into a smaller number of "bins" located on a grid.
core.Histogram2DFloat32(self, x, y[, bins])	Group a number of more or less continuous values into a smaller number of "bins" located on a grid.

Bivariate Interpolators

Object oriented 2D interpolator classes.

core.Bilinear2D	Bilinear interpolation in a 2D space.
core.BivariateInterpolator2D	Bilinear interpolation in a 2D space.
core.InverseDistanceWeighting2D	Inverse distance weighting interpolation in a 2D space.
core.Nearest2D	Nearest interpolation in a 2D space.

Bivariate Kernel Functions

Vectorized functional 2D interpolation routines.

core.bivariate_int8(grid, x, y, interpolator)	Interpolate the values provided on the defined bivariate function.
core.bivariate_float32(grid, x, y, interpolator)	Interpolate the values provided on the defined bivariate function.
core.bivariate_float64(grid, x, y, interpolator)	Interpolate the values provided on the defined bivariate function.

Cartesian Grids

Typed grid containers.

core.Grid2DInt8(self, x, y, array)	Cartesian Grid 2D.
core.Grid2DFloat32(self, x, y, array)	Cartesian Grid 2D.
core.Grid2DFloat64(self, x, y, array)	Cartesian Grid 2D.
core.Grid3DInt8(self, x, y, z, array)	Cartesian Grid 3D
core.Grid3DFloat32(self, x, y, z, array)	Cartesian Grid 3D
core.Grid3DFloat64(self, x, y, z, array)	Cartesian Grid 3D
core.Grid4DInt8(self, x, y, z, u, array)	Cartesian Grid 4D
core.Grid4DFloat32(self, x, y, z, u, array)	Cartesian Grid 4D
core.Grid4DFloat64(self, x, y, z, u, array)	Cartesian Grid 4D

Univariate Descriptive Statistics

Streaming statistics.

core.DescriptiveStatisticsFloat32(self, values)	Univariate descriptive statistics.
core.DescriptiveStatisticsFloat64(self, values)	Univariate descriptive statistics.

Geodetic System

Geodetic primitives and spatial operations.

core.geodetic.Box(self, min_corner, max_corner)	Defines a box made of two describing points.
core.geodetic.Coordinates(self[, spheroid])	World Geodetic Coordinates System.
core.geodetic.Crossover(self, half_orbit_1, ...)	Calculate the crossover between two half-orbits.
core.geodetic.LineString(self, lon, lat)	A linestring (named so by OGC) is a collection of points.
core.geodetic.MultiPolygon	A MultiPolygon is a collection of polygons.
core.geodetic.Point(self[, lon, lat])	Handle a point in a geographic coordinates system in degrees.
core.geodetic.Polygon(self, outer[, inners])	The polygon contains an outer ring and zero or more inner rings.
core.geodetic.RTree(self[, spheroid])	R*Tree spatial index.
core.geodetic.Spheroid(self, ...)	World Geodetic System (WGS).

Geohash (Integer)

Integer encoded geohash helpers.

core.geohash.int64.decode(hash[, precision, ...])	Decode hash into a geographic points with the given precision.
core.geohash.int64.encode(lon, lat[, precision])	Encode coordinates into geohash with the given precision.
core.geohash.int64.neighbors(hash[, precision])	Returns all neighbors hash clockwise from north around northwest at the given precision.

Geohash (Bytes)

Byte encoded geohash helpers and transformations.

core.GeoHash(self, latitude, longitude[, ...])	Handle GeoHash encoded in base 32.
core.geohash.area(hash[, wgs])	Calculated the area caovered by the GeoHash codes.
core.geohash.bounding_boxes(*args, **kwargs)	Overloaded function.
core.geohash.decode(hash[, round])	Decode hashes into a geographic points.
core.geohash.encode(lon, lat[, precision])	Encode coordinates into geohash with the given precision.
core.geohash.int64	GeoHash encoded as integer 64 bits
core.geohash.transform(hash[, precision])	Transforms the given codes from one precision to another.
core.geohash.where(hash)	Returns the start and end indexes of the different GeoHash boxes.

Temporal Cartesian Grids

Grids extended with a time dimension.

core.TemporalGrid3DFloat32(self, x, y, z, array)	Temporal Cartesian Grid 3D
core.TemporalGrid3DFloat64(self, x, y, z, array)	Temporal Cartesian Grid 3D
core.TemporalGrid4DFloat32(self, x, y, z, u, ...)	Temporal Cartesian Grid 4D
core.TemporalGrid4DFloat64(self, x, y, z, u, ...)	Temporal Cartesian Grid 4D

4D Interpolation Kernels

Functional 4D interpolation (space + time) routines.

core.quadrivariate_float32(*args, **kwargs)	Overloaded function.
core.quadrivariate_float64(*args, **kwargs)	Overloaded function.

R*Tree

Spatial index & associated interpolation kernels.

core.RadialBasisFunction	Radial basis functions
core.WindowFunction	Window functions
core.RTree3DFloat32(self[, spheroid])	RTree spatial index for geodetic scalar values
core.RTree3DFloat64(self[, spheroid])	RTree spatial index for geodetic scalar values

Replace Undefined Values

Gap filling routines and supporting types.

core.fill.ValueType	Type of values processed by the loess filter
core.fill.FirstGuess	Type of first guess grid to solve Poisson's equation.
core.fill.loess_float64(*args, **kwargs)	Overloaded function.
core.fill.loess_float32(*args, **kwargs)	Overloaded function.
core.fill.gauss_seidel_float64(grid, , ], ...)	Replaces all undefined values (NaN) in a grid using the Gauss-Seidel method by relaxation.
core.fill.gauss_seidel_float32(grid, , ], ...)	Replaces all undefined values (NaN) in a grid using the Gauss-Seidel method by relaxation.

3D Interpolators

Object oriented 3D interpolator classes.

core.Bilinear3D	Bilinear interpolation in a 3D space.
core.BivariateInterpolator3D	Bilinear interpolation in a 3D space.
core.InverseDistanceWeighting3D	Inverse distance weighting interpolation in a 3D space.
core.Nearest3D	Nearest interpolation in a 3D space.

Temporal 3D Interpolators

Object oriented 3D + time interpolator classes.

core.TemporalBilinear3D	Bilinear interpolation in a 3D space.
core.TemporalBivariateInterpolator3D	Bilinear interpolation in a 3D space.
core.TemporalInverseDistanceWeighting3D	Inverse distance weighting interpolation in a 3D space.
core.TemporalNearest3D	Nearest interpolation in a 3D space.

3D Interpolation Kernels

Vectorized functional 3D interpolation routines.

core.trivariate_float32(*args, **kwargs)	Overloaded function.
core.trivariate_float64(*args, **kwargs)	Overloaded function.