sagang_polygonshapeindices: QGIS algorithm - Polygon shape indices

View source: R/sagang_polygonshapeindices.R

sagang_polygonshapeindicesR Documentation

QGIS algorithm - Polygon shape indices

Description

QGIS Algorithm provided by SAGA Next Gen Polygon shape indices (sagang:polygonshapeindices). —————- Arguments —————- SHAPES: Shapes Argument type: source Acceptable values: - Path to a vector layer INDEX: Shape Indices Argument type: vectorDestination Acceptable values: - Path for new vector layer DMAX: Maximum Diameter Argument type: vectorDestination Acceptable values: - Path for new vector layer GYROS: Diameter of Gyration 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 FERET: Feret Diameters 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 FERET_DIRS: Number of Directions Default value: 18 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_polygonshapeindices(
  SHAPES = qgisprocess:::qgis_default_value(),
  INDEX = qgisprocess:::qgis_default_value(),
  DMAX = qgisprocess:::qgis_default_value(),
  GYROS = qgisprocess:::qgis_default_value(),
  FERET = qgisprocess:::qgis_default_value(),
  FERET_DIRS = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

SHAPES

source - Shapes. Path to a vector layer.

INDEX

vectorDestination - Shape Indices. Path for new vector layer.

DMAX

vectorDestination - Maximum Diameter. Path for new vector layer.

GYROS

boolean - Diameter of Gyration. 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.

FERET

boolean - Feret Diameters. 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.

FERET_DIRS

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

  • DMAX - outputVector - Maximum Diameter

  • INDEX - outputVector - Shape Indices


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