sagang_cloudoverlap: QGIS algorithm - Cloud overlap

View source: R/sagang_cloudoverlap.R

sagang_cloudoverlapR Documentation

QGIS algorithm - Cloud overlap

Description

QGIS Algorithm provided by SAGA Next Gen Cloud overlap (sagang:cloudoverlap). —————- Arguments —————- COVERS: Cloud Fractions Argument type: multilayer HEIGHTS: Heights Argument type: multilayer GROUND: Surface Elevation Argument type: raster Acceptable values: - Path to a raster layer WIND: Wind effect Argument type: raster Acceptable values: - Path to a raster layer CBASE: Cloud Base Argument type: raster Acceptable values: - Path to a raster layer COVER: Total Cloud Cover Argument type: rasterDestination Acceptable values: - Path for new raster layer BLOCKS: Number of Cloud Blocks Argument type: rasterDestination Acceptable values: - Path for new raster layer INTERVAL: Interval Default value: 100 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 MINCOVER: Minimum Cloud Cover Fraction Default value: 0.1 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_cloudoverlap(
  COVERS = qgisprocess:::qgis_default_value(),
  HEIGHTS = qgisprocess:::qgis_default_value(),
  GROUND = qgisprocess:::qgis_default_value(),
  WIND = qgisprocess:::qgis_default_value(),
  CBASE = qgisprocess:::qgis_default_value(),
  COVER = qgisprocess:::qgis_default_value(),
  BLOCKS = qgisprocess:::qgis_default_value(),
  INTERVAL = qgisprocess:::qgis_default_value(),
  MINCOVER = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

COVERS

multilayer - Cloud Fractions. .

HEIGHTS

multilayer - Heights. .

GROUND

raster - Surface Elevation. Path to a raster layer.

WIND

raster - Wind effect. Path to a raster layer.

CBASE

raster - Cloud Base. Path to a raster layer.

COVER

rasterDestination - Total Cloud Cover. Path for new raster layer.

BLOCKS

rasterDestination - Number of Cloud Blocks. Path for new raster layer.

INTERVAL

number - Interval. 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.

MINCOVER

number - Minimum Cloud Cover Fraction. 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

  • BLOCKS - outputRaster - Number of Cloud Blocks

  • COVER - outputRaster - Total Cloud Cover


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