grass_r_sim_sediment: QGIS algorithm - r.sim.sediment

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

QGIS algorithm - r.sim.sediment

Description

QGIS Algorithm provided by GRASS r.sim.sediment (grass:r.sim.sediment). Sediment transport and erosion/deposition simulation using path sampling method (SIMWE).

Usage

grass_r_sim_sediment(
  elevation = qgisprocess:::qgis_default_value(),
  water_depth = qgisprocess:::qgis_default_value(),
  dx = qgisprocess:::qgis_default_value(),
  dy = qgisprocess:::qgis_default_value(),
  detachment_coeff = qgisprocess:::qgis_default_value(),
  transport_coeff = qgisprocess:::qgis_default_value(),
  shear_stress = qgisprocess:::qgis_default_value(),
  man = qgisprocess:::qgis_default_value(),
  man_value = qgisprocess:::qgis_default_value(),
  observation = qgisprocess:::qgis_default_value(),
  nwalkers = qgisprocess:::qgis_default_value(),
  niterations = qgisprocess:::qgis_default_value(),
  output_step = qgisprocess:::qgis_default_value(),
  diffusion_coeff = qgisprocess:::qgis_default_value(),
  transport_capacity = qgisprocess:::qgis_default_value(),
  tlimit_erosion_deposition = qgisprocess:::qgis_default_value(),
  sediment_concentration = qgisprocess:::qgis_default_value(),
  sediment_flux = qgisprocess:::qgis_default_value(),
  erosion_deposition = qgisprocess:::qgis_default_value(),
  walkers_output = qgisprocess:::qgis_default_value(),
  logfile = 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(),
  GRASS_SNAP_TOLERANCE_PARAMETER = qgisprocess:::qgis_default_value(),
  GRASS_MIN_AREA_PARAMETER = qgisprocess:::qgis_default_value(),
  GRASS_OUTPUT_TYPE_PARAMETER = qgisprocess:::qgis_default_value(),
  GRASS_VECTOR_DSCO = qgisprocess:::qgis_default_value(),
  GRASS_VECTOR_LCO = qgisprocess:::qgis_default_value(),
  GRASS_VECTOR_EXPORT_NOCAT = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

elevation	raster - Name of the elevation raster map (m). Path to a raster layer.
water_depth	raster - Name of the water depth raster map (m). Path to a raster layer.
dx	raster - Name of the x-derivatives raster map (m/m). Path to a raster layer.
dy	raster - Name of the y-derivatives raster map (m/m). Path to a raster layer.
detachment_coeff	raster - Name of the detachment capacity coefficient raster map (s/m). Path to a raster layer.
transport_coeff	raster - Name of the transport capacity coefficient raster map (s). Path to a raster layer.
shear_stress	raster - Name of the critical shear stress raster map (Pa). Path to a raster layer.
man	raster - Name of the Mannings n raster map. Path to a raster layer.
man_value	number - Name of the Mannings n value. 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.
observation	source - Sampling locations vector points. Path to a vector layer.
nwalkers	number - Number of walkers. 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.
niterations	number - Time used for iterations (minutes). 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_step	number - Time interval for creating output maps (minutes). 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.
diffusion_coeff	number - Water diffusion constant. 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.
transport_capacity	rasterDestination - Transport capacity (kg/ms). Path for new raster layer.
tlimit_erosion_deposition	rasterDestination - Transport limited erosion-deposition (kg/m2s). Path for new raster layer.
sediment_concentration	rasterDestination - Sediment concentration (particle/m3). Path for new raster layer.
sediment_flux	rasterDestination - Sediment flux (kg/ms). Path for new raster layer.
erosion_deposition	rasterDestination - Erosion-deposition (kg/m2s). Path for new raster layer.
walkers_output	vectorDestination - Name of the output walkers vector points layer. Path for new vector layer.
logfile	fileDestination - Name for sampling points output text file.. 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.
GRASS_SNAP_TOLERANCE_PARAMETER	number - v.in.ogr snap tolerance (-1 = no snap). 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_MIN_AREA_PARAMETER	number - v.in.ogr min area. 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_OUTPUT_TYPE_PARAMETER	enum of ⁠("auto", "point", "line", "area")⁠ - v.out.ogr output type. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.
GRASS_VECTOR_DSCO	string - v.out.ogr output data source options (dsco). 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_VECTOR_LCO	string - v.out.ogr output layer options (lco). 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_VECTOR_EXPORT_NOCAT	boolean - Also export features without category (not labeled). Otherwise only features with category are exported. 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.
...	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

• erosion_deposition - outputRaster - Erosion-deposition (kg/m2s)

• logfile - outputFile - Name for sampling points output text file.

• sediment_concentration - outputRaster - Sediment concentration (particle/m3)

• sediment_flux - outputRaster - Sediment flux (kg/ms)

• tlimit_erosion_deposition - outputRaster - Transport limited erosion-deposition (kg/m2s)

• transport_capacity - outputRaster - Transport capacity (kg/ms)

• walkers_output - outputVector - Name of the output walkers vector points layer

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