SAGA-GIS Module Library Documentation (v2.3.0)

Module Regression Kriging

Regression Kriging for grid interpolation from irregular sample points.

Parameters

 NameTypeIdentifierDescriptionConstraints
InputPointsShapes (input)POINTS--
PredictorsGrid list (input)PREDICTORS--
OutputRegressionGrid (output)REGRESSIONregression model applied to predictor grids-
PredictionGrid (output)PREDICTION--
Residuals (*)Grid (optional output)RESIDUALS--
Quality Measure (*)Grid (optional output)VARIANCE--
Regression: Coefficients (*)Table (optional output)INFO_COEFF--
Regression: Model (*)Table (optional output)INFO_MODEL--
Regression: Steps (*)Table (optional output)INFO_STEPS--
OptionsGrid systemGrid systemPARAMETERS_GRID_SYSTEMGrid system-
AttributeTable fieldFIELD--
Type of Quality MeasureChoiceTQUALITY-Available Choices:
[0] standard deviation
[1] variance
Default: 0
Logarithmic TransformationBooleanLOG-Default: 0
Block KrigingBooleanBLOCK-Default: 0
Block SizeFloating pointDBLOCK-Minimum: 0.000000
Default: 100.000000
Maximum DistanceFloating pointVAR_MAXDISTmaximum distance for variogram estimationDefault: -1.000000
Lag Distance ClassesIntegerVAR_NCLASSESinitial number of lag distance classes for variogram estimationMinimum: 1
Default: 100
SkipIntegerVAR_NSKIP-Minimum: 1
Default: 1
Variogram ModelTextVAR_MODEL-Default: a + b * x
Include X CoordinateBooleanCOORD_X-Default: 0
Include Y CoordinateBooleanCOORD_Y-Default: 0
InterceptBooleanINTERCEPT-Default: 1
MethodChoiceMETHOD-Available Choices:
[0] include all
[1] forward
[2] backward
[3] stepwise
Default: 3
Significance LevelFloating pointP_VALUESignificance level (aka p-value) as threshold for automated predictor selection, given as percentageMinimum: 0.000000
Maximum: 100.000000
Default: 5.000000
ResamplingChoiceRESAMPLING-Available Choices:
[0] Nearest Neighbour
[1] Bilinear Interpolation
[2] Bicubic Spline Interpolation
[3] B-Spline Interpolation
Default: 3
Search RangeChoiceSEARCH_RANGE-Available Choices:
[0] local
[1] global
Default: 0
Maximum Search DistanceFloating pointSEARCH_RADIUSlocal maximum search distance given in map unitsMinimum: 0.000000
Default: 1000.000000
Number of PointsChoiceSEARCH_POINTS_ALL-Available Choices:
[0] maximum number of nearest points
[1] all points within search distance
Default: 0
MinimumIntegerSEARCH_POINTS_MINminimum number of points to useMinimum: 1
Default: 16
MaximumIntegerSEARCH_POINTS_MAXmaximum number of nearest pointsMinimum: 1
Default: 20
DirectionChoiceSEARCH_DIRECTION-Available Choices:
[0] all directions
[1] quadrants
Default: 0
(*) optional

Command-line

Usage: saga_cmd statistics_kriging 3 [-POINTS <str>] [-FIELD <str>] [-PREDICTORS <str>] [-REGRESSION <str>] [-PREDICTION <str>] [-RESIDUALS <str>] [-VARIANCE <str>] [-TQUALITY <str>] [-LOG <str>] [-BLOCK <str>] [-DBLOCK <double>] [-VAR_MAXDIST <double>] [-VAR_NCLASSES <num>] [-VAR_NSKIP <num>] [-VAR_MODEL <str>] [-INFO_COEFF <str>] [-INFO_MODEL <str>] [-INFO_STEPS <str>] [-COORD_X <str>] [-COORD_Y <str>] [-INTERCEPT <str>] [-METHOD <str>] [-P_VALUE <double>] [-RESAMPLING <str>] [-SEARCH_RANGE <str>] [-SEARCH_RADIUS <double>] [-SEARCH_POINTS_ALL <str>] [-SEARCH_POINTS_MIN <num>] [-SEARCH_POINTS_MAX <num>] [-SEARCH_DIRECTION <str>]
  -POINTS:<str>           	Points
	Shapes (input)
  -FIELD:<str>            	Attribute
	Table field
  -PREDICTORS:<str>       	Predictors
	Grid list (input)
  -REGRESSION:<str>       	Regression
	Grid (output)
  -PREDICTION:<str>       	Prediction
	Grid (output)
  -RESIDUALS:<str>        	Residuals
	Grid (optional output)
  -VARIANCE:<str>         	Quality Measure
	Grid (optional output)
  -TQUALITY:<str>         	Type of Quality Measure
	Choice
	Available Choices:
	[0] standard deviation
	[1] variance
	Default: 0
  -LOG:<str>              	Logarithmic Transformation
	Boolean
	Default: 0
  -BLOCK:<str>            	Block Kriging
	Boolean
	Default: 0
  -DBLOCK:<double>        	Block Size
	Floating point
	Minimum: 0.000000
	Default: 100.000000
  -VAR_MAXDIST:<double>   	Maximum Distance
	Floating point
	Default: -1.000000
  -VAR_NCLASSES:<num>     	Lag Distance Classes
	Integer
	Minimum: 1
	Default: 100
  -VAR_NSKIP:<num>        	Skip
	Integer
	Minimum: 1
	Default: 1
  -VAR_MODEL:<str>        	Variogram Model
	Text
	Default: a + b * x
  -INFO_COEFF:<str>       	Regression: Coefficients
	Table (optional output)
  -INFO_MODEL:<str>       	Regression: Model
	Table (optional output)
  -INFO_STEPS:<str>       	Regression: Steps
	Table (optional output)
  -COORD_X:<str>          	Include X Coordinate
	Boolean
	Default: 0
  -COORD_Y:<str>          	Include Y Coordinate
	Boolean
	Default: 0
  -INTERCEPT:<str>        	Intercept
	Boolean
	Default: 1
  -METHOD:<str>           	Method
	Choice
	Available Choices:
	[0] include all
	[1] forward
	[2] backward
	[3] stepwise
	Default: 3
  -P_VALUE:<double>       	Significance Level
	Floating point
	Minimum: 0.000000
	Maximum: 100.000000
	Default: 5.000000
  -RESAMPLING:<str>       	Resampling
	Choice
	Available Choices:
	[0] Nearest Neighbour
	[1] Bilinear Interpolation
	[2] Bicubic Spline Interpolation
	[3] B-Spline Interpolation
	Default: 3
  -SEARCH_RANGE:<str>     	Search Range
	Choice
	Available Choices:
	[0] local
	[1] global
	Default: 0
  -SEARCH_RADIUS:<double> 	Maximum Search Distance
	Floating point
	Minimum: 0.000000
	Default: 1000.000000
  -SEARCH_POINTS_ALL:<str>	Number of Points
	Choice
	Available Choices:
	[0] maximum number of nearest points
	[1] all points within search distance
	Default: 0
  -SEARCH_POINTS_MIN:<num>	Minimum
	Integer
	Minimum: 1
	Default: 16
  -SEARCH_POINTS_MAX:<num>	Maximum
	Integer
	Minimum: 1
	Default: 20
  -SEARCH_DIRECTION:<str> 	Direction
	Choice
	Available Choices:
	[0] all directions
	[1] quadrants
	Default: 0