Overview

Geostatistical functions describe geospatial association of samples based on their locations. These functions have different properties, which are relevant for specific applications, and are documented in the Variograms, Covariances and Transiograms sections.

Below we list the general properties of all geostatistical functions as well as utilities to properly plot these functions.

Properties

The following properties can be checked about a geostatistical function:

GeoStatsFunctions.isstationary — Method

isstationary(f)

Check if geostatistical function f possesses the 2nd-order stationary property.

source

GeoStatsFunctions.isisotropic — Method

isisotropic(f)

Tells whether or not the geostatistical function f is isotropic.

source

LinearAlgebra.issymmetric — Method

issymmetric(f)

Tell whether or not the geostatistical function f is symmetric.

source

GeoStatsFunctions.isbanded — Method

isbanded(f)

Tells whether or not the geostatistical function f produces a banded matrix.

source

GeoStatsFunctions.metricball — Method

metricball(f)

Return the metric ball of the geostatistical function f.

source

Base.range — Method

range(f)

Return the maximum effective range of the geostatistical function f.

source

GeoStatsFunctions.nvariates — Method

nvariates(f)

Return the number of (co)variates of the geostatistical function f.

source

Plotting

The function funplot/funplot! can be used to plot any geostatistical function, including composite anisotropic models.

GeoStatsFunctions.funplot — Function

funplot(f; [options])

Plot the geostatistical function f with given options.

Common options:

color - color
size - size (line width)
maxlag - maximum lag
labels - variable names

Empirical function options:

pointsize - size of points
showtext - show text counts
textsize - size of text counts
showhist - show histogram
histcolor - color of histogram

Notes

This function will only work in the presence of a Makie.jl backend via package extensions in Julia v1.9 or later versions of the language.

source

GeoStatsFunctions.funplot! — Function

funplot!(fig, f; [options])

Mutating version of [funplot[@ref] where the figure fig is updated with the plot of the geostatistical function f.

See the documentation of funplot for options.

source

Consider the following example with an anisotropic Gaussian variogram:

γ = GaussianVariogram(ranges=(3, 2, 1))

GaussianVariogram
├─ ranges: (3.0 m, 2.0 m, 1.0 m)
├─ rotation: UniformScaling{Bool}(true)
├─ sill: 1.0
└─ nugget: 0.0

funplot(γ)

The function surfplot/surfplot! can be used to plot surfaces of association given a normal direction:

GeoStatsFunctions.surfplot — Function

surfplot(f; [options])

Plot the geostatistical surface f with given options.

Common options

colormap - Color map
maxlag - maximum lag
labels - variable names

Theoretical function options

normal - Normal direction to plane (default to vertical)
nlags - Number of lags (default to 20)
nangs - Number of angles (default to 50)

Notes

This function will only work in the presence of a Makie.jl backend via package extensions in Julia v1.9 or later versions of the language.

source

GeoStatsFunctions.surfplot! — Function

surfplot!(fig, f; [options])

Mutating version of [surfplot[@ref] where the figure fig is updated with the plot of the geostatistical surface f.

See the documentation of surfplot for options.

source

surfplot(γ)