SAGA-GIS Tool Library Documentation (v9.2.0)

Tool Clip Grids

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