SAGA-GIS Module Library Documentation (v2.2.2)

Module Average With Mask 1

Average With Mask 1 calculates average for cells specified by a mask grid. Cell excluded by the mask grid are NOT used in the average calculation.

Parameters

 NameTypeIdentifierDescriptionConstraints
InputInputGrid (input)INPUTThis must be your input data of type grid.-
Mask GridGrid (input)MASKThis grid indicates the cells you want calculate the average.-
OutputAWM1 GridGrid (output)RESULTNew grid filtered with the AvWiMa1 module-
OptionsMask valueFloating pointVValue of right cells in the Mask GridDefault: 1.000000
Radius XIntegerRX-Minimum: 1
Default: 1
Radius YIntegerRY-Minimum: 1
Default: 1

Command-line

Usage: saga_cmd contrib_perego 3 [-INPUT <str>] [-MASK <str>] [-RESULT <str>] [-V <str>] [-RX <num>] [-RY <num>]
  -INPUT:<str> 	Input
	Grid (input)
  -MASK:<str>  	Mask Grid
	Grid (input)
  -RESULT:<str>	AWM1 Grid
	Grid (output)
  -V:<str>     	Mask value
	Floating point
	Default: 1.000000
  -RX:<num>    	Radius X
	Integer
	Minimum: 1
	Default: 1
  -RY:<num>    	Radius Y
	Integer
	Minimum: 1
	Default: 1