py_eddy_tracker.eddy_feature.Amplitude

class py_eddy_tracker.eddy_feature.Amplitude(contour, contour_height, data, interval, mle=1, nb_step_min=2, nb_step_to_be_mle=2)

Bases: object

Class to calculate amplitude and counts of local maxima/minima within a closed region of a sea surface height field.

Create amplitude object

Parameters:

• contour (Contours) – usefull class defined below

• contour_height (float) – field value of the contour

• data (array) – grid

• interval (float) – step between two contours

• mle (int) – maximum number of local extrema in contour

• nb_step_min (int) – minimum number of intervals to consider the contour as an eddy

• nb_step_to_be_mle (int) – number of intervals to be considered as another extrema

Methods

all_pixels_above_h0	Check CSS11 criterion 1: The SSH values of all of the pixels are above a given SSH threshold for anticyclonic eddies.
all_pixels_below_h0	Check CSS11 criterion 1: The SSH values of all of the pixels are below a given SSH threshold for cyclonic eddies.
within_amplitude_limits	Need update

Attributes

h_0
grid_extract
pixel_mask
nb_pixel
sla
contour
interval_min
interval_min_secondary
amplitude
mle
EPSILON

EPSILON = 1e-08

all_pixels_above_h0(level)

Check CSS11 criterion 1: The SSH values of all of the pixels are above a given SSH threshold for anticyclonic eddies.

all_pixels_below_h0(level)

Check CSS11 criterion 1: The SSH values of all of the pixels are below a given SSH threshold for cyclonic eddies.

amplitude

contour

grid_extract

h_0

interval_min

interval_min_secondary

mle

nb_pixel

pixel_mask

sla

within_amplitude_limits()

Need update