SAGA-GIS Tool Library Documentation (v8.5.1)

Tool Gradient Vectors from Directional Components

Create lines indicating the gradient.

Parameters

 NameTypeIdentifierDescriptionConstraints
InputX ComponentGrid, inputX--
Y ComponentGrid, inputY--
OutputGradient VectorsShapes, outputVECTORS--
OptionsGrid SystemGrid systemPARAMETERS_GRID_SYSTEM--
StepIntegerSTEP-Minimum: 1
Default: 1
Size RangeValue rangeSIZEsize range as percentage of step-
AggregationChoiceAGGRhow to request values if step size is more than one cellAvailable Choices:
[0] nearest neighbour
[1] mean value
Default: 1
StyleChoiceSTYLE-Available Choices:
[0] simple line
[1] arrow
[2] arrow (centered to cell)
Default: 2

Command-line

Usage: saga_cmd shapes_grid 17 [-X <str>] [-Y <str>] [-VECTORS <str>] [-STEP <num>] [-SIZE_MIN <double>] [-SIZE_MAX <double>] [-AGGR <str>] [-STYLE <str>]
  -X:<str>          	X Component
	Grid, input
  -Y:<str>          	Y Component
	Grid, input
  -VECTORS:<str>    	Gradient Vectors
	Shapes, output
  -STEP:<num>       	Step
	Integer
	Minimum: 1
	Default: 1
  -SIZE_MIN:<double>	Size Range
	Value range
  -SIZE_MAX:<double>	Size Range
	Value range
  -AGGR:<str>       	Aggregation
	Choice
	Available Choices:
	[0] nearest neighbour
	[1] mean value
	Default: 1
  -STYLE:<str>      	Style
	Choice
	Available Choices:
	[0] simple line
	[1] arrow
	[2] arrow (centered to cell)
	Default: 2