kwplot · Python Simple Repository Browser

Project Links

Meta

Author: Jon Crall

Requires Python: >=3.8

Classifiers

Development Status

1 - Planning

Intended Audience

Developers

Topic

Software Development :: Libraries :: Python Modules
Utilities

License

OSI Approved :: Apache Software License

Programming Language

Python :: 3.8
Python :: 3.9
Python :: 3.10
Python :: 3.11
Python :: 3.12

ReadTheDocs	https://kwplot.readthedocs.io/en/latest/
Gitlab (main)	https://gitlab.kitware.com/computer-vision/kwplot
Github (mirror)	https://github.com/Kitware/kwplot
Pypi	https://pypi.org/project/kwplot

The kwplot module is a wrapper around matplotlib and can be used for visualizing algorithm results.

The top-level API is:

from .auto_backends import (autompl, autoplt, set_mpl_backend,)
from .draw_conv import (make_conv_images, plot_convolutional_features,)
from .mpl_3d import (plot_surface3d,)
from .mpl_color import (Color,)
from .mpl_core import (distinct_colors, distinct_markers, ensure_fnum, figure,
                       imshow, legend, next_fnum, set_figtitle,
                       show_if_requested,)
from .mpl_draw import (draw_boxes, draw_boxes_on_image, draw_clf_on_image,
                       draw_line_segments, draw_text_on_image, plot_matrix, draw_points,)
from .mpl_make import (make_heatmask, make_orimask, make_vector_field,)
from .mpl_multiplot import (multi_plot,)
from .mpl_plotnums import (PlotNums,)

One of the key features is the kwplot.autompl function, which is able to somewhat intelligently set the notorious matplotlib backend. By default it will attempt to use PyQt5 if it is installed and a DISPLAY is available. Otherwise it will ensure the backend is set to Agg. For convinience, the functions: kwplot.autoplt and kwplot.autosns also execute this auto-backend behavior, but return the pyplot and seaborn module, respectively. It is recommended to call one of these functions before any use of pyplot due to pyplot’s import-time side effects (note: pre-importing most other matplotlib modules is ok).

The kwplot.imshow and kwplot.figure functions are extensions of the matplotlib versions with slightly extended interfaces (again to help reduce the density of visualization code in research scripts). The kwplot.PlotNums helps manage subplots locations, especially when you are developing / reordering them.