Source code for pyinterp.interpolator.trivariate

# Copyright (c) 2024 CNES
#
# All rights reserved. Use of this source code is governed by a
# BSD-style license that can be found in the LICENSE file.
"""
Trivariate interpolation
========================
"""
import numpy

from .. import core, grid, interface




def trivariate(grid3d: grid.Grid3D,
               x: numpy.ndarray,
               y: numpy.ndarray,
               z: numpy.ndarray,
               interpolator: str = 'bilinear',
               z_method: str = 'linear',
               bounds_error: bool = False,
               num_threads: int = 0,
               **kwargs) -> numpy.ndarray:
    """Interpolate the values provided on the defined trivariate function.

    Args:
        grid3d: Function on a uniform 3-dimensional grid to be interpolated.
        x: X-values.
        y: Y-values.
        z: Z-values.
        interpolator: The interpolation method to be performed on the surface
            defined by the Y and Y axes. Supported are ``bilinear`` and
            ``nearest``, and ``inverse_distance_weighting``. Default to
            ``bilinear``.
        z_method: The interpolation method to be performed on the Z axis.
            Supported are ``linear`` and ``nearest``. Default to ``linear``.
        bounds_error: If True, when interpolated values are requested outside
            of the domain of the inumpyut axes (x,y), a :py:class:`ValueError`
            is raised. If False, then the value is set to NaN. Default to
            ``False``.
        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``.
        p: The power to be used by the interpolator inverse_distance_weighting.
            Default to ``2``.
    Returns:
        Values interpolated.
    """
    instance = grid3d._instance
    function = interface._core_function('trivariate', instance)
    return getattr(core, function)(instance,
                                   numpy.asarray(x),
                                   numpy.asarray(y),
                                   numpy.asarray(z),
                                   grid._core_variate_interpolator(
                                       grid3d, interpolator, **kwargs),
                                   z_method=z_method,
                                   bounds_error=bounds_error,
                                   num_threads=num_threads)