SAGA 9.4.2 | Tool Library Documentation

Clip Grids


Description

Clip selected grids to specified extent.


Parameters

 NameTypeIdentifierDescriptionConstraints
InputGridsgrid list, inputGRIDS--
Shapes Extentshapes, inputSHAPES--
Polygonsshapes, inputPOLYGONS--
OutputClipped Gridsgrid list, outputCLIPPED--
OptionsGrid Systemgrid systemPARAMETERS_GRID_SYSTEM--
ExtentchoiceEXTENT-Available Choices: [0] user defined [1] grid system [2] shapes extent [3] polygon Default: 0
Grid Systemgrid systemGRIDSYSTEM--
InteriorbooleanINTERIORClip those cells that are covered by the polygons instead of those that are not.Default: 0
CropbooleanCROP-Default: 1
Leftfloating point numberXMIN-Default: 0.000000
Rightfloating point numberXMAX-Default: 0.000000
Bottomfloating point numberYMIN-Default: 0.000000
Topfloating point numberYMAX-Default: 0.000000
Columnsinteger numberNX-Minimum: 1 Default: 1
Rowsinteger numberNY-Minimum: 1 Default: 1
Bufferfloating point numberBUFFERadd buffer (map units) to extentMinimum: 0.000000 Default: 0.000000

Command Line


Usage: saga_cmd grid_tools 31 [-GRIDS ] [-CLIPPED ] [-EXTENT ] [-GRIDSYSTEM_D ] [-GRIDSYSTEM_X ] [-GRIDSYSTEM_Y ] [-GRIDSYSTEM_NX ] [-GRIDSYSTEM_NY ] [-GRIDSYSTEM_FILE ] [-SHAPES ] [-POLYGONS ] [-INTERIOR ] [-CROP ] [-XMIN ] [-XMAX ] [-YMIN ] [-YMAX ] [-NX ] [-NY ] [-BUFFER ]
  -GRIDS:          	Grids
	grid list, input
  -CLIPPED:        	Clipped Grids
	grid list, output
  -EXTENT:         	Extent
	choice
	Available Choices:
	[0] user defined
	[1] grid system
	[2] shapes extent
	[3] polygon
	Default: 0
  -GRIDSYSTEM_D:	Cell Size
  -GRIDSYSTEM_X:	Lower Left Center Cell X-Coordinate
  -GRIDSYSTEM_Y:	Lower Left Center Cell Y-Coordinate
  -GRIDSYSTEM_NX:  	Number of Columns
  -GRIDSYSTEM_NY:  	Number of Rows
  -GRIDSYSTEM_FILE:	Grid File
  -SHAPES:         	Shapes Extent
	shapes, input
  -POLYGONS:       	Polygons
	shapes, input
  -INTERIOR:       	Interior
	boolean
	Default: 0
  -CROP:           	Crop
	boolean
	Default: 1
  -XMIN:        	Left
	floating point number
	Default: 0.000000
  -XMAX:        	Right
	floating point number
	Default: 0.000000
  -YMIN:        	Bottom
	floating point number
	Default: 0.000000
  -YMAX:        	Top
	floating point number
	Default: 0.000000
  -NX:             	Columns
	integer number
	Minimum: 1
	Default: 1
  -NY:             	Rows
	integer number
	Minimum: 1
	Default: 1
  -BUFFER:      	Buffer
	floating point number
	Minimum: 0.000000
	Default: 0.000000