KrigingParameters

GitHub source

KrigingParameters

evo.compute.tasks.geostatistics.kriging.KrigingParameters

Parameters for the kriging task.

Defines all inputs needed to run a kriging interpolation task.

Example: >>> from evo.compute.tasks import run, SearchNeighborhood, Ellipsoid, EllipsoidRanges >>> from evo.compute.tasks.geostatistics.kriging import KrigingParameters >>> from evo.compute.tasks.common import Filter, FilterCondition >>> >>> params = KrigingParameters( ... source=pointset.attributes["grade"], # Source attribute ... target=block_model.attributes["kriged_grade"], # Target attribute (creates if doesn't exist) ... variogram=variogram, # Variogram model ... search=SearchNeighborhood( ... ellipsoid=Ellipsoid(ranges=EllipsoidRanges(200, 150, 100)), ... max_samples=20, ... ), ... # method defaults to ordinary kriging ... ) >>> >>> # With a target filter to restrict kriging to specific categories on the target: >>> params_filtered = KrigingParameters( ... source=pointset.attributes["grade"], ... target=block_model.attributes["kriged_grade"], ... variogram=variogram, ... search=SearchNeighborhood(...), ... target_filter=Filter( ... where=FilterCondition( ... attribute=block_model.attributes["domain"], ... operator="in", ... values=["LMS1", "LMS2"], ... ), ... ), ... ) >>> >>> # With diagnostics written alongside the estimate: >>> params_with_diagnostics = KrigingParameters( ... source=pointset.attributes["grade"], ... target=block_model.attributes["kriged_grade"], ... variogram=variogram, ... search=SearchNeighborhood(...), ... diagnostics=KrigingDiagnostics(kriging_variance=True, num_samples=True), ... )

source

source: AnySourceAttribute

The source object and attribute containing known values.

target

target: AnyTargetAttribute

The target object and attribute to create or update with kriging results.

variogram

variogram: GeoscienceObjectReference

Model of the covariance within the domain (Variogram object or reference).

search

search: SearchNeighborhood = Field(alias='neighborhood')

Search neighborhood parameters.

method

method: SimpleKriging | OrdinaryKriging = Field(default_factory=OrdinaryKriging, alias='kriging_method')

The kriging method to use. Defaults to ordinary kriging if not specified.

source_filter

source_filter: Filter | None = Field(None, exclude=True)

Optional filter to restrict kriging to a subset of the source data.

target_filter

target_filter: Filter | None = Field(None, exclude=True)

Optional filter to restrict kriging to a subset of the target object.

block_discretisation

block_discretisation: BlockDiscretisation | None = None

Optional sub-block discretisation for block kriging.

When provided, each target block is subdivided into nx × ny × nz sub-cells and the kriged value is averaged across these sub-cells. When omitted, point kriging is performed. Only applicable when the target is a 3D grid or block model.

diagnostics

diagnostics: KrigingDiagnostics | None = Field(None, exclude=True)

Optional diagnostics to write onto the target object alongside the estimate.

Only the diagnostics you select are computed. See :class:KrigingDiagnostics for the available outputs and the shorthands each of them accepts.