skrt.better_viewer.options module

Module for functions relevant to image display:

• set_viewer_options(): Define options for use with skrt.better_viewer.BetterViewer.

skrt.better_viewer.options.set_viewer_options(to_exclude=None, usetex=False, **kwargs)

Define options for use with skrt.better_viewer.BetterViewer.

Options for Matplotlib runtime configuration are applied automatically. The options dictionary returned by this function may be passed to BetterViewer as **kwargs.

All options may be overwritten before calling BetterViewer.

Parameter: to_exclude: list

List of keys not to include in the returned dictionary.

usetex: bool, default=False

Indicate whether to use LaTeX for text rendering. Setting to True when no LaTeX installation is avaiable will generate an error.

kwargs: dict

Key-value pairs with which to update BetterViewer options dictionary created here.