Function interplevel

src/wrf/interp.py:23–119

Return the three-dimensional field interpolated to a horizontal plane at the specified vertical level. Args: field3d (:class:`xarray.DataArray` or :class:`numpy.ndarray`): A three-dimensional field to interpolate, with the rightmost dimensions of nz x ny x n

(field3d, vert, desiredlev, missing=default_fill(np.float64),
                squeeze=True, meta=True)

#  Note:  Extension decorator is good enough to handle left dims
@set_interp_metadata("horiz")
def interplevel(field3d, vert, desiredlev, missing=default_fill(np.float64),
                squeeze=True, meta=True):
    """Return the three-dimensional field interpolated to a horizontal plane
    at the specified vertical level.

    Args:

        field3d (:class:`xarray.DataArray` or :class:`numpy.ndarray`): A
            three-dimensional field to interpolate, with the rightmost
            dimensions of nz x ny x nx.

        vert (:class:`xarray.DataArray` or :class:`numpy.ndarray`): A
            three-dimensional array for the vertical coordinate, typically
            pressure or height. This array must have the same dimensionality
            as *field3d*.

        desiredlev (:obj:`float`, 1D sequence, or :class:`numpy.ndarray`): The
            desired vertical level(s). This can be a single value (e.g. 500),
            a sequence of values (e.g. [1000, 850, 700, 500, 250]), or a
            multidimensional array where the right two dimensions (ny x nx)
            must match *field3d*, and any leftmost dimensions match
            field3d.shape[:-3] (e.g. planetary boundary layer).
            Must be in the same units as the *vert* parameter.

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

        squeeze (:obj:`bool`, optional): Set to False to prevent dimensions
            with a size of 1 from being automatically removed from the shape
            of the output. Default is True.

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

    Returns:

        :class:`xarray.DataArray` or :class:`numpy.ndarray`: The
        interpolated variable.  If xarray is enabled and
        the *meta* parameter is True, then the result will be an
        :class:`xarray.DataArray` object.  Otherwise, the result will
        be a :class:`numpy.ndarray` object with no metadata.

    Example:

        Interpolate Geopotential Height to 500 hPa

        .. code-block:: python

            from netCDF4 import Dataset
            from wrf import getvar, interplevel

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

            p = getvar(wrfin, "pressure")
            ht = getvar(wrfin, "z", units="dm")

            ht_500 = interplevel(ht, p, 500.0)