glidertools.utils.mask_profile_depth

glidertools.utils.mask_profile_depth(df, mask_depth, above)

Masks either above or below mask_depth. If type(mask_depth)=np.nan, the whole profile will be masked. Warning: This function is for a SINGLE profile only, for masking a complete Glider Dataset please look for utils.mask_above_depth and/or utils.mask_below_depth.

Parameters:
  • df (xarray.Dataframe or pandas.Dataframe)

  • mask_depths (float (for constant depth masking) or pandas.Series as) – returned e.g. by the mixed_layer_depth function

  • above (boolean) – Mask either above mask_depth (True) or below (False)