SAGA-GIS Tool Library Documentation (v8.1.0)

Tool Shannon Index

Grid based analysis of diversity with the Shannon Index. The index is calculated locally for each grid cell using the specified kernel (aka 'moving window'). It is assumed that the grid cell values represent a classification.


References


Parameters

 NameTypeIdentifierDescriptionConstraints
InputCategoriesGrid, inputCATEGORIES--
OutputNumber of Categories (*)Grid, output, optionalCOUNTnumber of different categories (unique values) within search area-
Shannon IndexGrid, outputINDEX--
Evenness (*)Grid, output, optionalEVENNESS--
OptionsGrid SystemGrid systemPARAMETERS_GRID_SYSTEM--
Kernel TypeChoiceKERNEL_TYPEThe kernel's shape.Available Choices:
[0] Square
[1] Circle
Default: 1
RadiusIntegerKERNEL_RADIUScellsMinimum: 0
Default: 2
(*) optional

Command-line

Usage: saga_cmd grid_analysis 22 [-CATEGORIES <str>] [-COUNT <str>] [-INDEX <str>] [-EVENNESS <str>] [-KERNEL_TYPE <str>] [-KERNEL_RADIUS <num>]
  -CATEGORIES:<str>   	Categories
	Grid, input
  -COUNT:<str>        	Number of Categories
	Grid, output, optional
  -INDEX:<str>        	Shannon Index
	Grid, output
  -EVENNESS:<str>     	Evenness
	Grid, output, optional
  -KERNEL_TYPE:<str>  	Kernel Type
	Choice
	Available Choices:
	[0] Square
	[1] Circle
	Default: 1
  -KERNEL_RADIUS:<num>	Radius
	Integer
	Minimum: 0
	Default: 2