xdem.spatialstats.plot_variogram

Contents

xdem.spatialstats.plot_variogram#

xdem.spatialstats.plot_variogram(df, list_fit_fun=None, list_fit_fun_label=None, ax=None, xscale='linear', xscale_range_split=None, xlabel=None, ylabel=None, xlim=None, ylim=None, out_fname=None)[source]#

Plot empirical variogram, and optionally also plot one or several model fits. Input dataframe is expected to be the output of xdem.spatialstats.sample_empirical_variogram. Input function model is expected to be the output of xdem.spatialstats.fit_sum_model_variogram.

Parameters:
  • df (DataFrame) – Empirical variogram, formatted as a dataframe with count (pairwise sample count), lags (upper bound of spatial lag bin), exp (experimental variance), and err_exp (error on experimental variance)

  • list_fit_fun (list[Callable[[ndarray[Any, dtype[floating[Any]]]], ndarray[Any, dtype[floating[Any]]]]]) – List of model function fits

  • list_fit_fun_label (list[str]) – List of model function fits labels

  • ax (Axes) – Plotting ax to use, creates a new one by default

  • xscale (str) – Scale of X-axis

  • xscale_range_split (list[float]) – List of ranges at which to split the figure

  • xlabel (str) – Label of X-axis

  • ylabel (str) – Label of Y-axis

  • xlim (str) – Limits of X-axis

  • ylim (str) – Limits of Y-axis

  • out_fname (str) – File to save the variogram plot to

Return type:

None

Returns: