QGIS algorithm - Shortest path (point to layer) — qgis

QGIS Algorithm provided by QGIS (native c++) Shortest path (point to layer) (native:shortestpathpointtolayer). This algorithm computes optimal (shortest or fastest) route between given start point and multiple end points defined by point vector layer. —————- Notes —————- - This algorithm drops existing primary keys or FID values and regenerates them in output layers.

qgis_shortestpathpointtolayer(
  INPUT = qgisprocess:::qgis_default_value(),
  STRATEGY = qgisprocess:::qgis_default_value(),
  DIRECTION_FIELD = qgisprocess:::qgis_default_value(),
  VALUE_FORWARD = qgisprocess:::qgis_default_value(),
  VALUE_BACKWARD = qgisprocess:::qgis_default_value(),
  VALUE_BOTH = qgisprocess:::qgis_default_value(),
  DEFAULT_DIRECTION = qgisprocess:::qgis_default_value(),
  SPEED_FIELD = qgisprocess:::qgis_default_value(),
  DEFAULT_SPEED = qgisprocess:::qgis_default_value(),
  TOLERANCE = qgisprocess:::qgis_default_value(),
  START_POINT = qgisprocess:::qgis_default_value(),
  END_POINTS = qgisprocess:::qgis_default_value(),
  POINT_TOLERANCE = qgisprocess:::qgis_default_value(),
  OUTPUT = qgisprocess:::qgis_default_value(),
  OUTPUT_NON_ROUTABLE = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

INPUT: source - Vector layer representing network. Path to a vector layer.
STRATEGY: enum of ("Shortest", "Fastest") - Path type to calculate. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.
DIRECTION_FIELD: field - Direction field. The name of an existing field. ; delimited list of existing field names.
VALUE_FORWARD: string - Value for forward direction. 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.
VALUE_BACKWARD: string - Value for backward direction. 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.
VALUE_BOTH: string - Value for both directions. 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.
DEFAULT_DIRECTION: enum of ("Forward direction", "Backward direction", "Both directions") - Default direction. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.
SPEED_FIELD: field - Speed field. The name of an existing field. ; delimited list of existing field names.
DEFAULT_SPEED: number - Default speed (km/h). 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.
TOLERANCE: distance - Topology tolerance. 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.
START_POINT: point - Start point. Point coordinate as an 'x,y' string, e.g. '1.5,10.1'.
END_POINTS: source - Vector layer with end points. Path to a vector layer.
POINT_TOLERANCE: distance - Maximum point distance from network. 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: sink - Shortest path. Path for new vector layer.
OUTPUT_NON_ROUTABLE: sink - Non-routable features. Path for new vector layer.
...: 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

OUTPUT - outputVector - Shortest path
OUTPUT_NON_ROUTABLE - outputVector - Non-routable features