SAGA 9.9.1 | Tool Library Documentation

Focal Statistics


Description

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 Valuegrid, output, optionalMEAN--
Minimum Valuegrid, output, optionalMIN--
Maximum Valuegrid, output, optionalMAX--
Value Rangegrid, output, optionalRANGE--
Standard Deviationgrid, output, optionalSTDDEV--
Variancegrid, output, optionalVARIANCE--
Sumgrid, output, optionalSUM--
Difference from Mean Valuegrid, output, optionalDIFF--
Deviation from Mean Valuegrid, output, optionalDEVMEAN--
Percentilegrid, output, optionalPERCENT--
Mediangrid, output, optionalMEDIAN--
Minoritygrid, output, optionalMINORITY--
Majoritygrid, 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 Radiusinteger numberKERNEL_INNERcellsMinimum: 0 Default: 0
Radiusinteger numberKERNEL_RADIUScellsMinimum: 0 Default: 2
Directionfloating point numberKERNEL_DIRECTIONdegreeMinimum: -360.000000 Maximum: 360.000000 Default: 0.000000
Tolerancefloating point numberKERNEL_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 point numberDW_IDW_POWER-Minimum: 0.000000 Default: 2.000000
Bandwidthfloating point numberDW_BANDWIDTHBandwidth for exponential and Gaussian weightingMinimum: 0.000000 Default: 1.000000

Command Line


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