qgis_intersection: QGIS algorithm - Intersection

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

QGIS algorithm - Intersection

Description

QGIS Algorithm provided by QGIS (native c++) Intersection (native:intersection). This algorithm extracts the overlapping portions of features in the Input and Overlay layers. Features in the output Intersection layer are assigned the attributes of the overlapping features from both the Input and Overlay layers. —————- Notes —————- - This algorithm drops existing primary keys or FID values and regenerates them in output layers.

Usage

qgis_intersection(
  INPUT = qgisprocess:::qgis_default_value(),
  OVERLAY = qgisprocess:::qgis_default_value(),
  INPUT_FIELDS = qgisprocess:::qgis_default_value(),
  OVERLAY_FIELDS = qgisprocess:::qgis_default_value(),
  OVERLAY_FIELDS_PREFIX = qgisprocess:::qgis_default_value(),
  OUTPUT = qgisprocess:::qgis_default_value(),
  GRID_SIZE = 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.
OVERLAY	source - Overlay layer. Path to a vector layer.
INPUT_FIELDS	field - Input fields to keep (leave empty to keep all fields). The name of an existing field. ; delimited list of existing field names.
OVERLAY_FIELDS	field - Overlay fields to keep (leave empty to keep all fields). The name of an existing field. ; delimited list of existing field names.
OVERLAY_FIELDS_PREFIX	string - Overlay fields prefix. 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	sink - Intersection. Path for new vector layer.
GRID_SIZE	number - Grid 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.
...	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 - Intersection

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