sagang_skyviewfactor: QGIS algorithm - Sky view factor

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

QGIS algorithm - Sky view factor

Description

QGIS Algorithm provided by SAGA Next Gen Sky view factor (sagang:skyviewfactor). —————- Arguments —————- DEM: Elevation Argument type: raster Acceptable values: - Path to a raster layer VISIBLE: Visible Sky Argument type: rasterDestination Acceptable values: - Path for new raster layer SVF: Sky View Factor Argument type: rasterDestination Acceptable values: - Path for new raster layer SIMPLE: Sky View Factor (Simplified) Argument type: rasterDestination Acceptable values: - Path for new raster layer TERRAIN: Terrain View Factor Argument type: rasterDestination Acceptable values: - Path for new raster layer DISTANCE: Average View Distance Argument type: rasterDestination Acceptable values: - Path for new raster layer RADIUS: Maximum Search Radius Default value: 10000 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 NDIRS: Number of Sectors Default value: 8 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 METHOD: Method Default value: 0 Argument type: enum Available values: - 0: (0) cell size - 1: (1) multi scale Acceptable values: - Number of selected option, e.g. '1' - Comma separated list of options, e.g. '1,3' DLEVEL: Multi Scale Factor Default value: 3 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_skyviewfactor(
  DEM = qgisprocess:::qgis_default_value(),
  VISIBLE = qgisprocess:::qgis_default_value(),
  SVF = qgisprocess:::qgis_default_value(),
  SIMPLE = qgisprocess:::qgis_default_value(),
  TERRAIN = qgisprocess:::qgis_default_value(),
  DISTANCE = qgisprocess:::qgis_default_value(),
  RADIUS = qgisprocess:::qgis_default_value(),
  NDIRS = qgisprocess:::qgis_default_value(),
  METHOD = qgisprocess:::qgis_default_value(),
  DLEVEL = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

DEM	raster - Elevation. Path to a raster layer.
VISIBLE	rasterDestination - Visible Sky. Path for new raster layer.
SVF	rasterDestination - Sky View Factor. Path for new raster layer.
SIMPLE	rasterDestination - Sky View Factor (Simplified). Path for new raster layer.
TERRAIN	rasterDestination - Terrain View Factor. Path for new raster layer.
DISTANCE	rasterDestination - Average View Distance. Path for new raster layer.
RADIUS	number - Maximum Search Radius. 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.
NDIRS	number - Number of Sectors. 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.
METHOD	enum of ⁠("(0) cell size", "(1) multi scale")⁠ - Method. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.
DLEVEL	number - Multi Scale Factor. 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

• DISTANCE - outputRaster - Average View Distance

• SIMPLE - outputRaster - Sky View Factor (Simplified)

• SVF - outputRaster - Sky View Factor

• TERRAIN - outputRaster - Terrain View Factor

• VISIBLE - outputRaster - Visible Sky

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