qgis_extractzvalues: QGIS algorithm - Extract Z values

View source: R/qgis_extractzvalues.R

qgis_extractzvaluesR Documentation

QGIS algorithm - Extract Z values

Description

QGIS Algorithm provided by QGIS (native c++) Extract Z values (native:extractzvalues). Extracts z values (or z value statistics) from geometries into feature attributes. Extracts z values from geometries into feature attributes. By default only the z value from the first vertex of each feature is extracted, however the algorithm can optionally calculate statistics on all of the geometry's z values, including sums, means, and minimums and maximums

Usage

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

Arguments

INPUT

source - Input layer. Path to a vector layer.

SUMMARIES

enum of ⁠("First", "Last", "Count", "Sum", "Mean", "Median", "St dev (pop)", "Minimum", "Maximum", "Range", "Minority", "Majority", "Variety", "Q1", "Q3", "IQR")⁠ - Summaries to calculate. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.

COLUMN_PREFIX

string - Output column prefix. 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.

OUTPUT

sink - Extracted. 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

  • OUTPUT - outputVector - Extracted


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