Skip to content

d.out.file

Saves the contents of the active display monitor to a graphics file.

d.out.file output=name format=string [size=width,height] [--overwrite] [--verbose] [--quiet] [--qq] [--ui]

Example:

d.out.file output=name format=png

grass.script.run_command("d.out.file", output, format="png", size=None, overwrite=None, verbose=None, quiet=None, superquiet=None)

Example:

gs.run_command("d.out.file", output="name", format="png")

grass.tools.Tools.d_out_file(output, format="png", size=None, overwrite=None, verbose=None, quiet=None, superquiet=None)

Example:

tools = Tools()
tools.d_out_file(output="name", format="png")

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

Parameters

output=name [required]
    Name for output file
format=string [required]
    Graphics file format
    Allowed values: png, jpg, bmp, gif, tif
    Default: png
size=width,height
    Width and height of output image
--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

output : str, required
    Name for output file
    Used as: output, file, name
format : str, required
    Graphics file format
    Allowed values: png, jpg, bmp, gif, tif
    Default: png
size : tuple[int, int] | list[int] | str, optional
    Width and height of output image
    Used as: width,height
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

output : str, required
    Name for output file
    Used as: output, file, name
format : str, required
    Graphics file format
    Allowed values: png, jpg, bmp, gif, tif
    Default: png
size : tuple[int, int] | list[int] | str, optional
    Width and height of output image
    Used as: width,height
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

d.out.file saves the content of the currently selected monitor into graphic file. The active monitor can be selected with d.mon. d.out.file can be run from GUI Console tab, too.

SEE ALSO

d.redraw, d.erase, d.rast, d.vect, d.mon

AUTHOR

Anna Petrasova, NCSU GeoForAll Lab

SOURCE CODE

Available at: d.out.file source code (history)
Latest change: Friday Feb 07 19:16:09 2025 in commit a82a39f