shoot.eddies.eddies2d.Eddies2D

shoot.eddies.eddies2d.Eddies2D#

class shoot.eddies.eddies2d.Eddies2D(time, eddies, window_center, window_fit, min_radius)[source]#

Collection of detected eddies at a single time step

Provides the main entry point for eddy detection via detect_eddies() and serialization to NetCDF via to_netcdf().

Parameters:
  • time (numpy.datetime64 or None) – Time of the detection.

  • eddies (list) – List of GriddedEddy2D or Eddy objects.

  • window_center (float) – Window size (km) used for center detection.

  • window_fit (float) – Window size (km) used for contour fitting.

  • min_radius (float) – Minimum eddy radius (km).

__init__(time, eddies, window_center, window_fit, min_radius)[source]#

Methods

detect_eddies(u, v, window_center[, ...])

Detect all eddies in a velocity field

reconstruct(ds)

test_eddy(min_radius)

to_netcdf(path_nc)

Save to NetCDF format

to_pv(path_pv)

Save to plan vecteur format

transfer_eddy_attr(other_eddy, attr_name)

Attributes

ds