[FEAT] Add plot that shows the max depth of each profile

glidertest/plots.py

@@ -1305,3 +1305,43 @@ def plot_ioosqc(data, suspect_threshold=[25], fail_threshold=[50], title='', ax=
         if force_plot:
             plt.show()
     return fig, ax
+
+def plot_max_depth_per_profile(ds: xr.Dataset, bins= 20, ax = None, **kw: dict) -> tuple({plt.Figure, plt.Axes}):
+    """
+    This function can be used to plot the maximum depth of each profile in a dataset.
+
+    Parameters
+    ----------
+    ds: xarray on OG1 format containing the profile number and the maximum depth. 
+    bins: int, optional (default=20)
+
+    Returns
+    -------
+    One figure with two plots illustrating the max depth of each profile and a histogram of the max depths
+
+    Original author
+    ----------------
+    Till Moritz
+    """
+    max_depths = tools.max_depth_per_profile(ds)
+    profile_nums = max_depths.profile_num
+    with plt.style.context(glidertest_style_file):
+        if ax is None:  
+            fig, ax = plt.subplots(1, 2)  
+            force_plot = True
+        else:
+            fig = plt.gcf()
+            force_plot = False
+
+        ax[0].plot(profile_nums, max_depths,**kw)
+        ax[0].set_xlabel('Profile number')
+        ax[0].set_ylabel(f'Max depth ({max_depths.units})')
+        ax[0].set_title('Max depth per profile')
+        ax[1].hist(max_depths, bins=bins)
+        ax[1].set_xlabel(f'Max depth ({max_depths.units})')
+        ax[1].set_ylabel('Number of profiles')
+        ax[1].set_title('Histogram of max depth per profile')
+        [a.grid() for a in ax]
+        if force_plot:
+            plt.show()
+    return fig, ax

glidertest/tools.py

@@ -480,3 +480,25 @@ def compute_global_range(ds: xr.Dataset, var='DOXY', min_val=-5, max_val=600):
     out_range = ds[var].where((ds[var]<min_val )| (ds[var]>max_val ))
     return out_range.dropna(dim='N_MEASUREMENTS')
 
+def max_depth_per_profile(ds: xr.Dataset):
+    """
+    This function computes the maximum depth for each profile in the dataset
+
+    Parameters
+    ----------
+    ds: xarray on OG1 format containing at least depth and profile_number. Data
+    should not be gridded.
+
+    Returns
+    -------
+    max_depths: pandas dataframe containing the profile number and the maximum depth of that profile
+
+    Original author
+    ----------------
+    Till Moritz
+    """
+    max_depths = ds.groupby('profile_num').apply(lambda x: x['DEPTH'].max())
+    ### add the unit to the dataarray
+    max_depths.attrs['units'] = ds['DEPTH'].attrs['units']
+    return max_depths
+