SAGA-GIS Tool Library Documentation (v7.8.2)

Tool Focal Statistics

Based on its neighbourhood this tool calculates for each grid cell various statistical measures. According to Wilson & Gallant (2000) this tool was named 'Residual Analysis (Grid)' in earlier versions.


References


Parameters

 NameTypeIdentifierDescriptionConstraints
InputGridGrid, inputGRID--
OutputMean Value (*)Grid, output, optionalMEAN--
Minimum Value (*)Grid, output, optionalMIN--
Maximum Value (*)Grid, output, optionalMAX--
Value Range (*)Grid, output, optionalRANGE--
Standard Deviation (*)Grid, output, optionalSTDDEV--
Variance (*)Grid, output, optionalVARIANCE--
Sum (*)Grid, output, optionalSUM--
Difference from Mean Value (*)Grid, output, optionalDIFF--
Deviation from Mean Value (*)Grid, output, optionalDEVMEAN--
Percentile (*)Grid, output, optionalPERCENT--
Median (*)Grid, output, optionalMEDIAN--
Minority (*)Grid, output, optionalMINORITY--
Majority (*)Grid, output, optionalMAJORITY--
OptionsGrid SystemGrid systemPARAMETERS_GRID_SYSTEM--
Include Center CellBooleanBCENTER-Default: 1
Kernel TypeChoiceKERNEL_TYPEThe kernel's shape.Available Choices:
[0] Square
[1] Circle
[2] Annulus
[3] Sector
Default: 1
Inner RadiusIntegerKERNEL_INNERcellsMinimum: 0
Default: 0
RadiusIntegerKERNEL_RADIUScellsMinimum: 0
Default: 2
DirectionFloating pointKERNEL_DIRECTIONdegreeMinimum: -360.000000
Maximum: 360.000000
Default: 0.000000
ToleranceFloating pointKERNEL_TOLERANCEdegreeMinimum: 0.000000
Maximum: 180.000000
Default: 5.000000
Weighting FunctionChoiceDW_WEIGHTING-Available Choices:
[0] no distance weighting
[1] inverse distance to a power
[2] exponential
[3] gaussian
Default: 0
PowerFloating pointDW_IDW_POWER-Minimum: 0.000000
Default: 2.000000
BandwidthFloating pointDW_BANDWIDTHBandwidth for exponential and Gaussian weightingMinimum: 0.000000
Default: 1.000000
(*) optional

Command-line

Usage: saga_cmd statistics_grid 1 [-GRID <str>] [-MEAN <str>] [-MIN <str>] [-MAX <str>] [-RANGE <str>] [-STDDEV <str>] [-VARIANCE <str>] [-SUM <str>] [-DIFF <str>] [-DEVMEAN <str>] [-PERCENT <str>] [-MEDIAN <str>] [-MINORITY <str>] [-MAJORITY <str>] [-BCENTER <str>] [-KERNEL_TYPE <str>] [-KERNEL_INNER <num>] [-KERNEL_RADIUS <num>] [-KERNEL_DIRECTION <double>] [-KERNEL_TOLERANCE <double>] [-DW_WEIGHTING <str>] [-DW_IDW_POWER <double>] [-DW_BANDWIDTH <double>]
  -GRID:<str>               	Grid
	Grid, input
  -MEAN:<str>               	Mean Value
	Grid, output, optional
  -MIN:<str>                	Minimum Value
	Grid, output, optional
  -MAX:<str>                	Maximum Value
	Grid, output, optional
  -RANGE:<str>              	Value Range
	Grid, output, optional
  -STDDEV:<str>             	Standard Deviation
	Grid, output, optional
  -VARIANCE:<str>           	Variance
	Grid, output, optional
  -SUM:<str>                	Sum
	Grid, output, optional
  -DIFF:<str>               	Difference from Mean Value
	Grid, output, optional
  -DEVMEAN:<str>            	Deviation from Mean Value
	Grid, output, optional
  -PERCENT:<str>            	Percentile
	Grid, output, optional
  -MEDIAN:<str>             	Median
	Grid, output, optional
  -MINORITY:<str>           	Minority
	Grid, output, optional
  -MAJORITY:<str>           	Majority
	Grid, output, optional
  -BCENTER:<str>            	Include Center Cell
	Boolean
	Default: 1
  -KERNEL_TYPE:<str>        	Kernel Type
	Choice
	Available Choices:
	[0] Square
	[1] Circle
	[2] Annulus
	[3] Sector
	Default: 1
  -KERNEL_INNER:<num>       	Inner Radius
	Integer
	Minimum: 0
	Default: 0
  -KERNEL_RADIUS:<num>      	Radius
	Integer
	Minimum: 0
	Default: 2
  -KERNEL_DIRECTION:<double>	Direction
	Floating point
	Minimum: -360.000000
	Maximum: 360.000000
	Default: 0.000000
  -KERNEL_TOLERANCE:<double>	Tolerance
	Floating point
	Minimum: 0.000000
	Maximum: 180.000000
	Default: 5.000000
  -DW_WEIGHTING:<str>       	Weighting Function
	Choice
	Available Choices:
	[0] no distance weighting
	[1] inverse distance to a power
	[2] exponential
	[3] gaussian
	Default: 0
  -DW_IDW_POWER:<double>    	Power
	Floating point
	Minimum: 0.000000
	Default: 2.000000
  -DW_BANDWIDTH:<double>    	Bandwidth
	Floating point
	Minimum: 0.000000
	Default: 1.000000