Function smooth2d

src/wrf/computation.py:681–732

Return the field smoothed. The smoothing kernel applied is: .. math:: \\frac{1}{4 + cenweight} * \\begin{bmatrix} 0 & 1 & 0 \\\\ 1 & cenweight & 1 \\\\ 0 & 1 & 0

(field, passes, cenweight=2.0, meta=True)

@set_smooth_metdata()
def smooth2d(field, passes, cenweight=2.0, meta=True):
    """Return the field smoothed.

    The smoothing kernel applied is:

    .. math::

        \\frac{1}{4 + cenweight} * \\begin{bmatrix}
                               0 & 1 & 0 \\\\
                               1 & cenweight & 1 \\\\
                               0 & 1 & 0
                             \\end{bmatrix}

    Data values along the borders are left unchanged. This routine does not
    modify the original data supplied by the *field* parameter..

    If you need more general purpose multidimensional filtering tools,
    try the :meth:`scipy.ndimage.convolve` method.

    Args:

        field (:class:`xarray.DataArray` or :class:`numpy.ndarray`): The field
            to smooth, which must be at least two dimensions.  Missing/fill
            values will be ignored as long as the type is either a
            :class:`numpy.ma.MaskedArray` or a :class:`xarray.DataArray` with
            a *_FillValue* attribute.

        passes (:obj:`int`): The number of smoothing passes.

        cenweight (:obj:`float`, optional): The weight to apply to the
            center of the smoothing kernel. Default is 2.0.

        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`, :class:`numpy.ma.MaskedArray` or \
        :class:`numpy.ndarray`): The smoothed field. 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 either a :class:`numpy.ndarray` or a :class:`numpy.ma.MaskedArray`
        depending on the type for *field*.

    See Also:

        :meth:`scipy.ndimage.convolve`


    """
    return _smooth2d(field, passes, cenweight)


@set_cape_alg_metadata(is2d=True, copyarg="pres_hpa")