Function interpz3d

src/wrf/computation.py:254–319

Return the field interpolated to a specified pressure or height level. This function is roughly equivalent to :meth:`interplevel`, but does not handle multi-product diagnostics (uvmet, cape_3d, etc) that contain an additional leftmost dimension for the product type. Also, a :class:

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

@set_interp_metadata("horiz")
def interpz3d(field3d, vert, desiredlev, missing=default_fill(np.float64),
              meta=True):
    """Return the field interpolated to a specified pressure or height level.

    This function is roughly equivalent to :meth:`interplevel`, but does not
    handle multi-product diagnostics (uvmet, cape_3d, etc) that contain an
    additional leftmost dimension for the product type.  Also, a
    :class:`numpy.ma.MaskedArray` is not created and this routine should
    be considered as low-level access to the underlying Fortran routine.

    See Also:

        :meth:`wrf.interplevel`

    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`): The desired vertical level.
            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)`.

        meta (:obj:`bool`): 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`: 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:

        Example 1: Interpolate Geopotential Height to 500 hPa

        .. code-block:: python

            from netCDF4 import Dataset
            from wrf import getvar, interpz3d

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