Skip to content

variogram_volume builtin

variogram_volume(
    coords,
    values,
    lag,
    max_lag,
    *,
    tolerance=20.0,
    directions=200,
    model="spherical",
    estimator="matheron",
)

Experimental variogram over a cube of lag vectors, and its principal axes of continuity.

Pairs are binned by lag vector into cubic cells of side lag out to max_lag on each axis. The axes are read over directions near-uniform directions: model is fitted to the omnidirectional variogram, and in each direction the lag where γ reaches the nugget plus half the sill traces an ellipsoid, whose axes give the rotation and ratios. One structure fitted to every direction's variogram, stretched onto the major axis, sets the major range.

Parameters:

Name Type Description Default
coords (array_like, PointSet or BlockModel)

(n, 3) sample coordinates, or a container holding values.

required
values array_like or str

Values, or a column name of coords.

required
lag float

Cell size of the lag grid and lag width of each direction's variogram.

required
max_lag float

Half-extent of the lag grid and longest lag read; at most 25 lags.

required
tolerance float

Half-angle of the cone about each direction, in degrees.

20.0
directions int

Directions read over the half-sphere; at least 9.

200
model str

Structure fitted to the variograms.

"spherical"
estimator str

As in experimental_variogram.

"matheron"

Returns:

Type Description
VariogramVolume

The cube and the principal axes; rotation and ratios go straight into Variogram.

used in