gdal_griddatametrics: QGIS algorithm - Grid (Data metrics)

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

QGIS algorithm - Grid (Data metrics)

Description

QGIS Algorithm provided by GDAL Grid (Data metrics) (gdal:griddatametrics). —————- Arguments —————- INPUT: Point layer Argument type: source Acceptable values: - Path to a vector layer Z_FIELD: Z value from field (optional) Argument type: field Acceptable values: - The name of an existing field - ; delimited list of existing field names METRIC: Data metric to use Default value: 0 Argument type: enum Available values: - 0: Minimum - 1: Maximum - 2: Range - 3: Count - 4: Average distance - 5: Average distance between points Acceptable values: - Number of selected option, e.g. '1' - Comma separated list of options, e.g. '1,3' RADIUS_1: The first radius of search ellipse Default value: 0 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 RADIUS_2: The second radius of search ellipse Default value: 0 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 ANGLE: Angle of search ellipse rotation in degrees (counter clockwise) Default value: 0 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 MIN_POINTS: Minimum number of data points to use Default value: 0 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 NODATA: NODATA marker to fill empty points Default value: 0 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 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 DATA_TYPE: Output data type Default value: 5 Argument type: enum Available values: - 0: Byte - 1: Int16 - 2: UInt16 - 3: UInt32 - 4: Int32 - 5: Float32 - 6: Float64 - 7: CInt16 - 8: CInt32 - 9: CFloat32 - 10: CFloat64 - 11: Int8 Acceptable values: - Number of selected option, e.g. '1' - Comma separated list of options, e.g. '1,3' OUTPUT: Interpolated (data metrics) Argument type: rasterDestination Acceptable values: - Path for new raster layer

Usage

gdal_griddatametrics(
  INPUT = qgisprocess:::qgis_default_value(),
  Z_FIELD = qgisprocess:::qgis_default_value(),
  METRIC = qgisprocess:::qgis_default_value(),
  RADIUS_1 = qgisprocess:::qgis_default_value(),
  RADIUS_2 = qgisprocess:::qgis_default_value(),
  ANGLE = qgisprocess:::qgis_default_value(),
  MIN_POINTS = qgisprocess:::qgis_default_value(),
  NODATA = qgisprocess:::qgis_default_value(),
  OPTIONS = qgisprocess:::qgis_default_value(),
  EXTRA = qgisprocess:::qgis_default_value(),
  DATA_TYPE = qgisprocess:::qgis_default_value(),
  OUTPUT = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

INPUT	source - Point layer. Path to a vector layer.
Z_FIELD	field - Z value from field. The name of an existing field. ; delimited list of existing field names.
METRIC	enum of ⁠("Minimum", "Maximum", "Range", "Count", "Average distance", "Average distance between points")⁠ - Data metric to use. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.
RADIUS_1	number - The first radius of search ellipse. 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.
RADIUS_2	number - The second radius of search ellipse. 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.
ANGLE	number - Angle of search ellipse rotation in degrees (counter clockwise). 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.
MIN_POINTS	number - Minimum number of data points to use. 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.
NODATA	number - NODATA marker to fill empty points. 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.
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.
DATA_TYPE	enum of ⁠("Byte", "Int16", "UInt16", "UInt32", "Int32", "Float32", "Float64", "CInt16", "CInt32", "CFloat32", "CFloat64", "Int8")⁠ - Output data type. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.
OUTPUT	rasterDestination - Interpolated (data metrics). 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 - Interpolated (data metrics)

JanCaha/r_package_qgis documentation built on April 4, 2024, 8:10 p.m.