QGIS Algorithm provided by GRASS r.drain (grass:r.drain). Traces a flow through an elevation model on a raster map.
grass_r_drain(
input = qgisprocess:::qgis_default_value(),
direction = qgisprocess:::qgis_default_value(),
start_coordinates = qgisprocess:::qgis_default_value(),
start_points = qgisprocess:::qgis_default_value(),
.c = qgisprocess:::qgis_default_value(),
.a = qgisprocess:::qgis_default_value(),
.n = qgisprocess:::qgis_default_value(),
.d = qgisprocess:::qgis_default_value(),
output = qgisprocess:::qgis_default_value(),
drain = 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()
)raster - Elevation. Path to a raster layer.
raster - Name of input movement direction map associated with the cost surface. Path to a raster layer.
point - Map coordinates of starting point(s) (E,N). Point coordinate as an 'x,y' string, e.g. '1.5,10.1'.
source - Vector layer containing starting point(s). Path to a vector layer.
boolean - Copy input cell values on output. 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: -c.
boolean - Accumulate input values along the path. 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: -a.
boolean - Count cell numbers along the path. 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: -n.
boolean - The input raster map is a cost surface (direction surface must also be specified). 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: -d.
rasterDestination - Least cost path. Path for new raster layer.
vectorDestination - Drain. Path for new vector layer.
extent - GRASS GIS 7 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..
number - GRASS GIS 7 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.
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.
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.
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.
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.
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'.
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.
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.
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()
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.
logical specifying if parameter .quiet for qgisprocess::qgis_run_algorithm() Default value is TRUE.
logical specifying if messages from qgisprocess::qgis_run_algorithm() should be printed (TRUE) or not (FALSE). Default value is FALSE.