sagang_connectivityanalysis: QGIS algorithm - Connectivity analysis

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

QGIS algorithm - Connectivity analysis

Description

QGIS Algorithm provided by SAGA Next Gen Connectivity analysis (sagang:connectivityanalysis). —————- Arguments —————- INPUT_GRID: Input Binary Grid Argument type: raster Acceptable values: - Path to a raster layer FILTERED_MASK: Filtered Image Argument type: rasterDestination Acceptable values: - Path for new raster layer FILTER: Apply Filter? Default value: true Argument type: boolean Acceptable values: - 1 for true/yes - 0 for false/no - 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 SIZE: Filter Size (Radius) 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 SYMBOLIC_IMAGE: Symbolic Image Argument type: rasterDestination Acceptable values: - Path for new raster layer OUTLINES: Outlines Argument type: vectorDestination Acceptable values: - Path for new vector layer BORDER_PIXEL_CENTERS: Pixel Centers? Default value: false Argument type: boolean Acceptable values: - 1 for true/yes - 0 for false/no - 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 REMOVE_MARGINAL_REGIONS: Remove Border Regions? Default value: false Argument type: boolean Acceptable values: - 1 for true/yes - 0 for false/no - 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_connectivityanalysis(
  INPUT_GRID = qgisprocess:::qgis_default_value(),
  FILTERED_MASK = qgisprocess:::qgis_default_value(),
  FILTER = qgisprocess:::qgis_default_value(),
  SIZE = qgisprocess:::qgis_default_value(),
  SYMBOLIC_IMAGE = qgisprocess:::qgis_default_value(),
  OUTLINES = qgisprocess:::qgis_default_value(),
  BORDER_PIXEL_CENTERS = qgisprocess:::qgis_default_value(),
  REMOVE_MARGINAL_REGIONS = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

INPUT_GRID	raster - Input Binary Grid. Path to a raster layer.
FILTERED_MASK	rasterDestination - Filtered Image. Path for new raster layer.
FILTER	boolean - Apply Filter?. 1 for true/yes. 0 for false/no. 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.
SIZE	number - Filter Size (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.
SYMBOLIC_IMAGE	rasterDestination - Symbolic Image. Path for new raster layer.
OUTLINES	vectorDestination - Outlines. Path for new vector layer.
BORDER_PIXEL_CENTERS	boolean - Pixel Centers?. 1 for true/yes. 0 for false/no. 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.
REMOVE_MARGINAL_REGIONS	boolean - Remove Border Regions?. 1 for true/yes. 0 for false/no. 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

• FILTERED_MASK - outputRaster - Filtered Image

• OUTLINES - outputVector - Outlines

• SYMBOLIC_IMAGE - outputRaster - Symbolic Image

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