sagang_crossprofiles: QGIS algorithm - Cross profiles

View source: R/sagang_crossprofiles.R

sagang_crossprofilesR Documentation

QGIS algorithm - Cross profiles

Description

QGIS Algorithm provided by SAGA Next Gen Cross profiles (sagang:crossprofiles). —————- Arguments —————- DEM: Elevation Argument type: raster Acceptable values: - Path to a raster layer LINES: Lines Argument type: source Acceptable values: - Path to a vector layer PROFILES: Cross Profiles Argument type: vectorDestination Acceptable values: - Path for new vector layer DIST_LINE: Profile Distance Default value: 10 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 DIST_PROFILE: Profile Length Default value: 10 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 NUM_PROFILE: Profile Samples 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 INTERPOLATION: Interpolation Default value: 3 Argument type: enum Available values: - 0: (0) Nearest Neighbour - 1: (1) Bilinear Interpolation - 2: (2) Bicubic Spline Interpolation - 3: (3) B-Spline Interpolation Acceptable values: - Number of selected option, e.g. '1' - Comma separated list of options, e.g. '1,3' OUTPUT: Output Default value: 2 Argument type: enum Available values: - 0: (0) vertices - 1: (1) attributes - 2: (2) vertices and attributes Acceptable values: - Number of selected option, e.g. '1' - Comma separated list of options, e.g. '1,3'

Usage

sagang_crossprofiles(
  DEM = qgisprocess:::qgis_default_value(),
  LINES = qgisprocess:::qgis_default_value(),
  PROFILES = qgisprocess:::qgis_default_value(),
  DIST_LINE = qgisprocess:::qgis_default_value(),
  DIST_PROFILE = qgisprocess:::qgis_default_value(),
  NUM_PROFILE = qgisprocess:::qgis_default_value(),
  INTERPOLATION = qgisprocess:::qgis_default_value(),
  OUTPUT = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

DEM

raster - Elevation. Path to a raster layer.

LINES

source - Lines. Path to a vector layer.

PROFILES

vectorDestination - Cross Profiles. Path for new vector layer.

DIST_LINE

number - Profile Distance. 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.

DIST_PROFILE

number - Profile Length. 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.

NUM_PROFILE

number - Profile Samples. 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.

INTERPOLATION

enum of ⁠("(0) Nearest Neighbour", "(1) Bilinear Interpolation", "(2) Bicubic Spline Interpolation", "(3) B-Spline Interpolation")⁠ - Interpolation. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.

OUTPUT

enum of ⁠("(0) vertices", "(1) attributes", "(2) vertices and attributes")⁠ - Output. 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

  • PROFILES - outputVector - Cross Profiles


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