Iterative Truncation
- Author: V. Wichmann (c) 2020
- Menu: Grid | Analysis
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
| 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 number | 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 number | SUBSTITUTE | The 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