pyinterp.core.trivariate_float64

pyinterp.core.trivariate_float64#

pyinterp.core.trivariate_float64(*args, **kwargs)#

Overloaded function.

  1. trivariate_float64(grid: pyinterp.core.Grid3DFloat64, x: typing.Annotated[numpy.typing.ArrayLike, numpy.float64], y: typing.Annotated[numpy.typing.ArrayLike, numpy.float64], z: typing.Annotated[numpy.typing.ArrayLike, numpy.float64], interpolator: pyinterp.core.BivariateInterpolator3D, z_method: str | None = None, bounds_error: bool = False, num_threads: typing.SupportsInt = 0) -> numpy.typing.NDArray[numpy.float64]

Interpolate values on a trivariate function.

Performs trivariate interpolation of the values provided on a 3D grid using the specified interpolator and z-axis interpolation method.

Parameters:

  • grid – Grid containing the values to be interpolated.

  • x – X-coordinate values.

  • y – Y-coordinate values.

  • z – Z-coordinate values.

  • interpolator – 3D interpolator used to interpolate values on the surface (x, y, z).

  • z_method – Method of interpolation to perform on Z-axis. Supported values are linear and nearest. Defaults to linear.

  • bounds_error – If True, raises ValueError when interpolated values are requested outside the domain of the input axes (x, y, z). If False, sets values to NaN. Defaults to False.

  • 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:

Array of interpolated values.

  1. trivariate_float64(grid: pyinterp.core.TemporalGrid3DFloat64, x: typing.Annotated[numpy.typing.ArrayLike, numpy.float64], y: typing.Annotated[numpy.typing.ArrayLike, numpy.float64], z: typing.Annotated[numpy.typing.ArrayLike, numpy.int64], interpolator: pyinterp.core.TemporalBivariateInterpolator3D, z_method: str | None = None, bounds_error: bool = False, num_threads: typing.SupportsInt = 0) -> numpy.typing.NDArray[numpy.float64]

Interpolate values on a trivariate function.

Performs trivariate interpolation of the values provided on a 3D grid using the specified interpolator and z-axis interpolation method.

Parameters:

  • grid – Grid containing the values to be interpolated.

  • x – X-coordinate values.

  • y – Y-coordinate values.

  • z – Z-coordinate values.

  • interpolator – 3D interpolator used to interpolate values on the surface (x, y, z).

  • z_method – Method of interpolation to perform on Z-axis. Supported values are linear and nearest. Defaults to linear.

  • bounds_error – If True, raises ValueError when interpolated values are requested outside the domain of the input axes (x, y, z). If False, sets values to NaN. Defaults to False.

  • 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:

Array of interpolated values.

Contents