grass_r_series_interp: QGIS algorithm - r.series.interp

View source: R/grass_r_series_interp.R

grass_r_series_interpR Documentation

QGIS algorithm - r.series.interp

Description

QGIS Algorithm provided by GRASS r.series.interp (grass:r.series.interp). Interpolates raster maps located (temporal or spatial) in between input raster maps at specific sampling positions.

Usage

grass_r_series_interp(
  input = qgisprocess:::qgis_default_value(),
  datapos = qgisprocess:::qgis_default_value(),
  infile = qgisprocess:::qgis_default_value(),
  output = qgisprocess:::qgis_default_value(),
  samplingpos = qgisprocess:::qgis_default_value(),
  outfile = qgisprocess:::qgis_default_value(),
  method = qgisprocess:::qgis_default_value(),
  output_dir = 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 layer(s). .

datapos

string - Data point position for each input map. 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.

infile

file - Input file with one input raster map name and data point position per line, field separator between name and sample point is 'pipe'. Path to a file.

output

string - Name for output raster map (comma separated list if multiple). 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.

samplingpos

string - Sampling point position for each output map (comma separated list). 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.

outfile

file - Input file with one output raster map name and sample point position per line, field separator between name and sample point is 'pipe'. Path to a file.

method

enum of ("linear") - Interpolation method, currently only linear interpolation is supported. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.

output_dir

folderDestination - Interpolated rasters. Path for an existing or new folder.

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_dir - outputFolder - Interpolated rasters


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