Skip to content

ImplicitModel

Implicit scalar field fitted to samples, boundary picks and structural readings; its level sets are geological surfaces.

Parameters:

Name Type Description Default
engine (rbf, kriging, gp)

Radial basis functions, dual kriging with derivative data, or a sparse variational Gaussian process.

 "rbf"
kernel (biharmonic, triharmonic, thin - plate)

RBF kernel; planes and lineations need triharmonic.

 "biharmonic"
variogram Variogram

Required by engine="kriging".

 required
degree int

0 constant, 1 linear drift.

 required
smoothing float

RBF ridge relative to the value scale; 0 interpolates exactly.

 required
rotation tuple of float

Azimuth, dip, rake of the anisotropy axes. With engine="gp" the ranges along them are learned; engine="kriging" takes its anisotropy from the variogram.

 required
ratios tuple of float

Semi-major/major and minor/major range ratios for engine="rbf".

 required

report property 

report

Fit diagnostics of engine="gp", else None.

fit method descriptor 

fit(
    coords=None,
    values=None,
    *,
    cutoff=None,
    boundaries=None,
    planes=None,
    lineations=None,
)

Parameters:

Name Type Description Default
coords array_like

Samples and their field values, e.g. +1 inside, -1 outside.

 None
values array_like

Samples and their field values, e.g. +1 inside, -1 outside.

 None
cutoff float

Take values as grades coded +1 at or above cutoff and -1 below, so the shell is the zero level.

 None
boundaries array_like

(m, 3) points on the surface, pinned to field value 0.

 None
planes array_like

(k, 5) rows x, y, z, dip, dip_direction; the field is flat along each plane.

 None
lineations array_like

(k, 5) rows x, y, z, plunge, trend; the field is flat along each line.

 None

from_parquet staticmethod 

from_parquet(path)

Reads to_parquet output; raises InvalidInput on another class's file or a newer format.

isosurface method descriptor 

isosurface(model, *, isovalue=0.0, closed=False)

Mesh of the isovalue surface, the field sampled at the block centroids of model. Blocks a masked model leaves out are outside the solid. closed caps the solid where the field exceeds isovalue on the block model's outer faces and at the edge of its mask.

predict method descriptor 

predict(targets, *, gradient=False, variance=False)

Field values at targets, with (n, 3) gradients when gradient, or the predictive variance of engine="gp" when variance.

to_parquet method descriptor 

to_parquet(path)

Writes the fit inputs as Parquet columns and parameters as JSON in the file metadata; from_parquet refits them to the same field.

used in