sagang_convexhull: QGIS algorithm - Convex hull

View source: R/sagang_convexhull.R

sagang_convexhullR Documentation

QGIS algorithm - Convex hull

Description

QGIS Algorithm provided by SAGA Next Gen Convex hull (sagang:convexhull). —————- Arguments —————- SHAPES: Points Argument type: source Acceptable values: - Path to a vector layer HULLS: Convex Hull Argument type: vectorDestination Acceptable values: - Path for new vector layer BOXES: Minimum Bounding Box Argument type: vectorDestination Acceptable values: - Path for new vector layer POLYPOINTS: Hull Construction Default value: 1 Argument type: enum Available values: - 0: (0) one hull for all shapes - 1: (1) one hull per shape - 2: (2) one hull per shape part Acceptable values: - Number of selected option, e.g. '1' - Comma separated list of options, e.g. '1,3' POLYGONCVX: Polygon Convexity 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_convexhull(
  SHAPES = qgisprocess:::qgis_default_value(),
  HULLS = qgisprocess:::qgis_default_value(),
  BOXES = qgisprocess:::qgis_default_value(),
  POLYPOINTS = qgisprocess:::qgis_default_value(),
  POLYGONCVX = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

SHAPES

source - Points. Path to a vector layer.

HULLS

vectorDestination - Convex Hull. Path for new vector layer.

BOXES

vectorDestination - Minimum Bounding Box. Path for new vector layer.

POLYPOINTS

enum of ⁠("(0) one hull for all shapes", "(1) one hull per shape", "(2) one hull per shape part")⁠ - Hull Construction. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.

POLYGONCVX

boolean - Polygon Convexity. 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

  • BOXES - outputVector - Minimum Bounding Box

  • HULLS - outputVector - Convex Hull


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