gdal_rasterize_over_fixed_value: QGIS algorithm - Rasterize (overwrite with fixed value)

View source: R/gdal_rasterize_over_fixed_value.R

gdal_rasterize_over_fixed_valueR Documentation

QGIS algorithm - Rasterize (overwrite with fixed value)

Description

QGIS Algorithm provided by GDAL Rasterize (overwrite with fixed value) (gdal:rasterize_over_fixed_value). —————- Arguments —————- INPUT: Input vector layer Argument type: source Acceptable values: - Path to a vector layer INPUT_RASTER: Input raster layer Argument type: raster Acceptable values: - Path to a raster layer BURN: A fixed value to burn 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 ADD: Add burn in values to existing raster values Default value: false Argument type: boolean Acceptable values: - 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 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

Usage

gdal_rasterize_over_fixed_value(
  INPUT = qgisprocess:::qgis_default_value(),
  INPUT_RASTER = qgisprocess:::qgis_default_value(),
  BURN = qgisprocess:::qgis_default_value(),
  ADD = qgisprocess:::qgis_default_value(),
  EXTRA = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

INPUT

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

INPUT_RASTER

raster - Input raster layer. Path to a raster layer.

BURN

number - A fixed value to burn. 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.

ADD

boolean - Add burn in values to existing raster values. 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.

EXTRA

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.

...

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 - outputRaster - Rasterized


JanCaha/r_package_qgis documentation built on April 4, 2024, 8:10 p.m.