sagang_visibilitypoints: QGIS algorithm - Visibility (points)

View source: R/sagang_visibilitypoints.R

sagang_visibilitypointsR Documentation

QGIS algorithm - Visibility (points)

Description

QGIS Algorithm provided by SAGA Next Gen Visibility (points) (sagang:visibilitypoints). —————- Arguments —————- ELEVATION: Elevation Argument type: raster Acceptable values: - Path to a raster layer VISIBILITY: Visibility Argument type: rasterDestination Acceptable values: - Path for new raster layer POINTS: Points Argument type: source Acceptable values: - Path to a vector layer FIELD_HEIGHT: Height Argument type: field Acceptable values: - The name of an existing field - ; delimited list of existing field names METHOD: Unit Default value: 1 Argument type: enum Available values: - 0: (0) Visibility - 1: (1) Shade - 2: (2) Distance - 3: (3) Size Acceptable values: - Number of selected option, e.g. '1' - Comma separated list of options, e.g. '1,3'

Usage

sagang_visibilitypoints(
  ELEVATION = qgisprocess:::qgis_default_value(),
  VISIBILITY = qgisprocess:::qgis_default_value(),
  POINTS = qgisprocess:::qgis_default_value(),
  FIELD_HEIGHT = qgisprocess:::qgis_default_value(),
  METHOD = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

ELEVATION

raster - Elevation. Path to a raster layer.

VISIBILITY

rasterDestination - Visibility. Path for new raster layer.

POINTS

source - Points. Path to a vector layer.

FIELD_HEIGHT

field - Height. The name of an existing field. ; delimited list of existing field names.

METHOD

enum of ⁠("(0) Visibility", "(1) Shade", "(2) Distance", "(3) Size")⁠ - Unit. 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

  • VISIBILITY - outputRaster - Visibility


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