grass_r_spread: QGIS algorithm - r.spread

In JanCaha/r_package_qgis: An extension of package "qgisprocess" providing direct R functions for QGIS functions

QGIS algorithm - r.spread

Description

QGIS Algorithm provided by GRASS r.spread (grass:r.spread). Simulates elliptically anisotropic spread.

Usage

grass_r_spread(
  base_ros = qgisprocess:::qgis_default_value(),
  max_ros = qgisprocess:::qgis_default_value(),
  direction_ros = qgisprocess:::qgis_default_value(),
  start = qgisprocess:::qgis_default_value(),
  spotting_distance = qgisprocess:::qgis_default_value(),
  wind_speed = qgisprocess:::qgis_default_value(),
  fuel_moisture = qgisprocess:::qgis_default_value(),
  backdrop = qgisprocess:::qgis_default_value(),
  least_size = qgisprocess:::qgis_default_value(),
  comp_dens = qgisprocess:::qgis_default_value(),
  init_time = qgisprocess:::qgis_default_value(),
  lag = qgisprocess:::qgis_default_value(),
  .s = qgisprocess:::qgis_default_value(),
  .i = qgisprocess:::qgis_default_value(),
  output = qgisprocess:::qgis_default_value(),
  x_output = qgisprocess:::qgis_default_value(),
  y_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()
)

Arguments

base_ros	raster - Raster map containing base ROS (cm/min). Path to a raster layer.
max_ros	raster - Raster map containing maximal ROS (cm/min). Path to a raster layer.
direction_ros	raster - Raster map containing directions of maximal ROS (degree). Path to a raster layer.
start	raster - Raster map containing starting sources. Path to a raster layer.
spotting_distance	raster - Raster map containing maximal spotting distance (m, required with -s). Path to a raster layer.
wind_speed	raster - Raster map containing midflame wind speed (ft/min, required with -s). Path to a raster layer.
fuel_moisture	raster - Raster map containing fine fuel moisture of the cell receiving a spotting firebrand (%, required with -s). Path to a raster layer.
backdrop	raster - Name of raster map as a display backdrop. Path to a raster layer.
least_size	enum of ⁠("3", "5", "7", "9", "11", "13", "15")⁠ - Basic sampling window size needed to meet certain accuracy (3). Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.
comp_dens	number - Sampling density for additional computing (range: 0.0 - 1.0 (0.5)). 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.
init_time	number - Initial time for current simulation (0) (min). 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.
lag	number - Simulating time duration LAG (fill the region) (min). 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.
.s	boolean - Consider spotting effect (for wildfires). 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: -s.
.i	boolean - Use start raster map values in output spread time raster map. 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: -i.
output	rasterDestination - Spread Time. Path for new raster layer.
x_output	rasterDestination - X Back Coordinates. Path for new raster layer.
y_output	rasterDestination - Y Back Coordinates. Path for new raster layer.
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..
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.
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.
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.
...	further parameters passed to qgisprocess::qgis_run_algorithm()
.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.
.quiet	logical specifying if parameter .quiet for qgisprocess::qgis_run_algorithm() Default value is TRUE.
.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 - Spread Time

• x_output - outputRaster - X Back Coordinates

• y_output - outputRaster - Y Back Coordinates

JanCaha/r_package_qgis documentation built on Nov. 3, 2024, 5:25 p.m.