QGIS algorithm - r.terraflow

QGIS Algorithm provided by GRASS r.terraflow (grass:r.terraflow). Flow computation for massive grids.

grass_r_terraflow(
  elevation = qgisprocess:::qgis_default_value(),
  .s = qgisprocess:::qgis_default_value(),
  d8cut = qgisprocess:::qgis_default_value(),
  memory = qgisprocess:::qgis_default_value(),
  filled = qgisprocess:::qgis_default_value(),
  direction = qgisprocess:::qgis_default_value(),
  swatershed = qgisprocess:::qgis_default_value(),
  accumulation = qgisprocess:::qgis_default_value(),
  tci = qgisprocess:::qgis_default_value(),
  stats = 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

elevation

raster - Name of elevation raster map. Path to a raster layer.

.s

boolean - SFD (D8) flow (default is MFD). 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.

d8cut

number - Routing using SFD (D8) direction. 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.

memory

number - Maximum memory to be used (in MB). 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.

filled

rasterDestination - Filled (flooded) elevation. Path for new raster layer.

direction

rasterDestination - Flow direction. Path for new raster layer.

swatershed

rasterDestination - Sink-watershed. Path for new raster layer.

accumulation

rasterDestination - Flow accumulation. Path for new raster layer.

tci

rasterDestination - Topographic convergence index (tci). Path for new raster layer.

stats

fileDestination - Runtime statistics. Path for new file.

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

• accumulation - outputRaster - Flow accumulation

• direction - outputRaster - Flow direction

• filled - outputRaster - Filled (flooded) elevation

• stats - outputFile - Runtime statistics

• swatershed - outputRaster - Sink-watershed

• tci - outputRaster - Topographic convergence index (tci)