sagang_gridcellareacoveredbypolygons: QGIS algorithm - Grid cell area covered by polygons

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

QGIS algorithm - Grid cell area covered by polygons

Description

QGIS Algorithm provided by SAGA Next Gen Grid cell area covered by polygons (sagang:gridcellareacoveredbypolygons). —————- Arguments —————- POLYGONS: Polygons Argument type: source Acceptable values: - Path to a vector layer METHOD: Method Default value: 1 Argument type: enum Available values: - 0: (0) cell wise - 1: (1) polygon wise Acceptable values: - Number of selected option, e.g. '1' - Comma separated list of options, e.g. '1,3' OUTPUT: Output Default value: 1 Argument type: enum Available values: - 0: (0) area - 1: (1) percentage Acceptable values: - Number of selected option, e.g. '1' - Comma separated list of options, e.g. '1,3' SELECTION: Only Selected Polygons Default value: true 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 TARGET_USER_XMIN TARGET_USER_XMAX TARGET_USER_YMIN TARGET_USER_YMAX: Output extent (optional) Argument type: extent Acceptable values: - 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. TARGET_USER_SIZE: Cellsize Default value: 100 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 AREA: Area of Coverage Argument type: rasterDestination Acceptable values: - Path for new raster layer

Usage

sagang_gridcellareacoveredbypolygons(
  POLYGONS = qgisprocess:::qgis_default_value(),
  METHOD = qgisprocess:::qgis_default_value(),
  OUTPUT = qgisprocess:::qgis_default_value(),
  SELECTION = qgisprocess:::qgis_default_value(),
  TARGET_USER_XMIN_TARGET_USER_XMAX_TARGET_USER_YMIN_TARGET_USER_YMAX =
    qgisprocess:::qgis_default_value(),
  TARGET_USER_SIZE = qgisprocess:::qgis_default_value(),
  AREA = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

POLYGONS	source - Polygons. Path to a vector layer.
METHOD	enum of ⁠("(0) cell wise", "(1) polygon wise")⁠ - Method. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.
OUTPUT	enum of ⁠("(0) area", "(1) percentage")⁠ - Output. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.
SELECTION	boolean - Only Selected Polygons. 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.
TARGET_USER_XMIN_TARGET_USER_XMAX_TARGET_USER_YMIN_TARGET_USER_YMAX	extent - Output 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.. Original algorithm parameter name: TARGET_USER_XMIN TARGET_USER_XMAX TARGET_USER_YMIN TARGET_USER_YMAX.
TARGET_USER_SIZE	number - Cellsize. 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.
AREA	rasterDestination - Area of Coverage. 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

• AREA - outputRaster - Area of Coverage

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