Skip to content

t.rast3d.mapcalc

Performs r3.mapcalc expressions on maps of sampled space time 3D raster datasets.

t.rast3d.mapcalc [-ns] inputs=name [,name,...] expression=string [method=name [,name,...]] output=name basename=string [nprocs=integer] [--overwrite] [--verbose] [--quiet] [--qq] [--ui]

Example:

t.rast3d.mapcalc inputs=name expression=string output=name basename=string

grass.tools.Tools.t_rast3d_mapcalc(inputs, expression, method="during,overlap,contain,equal", output, basename, nprocs=1, flags=None, overwrite=None, verbose=None, quiet=None, superquiet=None)

Example:

tools = Tools()
tools.t_rast3d_mapcalc(inputs="name", expression="string", output="name", basename="string")

This grass.tools API is experimental in version 8.5 and expected to be stable in version 8.6.

grass.script.run_command("t.rast3d.mapcalc", inputs, expression, method="during,overlap,contain,equal", output, basename, nprocs=1, flags=None, overwrite=None, verbose=None, quiet=None, superquiet=None)

Example:

gs.run_command("t.rast3d.mapcalc", inputs="name", expression="string", output="name", basename="string")

Parameters

inputs=name [,name,...] [required]
    Name of the input space time raster3d datasets
expression=string [required]
    r3.mapcalc expression applied to each time step of the sampled data
method=name [,name,...]
    The method to be used for sampling the input dataset
    Allowed values: start, during, overlap, contain, equal, follows, precedes
    Default: during,overlap,contain,equal
output=name [required]
    Name of the output space time raster3d dataset
basename=string [required]
    Basename of the new generated output maps
    A numerical suffix separated by an underscore will be attached to create a unique identifier
nprocs=integer
    Number of r3.mapcalc processes to run in parallel
    Default: 1
-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
--qq
    Very quiet module output
--ui
    Force launching GUI dialog

inputs : str | list[str], required
    Name of the input space time raster3d datasets
    Used as: input, str3ds, name
expression : str, required
    r3.mapcalc expression applied to each time step of the sampled data
method : str | list[str], optional
    The method to be used for sampling the input dataset
    Used as: name
    Allowed values: start, during, overlap, contain, equal, follows, precedes
    Default: during,overlap,contain,equal
output : str, required
    Name of the output space time raster3d dataset
    Used as: output, str3ds, name
basename : str, required
    Basename of the new generated output maps
    A numerical suffix separated by an underscore will be attached to create a unique identifier
nprocs : int, optional
    Number of r3.mapcalc processes to run in parallel
    Default: 1
flags : str, optional
    Allowed values: n, s
    n
        Register Null maps
    s
        Check the spatial topology of temporally related maps and process only spatially related maps
overwrite : bool, optional
    Allow output files to overwrite existing files
    Default: None
verbose : bool, optional
    Verbose module output
    Default: None
quiet : bool, optional
    Quiet module output
    Default: None
superquiet : bool, optional
    Very quiet module output
    Default: None

Returns:

result : grass.tools.support.ToolResult | None
If the tool produces text as standard output, a ToolResult object will be returned. Otherwise, None will be returned.

Raises:

grass.tools.ToolError: When the tool ended with an error.

inputs : str | list[str], required
    Name of the input space time raster3d datasets
    Used as: input, str3ds, name
expression : str, required
    r3.mapcalc expression applied to each time step of the sampled data
method : str | list[str], optional
    The method to be used for sampling the input dataset
    Used as: name
    Allowed values: start, during, overlap, contain, equal, follows, precedes
    Default: during,overlap,contain,equal
output : str, required
    Name of the output space time raster3d dataset
    Used as: output, str3ds, name
basename : str, required
    Basename of the new generated output maps
    A numerical suffix separated by an underscore will be attached to create a unique identifier
nprocs : int, optional
    Number of r3.mapcalc processes to run in parallel
    Default: 1
flags : str, optional
    Allowed values: n, s
    n
        Register Null maps
    s
        Check the spatial topology of temporally related maps and process only spatially related maps
overwrite : bool, optional
    Allow output files to overwrite existing files
    Default: None
verbose : bool, optional
    Verbose module output
    Default: None
quiet : bool, optional
    Quiet module output
    Default: None
superquiet : bool, optional
    Very quiet module output
    Default: None

DESCRIPTION

t.rast3d.mapcalc provides exact the same functionality as t.rast.mapcalc, but for space time 3D raster datasets. Please refer to t.rast.mapcalc for documentation.

It is a simple wrapper for r3.mapcalc enhanced with temporal functions.

SEE ALSO

t.rast.mapcalc, t.rast3d.algebra, r3.mapcalc

AUTHOR

Sören Gebbert, Thünen Institute of Climate-Smart Agriculture

SOURCE CODE

Available at: t.rast3d.mapcalc source code (history)
Latest change: Thursday Dec 18 07:11:47 2025 in commit cf870a5