pyinterp.core.trivariate_float64¶
- pyinterp.core.trivariate_float64(*args, **kwargs)¶
Overloaded function.
trivariate_float64(grid: pyinterp.core.Grid3DFloat64, x: numpy.ndarray[numpy.float64], y: numpy.ndarray[numpy.float64], z: numpy.ndarray[numpy.float64], interpolator: pyinterp.core.BivariateInterpolator3D, z_method: Optional[str] = None, bounds_error: bool = False, num_threads: int = 0) -> numpy.ndarray[numpy.float64]
Interpolate the values provided on the defined trivariate function.
- Parameters:
grid – Grid containing the values to be interpolated.
x – X-values.
y – Y-values.
z – Z-values.
interpolator – 3D interpolator used to interpolate values on the surface (x, y, z).
z_method – The method of interpolation to perform on Z-axis. Supported are
linear
andnearest
. Default tolinear
.bounds_error – If True, when interpolated values are requested outside of the domain of the input axes (x,y,z), a ValueError is raised. If False, then value is set to NaN.
num_threads – The number of threads to use for the computation. If 0 all CPUs are used. If 1 is given, no parallel computing code is used at all, which is useful for debugging. Defaults to
0
.
- Returns:
Values interpolated.
trivariate_float64(grid: pyinterp.core.TemporalGrid3DFloat64, x: numpy.ndarray[numpy.float64], y: numpy.ndarray[numpy.float64], z: numpy.ndarray[numpy.int64], interpolator: pyinterp.core.TemporalBivariateInterpolator3D, z_method: Optional[str] = None, bounds_error: bool = False, num_threads: int = 0) -> numpy.ndarray[numpy.float64]
Interpolate the values provided on the defined trivariate function.
- Parameters:
grid – Grid containing the values to be interpolated.
x – X-values.
y – Y-values.
z – Z-values.
interpolator – 3D interpolator used to interpolate values on the surface (x, y, z).
z_method – The method of interpolation to perform on Z-axis. Supported are
linear
andnearest
. Default tolinear
.bounds_error – If True, when interpolated values are requested outside of the domain of the input axes (x,y,z), a ValueError is raised. If False, then value is set to NaN.
num_threads – The number of threads to use for the computation. If 0 all CPUs are used. If 1 is given, no parallel computing code is used at all, which is useful for debugging. Defaults to
0
.
- Returns:
Values interpolated.