qgis_rasterize: QGIS algorithm - Convert map to raster

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

QGIS algorithm - Convert map to raster

Description

QGIS Algorithm provided by QGIS (native c++) Convert map to raster (native:rasterize). Renders the map canvas to a raster file. This algorithm rasterizes map canvas content. A map theme can be selected to render a predetermined set of layers with a defined style for each layer. Alternatively, a set of layers can be selected if no map theme is set. If neither map theme nor layer is set, all the visible layers in the set extent will be rendered. The minimum extent entered will internally be extended to a multiple of the tile size.

Usage

qgis_rasterize(
  EXTENT = qgisprocess:::qgis_default_value(),
  EXTENT_BUFFER = qgisprocess:::qgis_default_value(),
  TILE_SIZE = qgisprocess:::qgis_default_value(),
  MAP_UNITS_PER_PIXEL = qgisprocess:::qgis_default_value(),
  MAKE_BACKGROUND_TRANSPARENT = qgisprocess:::qgis_default_value(),
  MAP_THEME = qgisprocess:::qgis_default_value(),
  LAYERS = qgisprocess:::qgis_default_value(),
  OUTPUT = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

EXTENT	extent - Minimum extent to render. 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..
EXTENT_BUFFER	number - Buffer around tiles in map units. 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.
TILE_SIZE	number - Tile size. 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.
MAP_UNITS_PER_PIXEL	number - Map units per pixel. 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.
MAKE_BACKGROUND_TRANSPARENT	boolean - Make background transparent. 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.
MAP_THEME	maptheme - Map theme to render. Name of an existing map theme.
LAYERS	multilayer - Layers to render. .
OUTPUT	rasterDestination - Output layer. Path for new raster 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 - outputRaster - Output layer

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