geostrophic_wind¶
-
metpy.calc.
geostrophic_wind
(heights, f, dx, dy)[source]¶ Calculate the geostrophic wind given from the heights or geopotential.
- Parameters
heights ((M, N)
pint.Quantity
) – The height field, with either leading dimensions of (x, y) or trailing dimensions of (y, x), depending on the value ofdim_order
.f (array_like) – The coriolis parameter. This can be a scalar to be applied everywhere or an array of values.
dx (
pint.Quantity
) – The grid spacing(s) in the x-direction. If an array, there should be one item less than the size of heights along the applicable axis.dy (
pint.Quantity
) – The grid spacing(s) in the y-direction. If an array, there should be one item less than the size of heights along the applicable axis.dim_order (str or
None
, optional) – The ordering of dimensions in passed in arrays. Can be one ofNone
,'xy'
, or'yx'
.'xy'
indicates that the dimension corresponding to x is the leading dimension, followed by y.'yx'
indicates that x is the last dimension, preceded by y.None
indicates that the default ordering should be assumed, which is ‘yx’. Can only be passed as a keyword argument, i.e. func(…, dim_order=’xy’).
- Returns
A 2-item tuple of arrays,
pint.Quantity
– A tuple of the u-component and v-component of the geostrophic wind.
Notes
If inputs have more than two dimensions, they are assumed to have either leading dimensions of (x, y) or trailing dimensions of (y, x), depending on the value of
dim_order
.