SAGA-GIS Module Library Documentation (v2.1.3)

Module Clip Grids

Clip selected grids to specified extent.

Parameters

 NameTypeIdentifierDescriptionConstraints
InputGridsGrid list (input)GRIDS--
Shapes ExtentShapes (input)SHAPES--
PolygonShapes (input)POLYGONS--
OutputClipped GridsGrid list (output)CLIPPED--
OptionsExtentChoiceEXTENT-Available Choices:
[0] user defined
[1] grid system
[2] shapes extent
[3] polygon
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_NX <num>] [-GRIDSYSTEM_NY <num>] [-GRIDSYSTEM_X <str>] [-GRIDSYSTEM_Y <str>] [-GRIDSYSTEM_D <str>] -SHAPES <str> -POLYGONS <str> [-XMIN <str>] [-XMAX <str>] [-YMIN <str>] [-YMAX <str>] [-NX <num>] [-NY <num>] [-BUFFER <str>]
  -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_NX:<num>	Grid System
	Grid system
  -GRIDSYSTEM_NY:<num>	Grid System
	Grid system
  -GRIDSYSTEM_X:<str> 	Grid System
	Grid system
  -GRIDSYSTEM_Y:<str> 	Grid System
	Grid system
  -GRIDSYSTEM_D:<str> 	Grid System
	Grid system
  -SHAPES:<str>       	Shapes Extent
	Shapes (input)
  -POLYGONS:<str>     	Polygon
	Shapes (input)
  -XMIN:<str>         	Left
	Floating point
	Default: 0.000000
  -XMAX:<str>         	Right
	Floating point
	Default: 0.000000
  -YMIN:<str>         	Bottom
	Floating point
	Default: 0.000000
  -YMAX:<str>         	Top
	Floating point
	Default: 0.000000
  -NX:<num>           	Columns
	Integer
	Minimum: 1
	Default: 1
  -NY:<num>           	Rows
	Integer
	Minimum: 1
	Default: 1
  -BUFFER:<str>       	Buffer
	Floating point
	Minimum: 0.000000
	Default: 0.000000