##' QGIS Algorithm provided by SAGA Next Gen Radius of variance (raster) (sagang:radiusofvarianceraster). ---------------- Arguments ---------------- INPUT: Grid Argument type: raster Acceptable values: - Path to a raster layer RESULT: Radius Argument type: rasterDestination Acceptable values: - Path for new raster layer STDDEV: Standard Deviation 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 RADIUS: Maximum Search Radius (cells) 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 OUTPUT: Type of Output Default value: 0 Argument type: enum Available values: - 0: (0) Cells - 1: (1) Map Units Acceptable values: - Number of selected option, e.g. '1' - Comma separated list of options, e.g. '1,3'
##'
##' @title QGIS algorithm - Radius of variance (raster)
##'
##' @param INPUT `raster` - Grid. Path to a raster layer.
##' @param RESULT `rasterDestination` - Radius. Path for new raster layer.
##' @param STDDEV `number` - Standard Deviation. 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 RADIUS `number` - Maximum Search Radius (cells). 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 OUTPUT `enum` of `("(0) Cells", "(1) Map Units")` - Type of Output. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.
##' @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
##' * RESULT - outputRaster - Radius
##'
##'
##' @export
##' @md
##' @importFrom qgisprocess qgis_run_algorithm
sagang_radiusofvarianceraster <- function(INPUT = qgisprocess:::qgis_default_value(), RESULT = qgisprocess:::qgis_default_value(), STDDEV = qgisprocess:::qgis_default_value(), RADIUS = qgisprocess:::qgis_default_value(), OUTPUT = qgisprocess:::qgis_default_value(),..., .complete_output = .complete_output_option(), .quiet = .quiet_option(), .messages = .message_option()) {
check_algorithm_necessities("sagang:radiusofvarianceraster")
if (.messages){
output <- qgisprocess::qgis_run_algorithm("sagang:radiusofvarianceraster", `INPUT` = INPUT, `RESULT` = RESULT, `STDDEV` = STDDEV, `RADIUS` = RADIUS, `OUTPUT` = OUTPUT,..., .quiet = .quiet)
} else {
suppressMessages(
output <- qgisprocess::qgis_run_algorithm("sagang:radiusofvarianceraster", `INPUT` = INPUT, `RESULT` = RESULT, `STDDEV` = STDDEV, `RADIUS` = RADIUS, `OUTPUT` = OUTPUT,..., .quiet = .quiet)
)
}
if (.complete_output) {
return(output)
}
else{
qgisprocess::qgis_extract_output(output, "RESULT")
}
}
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.