SAGA-GIS Tool Library Documentation (v8.2.1)

Tool Grid Masking

Cells of the input grid will be set to no-data, if their cell center lies outside or within a no-data cell of the mask grid.

Parameters

 NameTypeIdentifierDescriptionConstraints
InputGridGrid, inputGRID--
GridsGrid list, inputGRIDS--
MaskGrid, inputMASK--
OutputMasked Grid (*)Grid, output, optionalMASKED--
Masked Grids (*)Grid list, output, optionalGRIDS_MASKED--
OptionsGrid SystemGrid systemPARAMETERS_GRID_SYSTEM--
List ProcessingBooleanLIST-Default: 0
Create CopiesBooleanGRIDS_CREATEWork on copies instead of overwriting the originals.Default: 0
Grid systemGrid systemMASK_GRIDSYSTEM--
Mask CellsChoiceNODATA-Available Choices:
[0] no-data cells
[1] data cells
Default: 0
(*) optional

Command-line

Usage: saga_cmd grid_tools 24 [-LIST <str>] [-GRID <str>] [-MASKED <str>] [-GRIDS <str>] [-GRIDS_CREATE <str>] [-GRIDS_MASKED <str>] [-MASK <str>] [-NODATA <str>]
  -LIST:<str>        	List Processing
	Boolean
	Default: 0
  -GRID:<str>        	Grid
	Grid, input
  -MASKED:<str>      	Masked Grid
	Grid, output, optional
  -GRIDS:<str>       	Grids
	Grid list, input
  -GRIDS_CREATE:<str>	Create Copies
	Boolean
	Default: 0
  -GRIDS_MASKED:<str>	Masked Grids
	Grid list, output, optional
  -MASK:<str>        	Mask
	Grid, input
  -NODATA:<str>      	Mask Cells
	Choice
	Available Choices:
	[0] no-data cells
	[1] data cells
	Default: 0