QGIS Algorithm provided by GDAL Proximity (raster distance) (gdal:proximity). —————- Arguments —————- INPUT: Input layer Argument type: raster Acceptable values: - Path to a raster layer BAND: Band number Default value: 1 Argument type: band Acceptable values: - Integer value representing an existing raster band number VALUES: A list of pixel values in the source image to be considered target pixels (optional) Argument type: string Acceptable 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 UNITS: Distance units Default value: 1 Argument type: enum Available values: - 0: Georeferenced coordinates - 1: Pixel coordinates Acceptable values: - Number of selected option, e.g. '1' - Comma separated list of options, e.g. '1,3' MAX_DISTANCE: The maximum distance to be generated (optional) Default value: 0 Argument type: number Acceptable values: - 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 REPLACE: Value to be applied to all pixels that are within the -maxdist of target pixels (optional) Default value: 0 Argument type: number Acceptable values: - 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 NODATA: Nodata value to use for the destination proximity raster (optional) Default value: 0 Argument type: number Acceptable values: - 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 OPTIONS: Additional creation options (optional) Default value: Argument type: string Acceptable 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 EXTRA: Additional command-line parameters (optional) Argument type: string Acceptable 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 DATA_TYPE: Output data type Default value: 5 Argument type: enum Available values: - 0: Byte - 1: Int16 - 2: UInt16 - 3: UInt32 - 4: Int32 - 5: Float32 - 6: Float64 - 7: CInt16 - 8: CInt32 - 9: CFloat32 - 10: CFloat64 - 11: Int8 Acceptable values: - Number of selected option, e.g. '1' - Comma separated list of options, e.g. '1,3' OUTPUT: Proximity map Argument type: rasterDestination Acceptable values: - Path for new raster layer
gdal_proximity(
INPUT = qgisprocess:::qgis_default_value(),
BAND = qgisprocess:::qgis_default_value(),
VALUES = qgisprocess:::qgis_default_value(),
UNITS = qgisprocess:::qgis_default_value(),
MAX_DISTANCE = qgisprocess:::qgis_default_value(),
REPLACE = qgisprocess:::qgis_default_value(),
NODATA = qgisprocess:::qgis_default_value(),
OPTIONS = qgisprocess:::qgis_default_value(),
EXTRA = qgisprocess:::qgis_default_value(),
DATA_TYPE = qgisprocess:::qgis_default_value(),
OUTPUT = qgisprocess:::qgis_default_value(),
...,
.complete_output = .complete_output_option(),
.quiet = .quiet_option(),
.messages = .message_option()
)raster - Input layer. Path to a raster layer.
band - Band number. Integer value representing an existing raster band number.
string - A list of pixel values in the source image to be considered target pixels. 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 ("Georeferenced coordinates", "Pixel coordinates") - Distance units. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.
number - The maximum distance to be generated. 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 - Value to be applied to all pixels that are within the -maxdist of target pixels. 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 - Nodata value to use for the destination proximity raster. 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 - Additional creation options. 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 - Additional command-line parameters. 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 ("Byte", "Int16", "UInt16", "UInt32", "Int32", "Float32", "Float64", "CInt16", "CInt32", "CFloat32", "CFloat64", "Int8") - Output data type. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.
rasterDestination - Proximity map. Path for new raster layer.
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.