wrf.metadecorators.set_height_metadata¶
-
wrf.metadecorators.
set_height_metadata
(geopt=False, stag=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: 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 anumpy.ndarray
object with no metadata.Return type: