SAGA-GIS Tool Library Documentation (v6.1.0)

Tool Copy Shapes from Region

Copies all shapes that belong to the specified region.

Parameters

 NameTypeIdentifierDescriptionConstraints
InputShapesShapes list (input)SHAPES--
ShapesShapes (input)SHAPES_EXT--
PolygonsShapes (input)POLYGONS--
OutputCopyShapes list (output)CUT--
OptionsMethodChoiceMETHOD-Available Choices:
[0] completely contained
[1] intersects
[2] center
Default: 1
RegionChoiceEXTENT-Available Choices:
[0] user defined
[1] grid project
[2] shapes layer extent
[3] polygons
Default: 0
LeftFloating pointAX-Default: 0.000000
RightFloating pointBX-Default: 1.000000
BottomFloating pointAY-Default: 0.000000
TopFloating pointBY-Default: 1.000000
Horizontal RangeFloating pointDX-Minimum: 0.000000
Default: 1.000000
Vertical RangeFloating pointDY-Minimum: 0.000000
Default: 1.000000
Grid SystemGrid systemGRID_SYS--
Minimum OverlapFloating pointOVERLAPminimum overlapping area as percentage of the total size of the input shape. applies to polygon layers only.Minimum: 0.000000
Maximum: 100.000000
Default: 50.000000

Command-line

Usage: saga_cmd shapes_tools 13 [-SHAPES <str>] [-CUT <str>] [-METHOD <str>] [-EXTENT <str>] [-AX <double>] [-BX <double>] [-AY <double>] [-BY <double>] [-DX <double>] [-DY <double>] [-GRID_SYS_NX <num>] [-GRID_SYS_NY <num>] [-GRID_SYS_X <double>] [-GRID_SYS_Y <double>] [-GRID_SYS_D <double>] [-SHAPES_EXT <str>] [-POLYGONS <str>] [-OVERLAP <double>]
  -SHAPES:<str>       	Shapes
	Shapes list (input)
  -CUT:<str>          	Copy
	Shapes list (output)
  -METHOD:<str>       	Method
	Choice
	Available Choices:
	[0] completely contained
	[1] intersects
	[2] center
	Default: 1
  -EXTENT:<str>       	Region
	Choice
	Available Choices:
	[0] user defined
	[1] grid project
	[2] shapes layer extent
	[3] polygons
	Default: 0
  -AX:<double>        	Left
	Floating point
	Default: 0.000000
  -BX:<double>        	Right
	Floating point
	Default: 1.000000
  -AY:<double>        	Bottom
	Floating point
	Default: 0.000000
  -BY:<double>        	Top
	Floating point
	Default: 1.000000
  -DX:<double>        	Horizontal Range
	Floating point
	Minimum: 0.000000
	Default: 1.000000
  -DY:<double>        	Vertical Range
	Floating point
	Minimum: 0.000000
	Default: 1.000000
  -GRID_SYS_NX:<num>  	Grid System
	Grid system
  -GRID_SYS_NY:<num>  	Grid System
	Grid system
  -GRID_SYS_X:<double>	Grid System
	Grid system
  -GRID_SYS_Y:<double>	Grid System
	Grid system
  -GRID_SYS_D:<double>	Grid System
	Grid system
  -SHAPES_EXT:<str>   	Shapes
	Shapes (input)
  -POLYGONS:<str>     	Polygons
	Shapes (input)
  -OVERLAP:<double>   	Minimum Overlap
	Floating point
	Minimum: 0.000000
	Maximum: 100.000000
	Default: 50.000000