QGIS Algorithm provided by GRASS r.mask.vect (grass:r.mask.vect). r.mask.vect - Creates a MASK for limiting raster operation with a vector layer.
grass_r_mask_vect(
vector = qgisprocess:::qgis_default_value(),
input = qgisprocess:::qgis_default_value(),
cats = qgisprocess:::qgis_default_value(),
where = qgisprocess:::qgis_default_value(),
.i = 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(),
GRASS_SNAP_TOLERANCE_PARAMETER = qgisprocess:::qgis_default_value(),
GRASS_MIN_AREA_PARAMETER = qgisprocess:::qgis_default_value(),
...,
.complete_output = .complete_output_option(),
.quiet = .quiet_option(),
.messages = .message_option()
)
source
- Name of vector map to use as mask. Path to a vector layer.
raster
- Name of raster map to which apply the mask. Path to a raster layer.
string
- Category values. Example: 1,3,7-9,13. 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.
string
- WHERE conditions of SQL statement without 'where' keyword. 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.
boolean
- Create inverse mask. 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.
rasterDestination
- Masked. Path for new raster layer.
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..
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.
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.
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.
number
- v.in.ogr snap tolerance (-1 = no snap). 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.
number
- v.in.ogr min area. 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()
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
.
logical specifying if parameter .quiet
for qgisprocess::qgis_run_algorithm()
Default value is TRUE
.
logical specifying if messages from qgisprocess::qgis_run_algorithm()
should be printed (TRUE
) or not (FALSE
). Default value is FALSE
.