SAGA-GIS Tool Library Documentation (v7.7.0)

Tool Diversity of Categories

Grid based analysis of diversity. It is assumed that the input grid provides a classification (i.e. not a contiuous field). For each cell it counts the number of different categories (classes) as well as the connectivity within the chosen search window.

Parameters

 NameTypeIdentifierDescriptionConstraints
InputCategoriesGrid, inputCATEGORIES--
OutputNumber of CategoriesGrid, outputCOUNTnumber of different categories (unique values) within search area-
DiversityGrid, outputDIVERSITYdistance weighted average of the number of different categories for distance classes-
ConnectivityGrid, outputCONNECTIVITY--
Averaged ConnectivityGrid, outputCONNECTEDAVGaverage size of the area covered by each category that occurs within search area-
OptionsGrid SystemGrid systemPARAMETERS_GRID_SYSTEM--
Connectivity NeighbourhoodChoiceNB_CASE-Available Choices:
[0] Rook's case
[1] Queen's case
Default: 1
NormalizeChoiceNORMALIZE-Available Choices:
[0] no
[1] by number of cells
[2] by area size
Default: 0
Kernel TypeChoiceKERNEL_TYPEThe kernel's shape.Available Choices:
[0] Square
[1] Circle
Default: 1
RadiusIntegerKERNEL_RADIUScellsMinimum: 0
Default: 2
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

Command-line

Usage: saga_cmd grid_analysis 21 [-CATEGORIES <str>] [-COUNT <str>] [-DIVERSITY <str>] [-CONNECTIVITY <str>] [-CONNECTEDAVG <str>] [-NB_CASE <str>] [-NORMALIZE <str>] [-KERNEL_TYPE <str>] [-KERNEL_RADIUS <num>] [-DW_WEIGHTING <str>] [-DW_IDW_POWER <double>] [-DW_BANDWIDTH <double>]
  -CATEGORIES:<str>     	Categories
	Grid, input
  -COUNT:<str>          	Number of Categories
	Grid, output
  -DIVERSITY:<str>      	Diversity
	Grid, output
  -CONNECTIVITY:<str>   	Connectivity
	Grid, output
  -CONNECTEDAVG:<str>   	Averaged Connectivity
	Grid, output
  -NB_CASE:<str>        	Connectivity Neighbourhood
	Choice
	Available Choices:
	[0] Rook's case
	[1] Queen's case
	Default: 1
  -NORMALIZE:<str>      	Normalize
	Choice
	Available Choices:
	[0] no
	[1] by number of cells
	[2] by area size
	Default: 0
  -KERNEL_TYPE:<str>    	Kernel Type
	Choice
	Available Choices:
	[0] Square
	[1] Circle
	Default: 1
  -KERNEL_RADIUS:<num>  	Radius
	Integer
	Minimum: 0
	Default: 2
  -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