shoot.eddies.eddies2d.GriddedEddy2D

class shoot.eddies.eddies2d.GriddedEddy2D(i, j, u, v, ssh=None, dx=None, dy=None, uv_error=0.01, max_ellipse_error=0.01, nlevels=100, robust=0.03, **attrs)

An eddy detected on a grid with contour and ellipse properties

Represents a single eddy candidate at a grid point. Given a local velocity field, it computes SSH contours, fits ellipses, and determines eddy boundaries and maximum velocity contours.

Parameters:

• i (int) – Grid index along X for the eddy center.

• j (int) – Grid index along Y for the eddy center.

• u (xarray.DataArray) – Local zonal velocity field.

• v (xarray.DataArray) – Local meridional velocity field.

• ssh (xarray.DataArray, optional) – Local SSH field. If None, computed from streamfunction.

• dx (xarray.DataArray, optional) – Grid resolution along X in meters.

• dy (xarray.DataArray, optional) – Grid resolution along Y in meters.

• max_ellipse_error (float, default 0.01) – Maximum allowed ellipse fit error.

• min_radius (float, optional) – Minimum eddy radius in km.

__init__(i, j, u, v, ssh=None, dx=None, dy=None, uv_error=0.01, max_ellipse_error=0.01, nlevels=100, robust=0.03, **attrs)

Methods

contains_eddy(eddy)
contains_points(lons, lats)
intersects_eddy(eddy)
is_eddy(min_radius)
lignes(nb_eddy, date)	provide the expected lignes for plan vecteur format
plot([ax, lw, color, vmax, boundary])	Quickly plot the eddy
plot_previ([ax, lw, color])	Quickly plot the eddy

Attributes

boundary_contour
color
contours
coriolis
eddy_type
elat	Latitude of ellipse or None
ellipse	Ellipse fitted from boundary_contour or None
elon	Longitude of ellipse or None
lat	Latitude of center either from grid or ellipse
length	Length deduced from ellipse or 0
lon	Longitude of center either from grid or ellipse
ncontours
radius	Radius deduced from ellipse or 0
ro	Rossby number of the eddy
sign
ssh	Sea surface height field
ugeos	Geostrophic zonal velocity
vgeos	Geostrophic meridional velocity
vmax_contour