Add examples

Author: AntSimi

examples/pet_center_count.py

@@ -24,6 +24,6 @@
 g.vars['count'] = g.vars['count'] / (step ** 2 * (t1 - t0))
 m = g.display(ax, name='count', vmin=0, vmax=2)
 ax.grid()
-cb = plt.colorbar(m)
+cb = plt.colorbar(m, cax=fig.add_axes([0.95, 0.05, 0.01, 0.9]))
 cb.set_label('Eddies by 1°^2 by day')
 

examples/pet_display_track.py

@@ -0,0 +1,29 @@
+"""
+Display Tracks
+======================
+
+"""
+
+from matplotlib import pyplot as plt
+from py_eddy_tracker.observations.tracking import TrackEddiesObservations
+import py_eddy_tracker_sample
+
+a = TrackEddiesObservations.load_file(
+    py_eddy_tracker_sample.get_path("eddies_med_adt_allsat_dt2018/Anticyclonic.zarr")
+)
+c = TrackEddiesObservations.load_file(
+    py_eddy_tracker_sample.get_path("eddies_med_adt_allsat_dt2018/Cyclonic.zarr")
+)
+
+a = a.extract_with_length((7 * 20, -1))
+c = c.extract_with_length((7 * 20, -1))
+
+# Plot
+fig = plt.figure(figsize=(15, 8))
+ax = fig.add_subplot(111)
+ax.set_aspect("equal")
+ax.set_xlim(-5, 37)
+ax.set_ylim(30, 46)
+a.plot(ax, ref=-10, label="Anticyclonic", color="b", lw=0.1)
+c.plot(ax, ref=-10, label="Cyclonic", color="r", lw=0.1)
+ax.legend()

examples/pet_histo_amplitude.py renamed to examples/pet_histo.py

@@ -1,5 +1,5 @@
 """
-Amplitude Histogram
+Parameter Histogram
 ===================
 
 """
@@ -22,10 +22,21 @@
 
 fig = plt.figure()
 ax = fig.add_subplot(111)
-bins = arange(0,150,1)
+bins = arange(0,200,1)
 ax.hist(a['radius_s'] / 1000., histtype='step', bins=bins, label='Anticyclonic')
 ax.hist(c['radius_s'] / 1000., histtype='step', bins=bins, label='Cyclonic')
 ax.set_xlabel('Speed_radius (km)')
 ax.set_xlim(0,150)
 ax.legend()
+ax.grid()
+
+fig = plt.figure()
+ax = fig.add_subplot(111)
+bins = arange(0,100,1)
+ax.hist(a['speed_average'] * 100., histtype='step', bins=bins, label='Anticyclonic')
+ax.hist(c['speed_average'] * 100., histtype='step', bins=bins, label='Cyclonic')
+ax.set_xlabel('speed_average (cm/s)')
+
+ax.set_xlim(0,50)
+ax.legend()
 ax.grid()

examples/pet_lifetime.py

@@ -0,0 +1,45 @@
+"""
+Lifetime Histogram
+===================
+
+"""
+from matplotlib import pyplot as plt
+from py_eddy_tracker.observations.tracking import TrackEddiesObservations
+import py_eddy_tracker_sample
+from numpy import arange
+
+a = TrackEddiesObservations.load_file(py_eddy_tracker_sample.get_path("eddies_med_adt_allsat_dt2018/Anticyclonic.zarr"))
+c = TrackEddiesObservations.load_file(py_eddy_tracker_sample.get_path("eddies_med_adt_allsat_dt2018/Cyclonic.zarr"))
+
+# Plot
+fig = plt.figure()
+ax_lifetime = fig.add_axes([0.05, 0.55, .4, .4])
+ax_cum_lifetime = fig.add_axes([0.55, 0.55, .4, .4])
+ax_ratio_lifetime = fig.add_axes([0.05, 0.05, .4, .4])
+ax_ratio_cum_lifetime = fig.add_axes([0.55, 0.05, .4, .4])
+
+
+cum_a, bins, _ = ax_cum_lifetime.hist(a['n'], histtype='step', bins=arange(0,800,1), label='Anticyclonic', color='b')
+cum_c, bins, _ = ax_cum_lifetime.hist(c['n'], histtype='step', bins=arange(0,800,1), label='Cyclonic', color='r')
+
+x = (bins[1:] + bins[:-1]) / 2.
+ax_ratio_cum_lifetime.plot(x, cum_c/cum_a)
+
+nb_a, nb_c = cum_a[:-1] - cum_a[1:], cum_c[:-1] - cum_c[1:]
+ax_lifetime.plot(x[1:], nb_a, label='Anticyclonic', color='b')
+ax_lifetime.plot(x[1:], nb_c, label='Cyclonic', color='r')
+
+ax_ratio_lifetime.plot(x[1:], nb_c / nb_a)
+
+
+for ax in (ax_lifetime, ax_cum_lifetime, ax_ratio_cum_lifetime, ax_ratio_lifetime):
+    ax.set_xlim(0,365)
+    if ax in (ax_lifetime, ax_cum_lifetime):
+        ax.set_ylim(1,None)
+        ax.set_yscale('log')
+        ax.legend()
+    else:
+        ax.set_ylim(0,2)
+        ax.set_ylabel('Ratio Cyclonic/Anticyclonic')
+    ax.set_xlabel('Lifetime (days)')
+    ax.grid()

examples/pet_propagation.py

@@ -0,0 +1,76 @@
+"""
+Propagation Histogram
+===================
+
+"""
+from matplotlib import pyplot as plt
+from py_eddy_tracker.observations.tracking import TrackEddiesObservations
+from py_eddy_tracker.generic import distance
+import py_eddy_tracker_sample
+from numpy import arange, empty
+from numba import njit
+
+
+@njit(cache=True)
+def cum_distance_by_track(distance, track):
+    tr_previous = 0
+    d_cum = 0
+    new_distance = empty(track.shape, dtype=distance.dtype)
+    for i in range(distance.shape[0]):
+        tr = track[i]
+        if i != 0 and tr != tr_previous:
+            d_cum = 0
+        new_distance[i] = d_cum
+        d_cum += distance[i]
+        tr_previous = tr
+    new_distance[i + 1] = d_cum
+    return new_distance
+
+a = TrackEddiesObservations.load_file(
+    py_eddy_tracker_sample.get_path("eddies_med_adt_allsat_dt2018/Anticyclonic.zarr")
+)
+c = TrackEddiesObservations.load_file(
+    py_eddy_tracker_sample.get_path("eddies_med_adt_allsat_dt2018/Cyclonic.zarr")
+)
+d_a = distance(a.longitude[:-1], a.latitude[:-1], a.longitude[1:], a.latitude[1:])
+d_c = distance(c.longitude[:-1], c.latitude[:-1], c.longitude[1:], c.latitude[1:])
+d_a = cum_distance_by_track(d_a, a["track"]) / 1000.
+d_c = cum_distance_by_track(d_c, c["track"]) / 1000.
+
+# Plot
+fig = plt.figure()
+ax_propagation = fig.add_axes([0.05, 0.55, 0.4, 0.4])
+ax_cum_propagation = fig.add_axes([0.55, 0.55, 0.4, 0.4])
+ax_ratio_propagation = fig.add_axes([0.05, 0.05, 0.4, 0.4])
+ax_ratio_cum_propagation = fig.add_axes([0.55, 0.05, 0.4, 0.4])
+
+
+bins = arange(0, 1500, 25)
+cum_a, bins, _ = ax_cum_propagation.hist(
+    d_a, histtype="step", bins=bins, label="Anticyclonic", color="b"
+)
+cum_c, bins, _ = ax_cum_propagation.hist(
+    d_c, histtype="step", bins=bins, label="Cyclonic", color="r"
+)
+
+x = (bins[1:] + bins[:-1]) / 2.0
+ax_ratio_cum_propagation.plot(x, cum_c / cum_a)
+
+nb_a, nb_c = cum_a[:-1] - cum_a[1:], cum_c[:-1] - cum_c[1:]
+ax_propagation.plot(x[1:], nb_a, label="Anticyclonic", color="b")
+ax_propagation.plot(x[1:], nb_c, label="Cyclonic", color="r")
+
+ax_ratio_propagation.plot(x[1:], nb_c / nb_a)
+
+
+for ax in (ax_propagation, ax_cum_propagation, ax_ratio_cum_propagation, ax_ratio_propagation):
+    ax.set_xlim(0, 1000)
+    if ax in (ax_propagation, ax_cum_propagation):
+        ax.set_ylim(1, None)
+        ax.set_yscale("log")
+        ax.legend()
+    else:
+        ax.set_ylim(0, 2)
+        ax.set_ylabel("Ratio Cyclonic/Anticyclonic")
+    ax.set_xlabel("Propagation (km)")
+    ax.grid()

src/py_eddy_tracker/generic.py

@@ -272,7 +272,7 @@ def split_line(x, y, i):
 
     Returns: x and y separate by nan at each i jump
     """
-    nb_jump = len(where(i[1:] - i[0] != 0)[0])
+    nb_jump = len(where(i[1:] - i[:-1] != 0)[0])
     nb_value = x.shape[0]
     final_size = (nb_jump - 1) + nb_value
     new_x = empty(final_size, dtype=x.dtype)

src/py_eddy_tracker/observations/tracking.py

@@ -355,9 +355,10 @@ def __extract_with_mask(
     def plot(self, ax, ref=None, ** kwargs):
         if "label" in kwargs:
             kwargs["label"] += " (%s eddies)" % (self.nb_obs_by_track != 0).sum()
-        x, y = split_line(self.longitude, self.latitude, self.tracks)
+        x = self.longitude
         if ref is not None:
             x = (x - ref) % 360 + ref
+        x, y = split_line(x, self.latitude, self.tracks)
         return ax.plot(x, y, **kwargs)