QGIS Algorithm provided by QGIS Distance matrix (qgis:distancematrix). This algorithm creates a table containing a distance matrix, with distances between all the points in a points layer.

qgis_distancematrix(
  INPUT = qgisprocess:::qgis_default_value(),
  INPUT_FIELD = qgisprocess:::qgis_default_value(),
  TARGET = qgisprocess:::qgis_default_value(),
  TARGET_FIELD = qgisprocess:::qgis_default_value(),
  MATRIX_TYPE = qgisprocess:::qgis_default_value(),
  NEAREST_POINTS = qgisprocess:::qgis_default_value(),
  OUTPUT = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

INPUT

source - Input point layer. Path to a vector layer.

INPUT_FIELD

field - Input unique ID field. The name of an existing field. ; delimited list of existing field names.

TARGET

source - Target point layer. Path to a vector layer.

TARGET_FIELD

field - Target unique ID field. The name of an existing field. ; delimited list of existing field names.

MATRIX_TYPE

enum of ("Linear (N*k x 3) distance matrix", "Standard (N x T) distance matrix", "Summary distance matrix (mean, std. dev., min, max)") - Output matrix type. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.

NEAREST_POINTS

number - Use only the nearest (k) target points. 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 - Distance matrix. 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 - Distance matrix