gdal_pansharp: QGIS algorithm - Pansharpening

View source: R/gdal_pansharp.R

gdal_pansharpR Documentation

QGIS algorithm - Pansharpening

Description

QGIS Algorithm provided by GDAL Pansharpening (gdal:pansharp). —————- Arguments —————- SPECTRAL: Spectral dataset Argument type: raster Acceptable values: - Path to a raster layer PANCHROMATIC: Panchromatic dataset Argument type: raster Acceptable values: - Path to a raster layer RESAMPLING: Resampling algorithm Default value: 2 Argument type: enum Available values: - 0: Nearest Neighbour - 1: Bilinear (2x2 Kernel) - 2: Cubic (4x4 Kernel) - 3: Cubic B-Spline (4x4 Kernel) - 4: Lanczos (6x6 Kernel) - 5: Average Acceptable values: - Number of selected option, e.g. '1' - Comma separated list of options, e.g. '1,3' 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 OUTPUT: Output Argument type: rasterDestination Acceptable values: - Path for new raster layer

Usage

gdal_pansharp(
  SPECTRAL = qgisprocess:::qgis_default_value(),
  PANCHROMATIC = qgisprocess:::qgis_default_value(),
  RESAMPLING = qgisprocess:::qgis_default_value(),
  OPTIONS = qgisprocess:::qgis_default_value(),
  EXTRA = qgisprocess:::qgis_default_value(),
  OUTPUT = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

SPECTRAL

raster - Spectral dataset. Path to a raster layer.

PANCHROMATIC

raster - Panchromatic dataset. Path to a raster layer.

RESAMPLING

enum of ⁠("Nearest Neighbour", "Bilinear (2x2 Kernel)", "Cubic (4x4 Kernel)", "Cubic B-Spline (4x4 Kernel)", "Lanczos (6x6 Kernel)", "Average")⁠ - Resampling algorithm. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.

OPTIONS

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.

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.

OUTPUT

rasterDestination - Output. 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


JanCaha/r_package_qgis documentation built on May 1, 2024, 3:30 a.m.