grass_r_ros: QGIS algorithm - r.ros

View source: R/grass_r_ros.R

grass_r_rosR Documentation

QGIS algorithm - r.ros

Description

QGIS Algorithm provided by GRASS r.ros (grass:r.ros). Generates rate of spread raster maps.

Usage

grass_r_ros(
  model = qgisprocess:::qgis_default_value(),
  moisture_1h = qgisprocess:::qgis_default_value(),
  moisture_10h = qgisprocess:::qgis_default_value(),
  moisture_100h = qgisprocess:::qgis_default_value(),
  moisture_live = qgisprocess:::qgis_default_value(),
  velocity = qgisprocess:::qgis_default_value(),
  direction = qgisprocess:::qgis_default_value(),
  slope = qgisprocess:::qgis_default_value(),
  aspect = qgisprocess:::qgis_default_value(),
  elevation = qgisprocess:::qgis_default_value(),
  base_ros = qgisprocess:::qgis_default_value(),
  max_ros = qgisprocess:::qgis_default_value(),
  direction_ros = qgisprocess:::qgis_default_value(),
  spotting_distance = 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

model

raster - Raster map containing fuel models. Path to a raster layer.

moisture_1h

raster - Raster map containing the 1-hour fuel moisture (%). Path to a raster layer.

moisture_10h

raster - Raster map containing the 10-hour fuel moisture (%). Path to a raster layer.

moisture_100h

raster - Raster map containing the 100-hour fuel moisture (%). Path to a raster layer.

moisture_live

raster - Raster map containing live fuel moisture (%). Path to a raster layer.

velocity

raster - Raster map containing midflame wind velocities (ft/min). Path to a raster layer.

direction

raster - Name of raster map containing wind directions (degree). Path to a raster layer.

slope

raster - Name of raster map containing slope (degree). Path to a raster layer.

aspect

raster - Raster map containing aspect (degree, CCW from E). Path to a raster layer.

elevation

raster - Raster map containing elevation (m, required for spotting). Path to a raster layer.

base_ros

rasterDestination - Base ROS. Path for new raster layer.

max_ros

rasterDestination - Max ROS. Path for new raster layer.

direction_ros

rasterDestination - Direction ROS. Path for new raster layer.

spotting_distance

rasterDestination - Spotting Distance. 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

  • base_ros - outputRaster - Base ROS

  • direction_ros - outputRaster - Direction ROS

  • max_ros - outputRaster - Max ROS

  • spotting_distance - outputRaster - Spotting Distance


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