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

Wilson, J.P. & Gallant, J.C. [Eds.] (2000): Terrain analysis - principles and applications. New York, John Wiley & Sons, Inc.

Author: O.Conrad (c) 2003
Menu: Spatial and Geostatistics|Grids

Parameters

	Name	Type	Identifier	Description	Constraints
Input	Grid	Grid (input)	`GRID`	-	-
Output	Mean Value (*)	Grid (optional output)	`MEAN`	-	-
	Minimum Value (*)	Grid (optional output)	`MIN`	-	-
	Maximum Value (*)	Grid (optional output)	`MAX`	-	-
	Value Range (*)	Grid (optional output)	`RANGE`	-	-
	Standard Deviation (*)	Grid (optional output)	`STDDEV`	-	-
	Variance (*)	Grid (optional output)	`VARIANCE`	-	-
	Sum (*)	Grid (optional output)	`SUM`	-	-
	Difference from Mean Value (*)	Grid (optional output)	`DIFF`	-	-
	Deviation from Mean Value (*)	Grid (optional output)	`DEVMEAN`	-	-
	Percentile (*)	Grid (optional output)	`PERCENT`	-	-
	Median (*)	Grid (optional output)	`MEDIAN`	-	-
	Minority (*)	Grid (optional output)	`MINORITY`	-	-
	Majority (*)	Grid (optional output)	`MAJORITY`	-	-
Options	Grid system	Grid system	`PARAMETERS_GRID_SYSTEM`	-	-
	Include Center Cell	Boolean	`BCENTER`	-	Default: 1
	Kernel Type	Choice	`KERNEL_TYPE`	The kernel's shape.	Available Choices: [0] Square [1] Circle [2] Annulus [3] Sector Default: 1
	Inner Radius	Integer	`KERNEL_INNER`	cells	Minimum: 0 Default: 0
	Radius	Integer	`KERNEL_RADIUS`	cells	Minimum: 0 Default: 2
	Direction	Floating point	`KERNEL_DIRECTION`	degree	Minimum: -360.000000 Maximum: 360.000000 Default: 0.000000
	Tolerance	Floating point	`KERNEL_TOLERANCE`	degree	Minimum: 0.000000 Maximum: 180.000000 Default: 5.000000
	Weighting Function	Choice	`DW_WEIGHTING`	-	Available Choices: [0] no distance weighting [1] inverse distance to a power [2] exponential [3] gaussian weighting Default: 0
	Inverse Distance Weighting Power	Floating point	`DW_IDW_POWER`	-	Minimum: 0.000000 Default: 1.000000
	Inverse Distance Offset	Boolean	`DW_IDW_OFFSET`	Calculates weights for distance plus one, avoiding division by zero for zero distances	Default: 1
	Gaussian and Exponential Weighting Bandwidth	Floating point	`DW_BANDWIDTH`	-	Minimum: 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_IDW_OFFSET <str>] [-DW_BANDWIDTH <double>]
  -GRID:<str>               	Grid
	Grid (input)
  -MEAN:<str>               	Mean Value
	Grid (optional output)
  -MIN:<str>                	Minimum Value
	Grid (optional output)
  -MAX:<str>                	Maximum Value
	Grid (optional output)
  -RANGE:<str>              	Value Range
	Grid (optional output)
  -STDDEV:<str>             	Standard Deviation
	Grid (optional output)
  -VARIANCE:<str>           	Variance
	Grid (optional output)
  -SUM:<str>                	Sum
	Grid (optional output)
  -DIFF:<str>               	Difference from Mean Value
	Grid (optional output)
  -DEVMEAN:<str>            	Deviation from Mean Value
	Grid (optional output)
  -PERCENT:<str>            	Percentile
	Grid (optional output)
  -MEDIAN:<str>             	Median
	Grid (optional output)
  -MINORITY:<str>           	Minority
	Grid (optional output)
  -MAJORITY:<str>           	Majority
	Grid (optional output)
  -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 weighting
	Default: 0
  -DW_IDW_POWER:<double>    	Inverse Distance Weighting Power
	Floating point
	Minimum: 0.000000
	Default: 1.000000
  -DW_IDW_OFFSET:<str>      	Inverse Distance Offset
	Boolean
	Default: 1
  -DW_BANDWIDTH:<double>    	Gaussian and Exponential Weighting Bandwidth
	Floating point
	Minimum: 0.000000
	Default: 1.000000