Function interp1d

src/wrf/computation.py:107–177

Return the linear interpolation of a one-dimensional variable. This function is typically used to interpolate a variable in a vertical column, but the coordinate system need not be a vertical coordinate system. Multiple interpolation points may be specified in the *z_out* parameter

(field, z_in, z_out, missing=default_fill(np.float64),
             meta=True)

@set_interp_metadata("1d")
def interp1d(field, z_in, z_out, missing=default_fill(np.float64),
             meta=True):
    """Return the linear interpolation of a one-dimensional variable.

    This function is typically used to interpolate a variable in a vertical
    column, but the coordinate system need not be a vertical coordinate
    system.  Multiple interpolation points may be specified in the *z_out*
    parameter.

    Args:

        field (:class:`xarray.DataArray` or :class:`numpy.ndarray`): A
            one-dimensional field.  Metadata for *field* is only copied
            to the output if *field* is a :class:`xarray.DataArray` object.

        z_in (:class:`xarray.DataArray` or :class:`numpy.ndarray`): The
            one-dimensional coordinates associated with *field* (usually the
            vertical coordinates, either height or pressure).

        z_out (:class:`xarray.DataArray`, :class:`numpy.ndarray`): A
            one-dimensional array of *z_in* coordinate points to interpolate
            to.  Must be the same type as *z_in*.

        missing (:obj:`float`, optional): The fill value to use for the
            output.  Default is :data:`wrf.default_fill(np.float64)`.

        meta (:obj:`bool`, optional): Set to False to disable metadata and
            return :class:`numpy.ndarray` instead of
            :class:`xarray.DataArray`.  Default is True.

    Warning:

        The input arrays must not contain any missing/fill values or
        :data:`numpy.nan` values.

    Returns:

        :class:`xarray.DataArray` or :class:`numpy.ndarray`: An array with the
        same dimensionality as *z_out* containing the interpolated values.
        If xarray is enabled and the *meta* parameter is True, then the result
        will be a :class:`xarray.DataArray` object.  Otherwise, the result will
        be a :class:`numpy.ndarray` object with no metadata.


    Examples:

        Example 1:  Calculate the 850 hPa and 500 hPa values at location \
        x,y = (100,200)

        .. code-block:: python

            import numpy as np
            from wrf import getvar, interp1d
            from netCDF4 import Dataset

            wrfnc = Dataset("wrfout_d02_2010-06-13_21:00:00")

            # Get a 1D vertical column for pressure at location x,y = 100,200