grass_v_surf_bspline: QGIS algorithm - v.surf.bspline

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

QGIS algorithm - v.surf.bspline

Description

QGIS Algorithm provided by GRASS v.surf.bspline (grass:v.surf.bspline). Bicubic or bilinear spline interpolation with Tykhonov regularization.

Usage

grass_v_surf_bspline(
  input = qgisprocess:::qgis_default_value(),
  column = qgisprocess:::qgis_default_value(),
  sparse_input = qgisprocess:::qgis_default_value(),
  ew_step = qgisprocess:::qgis_default_value(),
  ns_step = qgisprocess:::qgis_default_value(),
  method = qgisprocess:::qgis_default_value(),
  lambda_i = qgisprocess:::qgis_default_value(),
  solver = qgisprocess:::qgis_default_value(),
  maxit = qgisprocess:::qgis_default_value(),
  error = qgisprocess:::qgis_default_value(),
  memory = qgisprocess:::qgis_default_value(),
  output = qgisprocess:::qgis_default_value(),
  raster_output = qgisprocess:::qgis_default_value(),
  GRASS_REGION_PARAMETER = qgisprocess:::qgis_default_value(),
  GRASS_REGION_CELLSIZE_PARAMETER = qgisprocess:::qgis_default_value(),
  GRASS_RASTER_FORMAT_OPT = qgisprocess:::qgis_default_value(),
  GRASS_RASTER_FORMAT_META = qgisprocess:::qgis_default_value(),
  GRASS_SNAP_TOLERANCE_PARAMETER = qgisprocess:::qgis_default_value(),
  GRASS_MIN_AREA_PARAMETER = qgisprocess:::qgis_default_value(),
  GRASS_OUTPUT_TYPE_PARAMETER = qgisprocess:::qgis_default_value(),
  GRASS_VECTOR_DSCO = qgisprocess:::qgis_default_value(),
  GRASS_VECTOR_LCO = qgisprocess:::qgis_default_value(),
  GRASS_VECTOR_EXPORT_NOCAT = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

input	source - Input points layer. Path to a vector layer.
column	field - Attribute table column with values to interpolate. The name of an existing field. ; delimited list of existing field names.
sparse_input	source - Sparse points layer. Path to a vector layer.
ew_step	number - Length of each spline step in the east-west direction. 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.
ns_step	number - Length of each spline step in the north-south direction. 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.
method	enum of ⁠("bilinear", "bicubic")⁠ - Spline interpolation algorithm. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.
lambda_i	number - Tykhonov regularization parameter (affects smoothing). 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.
solver	enum of ⁠("cholesky", "cg")⁠ - Type of solver which should solve the symmetric linear equation system. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.
maxit	number - Maximum number of iteration used to solve the linear equation system. 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.
error	number - Error break criteria for iterative solver. 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.
memory	number - Maximum memory to be used (in MB). 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.
output	vectorDestination - Output vector. Path for new vector layer.
raster_output	rasterDestination - Interpolated spline. Path for new raster layer.
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_RASTER_FORMAT_OPT	string - Output Rasters format options (createopt). 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.
GRASS_RASTER_FORMAT_META	string - Output Rasters format metadata options (metaopt). 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.
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.
GRASS_OUTPUT_TYPE_PARAMETER	enum of ⁠("auto", "point", "line", "area")⁠ - v.out.ogr output type. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.
GRASS_VECTOR_DSCO	string - v.out.ogr output data source options (dsco). 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.
GRASS_VECTOR_LCO	string - v.out.ogr output layer options (lco). 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.
GRASS_VECTOR_EXPORT_NOCAT	boolean - Also export features without category (not labeled). Otherwise only features with category are exported. 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.
...	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 - outputVector - Output vector

• raster_output - outputRaster - Interpolated spline

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