Skip to content

wxpyimgview

Views BMP images from the PNG driver.

wxpyimgview image=name [percent=integer] [--verbose] [--quiet] [--qq] [--ui]

Example:

wxpyimgview image=name

grass.script.run_command("wxpyimgview", image, percent=10, verbose=None, quiet=None, superquiet=None)

Example:

gs.run_command("wxpyimgview", image="name")

grass.tools.Tools.wxpyimgview(image, percent=10, verbose=None, quiet=None, superquiet=None)

Example:

tools = Tools()
tools.wxpyimgview(image="name")

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

Parameters

image=name [required]
    Name of input image file
percent=integer
    Percentage of CPU time to use
    Default: 10
--help
    Print usage summary
--verbose
    Verbose module output
--quiet
    Quiet module output
--qq
    Very quiet module output
--ui
    Force launching GUI dialog

image : str, required
    Name of input image file
    Used as: input, file, name
percent : int, optional
    Percentage of CPU time to use
    Default: 10
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

image : str | io.StringIO, required
    Name of input image file
    Used as: input, file, name
percent : int, optional
    Percentage of CPU time to use
    Default: 10
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.

DESCRIPTION

wxpyimgview is a simple wxWidgets image viewer for 32-bpp BMP images, as can be created with the PNG and cairo drivers. The display is continually refreshed.

NOTES

The display driver must be configure to map the file, with GRASS_RENDER_FILE_MAPPED=TRUE. This ensures that the file will remain a constant size, rather than being truncated whenever it is updated.

SEE ALSO

PNG driver, cairo driver

AUTHOR

Glynn Clements

SOURCE CODE

Available at: wxpyimgview source code (history)
Latest change: Friday Mar 07 23:20:43 2025 in commit b94776a