sagang_texturalfeatures: QGIS algorithm - Textural features

View source: R/sagang_texturalfeatures.R

sagang_texturalfeaturesR Documentation

QGIS algorithm - Textural features

Description

QGIS Algorithm provided by SAGA Next Gen Textural features (sagang:texturalfeatures). —————- Arguments —————- GRID: Grid Argument type: raster Acceptable values: - Path to a raster layer ASM: Angular Second Moment Argument type: rasterDestination Acceptable values: - Path for new raster layer CONTRAST: Contrast Argument type: rasterDestination Acceptable values: - Path for new raster layer CORRELATION: Correlation Argument type: rasterDestination Acceptable values: - Path for new raster layer VARIANCE: Variance Argument type: rasterDestination Acceptable values: - Path for new raster layer IDM: Inverse Diff Moment Argument type: rasterDestination Acceptable values: - Path for new raster layer SUM_AVERAGE: Sum Average Argument type: rasterDestination Acceptable values: - Path for new raster layer SUM_ENTROPY: Sum Entropy Argument type: rasterDestination Acceptable values: - Path for new raster layer SUM_VARIANCE: Sum Variance Argument type: rasterDestination Acceptable values: - Path for new raster layer ENTROPY: Entropy Argument type: rasterDestination Acceptable values: - Path for new raster layer DIF_VARIANCE: Difference Variance Argument type: rasterDestination Acceptable values: - Path for new raster layer DIF_ENTROPY: Difference Entropy Argument type: rasterDestination Acceptable values: - Path for new raster layer MOC_1: Measure of Correlation-1 Argument type: rasterDestination Acceptable values: - Path for new raster layer MOC_2: Measure of Correlation-2 Argument type: rasterDestination Acceptable values: - Path for new raster layer DIRECTION: Direction Default value: 0 Argument type: enum Available values: - 0: (0) all - 1: (1) N-S - 2: (2) NE-SW - 3: (3) E-W - 4: (4) SE-NW Acceptable values: - Number of selected option, e.g. '1' - Comma separated list of options, e.g. '1,3' RADIUS: Radius Default value: 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 DISTANCE: Distance Default value: 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 MAX_CATS: Maximum Number of Categories Default value: 256 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_texturalfeatures(
  GRID = qgisprocess:::qgis_default_value(),
  ASM = qgisprocess:::qgis_default_value(),
  CONTRAST = qgisprocess:::qgis_default_value(),
  CORRELATION = qgisprocess:::qgis_default_value(),
  VARIANCE = qgisprocess:::qgis_default_value(),
  IDM = qgisprocess:::qgis_default_value(),
  SUM_AVERAGE = qgisprocess:::qgis_default_value(),
  SUM_ENTROPY = qgisprocess:::qgis_default_value(),
  SUM_VARIANCE = qgisprocess:::qgis_default_value(),
  ENTROPY = qgisprocess:::qgis_default_value(),
  DIF_VARIANCE = qgisprocess:::qgis_default_value(),
  DIF_ENTROPY = qgisprocess:::qgis_default_value(),
  MOC_1 = qgisprocess:::qgis_default_value(),
  MOC_2 = qgisprocess:::qgis_default_value(),
  DIRECTION = qgisprocess:::qgis_default_value(),
  RADIUS = qgisprocess:::qgis_default_value(),
  DISTANCE = qgisprocess:::qgis_default_value(),
  MAX_CATS = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

GRID

raster - Grid. Path to a raster layer.

ASM

rasterDestination - Angular Second Moment. Path for new raster layer.

CONTRAST

rasterDestination - Contrast. Path for new raster layer.

CORRELATION

rasterDestination - Correlation. Path for new raster layer.

VARIANCE

rasterDestination - Variance. Path for new raster layer.

IDM

rasterDestination - Inverse Diff Moment. Path for new raster layer.

SUM_AVERAGE

rasterDestination - Sum Average. Path for new raster layer.

SUM_ENTROPY

rasterDestination - Sum Entropy. Path for new raster layer.

SUM_VARIANCE

rasterDestination - Sum Variance. Path for new raster layer.

ENTROPY

rasterDestination - Entropy. Path for new raster layer.

DIF_VARIANCE

rasterDestination - Difference Variance. Path for new raster layer.

DIF_ENTROPY

rasterDestination - Difference Entropy. Path for new raster layer.

MOC_1

rasterDestination - Measure of Correlation-1. Path for new raster layer.

MOC_2

rasterDestination - Measure of Correlation-2. Path for new raster layer.

DIRECTION

enum of ⁠("(0) all", "(1) N-S", "(2) NE-SW", "(3) E-W", "(4) SE-NW")⁠ - Direction. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.

RADIUS

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

DISTANCE

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

MAX_CATS

number - Maximum Number of Categories. 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

  • ASM - outputRaster - Angular Second Moment

  • CONTRAST - outputRaster - Contrast

  • CORRELATION - outputRaster - Correlation

  • DIF_ENTROPY - outputRaster - Difference Entropy

  • DIF_VARIANCE - outputRaster - Difference Variance

  • ENTROPY - outputRaster - Entropy

  • IDM - outputRaster - Inverse Diff Moment

  • MOC_1 - outputRaster - Measure of Correlation-1

  • MOC_2 - outputRaster - Measure of Correlation-2

  • SUM_AVERAGE - outputRaster - Sum Average

  • SUM_ENTROPY - outputRaster - Sum Entropy

  • SUM_VARIANCE - outputRaster - Sum Variance

  • VARIANCE - outputRaster - Variance


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