qgis_fuzzifyrasterpowermembership: QGIS algorithm - Fuzzify raster (power membership)

View source: R/qgis_fuzzifyrasterpowermembership.R

qgis_fuzzifyrasterpowermembershipR Documentation

QGIS algorithm - Fuzzify raster (power membership)

Description

QGIS Algorithm provided by QGIS (native c++) Fuzzify raster (power membership) (native:fuzzifyrasterpowermembership). The Fuzzify raster (power membership) algorithm transforms an input raster to a fuzzified raster and thereby assigns values between 0 and 1 following a power function. The value of 0 implies no membership with the defined fuzzy set, a value of 1 depicts full membership. In between, the degree of membership of raster values follows a power function. The power function is constructed using three user-defined input raster values which set the point of full membership (high bound, results to 1), no membership (low bound, results to 0) and function exponent (only positive) respectively. The fuzzy set in between those the upper and lower bounds values is then defined as a power function. Both increasing and decreasing fuzzy sets can be modeled by swapping the high and low bound parameters.

Usage

qgis_fuzzifyrasterpowermembership(
  INPUT = qgisprocess:::qgis_default_value(),
  BAND = qgisprocess:::qgis_default_value(),
  FUZZYLOWBOUND = qgisprocess:::qgis_default_value(),
  FUZZYHIGHBOUND = qgisprocess:::qgis_default_value(),
  FUZZYEXPONENT = qgisprocess:::qgis_default_value(),
  CREATE_OPTIONS = qgisprocess:::qgis_default_value(),
  OUTPUT = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

INPUT

raster - Input Raster. Path to a raster layer.

BAND

band - Band Number. Integer value representing an existing raster band number.

FUZZYLOWBOUND

number - Low fuzzy membership bound. 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.

FUZZYHIGHBOUND

number - High fuzzy membership bound. 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.

FUZZYEXPONENT

number - Membership function exponent. 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.

CREATE_OPTIONS

string - Creation options. String 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.

OUTPUT

rasterDestination - Fuzzified raster. Path for new raster layer.

...

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

  • CRS_AUTHID - outputString - CRS authority identifier

  • EXTENT - outputString - Extent

  • HEIGHT_IN_PIXELS - outputNumber - Height in pixels

  • OUTPUT - outputRaster - Fuzzified raster

  • TOTAL_PIXEL_COUNT - outputNumber - Total pixel count

  • WIDTH_IN_PIXELS - outputNumber - Width in pixels


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