wrf.metadecorators.set_height_metadata

wrf.metadecorators.set_height_metadata(geopt=False)

A decorator that sets the metadata for a wrapped height function’s output.

This is a special metadata decorator for working with height functions.

If the wrapped function’s meta argument is False, then this decorator returns the wrapped function output without applying the metadata.

Parameters:geopt (bool, optional) – Set to True if the wrapped function returns geopotential. Set to True if the wrapped function returns geopotential height. Default is False. Returns:The wrapped height function output with or without metadata. If xarray is enabled and the meta parameter is True, then the result will be a xarray.DataArray object. Otherwise, the result will be a numpy.ndarray object with no metadata. Return type:xarray.DataArray or numpy.ndarray