grass_r_quant: QGIS algorithm - r.quant

View source: R/grass_r_quant.R

grass_r_quantR Documentation

QGIS algorithm - r.quant

Description

QGIS Algorithm provided by GRASS r.quant (grass:r.quant). Produces the quantization file for a floating-point map.

Usage

grass_r_quant(
  input = qgisprocess:::qgis_default_value(),
  basemap = qgisprocess:::qgis_default_value(),
  fprange = qgisprocess:::qgis_default_value(),
  range = qgisprocess:::qgis_default_value(),
  .t = qgisprocess:::qgis_default_value(),
  .r = qgisprocess:::qgis_default_value(),
  output = qgisprocess:::qgis_default_value(),
  GRASS_REGION_PARAMETER = qgisprocess:::qgis_default_value(),
  GRASS_REGION_CELLSIZE_PARAMETER = qgisprocess:::qgis_default_value(),
  GRASS_SNAP_TOLERANCE_PARAMETER = qgisprocess:::qgis_default_value(),
  GRASS_MIN_AREA_PARAMETER = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

input

multilayer - Raster layer(s) to be quantized. .

basemap

raster - Base layer to take quant rules from. Path to a raster layer.

fprange

range - Floating point range: dmin,dmax. Two comma separated numeric values, e.g. '1,10'.

range

range - Integer range: min,max. Two comma separated numeric values, e.g. '1,10'.

.t

boolean - Truncate floating point data. 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: -t.

.r

boolean - Round floating point data. 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: -r.

output

folderDestination - Quantized raster(s). Path for an existing or new folder.

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_SNAP_TOLERANCE_PARAMETER

number - v.in.ogr snap tolerance (-1 = no snap). 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_MIN_AREA_PARAMETER

number - v.in.ogr min area. 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

  • output - outputFolder - Quantized raster(s)


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