potential_vorticity_barotropic#
- metpy.calc.potential_vorticity_barotropic(height, u, v, dx=None, dy=None, latitude=None, x_dim=-1, y_dim=-2, *, parallel_scale=None, meridional_scale=None, longitude=None, crs=None)#
Calculate the barotropic (Rossby) potential vorticity.
\[PV = \frac{f + \zeta}{H}\]This formula is based on equation 7.27 [Hobbs2006].
- Parameters:
height ((…, M, N)
xarray.DataArray
orpint.Quantity
) – atmospheric heightu ((…, M, N)
xarray.DataArray
orpint.Quantity
) – x component of the windv ((…, M, N)
xarray.DataArray
orpint.Quantity
) – y component of the winddx (
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 (
pint.Quantity
, optional) – Latitude of the wind data. Optional ifxarray.DataArray
with latitude/longitude coordinates used as input. Note that an argument without units is treated as dimensionless, which translates 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
.parallel_scale (
pint.Quantity
, optional) – Parallel scale of map projection at data coordinate. Optional ifxarray.DataArray
with latitude/longitude coordinates and MetPy CRS used as input. Also optional if longitude, latitude, and crs are given. If otherwise omitted, calculation will be carried out on a Cartesian, rather than geospatial, grid. Keyword-only argument.meridional_scale (
pint.Quantity
, optional) – Meridional scale of map projection at data coordinate. Optional ifxarray.DataArray
with latitude/longitude coordinates and MetPy CRS used as input. Also optional if longitude, latitude, and crs are given. If otherwise omitted, calculation will be carried out on a Cartesian, rather than geospatial, grid. Keyword-only argument.longitude (
pint.Quantity
, optional) – Longitude of data. Optional ifxarray.DataArray
with latitude/longitude coordinates used as input. Also optional if parallel_scale and meridional_scale are given. If otherwise omitted, calculation will be carried out on a Cartesian, rather than geospatial, grid. Keyword-only argument.crs (
pyproj.crs.CRS
, optional) – Coordinate Reference System of data. Optional ifxarray.DataArray
with MetPy CRS used as input. Also optional if parallel_scale and meridional_scale are given. If otherwise omitted, calculation will be carried out on a Cartesian, rather than geospatial, grid. Keyword-only argument.
- Returns:
(…, M, N)
xarray.DataArray
orpint.Quantity
– barotropic potential vorticity
Changed in version 1.0: Changed signature from
(heights, u, v, dx, dy, lats, dim_order='yx')