grass_i_pansharpen: QGIS algorithm - i.pansharpen

View source: R/grass_i_pansharpen.R

grass_i_pansharpenR Documentation

QGIS algorithm - i.pansharpen

Description

QGIS Algorithm provided by GRASS i.pansharpen (grass:i.pansharpen). Image fusion algorithms to sharpen multispectral with high-res panchromatic channels

Usage

grass_i_pansharpen(
  red = qgisprocess:::qgis_default_value(),
  green = qgisprocess:::qgis_default_value(),
  blue = qgisprocess:::qgis_default_value(),
  pan = qgisprocess:::qgis_default_value(),
  method = qgisprocess:::qgis_default_value(),
  .l = qgisprocess:::qgis_default_value(),
  .s = qgisprocess:::qgis_default_value(),
  redoutput = qgisprocess:::qgis_default_value(),
  greenoutput = qgisprocess:::qgis_default_value(),
  blueoutput = 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

red

raster - Name of red channel. Path to a raster layer.

green

raster - Name of green channel. Path to a raster layer.

blue

raster - Name of blue channel. Path to a raster layer.

pan

raster - Name of raster map to be used for high resolution panchromatic channel. Path to a raster layer.

method

enum of ⁠("brovey", "ihs", "pca")⁠ - Method. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.

.l

boolean - Rebalance blue channel for LANDSAT. 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. Original algorithm parameter name: -l.

.s

boolean - Process bands serially (default: run in parallel). 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. Original algorithm parameter name: -s.

redoutput

rasterDestination - Enhanced Red. Path for new raster layer.

greenoutput

rasterDestination - Enhanced Green. Path for new raster layer.

blueoutput

rasterDestination - Enhanced 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

  • blueoutput - outputRaster - Enhanced Blue

  • greenoutput - outputRaster - Enhanced Green

  • redoutput - outputRaster - Enhanced Red


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