qgis_climbalongline: QGIS algorithm - Climb along line

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

QGIS algorithm - Climb along line

Description

QGIS Algorithm provided by QGIS Climb along line (qgis:climbalongline). This algorithm calculates the total climb and descent along line geometries. Input layers must have Z values present. If Z values are not available, the "Drape" (set Z value from raster) algorithm may be used to add Z values from a DEM layer. The output layer is a copy of the input layer with additional fields that contain the total climb, total descent, the minimum elevation and the maximum elevation for each line geometry. If the input layer contains fields with the same names as these added fields, they will be renamed (field names will be altered to "name_2", "name_3", etc, finding the first non-duplicate name).

Usage

qgis_climbalongline(
  INPUT = qgisprocess:::qgis_default_value(),
  OUTPUT = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

INPUT	source - Line layer. Path to a vector layer.
OUTPUT	sink - Climb layer. Path for new vector 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

• MAXELEVATION - outputNumber - Maximum elevation

• MINELEVATION - outputNumber - Minimum elevation

• OUTPUT - outputVector - Climb layer

• TOTALCLIMB - outputNumber - Total climb

• TOTALDESCENT - outputNumber - Total descent

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