SAGA 9.4.2 | Tool Library Documentation

Coverage of Categories


Description

The Coverage of Categories tool calculates for each category of the categories input grid the percentage it covers in each cell of the target grid system.


Parameters

 NameTypeIdentifierDescriptionConstraints
InputCategoriesgrid, inputCLASSES--
Classificationtable, input, optionalLUT--
Target Systemgrid, input, optional, CMDTARGET_TEMPLATEuse this grid's system for output grids-
OutputCoveragesgrid list, outputCOVERAGES--
OptionsGrid Systemgrid systemPARAMETERS_GRID_SYSTEM--
Valuetable fieldLUT_VALThe class value or - in combination with value 2 - the minimum/maximum value specifying a value range.-
Maximum Valuetable fieldLUT_MAXUse this option to specify a value range equal or greater than previous value and less than this (maximum) value.-
Class nametable fieldLUT_NAMEOptional, a class name used for the naming of the target coverage rasters.-
Mark No Coverage as No-DatabooleanNO_DATA-Default: 1
Data Depthdata typeDATADEPTH-Available Choices: [0] unsigned 1 byte integer [1] unsigned 2 byte integer [2] 4 byte floating point number [3] 8 byte floating point number Default: 1
UnitchoiceUNIT-Available Choices: [0] fraction [1] percent Default: 0
Target Grid SystemchoiceTARGET_DEFINITION-Available Choices: [0] user defined [1] grid or grid system Default: 0
Cellsizefloating point numberTARGET_USER_SIZE-Minimum: 0.000000 Default: 1.000000
Westfloating point numberTARGET_USER_XMIN-Default: 0.000000
Eastfloating point numberTARGET_USER_XMAX-Default: 100.000000
Southfloating point numberTARGET_USER_YMIN-Default: 0.000000
Northfloating point numberTARGET_USER_YMAX-Default: 100.000000
Columnsinteger numberTARGET_USER_COLSNumber of cells in East-West direction.Minimum: 1 Default: 101
Rowsinteger numberTARGET_USER_ROWSNumber of cells in North-South direction.Minimum: 1 Default: 101
FitchoiceTARGET_USER_FITS-Available Choices: [0] nodes [1] cells Default: 0
Grid Systemgrid systemTARGET_SYSTEM--

Command Line


Usage: saga_cmd grid_analysis 26 [-CLASSES ] [-COVERAGES ] [-LUT ] [-LUT_VAL ] [-LUT_MAX ] [-LUT_NAME ] [-NO_DATA ] [-DATADEPTH ] [-UNIT ] [-TARGET_DEFINITION ] [-TARGET_USER_SIZE ] [-TARGET_USER_XMIN ] [-TARGET_USER_XMAX ] [-TARGET_USER_YMIN ] [-TARGET_USER_YMAX ] [-TARGET_USER_COLS ] [-TARGET_USER_ROWS ] [-TARGET_USER_FITS ] [-TARGET_TEMPLATE ]
  -CLASSES:            	Categories
	grid, input
  -COVERAGES:          	Coverages
	grid list, output
  -LUT:                	Classification
	table, input, optional
  -LUT_VAL:            	Value
	table field
  -LUT_MAX:            	Maximum Value
	table field
  -LUT_NAME:           	Class name
	table field
  -NO_DATA:            	Mark No Coverage as No-Data
	boolean
	Default: 1
  -DATADEPTH:          	Data Depth
	data type
	Available Choices:
	[0] unsigned 1 byte integer
	[1] unsigned 2 byte integer
	[2] 4 byte floating point number
	[3] 8 byte floating point number
	Default: 1
  -UNIT:               	Unit
	choice
	Available Choices:
	[0] fraction
	[1] percent
	Default: 0
  -TARGET_DEFINITION:  	Target Grid System
	choice
	Available Choices:
	[0] user defined
	[1] grid or grid system
	Default: 0
  -TARGET_USER_SIZE:	Cellsize
	floating point number
	Minimum: 0.000000
	Default: 1.000000
  -TARGET_USER_XMIN:	West
	floating point number
	Default: 0.000000
  -TARGET_USER_XMAX:	East
	floating point number
	Default: 100.000000
  -TARGET_USER_YMIN:	South
	floating point number
	Default: 0.000000
  -TARGET_USER_YMAX:	North
	floating point number
	Default: 100.000000
  -TARGET_USER_COLS:   	Columns
	integer number
	Minimum: 1
	Default: 101
  -TARGET_USER_ROWS:   	Rows
	integer number
	Minimum: 1
	Default: 101
  -TARGET_USER_FITS:   	Fit
	choice
	Available Choices:
	[0] nodes
	[1] cells
	Default: 0
  -TARGET_TEMPLATE:    	Target System
	grid, input, optional, CMD