SAGA 9.3.3 | Tool Library Documentation

Iterative Truncation


Description

The tool allows one to perform an iterative truncation to a target average. This operation iteratively removes the highest values from the input grid until the average of all grid values matches the user-specified target average. Instead of simply removing the highest cell values, these values can also be replaced by a substitute value. An example application is surface soil cleanup, where the highest soil contaminant concentrations are removed until targeted post-remediation concentrations are reached. In this case, the substitute value would be set to the concentration of clean fill.


Parameters

 NameTypeIdentifierDescriptionConstraints
InputInputgrid, inputINPUTGrid to analyse.-
OutputRemoved Cellsgrid, outputREMOVEDOutput grid showing the removed cells (1/NoData).-
Outputgrid, output, optionalOUTPUTThe modified input grid.-
OptionsGrid Systemgrid systemPARAMETERS_GRID_SYSTEM--
Target Averagefloating point numberTARGETThe target average.Default: 100.000000
MethodchoiceMETHODChoose a mode of operation.Available Choices: [0] remove cell values [1] replace cell values Default: 0
Substitute Valuefloating point numberSUBSTITUTEThe value with which the removed cell values are replaced.Default: 0.000000

Command Line


Usage: saga_cmd grid_analysis 29 [-INPUT ] [-REMOVED ] [-OUTPUT ] [-TARGET ] [-METHOD ] [-SUBSTITUTE ]
  -INPUT:        	Input
	grid, input
  -REMOVED:      	Removed Cells
	grid, output
  -OUTPUT:       	Output
	grid, output, optional
  -TARGET:    	Target Average
	floating point number
	Default: 100.000000
  -METHOD:       	Method
	choice
	Available Choices:
	[0] remove cell values
	[1] replace cell values
	Default: 0
  -SUBSTITUTE:	Substitute Value
	floating point number
	Default: 0.000000