qgis_minimumboundinggeometry: QGIS algorithm - Minimum bounding geometry

View source: R/qgis_minimumboundinggeometry.R

qgis_minimumboundinggeometryR Documentation

QGIS algorithm - Minimum bounding geometry

Description

QGIS Algorithm provided by QGIS Minimum bounding geometry (qgis:minimumboundinggeometry). This algorithm creates geometries which enclose the features from an input layer. Numerous enclosing geometry types are supported, including bounding boxes (envelopes), oriented rectangles, circles and convex hulls. Optionally, the features can be grouped by a field. If set, this causes the output layer to contain one feature per grouped value with a minimal geometry covering just the features with matching values.

Usage

qgis_minimumboundinggeometry(
  INPUT = qgisprocess:::qgis_default_value(),
  FIELD = qgisprocess:::qgis_default_value(),
  TYPE = qgisprocess:::qgis_default_value(),
  OUTPUT = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

INPUT

source - Input layer. Path to a vector layer.

FIELD

field - Field (optional, set if features should be grouped by class). The name of an existing field. ; delimited list of existing field names.

TYPE

enum of ⁠("Envelope (Bounding Box)", "Minimum Oriented Rectangle", "Minimum Enclosing Circle", "Convex Hull")⁠ - Geometry type. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.

OUTPUT

sink - Bounding geometry. Path for new vector 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

  • OUTPUT - outputVector - Bounding geometry


JanCaha/r_package_qgis documentation built on April 4, 2024, 8:10 p.m.