ILNumerics Ultimate VS

KrigingInterpolatorSingle Constructor

ILNumerics Ultimate VS Documentation
ILNumerics - Technical Application Development
Create a Kriging interpolator

[ILNumerics Interpolation Toolbox]

Namespace:  ILNumerics.Toolboxes
Assembly:  ILNumerics.Toolboxes.Interpolation (in ILNumerics.Toolboxes.Interpolation.dll) Version: 5.5.0.0 (5.5.7503.3146)
Syntax

public KrigingInterpolatorSingle(
	InArray<float> Y,
	InArray<float> X,
	Func<InArray<float>, RetArray<float>> variogram = null,
	InArray<float> errors = null,
	bool doChecks = true,
	Nullable<float> alpha = null,
	Nullable<float> beta = null
)

Parameters

Y
Type: ILNumericsInArraySingle
Data values, matrix with measured values at the n data points specified by X. Size [k x n].
X
Type: ILNumericsInArraySingle
Data points, matrix with sample locations of dimension m in n columns. At least 2 samples must be provided.
variogram (Optional)
Type: SystemFuncInArraySingle, RetArraySingle
[Optional] Variogram function of the euclidian distances. Default: PowerLawVariogram(InArraySingle)
errors (Optional)
Type: ILNumericsInArraySingle
[Optional] (this paramter is currently ignored)
doChecks (Optional)
Type: SystemBoolean
[Optional] True: check the distances between points provided in X for too small values (default). False: do not perform these checks (and save some computations).
alpha (Optional)
Type: SystemNullableSingle
[Optional] Default alpha factor for the default Power variogramm. Ignored, if a custom variogramm was specified. Default: auto computed.
beta (Optional)
Type: SystemNullableSingle
[Optional] Default beta exponent for the default Power variogramm. Ignored, if a custom variogramm was specified. Range: [0 ...). Default: 1.5.
Exceptions

ExceptionCondition
ArgumentException is thrown if either of X or Y are null or do not have matching sizes.
ArgumentException if errors is not null but also not a vector of lenght X.S[1].
ArgumentException if too few points are provided or all provided points X are too close to each other so that no reliable interpolation can be performed.
Remarks

The optional parameter doChecks is used to prevent the kriging interpolator from instability effects caused by disadvantageous positions X. If points in X are too close to each other, the resulting distance matrix (and its inversion later on) might cause singularity problems. Therefore and if doChecks is true checks are automatically made for that and potential redundant values are removed from the data set.

[ILNumerics Interpolation Toolbox]

See Also

Reference