QGIS Algorithm provided by GRASS r.distance (grass:r.distance). Locates the closest points between objects in two raster maps.
grass_r_distance(
map = qgisprocess:::qgis_default_value(),
separator = qgisprocess:::qgis_default_value(),
sort = qgisprocess:::qgis_default_value(),
.l = qgisprocess:::qgis_default_value(),
.o = qgisprocess:::qgis_default_value(),
.n = qgisprocess:::qgis_default_value(),
html = qgisprocess:::qgis_default_value(),
GRASS_REGION_PARAMETER = qgisprocess:::qgis_default_value(),
GRASS_REGION_CELLSIZE_PARAMETER = qgisprocess:::qgis_default_value(),
...,
.complete_output = .complete_output_option(),
.quiet = .quiet_option(),
.messages = .message_option()
)
multilayer
- Name of two input raster for computing inter-class distances. .
string
- Field separator (Special characters: pipe, comma, space, tab, newline). 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.
enum
of ("asc", "desc")
- Sort output by distance. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.
boolean
- Include category labels in the 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: -l.
boolean
- Report zero distance if rasters are overlapping. 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: -o.
boolean
- Report null objects as *. 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.
fileDestination
- Distance. Path for new file.
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..
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.
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
.