diff --git a/share/tracking.yaml b/share/tracking.yaml index 0f8766b8..b9c98488 100644 --- a/share/tracking.yaml +++ b/share/tracking.yaml @@ -8,6 +8,6 @@ PATHS: TRACK_DURATION_MIN: 4 VIRTUAL_LENGTH_MAX: 0 -#CLASS: -# MODULE: py_eddy_tracker.featured_tracking.old_tracker_reference -# CLASS: CheltonTracker +CLASS: + MODULE: py_eddy_tracker.featured_tracking.area_tracker + CLASS: AreaTracker diff --git a/src/py_eddy_tracker/dataset/grid.py b/src/py_eddy_tracker/dataset/grid.py index bd9e70d3..a2237c61 100644 --- a/src/py_eddy_tracker/dataset/grid.py +++ b/src/py_eddy_tracker/dataset/grid.py @@ -617,7 +617,10 @@ def eddy_identification( :param float,None precision: Truncate values at the defined precision in m :param str force_height_unit: Unit used for height unit :param str force_speed_unit: Unit used for speed unit - :param dict kwargs: Argument given to amplitude + :param dict kwargs: Arguments given to amplitude (mle, nb_step_min, nb_step_to_be_mle). + Look at :py:meth:`py_eddy_tracker.eddy_feature.Amplitude` + The amplitude threshold is given by `step*nb_step_min` + :return: Return a list of 2 elements: Anticyclones and Cyclones :rtype: py_eddy_tracker.observations.observation.EddiesObservations diff --git a/src/py_eddy_tracker/eddy_feature.py b/src/py_eddy_tracker/eddy_feature.py index 037beb35..f6db848b 100644 --- a/src/py_eddy_tracker/eddy_feature.py +++ b/src/py_eddy_tracker/eddy_feature.py @@ -65,7 +65,7 @@ def __init__( :param float contour_height: :param array data: :param float interval: - :param int mle: maximum number of local maxima in contour + :param int mle: maximum number of local extrema in contour :param int nb_step_min: number of intervals to consider an eddy :param int nb_step_to_be_mle: number of intervals to be considered as an another maxima """ diff --git a/src/py_eddy_tracker/generic.py b/src/py_eddy_tracker/generic.py index a48c0e2f..94cf321f 100644 --- a/src/py_eddy_tracker/generic.py +++ b/src/py_eddy_tracker/generic.py @@ -309,7 +309,7 @@ def uniform_resample(x_val, y_val, num_fac=2, fixed_size=None): :param array_like x_val: input x contour coordinates :param array_like y_val: input y contour coordinates :param int num_fac: factor to increase lengths of output coordinates - :param int,None fixed_size: if define, it will used to set sampling + :param int,None fixed_size: if defined, will be used to set sampling """ nb = x_val.shape[0] # Get distances