Function ctt

src/wrf/computation.py:1093–1202

Return the cloud top temperature. This is the raw computational algorithm and does not extract any variables from WRF output files. Use :meth:`wrf.getvar` to both extract and compute diagnostic variables. Args: pres_hpa (:class:`xarray.DataArray` or :class:`numpy.ndarray`

(pres_hpa, tkel, qv, qcld, height, terrain, qice=None,
        fill_nocloud=False, missing=default_fill(np.float64),
        opt_thresh=1.0, meta=True, units="degC")

                  description="cloud top temperature")
@convert_units("temp", "c")
def ctt(pres_hpa, tkel, qv, qcld, height, terrain, qice=None,
        fill_nocloud=False, missing=default_fill(np.float64),
        opt_thresh=1.0, meta=True, units="degC"):
    """Return the cloud top temperature.

    This is the raw computational algorithm and does not extract any variables
    from WRF output files.  Use :meth:`wrf.getvar` to both extract and compute
    diagnostic variables.

    Args:

        pres_hpa (:class:`xarray.DataArray` or :class:`numpy.ndarray`): Full
            pressure (perturbation + base state pressure) in [hPa], with the
            rightmost dimensions as bottom_top x south_north x west_east

            Note:

                The units for *psfc_hpa* are [hPa].

            Note:

                This variable must be
                supplied as a :class:`xarray.DataArray` in order to copy the
                dimension names to the output.  Otherwise, default names will
                be used.

        tkel (:class:`xarray.DataArray` or :class:`numpy.ndarray`): Temperature
            in [K] with same dimensionality as *pres_hpa*.

        qv (:class:`xarray.DataArray` or :class:`numpy.ndarray`): Water vapor
            mixing ratio in [kg/kg] with the same dimensionality as *pres_hpa*.

        qcld (:class:`xarray.DataArray` or :class:`numpy.ndarray`): Cloud water
            vapor mixing ratio in [kg/kg] with the same dimensionality as
            *pres_hpa*.

        height (:class:`xarray.DataArray` or :class:`numpy.ndarray`):
            Geopotential height in [m] with the same dimensionality as
            *pres_hpa*.

        terrain (:class:`xarray.DataArray` or :class:`numpy.ndarray`):
            Terrain height in [m].  This is at least a two-dimensional array
            with the same dimensionality as *pres_hpa*, excluding the vertical
            (bottom_top/top_bottom) dimension.

        qice (:class:`xarray.DataArray` or :class:`numpy.ndarray`, optional):
            Ice mixing ratio in [kg/kg] with the same dimensionality as
            *pres_hpa*.

        fill_nocloud (:obj:`bool`, optional): Set to True to use fill values in
            regions where clouds are not detected (optical depth less than 1).
            Otherwise, the output will contain the surface temperature for
            areas without clouds. Default is False.

        missing (:obj:`float`, optional): The fill value to use for areas
            where no clouds are detected. Only used if *fill_nocloud* is
            True. Default is
            :data:`wrf.default_fill(numpy.float64)`.