r3.mask
Establishes the current working 3D raster mask.
r3.mask map=string [maskvalues=val[-val] [,val[-val],...]] [--verbose] [--quiet] [--qq] [--ui]
Example:
r3.mask map=string
grass.script.run_command("r3.mask", map, maskvalues=None, verbose=False, quiet=False, superquiet=False)
Example:
gs.run_command("r3.mask", map="string")
Parameters
map=string [required]
3D raster map with reference values
maskvalues=val[-val] [,val[-val],...]
List of cell values to be masked out
--help
Print usage summary
--verbose
Verbose module output
--quiet
Quiet module output
--qq
Very quiet module output
--ui
Force launching GUI dialog
map : str, required
3D raster map with reference values
Used as: input, 3d-raster
maskvalues : str | list[str], optional
List of cell values to be masked out
Used as: val[-val]
verbose: bool, optional
Verbose module output
Default: False
quiet: bool, optional
Quiet module output
Default: False
superquiet: bool, optional
Very quiet module output
Default: False
DESCRIPTION
r3.mask facilitates the creation of a raster3d "MASK" map to control raster3d operations. The raster3d map is used as the reference map. Cells in the mask are marked as "mask out" if the corresponding cell in map contains a value in the range specified with maskvalues.
NOTES
Before a new 3D-mask can be created the existing mask has to be removed with g.remove.
SEE ALSO
AUTHORS
Roman Waupotitsch, Michael Shapiro, Helena Mitasova, Bill Brown, Lubos Mitas, Jaro Hofierka
SOURCE CODE
Available at: r3.mask source code
(history)
Latest change: Friday Feb 07 19:16:09 2025 in commit a82a39f