grass_r_in_lidar: QGIS algorithm - r.in.lidar

View source: R/grass_r_in_lidar.R

grass_r_in_lidarR Documentation

QGIS algorithm - r.in.lidar

Description

QGIS Algorithm provided by GRASS r.in.lidar (grass:r.in.lidar). Creates a raster map from LAS LiDAR points using univariate statistics.

Usage

grass_r_in_lidar(
  input = qgisprocess:::qgis_default_value(),
  method = qgisprocess:::qgis_default_value(),
  type = qgisprocess:::qgis_default_value(),
  base_raster = qgisprocess:::qgis_default_value(),
  zrange = qgisprocess:::qgis_default_value(),
  zscale = qgisprocess:::qgis_default_value(),
  intensity_range = qgisprocess:::qgis_default_value(),
  intensity_scale = qgisprocess:::qgis_default_value(),
  percent = qgisprocess:::qgis_default_value(),
  pth = qgisprocess:::qgis_default_value(),
  trim = qgisprocess:::qgis_default_value(),
  resolution = qgisprocess:::qgis_default_value(),
  return_filter = qgisprocess:::qgis_default_value(),
  class_filter = qgisprocess:::qgis_default_value(),
  .e = qgisprocess:::qgis_default_value(),
  .n = qgisprocess:::qgis_default_value(),
  .o = qgisprocess:::qgis_default_value(),
  .i = qgisprocess:::qgis_default_value(),
  .j = qgisprocess:::qgis_default_value(),
  .d = qgisprocess:::qgis_default_value(),
  .v = qgisprocess:::qgis_default_value(),
  output = qgisprocess:::qgis_default_value(),
  GRASS_REGION_PARAMETER = qgisprocess:::qgis_default_value(),
  GRASS_REGION_CELLSIZE_PARAMETER = qgisprocess:::qgis_default_value(),
  GRASS_RASTER_FORMAT_OPT = qgisprocess:::qgis_default_value(),
  GRASS_RASTER_FORMAT_META = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

input

file - LAS input file. Path to a file.

method

enum of ⁠("n", "min", "max", "range", "sum", "mean", "stddev", "variance", "coeff_var", "median", "percentile", "skewness", "trimmean")⁠ - Statistic to use for raster values. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.

type

enum of ⁠("CELL", "FCELL", "DCELL")⁠ - Storage type for resultant raster map. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.

base_raster

raster - Subtract raster values from the Z coordinates. Path to a raster layer.

zrange

range - Filter range for z data (min, max). Two comma separated numeric values, e.g. '1,10'.

zscale

number - Scale to apply to z data. 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.

intensity_range

range - Filter range for intensity values (min, max). Two comma separated numeric values, e.g. '1,10'.

intensity_scale

number - Scale to apply to intensity values. 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.

percent

number - Percent of map to keep in memory. 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.

pth

number - pth percentile of the values (between 1 and 100). 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.

trim

number - Discard trim percent of the smallest and trim percent of the largest observations (0-50). 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.

resolution

number - Output raster resolution. 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.

return_filter

string - Only import points of selected return type Options: first, last, mid. 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.

class_filter

string - Only import points of selected class(es) (comma separated integers). 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.

.e

boolean - Use the extent of the input for the raster extent. 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: -e.

.n

boolean - Set computation region to match the new raster map. 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: -n.

.o

boolean - Override projection check (use current location's projection). 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.

.i

boolean - Use intensity values rather than Z 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. Original algorithm parameter name: -i.

.j

boolean - Use Z values for filtering, but intensity values for statistics. 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: -j.

.d

boolean - Use base raster resolution instead of computational region. 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: -d.

.v

boolean - Use only valid points. 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.

output

rasterDestination - Lidar Raster. Path for new raster layer.

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.

GRASS_RASTER_FORMAT_OPT

string - Output Rasters format options (createopt). 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.

GRASS_RASTER_FORMAT_META

string - Output Rasters format metadata options (metaopt). 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.

...

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 - outputRaster - Lidar Raster


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