SAGA-GIS Tool Library Documentation (v9.1.2)

Tool CliffMetrics

CliffMetrics (Automatic Cliff Metrics delineation) delineates the location of the coastline, coastline normals, and cliff top and toe location along these normals.


References


Parameters

 NameTypeIdentifierDescriptionConstraints
InputElevationGrid, inputDEM--
User Defined Coastline Points (*)Shapes, input, optionalCOAST_INITIALif non empty, cliffmetric will use the user defined coastal line to draw the transects-
OutputSediment Top ElevationGrid, outputSEDIMENT_TOP--
Coastline (*)Grid, output, optionalRASTER_COAST--
Normals (*)Grid, output, optionalRASTER_NORMAL--
CoastlineShapes, outputCOAST--
Coastline-Normal ProfilesShapes, outputNORMALS--
Cliff Top PointsShapes, outputCLIFF_TOP--
Cliff Toe PointsShapes, outputCLIFF_TOE--
Coast PointsShapes, outputCOAST_POINT--
Invalid Coastline-Normal Profiles (*)Shapes, output, optionalINVALID_NORMALS--
Coastline Curvature (*)Shapes, output, optionalCOAST_CURVATURE--
Profile DataTable, outputPROFILES--
OptionsGrid SystemGrid systemPARAMETERS_GRID_SYSTEM--
Sea handinessChoiceCoastSeaHandinessas you traverse the coastline, on which side of shoreline the sea is?Available Choices:
[0] right
[1] left
Default: 0
Start edge coastlineChoiceStartEdgeUserCoastLineon which edge of the DTM the start of coastline is?Available Choices:
[0] North
[1] East
[2] South
[3] West
Default: 0
End edge coastlineChoiceEndEdgeUserCoastLineon which edge of the DTM the end of coastline is?Available Choices:
[0] North
[1] East
[2] South
[3] West
Default: 0
Still Water LevelFloating pointStillWaterLevelStill water level (m) used to extract the shoreline.Minimum: 0.000000
Default: 1.000000
Coastline Smoothing AlgorithmChoiceCoastSmoothVector coastline smoothing algorithm.Available Choices:
[0] none
[1] running mean
[2] Savitsky-Golay
Default: 1
Coastline Smoothing Window SizeIntegerCoastSmoothWindowSize of coastline smoothing window, resulting kernel size will be: 1 + 2 * size.Minimum: 1
Default: 30
Polynomial Order for Savitsky-GolayIntegerSavGolCoastPolyOrder of coastline profile smoothing polynomial for Savitsky-Golay smoothing: usually 2 or 4, max is 6.Minimum: 1
Maximum: 6
Default: 4
Scale Raster Output ValuesBooleanScaleRasterOutputIf needed, scale GIS raster output values.Default: 1
Random Edge for Coastline SearchBooleanRandomCoastEdgeSearchRandom edge for coastline search.Default: 1
Length of Coastline NormalsFloating pointCoastNormalLengthLength of coastline normals (m).Minimum: 0.010000
Default: 500.000000
Vertical ToleranceFloating pointEleToleranceVertical tolerance to avoid false cliff tops and toes.Minimum: 0.010000
Default: 0.500000
Main Output File DirectoryFile pathOutPath--
(*) optional

Command-line

Usage: saga_cmd ta_cliffmetrics 0 [-DEM <str>] [-SEDIMENT_TOP <str>] [-RASTER_COAST <str>] [-RASTER_NORMAL <str>] [-COAST_INITIAL <str>] [-CoastSeaHandiness <str>] [-StartEdgeUserCoastLine <str>] [-EndEdgeUserCoastLine <str>] [-COAST <str>] [-NORMALS <str>] [-CLIFF_TOP <str>] [-CLIFF_TOE <str>] [-COAST_POINT <str>] [-INVALID_NORMALS <str>] [-COAST_CURVATURE <str>] [-PROFILES <str>] [-StillWaterLevel <double>] [-CoastSmooth <str>] [-CoastSmoothWindow <num>] [-SavGolCoastPoly <num>] [-ScaleRasterOutput <str>] [-RandomCoastEdgeSearch <str>] [-CoastNormalLength <double>] [-EleTolerance <double>] [-OutPath <str>]
  -DEM:<str>                   	Elevation
	Grid, input
  -SEDIMENT_TOP:<str>          	Sediment Top Elevation
	Grid, output
  -RASTER_COAST:<str>          	Coastline
	Grid, output, optional
  -RASTER_NORMAL:<str>         	Normals
	Grid, output, optional
  -COAST_INITIAL:<str>         	User Defined Coastline Points
	Shapes, input, optional
  -CoastSeaHandiness:<str>     	Sea handiness
	Choice
	Available Choices:
	[0] right
	[1] left
	Default: 0
  -StartEdgeUserCoastLine:<str>	Start edge coastline
	Choice
	Available Choices:
	[0] North
	[1] East
	[2] South
	[3] West
	Default: 0
  -EndEdgeUserCoastLine:<str>  	End edge coastline
	Choice
	Available Choices:
	[0] North
	[1] East
	[2] South
	[3] West
	Default: 0
  -COAST:<str>                 	Coastline
	Shapes, output
  -NORMALS:<str>               	Coastline-Normal Profiles
	Shapes, output
  -CLIFF_TOP:<str>             	Cliff Top Points
	Shapes, output
  -CLIFF_TOE:<str>             	Cliff Toe Points
	Shapes, output
  -COAST_POINT:<str>           	Coast Points
	Shapes, output
  -INVALID_NORMALS:<str>       	Invalid Coastline-Normal Profiles
	Shapes, output, optional
  -COAST_CURVATURE:<str>       	Coastline Curvature
	Shapes, output, optional
  -PROFILES:<str>              	Profile Data
	Table, output
  -StillWaterLevel:<double>    	Still Water Level
	Floating point
	Minimum: 0.000000
	Default: 1.000000
  -CoastSmooth:<str>           	Coastline Smoothing Algorithm
	Choice
	Available Choices:
	[0] none
	[1] running mean
	[2] Savitsky-Golay
	Default: 1
  -CoastSmoothWindow:<num>     	Coastline Smoothing Window Size
	Integer
	Minimum: 1
	Default: 30
  -SavGolCoastPoly:<num>       	Polynomial Order for Savitsky-Golay
	Integer
	Minimum: 1
	Maximum: 6
	Default: 4
  -ScaleRasterOutput:<str>     	Scale Raster Output Values
	Boolean
	Default: 1
  -RandomCoastEdgeSearch:<str> 	Random Edge for Coastline Search
	Boolean
	Default: 1
  -CoastNormalLength:<double>  	Length of Coastline Normals
	Floating point
	Minimum: 0.010000
	Default: 500.000000
  -EleTolerance:<double>       	Vertical Tolerance
	Floating point
	Minimum: 0.010000
	Default: 0.500000
  -OutPath:<str>               	Main Output File Directory
	File path