sagang_superpixelsegmentation: QGIS algorithm - Superpixel segmentation

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

QGIS algorithm - Superpixel segmentation

Description

QGIS Algorithm provided by SAGA Next Gen Superpixel segmentation (sagang:superpixelsegmentation). —————- Arguments —————- FEATURES: Features Argument type: multilayer NORMALIZE: Normalize 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 POLYGONS: Segments Argument type: vectorDestination Acceptable values: - Path for new vector layer MAX_ITERATIONS: Maximum Iterations 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 REGULARIZATION: Regularization 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 SIZE: Region Size Default value: 10 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 SIZE_MIN: Minimum Region Size 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 SUPERPIXELS_DO: Create Superpixel Grids 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 SUPERPIXELS: Superpixels Argument type: rasterDestination Acceptable values: - Path for new raster layer POSTPROCESSING: Post-Processing Default value: 0 Argument type: enum Available values: - 0: (0) none - 1: (1) unsupervised classification Acceptable values: - Number of selected option, e.g. '1' - Comma separated list of options, e.g. '1,3' NCLUSTER: Number of Clusters Default value: 12 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 SPLIT_CLUSTERS: Split Clusters 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

Usage

sagang_superpixelsegmentation(
  FEATURES = qgisprocess:::qgis_default_value(),
  NORMALIZE = qgisprocess:::qgis_default_value(),
  POLYGONS = qgisprocess:::qgis_default_value(),
  MAX_ITERATIONS = qgisprocess:::qgis_default_value(),
  REGULARIZATION = qgisprocess:::qgis_default_value(),
  SIZE = qgisprocess:::qgis_default_value(),
  SIZE_MIN = qgisprocess:::qgis_default_value(),
  SUPERPIXELS_DO = qgisprocess:::qgis_default_value(),
  SUPERPIXELS = qgisprocess:::qgis_default_value(),
  POSTPROCESSING = qgisprocess:::qgis_default_value(),
  NCLUSTER = qgisprocess:::qgis_default_value(),
  SPLIT_CLUSTERS = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

FEATURES	multilayer - Features. .
NORMALIZE	boolean - Normalize. 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.
POLYGONS	vectorDestination - Segments. Path for new vector layer.
MAX_ITERATIONS	number - Maximum Iterations. 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.
REGULARIZATION	number - Regularization. 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.
SIZE	number - Region Size. 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.
SIZE_MIN	number - Minimum Region Size. 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.
SUPERPIXELS_DO	boolean - Create Superpixel Grids. 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.
SUPERPIXELS	rasterDestination - Superpixels. Path for new raster layer.
POSTPROCESSING	enum of ⁠("(0) none", "(1) unsupervised classification")⁠ - Post-Processing. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.
NCLUSTER	number - Number of Clusters. 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.
SPLIT_CLUSTERS	boolean - Split Clusters. 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

• POLYGONS - outputVector - Segments

• SUPERPIXELS - outputRaster - Superpixels

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