t.rast.out.xyz
Export space time raster dataset to a CSV file.
t.rast.out.xyz [-i] strds=name [output=name] [where=sql_query] [separator=character] [--overwrite] [--verbose] [--quiet] [--qq] [--ui]
Example:
t.rast.out.xyz strds=name
grass.script.run_command("t.rast.out.xyz", strds, output="-", where=None, separator="pipe", flags=None, overwrite=None, verbose=None, quiet=None, superquiet=None)
Example:
gs.run_command("t.rast.out.xyz", strds="name")
grass.tools.Tools.t_rast_out_xyz(strds, output="-", where=None, separator="pipe", flags=None, overwrite=None, verbose=None, quiet=None, superquiet=None)
Example:
tools = Tools()
tools.t_rast_out_xyz(strds="name")
This grass.tools API is experimental in version 8.5 and expected to be stable in version 8.6.
Parameters
strds=name [required]
Name of the input space time raster dataset
output=name
Name for the output file or "-" in case stdout should be used
Default: -
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'
separator=character
Field separator
Special characters: pipe, comma, space, tab, newline
Default: pipe
-i
Include no data values
--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
strds : str, required
Name of the input space time raster dataset
Used as: input, strds, name
output : str, optional
Name for the output file or "-" in case stdout should be used
Used as: output, file, name
Default: -
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
separator : str, optional
Field separator
Special characters: pipe, comma, space, tab, newline
Used as: input, separator, character
Default: pipe
flags : str, optional
Allowed values: i
i
Include no data values
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
strds : str, required
Name of the input space time raster dataset
Used as: input, strds, name
output : str, optional
Name for the output file or "-" in case stdout should be used
Used as: output, file, name
Default: -
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
separator : str, optional
Field separator
Special characters: pipe, comma, space, tab, newline
Used as: input, separator, character
Default: pipe
flags : str, optional
Allowed values: i
i
Include no data values
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.
DESCRIPTION
The t.rast.out.xyz module exports a space time raster dataset as a list of x,y,z values into an ASCII text file.
NOTES
By default, this module does not export x,y coordinates for raster cells
containing a NULL value. This includes cells masked by a raster MASK.
However, using the flag -i also these raster cells will be included
in the exported data. t.rast.out.xyz is simply a front-end for
"r.out.xyz
".
EXAMPLE
# export strds without NULL cells
t.rast.out.xyz strds=mystrds output=/tmp/mystrds.csv
# export strds including NULL cells and for a certain time period
t.rast.out.xyz -i strds=mystrds output=/tmp/mystrds.csv \
where="start_time > '2010-01-01 00:00:00'"
SEE ALSO
AUTHOR
Luca Delucchi, Fondazione Edmund Mach
SOURCE CODE
Available at: t.rast.out.xyz source code
(history)
Latest change: Thursday Feb 20 13:02:26 2025 in commit 53de819