ageostrophic_wind¶
- metpy.calc.ageostrophic_wind(height, u, v, dx=None, dy=None, latitude=None, x_dim=- 1, y_dim=- 2)¶
Calculate the ageostrophic wind given from the height or geopotential.
- Parameters
height ((M, N) ndarray) – The height or geopotential field.
u ((…, M, N)
xarray.DataArray
orpint.Quantity
) – The u wind field.v ((…, M, N)
xarray.DataArray
orpint.Quantity
) – The u wind field.dx (
pint.Quantity
, optional) – The grid spacing(s) in the x-direction. If an array, there should be one item less than the size of u along the applicable axis. Optional ifxarray.DataArray
with latitude/longitude coordinates used as input.dy (
pint.Quantity
, optional) – The grid spacing(s) in the y-direction. If an array, there should be one item less than the size of u along the applicable axis. Optional ifxarray.DataArray
with latitude/longitude coordinates used as input.latitude (
xarray.DataArray
orpint.Quantity
) – The latitude, which is used to calculate the Coriolis parameter. Its dimensions must be broadcastable with those of height. Optional ifxarray.DataArray
with latitude coordinate used as input. Note that an argument without units is treated as dimensionless, which is equivalent to radians.x_dim (int, optional) – Axis number of x dimension. Defaults to -1 (implying […, Y, X] order). Automatically parsed from input if using
xarray.DataArray
.y_dim (int, optional) – Axis number of y dimension. Defaults to -2 (implying […, Y, X] order). Automatically parsed from input if using
xarray.DataArray
.
- Returns
A 2-item tuple of arrays – A tuple of the u-component and v-component of the ageostrophic wind
Changed in version 1.0: Changed signature from
(heights, f, dx, dy, u, v, dim_order='yx')