SAGA-GIS Tool Library Documentation (v6.1.0)

Tool Grid Statistics for Polygons

Zonal grid statistics. For each polygon statistics based on all covered grid cells will be calculated.

Parameters

 NameTypeIdentifierDescriptionConstraints
InputGridsGrid list (input)GRIDS--
PolygonsShapes (input)POLYGONS--
OutputStatistics (*)Shapes (optional output)RESULT--
OptionsGrid systemGrid systemPARAMETERS_GRID_SYSTEM--
Field NamingChoiceNAMING-Available Choices:
[0] grid number
[1] grid name
Default: 1
MethodChoiceMETHOD-Available Choices:
[0] simple and fast
[1] polygon wise (cell centers)
[2] polygon wise (cell area)
[3] polygon wise (cell area weighted)
Default: 0
Use Multiple CoresBooleanPARALLELIZED-Default: 0
Number of CellsBooleanCOUNT-Default: 1
MinimumBooleanMIN-Default: 1
MaximumBooleanMAX-Default: 1
RangeBooleanRANGE-Default: 1
SumBooleanSUM-Default: 1
MeanBooleanMEAN-Default: 1
VarianceBooleanVAR-Default: 1
Standard DeviationBooleanSTDDEV-Default: 1
QuantileIntegerQUANTILECalculate distribution quantiles. Value specifies interval (median=50, quartiles=25, deciles=10, ...). Set to zero to omit quantile calculation.Minimum: 0
Maximum: 50
Default: 0
GiniBooleanGINI-Default: 0
(*) optional

Command-line

Usage: saga_cmd shapes_grid 2 [-GRIDS <str>] [-POLYGONS <str>] [-NAMING <str>] [-METHOD <str>] [-PARALLELIZED <str>] [-RESULT <str>] [-COUNT <str>] [-MIN <str>] [-MAX <str>] [-RANGE <str>] [-SUM <str>] [-MEAN <str>] [-VAR <str>] [-STDDEV <str>] [-QUANTILE <num>] [-GINI <str>]
  -GRIDS:<str>       	Grids
	Grid list (input)
  -POLYGONS:<str>    	Polygons
	Shapes (input)
  -NAMING:<str>      	Field Naming
	Choice
	Available Choices:
	[0] grid number
	[1] grid name
	Default: 1
  -METHOD:<str>      	Method
	Choice
	Available Choices:
	[0] simple and fast
	[1] polygon wise (cell centers)
	[2] polygon wise (cell area)
	[3] polygon wise (cell area weighted)
	Default: 0
  -PARALLELIZED:<str>	Use Multiple Cores
	Boolean
	Default: 0
  -RESULT:<str>      	Statistics
	Shapes (optional output)
  -COUNT:<str>       	Number of Cells
	Boolean
	Default: 1
  -MIN:<str>         	Minimum
	Boolean
	Default: 1
  -MAX:<str>         	Maximum
	Boolean
	Default: 1
  -RANGE:<str>       	Range
	Boolean
	Default: 1
  -SUM:<str>         	Sum
	Boolean
	Default: 1
  -MEAN:<str>        	Mean
	Boolean
	Default: 1
  -VAR:<str>         	Variance
	Boolean
	Default: 1
  -STDDEV:<str>      	Standard Deviation
	Boolean
	Default: 1
  -QUANTILE:<num>    	Quantile
	Integer
	Minimum: 0
	Maximum: 50
	Default: 0
  -GINI:<str>        	Gini
	Boolean
	Default: 0