Skip to content

t.rast3d.list

Lists registered maps of a space time raster3d dataset.

t.rast3d.list [-s] input=name [order=string [,string,...]] [granule=string] [columns=string [,string,...]] [where=sql_query] [method=string] [separator=character] format=name [output=name] [--overwrite] [--verbose] [--quiet] [--qq] [--ui]

Example:

t.rast3d.list input=name format=plain

grass.tools.Tools.t_rast3d_list(input, order=None, granule=None, columns=None, where=None, method="cols", separator="", format="plain", output=None, flags=None, overwrite=None, verbose=None, quiet=None, superquiet=None)

Example:

tools = Tools()
tools.t_rast3d_list(input="name", format="json")

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

grass.script.parse_command("t.rast3d.list", input, order=None, granule=None, columns=None, where=None, method="cols", separator="", format="plain", output=None, flags=None, overwrite=None, verbose=None, quiet=None, superquiet=None)

Example:

gs.parse_command("t.rast3d.list", input="name", format="json")

Parameters

input=name [required]
    Name of the input space time raster3d dataset
order=string [,string,...]
    Order the space time dataset by category
    Allowed values: id, name, creator, mapset, temporal_type, creation_time, start_time, end_time, north, south, west, east, nsres, tbres, ewres, cols, rows, depths, number_of_cells, min, max
granule=string
    The granule to be used for listing. The granule must be specified as string eg.: absolute time "1 months" or relative time "1"
columns=string [,string,...]
    Columns to be printed to stdout
    Allowed values: id, name, creator, mapset, temporal_type, creation_time, start_time, end_time, north, south, west, east, nsres, tbres, ewres, cols, rows, depths, number_of_cells, min, max, interval_length, distance_from_begin
where=sql_query
    WHERE conditions of SQL statement without 'where' keyword used in the temporal GIS framework
    Example: start_time > '2001-01-01 12:30:00'
method=string
    Method used for data listing
    Allowed values: cols, comma, delta, deltagaps, gran
    Default: cols
separator=character
    Field separator character between the output columns
    Special characters: pipe, comma, space, tab, newline
format=name [required]
    Output format
    Allowed values: plain, line, json, yaml, csv
    Default: plain
    plain: Plain text output
    line: Comma separated list of map names
    json: JSON (JavaScript Object Notation)
    yaml: YAML (YAML Ain't Markup Language)
    csv: CSV (Comma Separated Values)
output=name
    Name for output file
-s
    Suppress printing of column names
--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

input : str, required
    Name of the input space time raster3d dataset
    Used as: input, str3ds, name
order : str | list[str], optional
    Order the space time dataset by category
    Allowed values: id, name, creator, mapset, temporal_type, creation_time, start_time, end_time, north, south, west, east, nsres, tbres, ewres, cols, rows, depths, number_of_cells, min, max
granule : str, optional
    The granule to be used for listing. The granule must be specified as string eg.: absolute time "1 months" or relative time "1"
columns : str | list[str], optional
    Columns to be printed to stdout
    Allowed values: id, name, creator, mapset, temporal_type, creation_time, start_time, end_time, north, south, west, east, nsres, tbres, ewres, cols, rows, depths, number_of_cells, min, max, interval_length, distance_from_begin
where : str, optional
    WHERE conditions of SQL statement without 'where' keyword used in the temporal GIS framework
    Example: start_time > '2001-01-01 12:30:00'
    Used as: sql_query
method : str, optional
    Method used for data listing
    Allowed values: cols, comma, delta, deltagaps, gran
    Default: cols
separator : str, optional
    Field separator character between the output columns
    Special characters: pipe, comma, space, tab, newline
    Used as: input, separator, character
format : str, required
    Output format
    Used as: name
    Allowed values: plain, line, json, yaml, csv
    plain: Plain text output
    line: Comma separated list of map names
    json: JSON (JavaScript Object Notation)
    yaml: YAML (YAML Ain't Markup Language)
    csv: CSV (Comma Separated Values)
    Default: plain
output : str, optional
    Name for output file
    Used as: output, file, name
flags : str, optional
    Allowed values: s
    s
        Suppress printing of column names
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.

input : str, required
    Name of the input space time raster3d dataset
    Used as: input, str3ds, name
order : str | list[str], optional
    Order the space time dataset by category
    Allowed values: id, name, creator, mapset, temporal_type, creation_time, start_time, end_time, north, south, west, east, nsres, tbres, ewres, cols, rows, depths, number_of_cells, min, max
granule : str, optional
    The granule to be used for listing. The granule must be specified as string eg.: absolute time "1 months" or relative time "1"
columns : str | list[str], optional
    Columns to be printed to stdout
    Allowed values: id, name, creator, mapset, temporal_type, creation_time, start_time, end_time, north, south, west, east, nsres, tbres, ewres, cols, rows, depths, number_of_cells, min, max, interval_length, distance_from_begin
where : str, optional
    WHERE conditions of SQL statement without 'where' keyword used in the temporal GIS framework
    Example: start_time > '2001-01-01 12:30:00'
    Used as: sql_query
method : str, optional
    Method used for data listing
    Allowed values: cols, comma, delta, deltagaps, gran
    Default: cols
separator : str, optional
    Field separator character between the output columns
    Special characters: pipe, comma, space, tab, newline
    Used as: input, separator, character
format : str, required
    Output format
    Used as: name
    Allowed values: plain, line, json, yaml, csv
    plain: Plain text output
    line: Comma separated list of map names
    json: JSON (JavaScript Object Notation)
    yaml: YAML (YAML Ain't Markup Language)
    csv: CSV (Comma Separated Values)
    Default: plain
output : str, optional
    Name for output file
    Used as: output, file, name
flags : str, optional
    Allowed values: s
    s
        Suppress printing of column names
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.list provides the same functionality as t.rast.list, the only difference is the 3D raster map layer metadata. Please refer to the manual page of t.rast.list.

SEE ALSO

t.rast.list, g.list, t.create, t.info, t.list, t.vect.list

AUTHOR

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

SOURCE CODE

Available at: t.rast3d.list source code (history)
Latest change: Tuesday Jun 16 08:08:04 2026 in commit fd05ede