shoot.eddies.eddies2d.EvolEddies2D.detect_eddies

shoot.eddies.eddies2d.EvolEddies2D.detect_eddies#

classmethod EvolEddies2D.detect_eddies(ds, window_center, window_fit, min_radius, u=None, v=None, ssh=None, paral=False, nb_procs=None, ellipse_error=0.1)[source]#

Detect eddies across all time steps of a dataset

Parameters:

  • ds (xarray.Dataset) – Dataset with velocity and optional SSH fields with a time dimension.

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

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

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

  • u (str, optional) – Name of zonal velocity variable. Auto-detected if None.

  • v (str, optional) – Name of meridional velocity variable. Auto-detected if None.

  • ssh (str, optional) – Name of SSH variable. Auto-detected if None.

  • paral (bool, default False) – Use parallel processing.

Returns:

Detected eddies at all time steps.

Return type:

EvolEddies2D