R/grass_r_out_vtk.R

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

##' QGIS Algorithm provided by GRASS r.out.vtk (grass:r.out.vtk). Converts raster maps into the VTK-ASCII format
##'
##' @title QGIS algorithm - r.out.vtk
##'
##' @param input `multilayer` - Input raster. .
##' @param elevation `raster` - Input elevation raster map. Path to a raster layer.
##' @param 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.
##' @param 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.
##' @param rgbmaps `multilayer` - Three (r,g,b) raster maps to create RGB values. .
##' @param vectormaps `multilayer` - Three (x,y,z) raster maps to create vector values. .
##' @param 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.
##' @param 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.
##' @param .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.
##' @param .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.
##' @param .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.
##' @param .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.
##' @param .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.
##' @param .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.
##' @param output `fileDestination` - VTK File. Path for new file.
##' @param 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..
##' @param 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.
##' @param ... further parameters passed to `qgisprocess::qgis_run_algorithm()`
##' @param .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`.
##' @param .quiet logical specifying if parameter `.quiet` for `qgisprocess::qgis_run_algorithm()` Default value is `TRUE`.
##' @param .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
##'
##'
##' @export
##' @md
##' @importFrom qgisprocess qgis_run_algorithm

grass_r_out_vtk <- function(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()) {

  check_algorithm_necessities("grass:r.out.vtk")

  if (.messages){
    output <- qgisprocess::qgis_run_algorithm("grass:r.out.vtk", `input` = input, `elevation` = elevation, `null` = null, `z` = z, `rgbmaps` = rgbmaps, `vectormaps` = vectormaps, `zscale` = zscale, `precision` = precision, `-p` = .p, `-s` = .s, `-t` = .t, `-v` = .v, `-o` = .o, `-c` = .c, `output` = output, `GRASS_REGION_PARAMETER` = GRASS_REGION_PARAMETER, `GRASS_REGION_CELLSIZE_PARAMETER` = GRASS_REGION_CELLSIZE_PARAMETER,..., .quiet = .quiet)
  } else {
    suppressMessages(
      output <- qgisprocess::qgis_run_algorithm("grass:r.out.vtk", `input` = input, `elevation` = elevation, `null` = null, `z` = z, `rgbmaps` = rgbmaps, `vectormaps` = vectormaps, `zscale` = zscale, `precision` = precision, `-p` = .p, `-s` = .s, `-t` = .t, `-v` = .v, `-o` = .o, `-c` = .c, `output` = output, `GRASS_REGION_PARAMETER` = GRASS_REGION_PARAMETER, `GRASS_REGION_CELLSIZE_PARAMETER` = GRASS_REGION_CELLSIZE_PARAMETER,..., .quiet = .quiet)
      )
  }

  if (.complete_output) {
    return(output)
  }
  else{
    qgisprocess::qgis_extract_output(output, "output")
  }
}