sagang_closegapswithspline: QGIS algorithm - Close gaps with spline

View source: R/sagang_closegapswithspline.R

sagang_closegapswithsplineR Documentation

QGIS algorithm - Close gaps with spline

Description

QGIS Algorithm provided by SAGA Next Gen Close gaps with spline (sagang:closegapswithspline). —————- Arguments —————- GRID: Grid Argument type: raster Acceptable values: - Path to a raster layer MASK: Mask (optional) Argument type: raster Acceptable values: - Path to a raster layer MAXGAPCELLS: Only Process Gaps with Less Cells 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 CLOSED: Closed Gaps Grid Argument type: rasterDestination Acceptable values: - Path for new raster layer MAXPOINTS: Maximum Points Default value: 1000 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 LOCALPOINTS: Number of Points for Local Interpolation Default value: 20 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 EXTENDED: Extended Neighourhood Default value: false 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 NEIGHBOURS: Neighbourhood Default value: 0 Argument type: enum Available values: - 0: (0) Neumann - 1: (1) Moore Acceptable values: - Number of selected option, e.g. '1' - Comma separated list of options, e.g. '1,3' RADIUS: Radius (Cells) 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 RELAXATION: Relaxation 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

Usage

sagang_closegapswithspline(
  GRID = qgisprocess:::qgis_default_value(),
  MASK = qgisprocess:::qgis_default_value(),
  MAXGAPCELLS = qgisprocess:::qgis_default_value(),
  CLOSED = qgisprocess:::qgis_default_value(),
  MAXPOINTS = qgisprocess:::qgis_default_value(),
  LOCALPOINTS = qgisprocess:::qgis_default_value(),
  EXTENDED = qgisprocess:::qgis_default_value(),
  NEIGHBOURS = qgisprocess:::qgis_default_value(),
  RADIUS = qgisprocess:::qgis_default_value(),
  RELAXATION = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

GRID

raster - Grid. Path to a raster layer.

MASK

raster - Mask. Path to a raster layer.

MAXGAPCELLS

number - Only Process Gaps with Less Cells. 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.

CLOSED

rasterDestination - Closed Gaps Grid. Path for new raster layer.

MAXPOINTS

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

LOCALPOINTS

number - Number of Points for Local Interpolation. 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.

EXTENDED

boolean - Extended Neighourhood. 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.

NEIGHBOURS

enum of ⁠("(0) Neumann", "(1) Moore")⁠ - Neighbourhood. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.

RADIUS

number - Radius (Cells). 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.

RELAXATION

number - Relaxation. 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

  • CLOSED - outputRaster - Closed Gaps Grid


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