hydrobox.geostat.variogram¶
- hydrobox.geostat.variogram(coordinates, values, estimator='matheron', model='spherical', dist_func='euclidean', bin_func='even', fit_method='trf', fit_sigma=None, use_nugget=False, maxlag=None, n_lags=10, return_type='object', **kwargs)¶
Uses scikit-gstat to estimate a Variogram. Refer to the
Variogram
class to learn about the different Parameters.- Parameters
return_type (str) – Specify how the Variogram instance should be returned. Object will return the actual instance. ‘describe’ is the dictionary output generated by the class, which is serializable. All other options return the different plot types
- Return type
Variogram
- Returns
variogram (skgstat.Variogram) – If the return type is ‘object’
plot (plotly.Figure, matplotlib.pyplot.Figure) – If the return type is one of the plots
description (dict) – If the return type is ‘describe’