Tool Iterative Truncation
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.
- Author: V. Wichmann (c) 2020
- Menu: Grid|Analysis
Parameters
| Name | Type | Identifier | Description | Constraints | |
|---|---|---|---|---|---|
| Input | Input | Grid, input | INPUT | Grid to analyse. | - |
| Output | Removed Cells | Grid, output | REMOVED | Output grid showing the removed cells (1/NoData). | - |
| Output (*) | Grid, output, optional | OUTPUT | The modified input grid. | - | |
| Options | Grid System | Grid system | PARAMETERS_GRID_SYSTEM | - | - |
| Target Average | Floating point | TARGET | The target average. | Default: 100.000000 | |
| Method | Choice | METHOD | Choose a mode of operation. | Available Choices: [0] remove cell values [1] replace cell values Default: 0 | |
| Substitute Value | Floating point | SUBSTITUTE | The value with which the removed cell values are replaced. | Default: 0.000000 | |
| (*) optional | |||||
Command-line
Usage: saga_cmd grid_analysis 29 [-INPUT <str>] [-REMOVED <str>] [-OUTPUT <str>] [-TARGET <double>] [-METHOD <str>] [-SUBSTITUTE <double>] -INPUT:<str> Input Grid, input -REMOVED:<str> Removed Cells Grid, output -OUTPUT:<str> Output Grid, output, optional -TARGET:<double> Target Average Floating point Default: 100.000000 -METHOD:<str> Method Choice Available Choices: [0] remove cell values [1] replace cell values Default: 0 -SUBSTITUTE:<double> Substitute Value Floating point Default: 0.000000