grass_r_out_vtk: QGIS algorithm - r.out.vtk

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

QGIS algorithm - r.out.vtk

Description

QGIS Algorithm provided by GRASS r.out.vtk (grass:r.out.vtk). Converts raster maps into the VTK-ASCII format

Usage

grass_r_out_vtk(
  input = qgisprocess:::qgis_default_value(),
  elevation = qgisprocess:::qgis_default_value(),
  null = qgisprocess:::qgis_default_value(),
  z = qgisprocess:::qgis_default_value(),
  rgbmaps = qgisprocess:::qgis_default_value(),
  vectormaps = qgisprocess:::qgis_default_value(),
  zscale = qgisprocess:::qgis_default_value(),
  precision = qgisprocess:::qgis_default_value(),
  .p = qgisprocess:::qgis_default_value(),
  .s = qgisprocess:::qgis_default_value(),
  .t = qgisprocess:::qgis_default_value(),
  .v = qgisprocess:::qgis_default_value(),
  .o = qgisprocess:::qgis_default_value(),
  .c = qgisprocess:::qgis_default_value(),
  output = qgisprocess:::qgis_default_value(),
  GRASS_REGION_PARAMETER = qgisprocess:::qgis_default_value(),
  GRASS_REGION_CELLSIZE_PARAMETER = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

input	multilayer - Input raster. .
elevation	raster - Input elevation raster map. Path to a raster layer.
null	number - Value to represent no data cell. 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.
z	number - Constant elevation (if no elevation map is specified). 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.
rgbmaps	multilayer - Three (r,g,b) raster maps to create RGB values. .
vectormaps	multilayer - Three (x,y,z) raster maps to create vector values. .
zscale	number - Scale factor for elevation. 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.
precision	number - Number of significant digits. 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.
.p	boolean - Create VTK point data instead of VTK cell data. 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. Original algorithm parameter name: -p.
.s	boolean - Use structured grid for elevation (not recommended). 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. Original algorithm parameter name: -s.
.t	boolean - Use polydata-trianglestrips for elevation grid creation. 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. Original algorithm parameter name: -t.
.v	boolean - Use polydata-vertices for elevation grid creation. 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. Original algorithm parameter name: -v.
.o	boolean - Scale factor affects the origin (if no elevation map is given). 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. Original algorithm parameter name: -o.
.c	boolean - Correct the coordinates to match the VTK-OpenGL precision. 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. Original algorithm parameter name: -c.
output	fileDestination - VTK File. Path for new file.
GRASS_REGION_PARAMETER	extent - GRASS GIS region extent. A comma delimited string of x min, x max, y min, y max. E.g. '4,10,101,105'. Path to a layer. The extent of the layer is used..
GRASS_REGION_CELLSIZE_PARAMETER	number - GRASS GIS region cellsize (leave 0 for default). 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 - outputFile - VTK File

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