krigekit.variogram_structure_st#

The complete theoretical space-time variogram for one variable pair.

A VgmStructureST is the space-time analogue of VgmStructure: it owns the theoretical coupling model and nothing else – no observations, empirical clouds, or fit state. It mirrors the Fortran vgm_struct_st layout, holding a spatial structure (cs) and a temporal structure (ct) plus the coupling parameters of either a product-sum or a sum-metric model. The analysis wrapper krigekit.SpaceTimeVariogramModel fits empirical clouds and writes the result into one of these objects.

Classes#

VgmStructureST

Theoretical space-time variogram: spatial/temporal structures + coupling.

Module Contents#

class krigekit.variogram_structure_st.VgmStructureST(spatial=None, temporal=None, *, name=None)#

Theoretical space-time variogram: spatial/temporal structures + coupling.

The active coupling form is named by model ("product_sum" or "sum_metric"). Use set_product_sum() or set_sum_metric() to populate it, then calc_variogram() to evaluate and to_kriging_specs() to emit engine-ready dictionaries.

Create an empty structure or wrap existing marginal structures.

property cs#: Alias for the spatial structure, matching vgm_struct_st%cs.

property ct#: Alias for the temporal structure, matching vgm_struct_st%ct.

property ncomponent_spatial#: Number of nested spatial components.

property ncomponent_temporal#: Number of nested temporal components.

copy()#: Return an independent copy of this structure and its parameters.

set_product_sum(params, *, spatial_vtype, temporal_vtype, anisotropy=None)#

Populate a product-sum coupling and rebuild cs/ct.

params is (a, b, p, spatial_range, temporal_range) with unit-sill marginals; a valid covariance conversion requires p <= 0, a + p > 0 and b + p > 0. cs/ct are rebuilt as single-component structures whose sills are a + p and b + p.

set_sum_metric(spatial, temporal, params, *, transform, time_nugget=0.0, time_sill=1.0)#

Populate a sum-metric coupling from fitted marginal structures.

spatial and temporal are VgmStructure marginal shapes, and params is (spatial_scale, temporal_scale, *joint_sills, at) with one joint sill per spatial component.

validate()#: Validate the active coupling parameters and return self.

calc_variogram(spatial_lag, temporal_lag)#: Evaluate the active space-time semivariogram at lag arrays.

to_kriging_specs(**kwargs)#: Return engine-ready specs for the active coupling model.