##' QGIS Algorithm provided by SAGA Next Gen Gravitational process path model (sagang:gravitationalprocesspathmodel). ---------------- Arguments ---------------- DEM: DEM Argument type: raster Acceptable values: - Path to a raster layer RELEASE_AREAS: Release Areas Argument type: raster Acceptable values: - Path to a raster layer MATERIAL: Material (optional) Argument type: raster Acceptable values: - Path to a raster layer FRICTION_ANGLE_GRID: Friction Angle (optional) Argument type: raster Acceptable values: - Path to a raster layer SLOPE_IMPACT_GRID: Slope Impact Areas (optional) Argument type: raster Acceptable values: - Path to a raster layer FRICTION_MU_GRID: Friction Parameter Mu (optional) Argument type: raster Acceptable values: - Path to a raster layer FRICTION_MASS_TO_DRAG_GRID: Mass to Drag Ratio (optional) Argument type: raster Acceptable values: - Path to a raster layer PROCESS_AREA: Process Area Argument type: rasterDestination Acceptable values: - Path for new raster layer DEPOSITION: Deposition Argument type: rasterDestination Acceptable values: - Path for new raster layer MAX_VELOCITY: Maximum Velocity Argument type: rasterDestination Acceptable values: - Path for new raster layer STOP_POSITIONS: Stopping Positions Argument type: rasterDestination Acceptable values: - Path for new raster layer PROCESS_PATH_MODEL: Model Default value: 1 Argument type: enum Available values: - 0: (0) Maximum Slope - 1: (1) Random Walk Acceptable values: - Number of selected option, e.g. '1' - Comma separated list of options, e.g. '1,3' RW_SLOPE_THRES: Slope Threshold Default value: 40 Argument type: number Acceptable values: - A numeric value - field:FIELD_NAME to use a data defined value taken from the FIELD_NAME field - expression:SOME EXPRESSION to use a data defined value calculated using a custom QGIS expression RW_EXPONENT: Exponent Default value: 2 Argument type: number Acceptable values: - A numeric value - field:FIELD_NAME to use a data defined value taken from the FIELD_NAME field - expression:SOME EXPRESSION to use a data defined value calculated using a custom QGIS expression RW_PERSISTENCE: Persistence Factor Default value: 1.5 Argument type: number Acceptable values: - A numeric value - field:FIELD_NAME to use a data defined value taken from the FIELD_NAME field - expression:SOME EXPRESSION to use a data defined value calculated using a custom QGIS expression GPP_ITERATIONS: Iterations Default value: 1000 Argument type: number Acceptable values: - A numeric value - field:FIELD_NAME to use a data defined value taken from the FIELD_NAME field - expression:SOME EXPRESSION to use a data defined value calculated using a custom QGIS expression GPP_PROCESSING_ORDER: Processing Order Default value: 2 Argument type: enum Available values: - 0: (0) RAs in Sequence - 1: (1) RAs in Sequence per Iteration - 2: (2) RAs in Parallel per Iteration Acceptable values: - Number of selected option, e.g. '1' - Comma separated list of options, e.g. '1,3' GPP_SEED: Seed Value Default value: 1 Argument type: number Acceptable values: - A numeric value - field:FIELD_NAME to use a data defined value taken from the FIELD_NAME field - expression:SOME EXPRESSION to use a data defined value calculated using a custom QGIS expression FRICTION_MODEL: Model Default value: 0 Argument type: enum Available values: - 0: (0) None - 1: (1) Geometric Gradient (Heim 1932) - 2: (2) Fahrboeschung Principle (Heim 1932) - 3: (3) Shadow Angle (Evans & Hungr 1988) - 4: (4) 1-parameter friction model (Scheidegger 1975) - 5: (5) PCM Model (Perla et al. 1980) Acceptable values: - Number of selected option, e.g. '1' - Comma separated list of options, e.g. '1,3' FRICTION_THRES_FREE_FALL: Threshold Angle Free Fall Default value: 60 Argument type: number Acceptable values: - A numeric value - field:FIELD_NAME to use a data defined value taken from the FIELD_NAME field - expression:SOME EXPRESSION to use a data defined value calculated using a custom QGIS expression FRICTION_METHOD_IMPACT: Method Impact Default value: 0 Argument type: enum Available values: - 0: (0) Energy Reduction (Scheidegger 1975) - 1: (1) Preserved Component of Velocity (Kirkby & Statham 1975) Acceptable values: - Number of selected option, e.g. '1' - Comma separated list of options, e.g. '1,3' FRICTION_IMPACT_REDUCTION: Reduction Default value: 75 Argument type: number Acceptable values: - A numeric value - field:FIELD_NAME to use a data defined value taken from the FIELD_NAME field - expression:SOME EXPRESSION to use a data defined value calculated using a custom QGIS expression FRICTION_ANGLE: Friction Angle Default value: 30 Argument type: number Acceptable values: - A numeric value - field:FIELD_NAME to use a data defined value taken from the FIELD_NAME field - expression:SOME EXPRESSION to use a data defined value calculated using a custom QGIS expression FRICTION_MU: Mu Default value: 0.25 Argument type: number Acceptable values: - A numeric value - field:FIELD_NAME to use a data defined value taken from the FIELD_NAME field - expression:SOME EXPRESSION to use a data defined value calculated using a custom QGIS expression FRICTION_MODE_OF_MOTION: Mode of Motion Default value: 0 Argument type: enum Available values: - 0: (0) Sliding - 1: (1) Rolling Acceptable values: - Number of selected option, e.g. '1' - Comma separated list of options, e.g. '1,3' FRICTION_MASS_TO_DRAG: Mass to Drag Ratio Default value: 200 Argument type: number Acceptable values: - A numeric value - field:FIELD_NAME to use a data defined value taken from the FIELD_NAME field - expression:SOME EXPRESSION to use a data defined value calculated using a custom QGIS expression FRICTION_INIT_VELOCITY: Initial Velocity Default value: 1 Argument type: number Acceptable values: - A numeric value - field:FIELD_NAME to use a data defined value taken from the FIELD_NAME field - expression:SOME EXPRESSION to use a data defined value calculated using a custom QGIS expression DEPOSITION_MODEL: Model Default value: 0 Argument type: enum Available values: - 0: (0) None - 1: (1) On Stop - 2: (2) Slope & On Stop - 3: (3) Velocity & On Stop - 4: (4) min(Slope,Velocity) & On Stop Acceptable values: - Number of selected option, e.g. '1' - Comma separated list of options, e.g. '1,3' DEPOSITION_INITIAL: Initial Deposition on Stop Default value: 20 Argument type: number Acceptable values: - A numeric value - field:FIELD_NAME to use a data defined value taken from the FIELD_NAME field - expression:SOME EXPRESSION to use a data defined value calculated using a custom QGIS expression DEPOSITION_SLOPE_THRES: Slope Threshold Default value: 20 Argument type: number Acceptable values: - A numeric value - field:FIELD_NAME to use a data defined value taken from the FIELD_NAME field - expression:SOME EXPRESSION to use a data defined value calculated using a custom QGIS expression DEPOSITION_VELOCITY_THRES: Velocity Threshold Default value: 15 Argument type: number Acceptable values: - A numeric value - field:FIELD_NAME to use a data defined value taken from the FIELD_NAME field - expression:SOME EXPRESSION to use a data defined value calculated using a custom QGIS expression DEPOSITION_MAX: Maximum Deposition along Path Default value: 20 Argument type: number Acceptable values: - A numeric value - field:FIELD_NAME to use a data defined value taken from the FIELD_NAME field - expression:SOME EXPRESSION to use a data defined value calculated using a custom QGIS expression DEPOSITION_MIN_PATH: Minimum Path Length Default value: 100 Argument type: number Acceptable values: - A numeric value - field:FIELD_NAME to use a data defined value taken from the FIELD_NAME field - expression:SOME EXPRESSION to use a data defined value calculated using a custom QGIS expression SINK_MIN_SLOPE: Minimum Slope Default value: 2.5 Argument type: number Acceptable values: - A numeric value - field:FIELD_NAME to use a data defined value taken from the FIELD_NAME field - expression:SOME EXPRESSION to use a data defined value calculated using a custom QGIS expression
##'
##' @title QGIS algorithm - Gravitational process path model
##'
##' @param DEM `raster` - DEM. Path to a raster layer.
##' @param RELEASE_AREAS `raster` - Release Areas. Path to a raster layer.
##' @param MATERIAL `raster` - Material. Path to a raster layer.
##' @param FRICTION_ANGLE_GRID `raster` - Friction Angle. Path to a raster layer.
##' @param SLOPE_IMPACT_GRID `raster` - Slope Impact Areas. Path to a raster layer.
##' @param FRICTION_MU_GRID `raster` - Friction Parameter Mu. Path to a raster layer.
##' @param FRICTION_MASS_TO_DRAG_GRID `raster` - Mass to Drag Ratio. Path to a raster layer.
##' @param PROCESS_AREA `rasterDestination` - Process Area. Path for new raster layer.
##' @param DEPOSITION `rasterDestination` - Deposition. Path for new raster layer.
##' @param MAX_VELOCITY `rasterDestination` - Maximum Velocity. Path for new raster layer.
##' @param STOP_POSITIONS `rasterDestination` - Stopping Positions. Path for new raster layer.
##' @param PROCESS_PATH_MODEL `enum` of `("(0) Maximum Slope", "(1) Random Walk")` - Model. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.
##' @param RW_SLOPE_THRES `number` - Slope Threshold. A numeric value. field:FIELD_NAME to use a data defined value taken from the FIELD_NAME field. expression:SOME EXPRESSION to use a data defined value calculated using a custom QGIS expression.
##' @param RW_EXPONENT `number` - Exponent. A numeric value. field:FIELD_NAME to use a data defined value taken from the FIELD_NAME field. expression:SOME EXPRESSION to use a data defined value calculated using a custom QGIS expression.
##' @param RW_PERSISTENCE `number` - Persistence Factor. A numeric value. field:FIELD_NAME to use a data defined value taken from the FIELD_NAME field. expression:SOME EXPRESSION to use a data defined value calculated using a custom QGIS expression.
##' @param GPP_ITERATIONS `number` - Iterations. A numeric value. field:FIELD_NAME to use a data defined value taken from the FIELD_NAME field. expression:SOME EXPRESSION to use a data defined value calculated using a custom QGIS expression.
##' @param GPP_PROCESSING_ORDER `enum` of `("(0) RAs in Sequence", "(1) RAs in Sequence per Iteration", "(2) RAs in Parallel per Iteration")` - Processing Order. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.
##' @param GPP_SEED `number` - Seed Value. A numeric value. field:FIELD_NAME to use a data defined value taken from the FIELD_NAME field. expression:SOME EXPRESSION to use a data defined value calculated using a custom QGIS expression.
##' @param FRICTION_MODEL `enum` of `("(0) None", "(1) Geometric Gradient (Heim 1932)", "(2) Fahrboeschung Principle (Heim 1932)", "(3) Shadow Angle (Evans & Hungr 1988)", "(4) 1-parameter friction model (Scheidegger 1975)", "(5) PCM Model (Perla et al. 1980)")` - Model. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.
##' @param FRICTION_THRES_FREE_FALL `number` - Threshold Angle Free Fall. A numeric value. field:FIELD_NAME to use a data defined value taken from the FIELD_NAME field. expression:SOME EXPRESSION to use a data defined value calculated using a custom QGIS expression.
##' @param FRICTION_METHOD_IMPACT `enum` of `("(0) Energy Reduction (Scheidegger 1975)", "(1) Preserved Component of Velocity (Kirkby & Statham 1975)")` - Method Impact. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.
##' @param FRICTION_IMPACT_REDUCTION `number` - Reduction. A numeric value. field:FIELD_NAME to use a data defined value taken from the FIELD_NAME field. expression:SOME EXPRESSION to use a data defined value calculated using a custom QGIS expression.
##' @param FRICTION_ANGLE `number` - Friction Angle. A numeric value. field:FIELD_NAME to use a data defined value taken from the FIELD_NAME field. expression:SOME EXPRESSION to use a data defined value calculated using a custom QGIS expression.
##' @param FRICTION_MU `number` - Mu. A numeric value. field:FIELD_NAME to use a data defined value taken from the FIELD_NAME field. expression:SOME EXPRESSION to use a data defined value calculated using a custom QGIS expression.
##' @param FRICTION_MODE_OF_MOTION `enum` of `("(0) Sliding", "(1) Rolling")` - Mode of Motion. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.
##' @param FRICTION_MASS_TO_DRAG `number` - Mass to Drag Ratio. A numeric value. field:FIELD_NAME to use a data defined value taken from the FIELD_NAME field. expression:SOME EXPRESSION to use a data defined value calculated using a custom QGIS expression.
##' @param FRICTION_INIT_VELOCITY `number` - Initial Velocity. A numeric value. field:FIELD_NAME to use a data defined value taken from the FIELD_NAME field. expression:SOME EXPRESSION to use a data defined value calculated using a custom QGIS expression.
##' @param DEPOSITION_MODEL `enum` of `("(0) None", "(1) On Stop", "(2) Slope & On Stop", "(3) Velocity & On Stop", "(4) min(Slope,Velocity) & On Stop")` - Model. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.
##' @param DEPOSITION_INITIAL `number` - Initial Deposition on Stop. A numeric value. field:FIELD_NAME to use a data defined value taken from the FIELD_NAME field. expression:SOME EXPRESSION to use a data defined value calculated using a custom QGIS expression.
##' @param DEPOSITION_SLOPE_THRES `number` - Slope Threshold. A numeric value. field:FIELD_NAME to use a data defined value taken from the FIELD_NAME field. expression:SOME EXPRESSION to use a data defined value calculated using a custom QGIS expression.
##' @param DEPOSITION_VELOCITY_THRES `number` - Velocity Threshold. A numeric value. field:FIELD_NAME to use a data defined value taken from the FIELD_NAME field. expression:SOME EXPRESSION to use a data defined value calculated using a custom QGIS expression.
##' @param DEPOSITION_MAX `number` - Maximum Deposition along Path. A numeric value. field:FIELD_NAME to use a data defined value taken from the FIELD_NAME field. expression:SOME EXPRESSION to use a data defined value calculated using a custom QGIS expression.
##' @param DEPOSITION_MIN_PATH `number` - Minimum Path Length. A numeric value. field:FIELD_NAME to use a data defined value taken from the FIELD_NAME field. expression:SOME EXPRESSION to use a data defined value calculated using a custom QGIS expression.
##' @param SINK_MIN_SLOPE `number` - Minimum Slope. A numeric value. field:FIELD_NAME to use a data defined value taken from the FIELD_NAME field. expression:SOME EXPRESSION to use a data defined value calculated using a custom QGIS expression.
##' @param ... further parameters passed to `qgisprocess::qgis_run_algorithm()`
##' @param .complete_output logical specifying if complete out of `qgisprocess::qgis_run_algorithm()` should be used (`TRUE`) or first output (most likely the main) should read (`FALSE`). Default value is `TRUE`.
##' @param .quiet logical specifying if parameter `.quiet` for `qgisprocess::qgis_run_algorithm()` Default value is `TRUE`.
##' @param .messages logical specifying if messages from `qgisprocess::qgis_run_algorithm()` should be printed (`TRUE`) or not (`FALSE`). Default value is `FALSE`.
##'
##' @details
##' ## Outputs description
##' * DEPOSITION - outputRaster - Deposition
##' * MAX_VELOCITY - outputRaster - Maximum Velocity
##' * PROCESS_AREA - outputRaster - Process Area
##' * STOP_POSITIONS - outputRaster - Stopping Positions
##'
##'
##' @export
##' @md
##' @importFrom qgisprocess qgis_run_algorithm
sagang_gravitationalprocesspathmodel <- function(DEM = qgisprocess:::qgis_default_value(), RELEASE_AREAS = qgisprocess:::qgis_default_value(), MATERIAL = qgisprocess:::qgis_default_value(), FRICTION_ANGLE_GRID = qgisprocess:::qgis_default_value(), SLOPE_IMPACT_GRID = qgisprocess:::qgis_default_value(), FRICTION_MU_GRID = qgisprocess:::qgis_default_value(), FRICTION_MASS_TO_DRAG_GRID = qgisprocess:::qgis_default_value(), PROCESS_AREA = qgisprocess:::qgis_default_value(), DEPOSITION = qgisprocess:::qgis_default_value(), MAX_VELOCITY = qgisprocess:::qgis_default_value(), STOP_POSITIONS = qgisprocess:::qgis_default_value(), PROCESS_PATH_MODEL = qgisprocess:::qgis_default_value(), RW_SLOPE_THRES = qgisprocess:::qgis_default_value(), RW_EXPONENT = qgisprocess:::qgis_default_value(), RW_PERSISTENCE = qgisprocess:::qgis_default_value(), GPP_ITERATIONS = qgisprocess:::qgis_default_value(), GPP_PROCESSING_ORDER = qgisprocess:::qgis_default_value(), GPP_SEED = qgisprocess:::qgis_default_value(), FRICTION_MODEL = qgisprocess:::qgis_default_value(), FRICTION_THRES_FREE_FALL = qgisprocess:::qgis_default_value(), FRICTION_METHOD_IMPACT = qgisprocess:::qgis_default_value(), FRICTION_IMPACT_REDUCTION = qgisprocess:::qgis_default_value(), FRICTION_ANGLE = qgisprocess:::qgis_default_value(), FRICTION_MU = qgisprocess:::qgis_default_value(), FRICTION_MODE_OF_MOTION = qgisprocess:::qgis_default_value(), FRICTION_MASS_TO_DRAG = qgisprocess:::qgis_default_value(), FRICTION_INIT_VELOCITY = qgisprocess:::qgis_default_value(), DEPOSITION_MODEL = qgisprocess:::qgis_default_value(), DEPOSITION_INITIAL = qgisprocess:::qgis_default_value(), DEPOSITION_SLOPE_THRES = qgisprocess:::qgis_default_value(), DEPOSITION_VELOCITY_THRES = qgisprocess:::qgis_default_value(), DEPOSITION_MAX = qgisprocess:::qgis_default_value(), DEPOSITION_MIN_PATH = qgisprocess:::qgis_default_value(), SINK_MIN_SLOPE = qgisprocess:::qgis_default_value(),..., .complete_output = .complete_output_option(), .quiet = .quiet_option(), .messages = .message_option()) {
check_algorithm_necessities("sagang:gravitationalprocesspathmodel")
if (.messages){
output <- qgisprocess::qgis_run_algorithm("sagang:gravitationalprocesspathmodel", `DEM` = DEM, `RELEASE_AREAS` = RELEASE_AREAS, `MATERIAL` = MATERIAL, `FRICTION_ANGLE_GRID` = FRICTION_ANGLE_GRID, `SLOPE_IMPACT_GRID` = SLOPE_IMPACT_GRID, `FRICTION_MU_GRID` = FRICTION_MU_GRID, `FRICTION_MASS_TO_DRAG_GRID` = FRICTION_MASS_TO_DRAG_GRID, `PROCESS_AREA` = PROCESS_AREA, `DEPOSITION` = DEPOSITION, `MAX_VELOCITY` = MAX_VELOCITY, `STOP_POSITIONS` = STOP_POSITIONS, `PROCESS_PATH_MODEL` = PROCESS_PATH_MODEL, `RW_SLOPE_THRES` = RW_SLOPE_THRES, `RW_EXPONENT` = RW_EXPONENT, `RW_PERSISTENCE` = RW_PERSISTENCE, `GPP_ITERATIONS` = GPP_ITERATIONS, `GPP_PROCESSING_ORDER` = GPP_PROCESSING_ORDER, `GPP_SEED` = GPP_SEED, `FRICTION_MODEL` = FRICTION_MODEL, `FRICTION_THRES_FREE_FALL` = FRICTION_THRES_FREE_FALL, `FRICTION_METHOD_IMPACT` = FRICTION_METHOD_IMPACT, `FRICTION_IMPACT_REDUCTION` = FRICTION_IMPACT_REDUCTION, `FRICTION_ANGLE` = FRICTION_ANGLE, `FRICTION_MU` = FRICTION_MU, `FRICTION_MODE_OF_MOTION` = FRICTION_MODE_OF_MOTION, `FRICTION_MASS_TO_DRAG` = FRICTION_MASS_TO_DRAG, `FRICTION_INIT_VELOCITY` = FRICTION_INIT_VELOCITY, `DEPOSITION_MODEL` = DEPOSITION_MODEL, `DEPOSITION_INITIAL` = DEPOSITION_INITIAL, `DEPOSITION_SLOPE_THRES` = DEPOSITION_SLOPE_THRES, `DEPOSITION_VELOCITY_THRES` = DEPOSITION_VELOCITY_THRES, `DEPOSITION_MAX` = DEPOSITION_MAX, `DEPOSITION_MIN_PATH` = DEPOSITION_MIN_PATH, `SINK_MIN_SLOPE` = SINK_MIN_SLOPE,..., .quiet = .quiet)
} else {
suppressMessages(
output <- qgisprocess::qgis_run_algorithm("sagang:gravitationalprocesspathmodel", `DEM` = DEM, `RELEASE_AREAS` = RELEASE_AREAS, `MATERIAL` = MATERIAL, `FRICTION_ANGLE_GRID` = FRICTION_ANGLE_GRID, `SLOPE_IMPACT_GRID` = SLOPE_IMPACT_GRID, `FRICTION_MU_GRID` = FRICTION_MU_GRID, `FRICTION_MASS_TO_DRAG_GRID` = FRICTION_MASS_TO_DRAG_GRID, `PROCESS_AREA` = PROCESS_AREA, `DEPOSITION` = DEPOSITION, `MAX_VELOCITY` = MAX_VELOCITY, `STOP_POSITIONS` = STOP_POSITIONS, `PROCESS_PATH_MODEL` = PROCESS_PATH_MODEL, `RW_SLOPE_THRES` = RW_SLOPE_THRES, `RW_EXPONENT` = RW_EXPONENT, `RW_PERSISTENCE` = RW_PERSISTENCE, `GPP_ITERATIONS` = GPP_ITERATIONS, `GPP_PROCESSING_ORDER` = GPP_PROCESSING_ORDER, `GPP_SEED` = GPP_SEED, `FRICTION_MODEL` = FRICTION_MODEL, `FRICTION_THRES_FREE_FALL` = FRICTION_THRES_FREE_FALL, `FRICTION_METHOD_IMPACT` = FRICTION_METHOD_IMPACT, `FRICTION_IMPACT_REDUCTION` = FRICTION_IMPACT_REDUCTION, `FRICTION_ANGLE` = FRICTION_ANGLE, `FRICTION_MU` = FRICTION_MU, `FRICTION_MODE_OF_MOTION` = FRICTION_MODE_OF_MOTION, `FRICTION_MASS_TO_DRAG` = FRICTION_MASS_TO_DRAG, `FRICTION_INIT_VELOCITY` = FRICTION_INIT_VELOCITY, `DEPOSITION_MODEL` = DEPOSITION_MODEL, `DEPOSITION_INITIAL` = DEPOSITION_INITIAL, `DEPOSITION_SLOPE_THRES` = DEPOSITION_SLOPE_THRES, `DEPOSITION_VELOCITY_THRES` = DEPOSITION_VELOCITY_THRES, `DEPOSITION_MAX` = DEPOSITION_MAX, `DEPOSITION_MIN_PATH` = DEPOSITION_MIN_PATH, `SINK_MIN_SLOPE` = SINK_MIN_SLOPE,..., .quiet = .quiet)
)
}
if (.complete_output) {
return(output)
}
else{
qgisprocess::qgis_extract_output(output, "DEPOSITION")
}
}
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.