wrf.metadecorators.set_uvmet_alg_metadata¶
- wrf.metadecorators.set_uvmet_alg_metadata(units=None, description='earth rotated u,v', latarg='lat', windarg='u')¶
A decorator that sets the metadata for the wrapped raw UVMET diagnostic function.
- Parameters:
units (
str
, optional) – The units to use if if there is no ‘units’ argument for the wrapped function. Default is None.description (
str
, optional) – A description for the wrapped algorithm, which is stored in thexarray.DataArray.attrs
attribute under the ‘description’ key. Default is None.( (latarg) – obj:’str`, optional): The wrapped function argument name for latitude. Default is ‘lat’.
windarg (
str
, optional) – The wrapped function argument name for the u wind component. Default is ‘u’.
- Returns:
The wrapped UVMET 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: