grass_r_blend_rgb: QGIS algorithm - r.blend.rgb

View source: R/grass_r_blend_rgb.R

grass_r_blend_rgbR Documentation

QGIS algorithm - r.blend.rgb

Description

QGIS Algorithm provided by GRASS r.blend.rgb (grass:r.blend.rgb). r.blend.rgb - Blends color components of two raster maps by a given ratio and exports into three rasters.

Usage

grass_r_blend_rgb(
  first = qgisprocess:::qgis_default_value(),
  second = qgisprocess:::qgis_default_value(),
  percent = qgisprocess:::qgis_default_value(),
  output_red = qgisprocess:::qgis_default_value(),
  output_green = qgisprocess:::qgis_default_value(),
  output_blue = qgisprocess:::qgis_default_value(),
  GRASS_REGION_PARAMETER = qgisprocess:::qgis_default_value(),
  GRASS_REGION_CELLSIZE_PARAMETER = qgisprocess:::qgis_default_value(),
  GRASS_RASTER_FORMAT_OPT = qgisprocess:::qgis_default_value(),
  GRASS_RASTER_FORMAT_META = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

first

raster - Name of first raster map for blending. Path to a raster layer.

second

raster - Name of second raster map for blending. Path to a raster layer.

percent

number - Percentage weight of first map for color blending. 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_red

rasterDestination - Blended Red. Path for new raster layer.

output_green

rasterDestination - Blended Green. Path for new raster layer.

output_blue

rasterDestination - Blended Blue. Path for new raster layer.

GRASS_REGION_PARAMETER

extent - GRASS GIS region extent. 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..

GRASS_REGION_CELLSIZE_PARAMETER

number - GRASS GIS region cellsize (leave 0 for default). 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.

GRASS_RASTER_FORMAT_OPT

string - Output Rasters format options (createopt). 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.

GRASS_RASTER_FORMAT_META

string - Output Rasters format metadata options (metaopt). 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_blue - outputRaster - Blended Blue

  • output_green - outputRaster - Blended Green

  • output_red - outputRaster - Blended Red


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