##' QGIS Algorithm provided by GRASS i.eb.soilheatflux (grass:i.eb.soilheatflux). Soil heat flux approximation (Bastiaanssen, 1995).
##'
##' @title QGIS algorithm - i.eb.soilheatflux
##'
##' @param albedo `raster` - Name of albedo raster map (0.0;1.0). Path to a raster layer.
##' @param ndvi `raster` - Name of NDVI raster map (-1.0;+1.0). Path to a raster layer.
##' @param temperature `raster` - Name of Surface temperature raster map (K). Path to a raster layer.
##' @param netradiation `raster` - Name of Net Radiation raster map (W\code{/}m2). Path to a raster layer.
##' @param localutctime `raster` - Name of time of satellite overpass raster map (local time in UTC). Path to a raster layer.
##' @param .r `boolean` - HAPEX-Sahel empirical correction (Roerink, 1995). 1 for true/yes. 0 for false/no. 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. Original algorithm parameter name: -r.
##' @param output `rasterDestination` - Soil Heat Flux. Path for new raster layer.
##' @param GRASS_REGION_PARAMETER `extent` - GRASS GIS region extent. A comma delimited string of x min, x max, y min, y max. E.g. '4,10,101,105'. Path to a layer. The extent of the layer is used..
##' @param GRASS_REGION_CELLSIZE_PARAMETER `number` - GRASS GIS region cellsize (leave 0 for default). 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 GRASS_RASTER_FORMAT_OPT `string` - Output Rasters format options (createopt). String 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 GRASS_RASTER_FORMAT_META `string` - Output Rasters format metadata options (metaopt). String 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
##' * output - outputRaster - Soil Heat Flux
##'
##'
##' @export
##' @md
##' @importFrom qgisprocess qgis_run_algorithm
grass_i_eb_soilheatflux <- function(albedo = qgisprocess:::qgis_default_value(), ndvi = qgisprocess:::qgis_default_value(), temperature = qgisprocess:::qgis_default_value(), netradiation = qgisprocess:::qgis_default_value(), localutctime = qgisprocess:::qgis_default_value(), .r = qgisprocess:::qgis_default_value(), output = qgisprocess:::qgis_default_value(), GRASS_REGION_PARAMETER = qgisprocess:::qgis_default_value(), GRASS_REGION_CELLSIZE_PARAMETER = qgisprocess:::qgis_default_value(), GRASS_RASTER_FORMAT_OPT = qgisprocess:::qgis_default_value(), GRASS_RASTER_FORMAT_META = qgisprocess:::qgis_default_value(),..., .complete_output = .complete_output_option(), .quiet = .quiet_option(), .messages = .message_option()) {
check_algorithm_necessities("grass:i.eb.soilheatflux")
if (.messages){
output <- qgisprocess::qgis_run_algorithm("grass:i.eb.soilheatflux", `albedo` = albedo, `ndvi` = ndvi, `temperature` = temperature, `netradiation` = netradiation, `localutctime` = localutctime, `-r` = .r, `output` = output, `GRASS_REGION_PARAMETER` = GRASS_REGION_PARAMETER, `GRASS_REGION_CELLSIZE_PARAMETER` = GRASS_REGION_CELLSIZE_PARAMETER, `GRASS_RASTER_FORMAT_OPT` = GRASS_RASTER_FORMAT_OPT, `GRASS_RASTER_FORMAT_META` = GRASS_RASTER_FORMAT_META,..., .quiet = .quiet)
} else {
suppressMessages(
output <- qgisprocess::qgis_run_algorithm("grass:i.eb.soilheatflux", `albedo` = albedo, `ndvi` = ndvi, `temperature` = temperature, `netradiation` = netradiation, `localutctime` = localutctime, `-r` = .r, `output` = output, `GRASS_REGION_PARAMETER` = GRASS_REGION_PARAMETER, `GRASS_REGION_CELLSIZE_PARAMETER` = GRASS_REGION_CELLSIZE_PARAMETER, `GRASS_RASTER_FORMAT_OPT` = GRASS_RASTER_FORMAT_OPT, `GRASS_RASTER_FORMAT_META` = GRASS_RASTER_FORMAT_META,..., .quiet = .quiet)
)
}
if (.complete_output) {
return(output)
}
else{
qgisprocess::qgis_extract_output(output, "output")
}
}
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.