SAGA-GIS Tool Library Documentation (v7.3.0)

Tool Inverse Distance Weighted (3D)

Inverse distance weighted interpolation for 3-dimensional data points. Output will be a grid collection with evenly spaced Z-levels representing the 3rd dimension.

Parameters

 NameTypeIdentifierDescriptionConstraints
InputPointsShapes (input)POINTS--
Target System (*)Grid (optional input)TARGET_TEMPLATEuse this grid's system for output grids-
OutputGrid CollectionGrids (output)GRIDS--
OptionsZTable fieldZ_FIELD--
Z FactorFloating pointZ_SCALE-Default: 1.000000
ValueTable fieldV_FIELD--
Target Grid SystemChoiceTARGET_DEFINITION-Available Choices:
[0] user defined
[1] grid or grid system
Default: 0
CellsizeFloating pointTARGET_USER_SIZE-Minimum: 0.000000
Default: 1.000000
WestFloating pointTARGET_USER_XMIN-Default: 0.000000
EastFloating pointTARGET_USER_XMAX-Default: 100.000000
SouthFloating pointTARGET_USER_YMIN-Default: 0.000000
NorthFloating pointTARGET_USER_YMAX-Default: 100.000000
ColumnsIntegerTARGET_USER_COLSNumber of cells in East-West direction.Minimum: 1
Default: 100
RowsIntegerTARGET_USER_ROWSNumber of cells in North-South direction.Minimum: 1
Default: 100
FitChoiceTARGET_USER_FITS-Available Choices:
[0] nodes
[1] cells
Default: 0
Grid SystemGrid systemTARGET_SYSTEM--
CellsizeFloating pointTARGET_USER_ZSIZE-Minimum: 0.000000
Default: 1.000000
BottomFloating pointTARGET_USER_ZMIN-Default: 0.000000
TopFloating pointTARGET_USER_ZMAX-Default: 100.000000
LevelsIntegerTARGET_USER_ZNUM-Minimum: 1
Default: 100
Search RangeChoiceSEARCH_RANGE-Available Choices:
[0] local
[1] global
Default: 1
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: 1
MinimumIntegerSEARCH_POINTS_MINminimum number of points to useMinimum: 1
Default: 1
MaximumIntegerSEARCH_POINTS_MAXmaximum number of nearest pointsMinimum: 1
Default: 20
Weighting FunctionChoiceDW_WEIGHTING-Available Choices:
[0] no distance weighting
[1] inverse distance to a power
[2] exponential
[3] gaussian weighting
Default: 1
Inverse Distance Weighting PowerFloating pointDW_IDW_POWER-Minimum: 0.000000
Default: 2.000000
Inverse Distance OffsetBooleanDW_IDW_OFFSETCalculates weights for distance plus one, avoiding division by zero for zero distancesDefault: 0
Gaussian and Exponential Weighting BandwidthFloating pointDW_BANDWIDTH-Minimum: 0.000000
Default: 1.000000
(*) optional

Command-line

Usage: saga_cmd grids_tools 6 [-POINTS <str>] [-Z_FIELD <str>] [-Z_SCALE <double>] [-V_FIELD <str>] [-TARGET_DEFINITION <str>] [-TARGET_USER_SIZE <double>] [-TARGET_USER_XMIN <double>] [-TARGET_USER_XMAX <double>] [-TARGET_USER_YMIN <double>] [-TARGET_USER_YMAX <double>] [-TARGET_USER_COLS <num>] [-TARGET_USER_ROWS <num>] [-TARGET_USER_FITS <str>] [-TARGET_TEMPLATE <str>] [-GRIDS <str>] [-TARGET_USER_ZSIZE <double>] [-TARGET_USER_ZMIN <double>] [-TARGET_USER_ZMAX <double>] [-TARGET_USER_ZNUM <num>] [-SEARCH_RANGE <str>] [-SEARCH_RADIUS <double>] [-SEARCH_POINTS_ALL <str>] [-SEARCH_POINTS_MIN <num>] [-SEARCH_POINTS_MAX <num>] [-DW_WEIGHTING <str>] [-DW_IDW_POWER <double>] [-DW_IDW_OFFSET <str>] [-DW_BANDWIDTH <double>]
  -POINTS:<str>              	Points
	Shapes (input)
  -Z_FIELD:<str>             	Z
	Table field
  -Z_SCALE:<double>          	Z Factor
	Floating point
	Default: 1.000000
  -V_FIELD:<str>             	Value
	Table field
  -TARGET_DEFINITION:<str>   	Target Grid System
	Choice
	Available Choices:
	[0] user defined
	[1] grid or grid system
	Default: 0
  -TARGET_USER_SIZE:<double> 	Cellsize
	Floating point
	Minimum: 0.000000
	Default: 1.000000
  -TARGET_USER_XMIN:<double> 	West
	Floating point
	Default: 0.000000
  -TARGET_USER_XMAX:<double> 	East
	Floating point
	Default: 100.000000
  -TARGET_USER_YMIN:<double> 	South
	Floating point
	Default: 0.000000
  -TARGET_USER_YMAX:<double> 	North
	Floating point
	Default: 100.000000
  -TARGET_USER_COLS:<num>    	Columns
	Integer
	Minimum: 1
	Default: 100
  -TARGET_USER_ROWS:<num>    	Rows
	Integer
	Minimum: 1
	Default: 100
  -TARGET_USER_FITS:<str>    	Fit
	Choice
	Available Choices:
	[0] nodes
	[1] cells
	Default: 0
  -TARGET_TEMPLATE:<str>     	Target System
	Grid (optional input)
  -GRIDS:<str>               	Grid Collection
	Grids (output)
  -TARGET_USER_ZSIZE:<double>	Cellsize
	Floating point
	Minimum: 0.000000
	Default: 1.000000
  -TARGET_USER_ZMIN:<double> 	Bottom
	Floating point
	Default: 0.000000
  -TARGET_USER_ZMAX:<double> 	Top
	Floating point
	Default: 100.000000
  -TARGET_USER_ZNUM:<num>    	Levels
	Integer
	Minimum: 1
	Default: 100
  -SEARCH_RANGE:<str>        	Search Range
	Choice
	Available Choices:
	[0] local
	[1] global
	Default: 1
  -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: 1
  -SEARCH_POINTS_MIN:<num>   	Minimum
	Integer
	Minimum: 1
	Default: 1
  -SEARCH_POINTS_MAX:<num>   	Maximum
	Integer
	Minimum: 1
	Default: 20
  -DW_WEIGHTING:<str>        	Weighting Function
	Choice
	Available Choices:
	[0] no distance weighting
	[1] inverse distance to a power
	[2] exponential
	[3] gaussian weighting
	Default: 1
  -DW_IDW_POWER:<double>     	Inverse Distance Weighting Power
	Floating point
	Minimum: 0.000000
	Default: 2.000000
  -DW_IDW_OFFSET:<str>       	Inverse Distance Offset
	Boolean
	Default: 0
  -DW_BANDWIDTH:<double>     	Gaussian and Exponential Weighting Bandwidth
	Floating point
	Minimum: 0.000000
	Default: 1.000000