Observations

Satellite observations

\[\kappa\left|{\bf u}\right|^2 + f\left|{\bf u}\right| = f\left|{\bf u_g}\right|\]
obs.satellite.gradient_wind_from_ssh(input_file, variables=('adt', 'ugos', 'vgos'), dimensions=('time', 'latitude', 'longitude'), transform=None, smooth=False, output_file=None, group=None)

Gradient wind velocities as a function of sea surface height.

Parameters

  • input_file (str, Path, file-like, DataArray or Dataset) – Netcdf filename, DataArray or Dataset

  • variables (tuple) – Names of the sea level and geostrophic velocities in the netcdf file or Dataset. Sea level required, geostrophic velocities optional.

  • dimensions (tuple) – Dimension names that apply along the sea level field.

  • transform (str, optional) – String form of to create the Proj.

  • smooth (str or dict, optional) – Smooth field after each differentiation, with ‘boxcar’ or ‘gaussian’ filter. If input is dict, the value in the dict is the size of the window in which the filter is apllied.

  • output_file (str, Path or file-like, optional) – Netcdf filename for output file

  • group (str, optional) – Group name in netCDF4 output file.

Returns

gradient_wind_velocities – Dataset or netcdf file

Return type

Dataset or file-like

Examples

>>> gradient_wind_from_ssh(
...     input_file,
...     variables=('adt', 'ugos', 'vgos'),
...     dimensions=('time', 'latitude', 'longitude'),
...     transform='+proj=utm +zone=55 +south +ellps=WGS84 +datum=WGS84 +units=m +no_defs',
...     smooth={'boxcar': 3},
...     output_file='gw-vel.nc', group='gradient-wind'
... )
obs.satellite.qg_from_ssh(input_file, output_file=None, group='quasi-geostrophy', dimensions=('time', 'latitude', 'longitude'), smooth=False, transform=None)

Calculate the quasi-geostrophic vorticity terms from gradient wind velocities.

Parameters

input_file (netcdf-file) –

Conductivity Temperature Depth (CTD) observations