pyinterp.core.RTree3DFloat32.radial_basis_function

RTree3DFloat32.radial_basis_function(self: pyinterp.core.RTree3DFloat32, coordinates: typing.Annotated[numpy.typing.ArrayLike, numpy.float32], radius: typing.SupportsFloat | None = None, k: typing.SupportsInt = 9, rbf: pyinterp.core.RadialBasisFunction = <RadialBasisFunction.Multiquadric: 4>, epsilon: typing.SupportsFloat | None = None, smooth: typing.SupportsFloat = 0, within: bool = True, num_threads: typing.SupportsInt = 0) → tuple

Interpolate values using radial basis functions.

Performs radial basis function (RBF) interpolation at the requested positions using the K nearest neighbors found within the specified search radius.

Parameters:

  • coordinates – Array of shape (n, 3) or (n, 2) containing observation coordinates. Here n is the number of observations and each row represents a coordinate in the order x, y, and optionally z. If the matrix shape is (n, 2), the z-coordinate is assumed to be zero. The coordinate system depends on the instance configuration: If ecef=True, coordinates are in the Cartesian coordinate system (ECEF). Otherwise, coordinates are in the geodetic system (longitude, latitude, altitude) in degrees, degrees, and meters, respectively.

  • radius – Maximum search radius in meters. Defaults to the largest representable value.

  • k – Number of nearest neighbors to use for interpolation. Defaults to 9.

  • rbf – The radial basis function to use (e.g., Multiquadric, Gaussian). Defaults to Multiquadric.

  • epsilon – Adjustable constant for Gaussian or Multiquadrics functions. Defaults to the average distance between nodes.

  • smooth – Smoothness parameter. Values greater than zero increase the smoothness of the approximation. Defaults to 0.

  • within – If True, ensures neighbors are located around the point of interest (no extrapolation). Defaults to True.

  • num_threads – Number of threads to use for computation. If 0, all CPUs are used. If 1, no parallel computing is used (useful for debugging). Defaults to 0.

Returns:

Tuple containing the interpolated value and the number of neighbors used for the calculation.