trackeddy.tracking.scan_eddym

trackeddy.tracking.scan_eddym(data, lon, lat, levels, date, areamap, mask='', destdir='', physics='', eddycenter='masscenter', maskopt='contour', preferences=None, mode='gaussian', basemap=False, checkgauss=True, areaparms=None, usefullfit=False, diagnostics=False, plotdata=False, debug=False)

scan_eddym wraps the identification and Gaussian fit functions.

Function to identify each eddy using closed contours, also this function checks if the elipse adjusted have a consistent eccentricity, vorticty and other parameters.

Parameters
args:
data: array

Sea Surface Height in cm.

lon: array|list

Longitude of data field.

lat: array|list

Latitude of data field.

levels: array|list

Discrete levels where the code will find the closed contours.

date: int | datetime

Date in julian days.

areamap: list

Section of interest [lon0,lon1,lat0,lat1].

mask: np.mask

Continent mask.

Returns
eddys: dict

OrderedDict of identified eddies.

check: boolean

Status of identification.

total_contours: int

Total number of contours analysed.