SAGA-GIS Tool Library Documentation (v8.2.1)

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
LeftFloating pointXMIN-Default: 0.000000
RightFloating pointXMAX-Default: 0.000000
BottomFloating pointYMIN-Default: 0.000000
TopFloating pointYMAX-Default: 0.000000
ColumnsIntegerNX-Minimum: 1
Default: 1
RowsIntegerNY-Minimum: 1
Default: 1
BufferFloating pointBUFFERadd 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>] [-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
  -XMIN:<double>        	Left
	Floating point
	Default: 0.000000
  -XMAX:<double>        	Right
	Floating point
	Default: 0.000000
  -YMIN:<double>        	Bottom
	Floating point
	Default: 0.000000
  -YMAX:<double>        	Top
	Floating point
	Default: 0.000000
  -NX:<num>             	Columns
	Integer
	Minimum: 1
	Default: 1
  -NY:<num>             	Rows
	Integer
	Minimum: 1
	Default: 1
  -BUFFER:<double>      	Buffer
	Floating point
	Minimum: 0.000000
	Default: 0.000000