gdal_overviews: QGIS algorithm - Build overviews (pyramids)

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

QGIS algorithm - Build overviews (pyramids)

Description

QGIS Algorithm provided by GDAL Build overviews (pyramids) (gdal:overviews). —————- Arguments —————- INPUT: Input layer Argument type: raster Acceptable values: - Path to a raster layer CLEAN: Remove all existing overviews 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 LEVELS: Overview levels (e.g. 2 4 8 16) (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 RESAMPLING: Resampling method (optional) Argument type: enum Available values: - 0: Nearest Neighbour (default) - 1: Average - 2: Gaussian - 3: Cubic (4x4 Kernel) - 4: Cubic B-Spline (4x4 Kernel) - 5: Lanczos (6x6 Kernel) - 6: Average MP - 7: Average in Mag/Phase Space - 8: Mode Acceptable values: - Number of selected option, e.g. '1' - Comma separated list of options, e.g. '1,3' FORMAT: Overviews format (optional) Default value: 0 Argument type: enum Available values: - 0: Internal (if possible) - 1: External (GTiff .ovr) - 2: External (ERDAS Imagine .aux) Acceptable values: - Number of selected option, e.g. '1' - Comma separated list of options, e.g. '1,3' 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_overviews(
  INPUT = qgisprocess:::qgis_default_value(),
  CLEAN = qgisprocess:::qgis_default_value(),
  LEVELS = qgisprocess:::qgis_default_value(),
  RESAMPLING = qgisprocess:::qgis_default_value(),
  FORMAT = qgisprocess:::qgis_default_value(),
  EXTRA = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

INPUT	raster - Input layer. Path to a raster layer.
CLEAN	boolean - Remove all existing overviews. 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.
LEVELS	string - Overview levels (e.g. 2 4 8 16). 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.
RESAMPLING	enum of ⁠("Nearest Neighbour (default)", "Average", "Gaussian", "Cubic (4x4 Kernel)", "Cubic B-Spline (4x4 Kernel)", "Lanczos (6x6 Kernel)", "Average MP", "Average in Mag/Phase Space", "Mode")⁠ - Resampling method. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.
FORMAT	enum of ⁠("Internal (if possible)", "External (GTiff .ovr)", "External (ERDAS Imagine .aux)")⁠ - Overviews format. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.
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 - Pyramidized

JanCaha/r_package_qgis documentation built on April 12, 2025, 10:51 a.m.