sagang_multilevelbsplinefromgridpoints: QGIS algorithm - Multilevel b-spline from grid points

View source: R/sagang_multilevelbsplinefromgridpoints.R

sagang_multilevelbsplinefromgridpointsR Documentation

QGIS algorithm - Multilevel b-spline from grid points

Description

QGIS Algorithm provided by SAGA Next Gen Multilevel b-spline from grid points (sagang:multilevelbsplinefromgridpoints). —————- Arguments —————- GRID: Grid Argument type: raster Acceptable values: - Path to a raster layer 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 TARGET_OUT_GRID: Target Grid Argument type: rasterDestination Acceptable values: - Path for new raster layer METHOD: Refinement Default value: 0 Argument type: enum Available values: - 0: (0) no - 1: (1) yes Acceptable values: - Number of selected option, e.g. '1' - Comma separated list of options, e.g. '1,3' EPSILON: Threshold Error Default value: 0.0001 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 LEVEL_MAX: Maximum Level Default value: 11 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 DATATYPE: Data Type Default value: 0 Argument type: enum Available values: - 0: (0) same as input grid - 1: (1) 4 byte floating point number Acceptable values: - Number of selected option, e.g. '1' - Comma separated list of options, e.g. '1,3'

Usage

sagang_multilevelbsplinefromgridpoints(
  GRID = 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(),
  TARGET_OUT_GRID = qgisprocess:::qgis_default_value(),
  METHOD = qgisprocess:::qgis_default_value(),
  EPSILON = qgisprocess:::qgis_default_value(),
  LEVEL_MAX = qgisprocess:::qgis_default_value(),
  DATATYPE = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

GRID

raster - Grid. Path to a raster layer.

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.

TARGET_OUT_GRID

rasterDestination - Target Grid. Path for new raster layer.

METHOD

enum of ⁠("(0) no", "(1) yes")⁠ - Refinement. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.

EPSILON

number - Threshold Error. 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.

LEVEL_MAX

number - Maximum Level. 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.

DATATYPE

enum of ⁠("(0) same as input grid", "(1) 4 byte floating point number")⁠ - Data Type. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.

...

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

  • TARGET_OUT_GRID - outputRaster - Target Grid


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