sagang_fastrepresentativeness: QGIS algorithm - Fast representativeness

View source: R/sagang_fastrepresentativeness.R

sagang_fastrepresentativenessR Documentation

QGIS algorithm - Fast representativeness

Description

QGIS Algorithm provided by SAGA Next Gen Fast representativeness (sagang:fastrepresentativeness). —————- Arguments —————- INPUT: Input Argument type: raster Acceptable values: - Path to a raster layer RESULT: Output Argument type: rasterDestination Acceptable values: - Path for new raster layer RESULT_LOD: Output Lod Argument type: rasterDestination Acceptable values: - Path for new raster layer SEEDS: Output Seeds Argument type: rasterDestination Acceptable values: - Path for new raster layer LOD: Level of Generalisation Default value: 16 Argument type: number Acceptable values: - 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

Usage

sagang_fastrepresentativeness(
  INPUT = qgisprocess:::qgis_default_value(),
  RESULT = qgisprocess:::qgis_default_value(),
  RESULT_LOD = qgisprocess:::qgis_default_value(),
  SEEDS = qgisprocess:::qgis_default_value(),
  LOD = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

INPUT

raster - Input. Path to a raster layer.

RESULT

rasterDestination - Output. Path for new raster layer.

RESULT_LOD

rasterDestination - Output Lod. Path for new raster layer.

SEEDS

rasterDestination - Output Seeds. Path for new raster layer.

LOD

number - Level of Generalisation. 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.

...

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

  • RESULT - outputRaster - Output

  • RESULT_LOD - outputRaster - Output Lod

  • SEEDS - outputRaster - Output Seeds


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