Change label format

Author: AntSimi

CHANGELOG.md

@@ -16,7 +16,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Add method to inspect contour rejection (which are not in eddies)
 - Grid interp could be "nearest" or "bilinear" 
 ### Changed
-
+- Now to have object informations in plot label used python ```fomat``` style, several key are available : 
+    - "t0"
+    - "t1"
+    - "nb_obs"
+    - "nb_tracks" (only for tracked eddies)
 ### Removed
 
 

examples/02_eddy_identification/pet_display_id.py

@@ -35,8 +35,8 @@
 ax.set_aspect("equal")
 ax.set_xlim(0, 360)
 ax.set_ylim(-80, 80)
-a.display(ax, label="Anticyclonic", color="r", lw=1)
-c.display(ax, label="Cyclonic", color="b", lw=1)
+a.display(ax, label="Anticyclonic ({nb_obs} eddies)", color="r", lw=1)
+c.display(ax, label="Cyclonic ({nb_obs} eddies)", color="b", lw=1)
 ax.legend(loc="upper right")
 
 # %%

examples/02_eddy_identification/pet_eddy_detection.py

@@ -133,8 +133,10 @@ def update_axes(ax, mappable=None):
 # the maximum mean speed. See figure 1 of https://doi.org/10.1175/JTECH-D-14-00019.1
 
 ax = start_axes("Detected Eddies")
-a.display(ax, color="r", linewidth=0.75, label="Anticyclonic", ref=-10)
-c.display(ax, color="b", linewidth=0.75, label="Cyclonic", ref=-10)
+a.display(
+    ax, color="r", linewidth=0.75, label="Anticyclonic ({nb_obs} eddies)", ref=-10
+)
+c.display(ax, color="b", linewidth=0.75, label="Cyclonic ({nb_obs} eddies)", ref=-10)
 ax.legend()
 update_axes(ax)
 

examples/02_eddy_identification/pet_eddy_detection_gulf_stream.py

@@ -143,8 +143,10 @@ def update_axes(ax, mappable=None):
 # maximum mean speed. See figure 1 of https://doi.org/10.1175/JTECH-D-14-00019.1
 
 ax = start_axes("Eddies detected")
-a.display(ax, color="r", linewidth=0.75, label="Anticyclonic", ref=-10)
-c.display(ax, color="b", linewidth=0.75, label="Cyclonic", ref=-10)
+a.display(
+    ax, color="r", linewidth=0.75, label="Anticyclonic ({nb_obs} eddies)", ref=-10
+)
+c.display(ax, color="b", linewidth=0.75, label="Cyclonic ({nb_obs} eddies)", ref=-10)
 ax.legend()
 great_current.display(ax, color="k")
 update_axes(ax)

examples/02_eddy_identification/pet_filter_and_detection.py

@@ -52,8 +52,16 @@ def update_axes(ax, mappable=None):
 # Display the two detections
 ax = start_axes("Eddies detected over ADT")
 m = g.display(ax, "adt", vmin=-0.15, vmax=0.15)
-merge_f.display(ax, lw=0.75, label="Eddies in the filtered grid", ref=-10, color="k")
-merge_t.display(ax, lw=0.75, label="Eddies without filter", ref=-10, color="r")
+merge_f.display(
+    ax,
+    lw=0.75,
+    label="Eddies in the filtered grid ({nb_obs} eddies)",
+    ref=-10,
+    color="k",
+)
+merge_t.display(
+    ax, lw=0.75, label="Eddies without filter ({nb_obs} eddies)", ref=-10, color="r"
+)
 ax.legend()
 update_axes(ax, m)
 

examples/02_eddy_identification/pet_interp_grid_on_dataset.py

@@ -56,8 +56,8 @@ def update_axes(ax, mappable=None):
 # Get mean of eke in each effective contour
 
 ax = start_axes("EKE mean (cm²/s²)")
-a.display(ax, color="r", linewidth=0.5, label="Anticyclonic", ref=-10)
-c.display(ax, color="b", linewidth=0.5, label="Cyclonic", ref=-10)
+a.display(ax, color="r", linewidth=0.5, label="Anticyclonic ({nb_obs} eddies)", ref=-10)
+c.display(ax, color="b", linewidth=0.5, label="Cyclonic ({nb_obs} eddies)", ref=-10)
 eke = a.interp_grid(aviso_map, "eke", method="mean", intern=False)
 a.filled(ax, eke, ref=-10, **eke_kwargs)
 eke = c.interp_grid(aviso_map, "eke", method="mean", intern=False)

examples/02_eddy_identification/pet_sla_and_adt.py

@@ -43,10 +43,14 @@ def update_axes(ax, mappable=None):
 date = datetime(2016, 5, 15)
 
 # %%
-kwargs_a_adt = dict(lw=0.5, label="Anticyclonic ADT", ref=-10, color="k")
-kwargs_c_adt = dict(lw=0.5, label="Cyclonic ADT", ref=-10, color="r")
-kwargs_a_sla = dict(lw=0.5, label="Anticyclonic SLA", ref=-10, color="g")
-kwargs_c_sla = dict(lw=0.5, label="Cyclonic SLA", ref=-10, color="b")
+kwargs_a_adt = dict(
+    lw=0.5, label="Anticyclonic ADT ({nb_obs} eddies)", ref=-10, color="k"
+)
+kwargs_c_adt = dict(lw=0.5, label="Cyclonic ADT ({nb_obs} eddies)", ref=-10, color="r")
+kwargs_a_sla = dict(
+    lw=0.5, label="Anticyclonic SLA ({nb_obs} eddies)", ref=-10, color="g"
+)
+kwargs_c_sla = dict(lw=0.5, label="Cyclonic SLA ({nb_obs} eddies)", ref=-10, color="b")
 
 # %%
 # Run algorithm of detection

examples/08_tracking_manipulation/pet_display_track.py

@@ -36,7 +36,7 @@
 ax = fig.add_axes((0.05, 0.1, 0.9, 0.9))
 ax.set_aspect("equal")
 ax.set_xlim(-6, 36.5), ax.set_ylim(30, 46)
-a.plot(ax, ref=-10, label="Anticyclonic", color="r", lw=0.1)
-c.plot(ax, ref=-10, label="Cyclonic", color="b", lw=0.1)
+a.plot(ax, ref=-10, label="Anticyclonic ({nb_tracks} tracks)", color="r", lw=0.1)
+c.plot(ax, ref=-10, label="Cyclonic ({nb_tracks} tracks)", color="b", lw=0.1)
 ax.legend()
 ax.grid()

examples/08_tracking_manipulation/pet_one_track.py

@@ -36,6 +36,6 @@
 ax.grid()
 eddy.plot(ax, color="r", lw=0.5, label="track")
 eddy.index(range(0, len(eddy), 40)).display(
-    ax, intern_only=True, label="observations every 40"
+    ax, intern_only=True, label="observations every 40 days"
 )
 ax.legend()

examples/08_tracking_manipulation/pet_select_track_across_area.py

@@ -29,8 +29,10 @@
 ax.set_ylim(36, 40)
 ax.set_aspect("equal")
 ax.grid()
-c.plot(ax, color="gray", lw=0.1, ref=-10, label="all tracks")
-c_subset.plot(ax, color="red", lw=0.2, ref=-10, label="selected tracks")
+c.plot(ax, color="gray", lw=0.1, ref=-10, label="All tracks ({nb_tracks} tracks)")
+c_subset.plot(
+    ax, color="red", lw=0.2, ref=-10, label="selected tracks ({nb_tracks} tracks)"
+)
 ax.plot(
     (x0, x0, x1, x1, x0),
     (y0, y1, y1, y0, y0),