grass_v_net_flow: QGIS algorithm - v.net.flow

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

QGIS algorithm - v.net.flow

Description

QGIS Algorithm provided by GRASS v.net.flow (grass:v.net.flow). Computes the maximum flow between two sets of nodes in the network.

Usage

grass_v_net_flow(
  input = qgisprocess:::qgis_default_value(),
  points = qgisprocess:::qgis_default_value(),
  threshold = qgisprocess:::qgis_default_value(),
  source_cats = qgisprocess:::qgis_default_value(),
  source_where = qgisprocess:::qgis_default_value(),
  sink_cats = qgisprocess:::qgis_default_value(),
  sink_where = qgisprocess:::qgis_default_value(),
  arc_column = qgisprocess:::qgis_default_value(),
  arc_backward_column = qgisprocess:::qgis_default_value(),
  node_column = qgisprocess:::qgis_default_value(),
  output = qgisprocess:::qgis_default_value(),
  cut = qgisprocess:::qgis_default_value(),
  GRASS_REGION_PARAMETER = 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

input	source - Input vector line layer (network). Path to a vector layer.
points	source - Input vector point layer (flow nodes). Path to a vector layer.
threshold	number - Threshold for connecting centers to the network (in map unit). 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.
source_cats	string - Source Category values. 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.
source_where	string - Source WHERE conditions of SQL statement without 'where' keyword. 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.
sink_cats	string - Sink Category values. 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.
sink_where	string - Sink WHERE conditions of SQL statement without 'where' keyword. 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.
arc_column	field - Arc forward/both direction(s) cost column (number). The name of an existing field. ; delimited list of existing field names.
arc_backward_column	field - Arc backward direction cost column (number). The name of an existing field. ; delimited list of existing field names.
node_column	field - Node cost column (number). The name of an existing field. ; delimited list of existing field names.
output	vectorDestination - Network_Flow. Path for new vector layer.
cut	vectorDestination - Network_Cut. Path for new vector 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_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

• cut - outputVector - Network_Cut

• output - outputVector - Network_Flow

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