ctdcal.ctd_plots.residual_vs_pressure¶
- ctdcal.ctd_plots.residual_vs_pressure(param, ref, prs, stn=None, xlim=(- 0.02, 0.02), ylim=(6000, 0), xlabel='Residual', ylabel='Pressure (dbar)', auto_title=True, grid=False, deep=False, f_out=None)[source]¶
Plot residuals (ref - param) as a function of pressure.
- Parameters
param (pd.Series or array-like) – Input variable
ref (pd.Series or array-like) – Reference variable
prs (pd.Series or array-like) – Pressure variable
stn (pd.Series or array-like, optional) – Station variable
xlim (tuple, optional) – Lower and upper x-limits
ylim (tuple, optional) – Lower and upper y-limits
xlabel (str, optional) – Label for the x-axis
ylabel (str, optional) – Label for the y-axis
auto_title (bool, optional) – Generate title from input attributes (iff dtype is pd.Series)
grid (bool, optional) – Overlay grid on figure
deep (bool, optional) – Whether to plot only values >2000 dbar
f_out (path-like, optional) – Path to save figure
- Returns
ax – Formatted scatter plot (if f_out is not given)
- Return type
matplotlib.axes, optional