t.rast.mask - GRASS manual

NAME

t.rast.mask - Mask a STRDS with another STRDS.

KEYWORDS

SYNOPSIS

t.rast.mask

t.rast.mask --help

t.rast.mask [-ins] input=name mask=name output=name basename=basename [nprocs=integer] [value=string] [--overwrite] [--help] [--verbose] [--quiet] [--ui]

Flags:

-i: Invert the mask; Default: keep cells that are not NULL and not zero in the mask
-n: Register Null maps
-s: Check the spatial topology of temporally related maps and process only spatially related maps
--overwrite: Allow output files to overwrite existing files
--help: Print usage summary
--verbose: Verbose module output
--quiet: Quiet module output
--ui: Force launching GUI dialog

Parameters:

input=name [required]: Name of the input space time raster dataset
mask=name [required]: Name of the input space time raster dataset
output=name [required]: Name of the output space time raster dataset
basename=basename [required]: Basename for output raster maps; A numerical suffix separated by an underscore will be attached to create a unique identifier
nprocs=integer: Number of r.mapcalc processes to run in parallel; Default: 1
value=string: The value used to replace masked cells; Default: NULL

DESCRIPTION
SEE ALSO
AUTHOR

DESCRIPTION

t.rast.mask applies one strds as a mask to another strds. By default, all cells in the input strds are set to mask_value where the mask strds is NULL or zero. This behaviour can be inverted with the -i flag, such that all cells in the input strds set to mask_value where the mask strds is not NULL and not zero.

Any semantic labels in the input strds are transferred to the output strds.

This module expects several parameters. The resulting space time raster dataset must be specified in the output option together with the basename of generated raster maps that are registered in the resulting STRDS. Empty maps resulting from map-calculation are not registered by default. This behavior can be changed with the -n flag. The flag -s can be used to assure that only spatially related maps in the STRDS's are processed. Spatially related means that temporaly related maps overlap in their spatial extent.

AUTHOR

Markus Metz, mundialis, Germany

SOURCE CODE

Available at: t.rast.mask source code (history)

Accessed: Monday Jul 27 12:30:24 2026