Metadata-Version: 2.1
Name: kwplot
Version: 0.4.11
Summary: A wrapper around matplotlib
Home-page: https://gitlab.kitware.com/computer-vision/kwplot
Author: Kitware Inc., Jon Crall
Author-email: kitware@kitware.com, jon.crall@kitware.com
License: Apache 2
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Visualization
Classifier: Topic :: Software Development
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Utilities
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Description-Content-Type: text/x-rst
Requires-Dist: six
Requires-Dist: ubelt
Requires-Dist: kwarray
Requires-Dist: kwimage
Requires-Dist: matplotlib ; python_version < "3.6" and python_version >= "3.5"
Requires-Dist: matplotlib ; python_version < "3.7" and python_version >= "3.6"
Requires-Dist: matplotlib ; python_version >= "3.7"
Provides-Extra: all
Requires-Dist: six ; extra == 'all'
Requires-Dist: ubelt ; extra == 'all'
Requires-Dist: kwarray ; extra == 'all'
Requires-Dist: kwimage ; extra == 'all'
Requires-Dist: coverage ; extra == 'all'
Requires-Dist: xdoctest ; extra == 'all'
Requires-Dist: seaborn ; extra == 'all'
Requires-Dist: pytest ; (python_version < "2.8.0" and python_version >= "2.7.0") and extra == 'all'
Requires-Dist: pytest-cov ; (python_version < "2.8.0" and python_version >= "2.7.0") and extra == 'all'
Requires-Dist: pytest ; (python_version < "3.10.0" and python_version >= "3.7.0") and extra == 'all'
Requires-Dist: pytest ; (python_version < "3.5.0" and python_version >= "3.4.0") and extra == 'all'
Requires-Dist: pytest-cov ; (python_version < "3.5.0" and python_version >= "3.4.0") and extra == 'all'
Requires-Dist: pandas ; (python_version < "3.5.3" and python_version >= "2.7") and extra == 'all'
Requires-Dist: matplotlib ; (python_version < "3.6" and python_version >= "3.5") and extra == 'all'
Requires-Dist: pytest ; (python_version < "3.6.0" and python_version >= "3.5.0") and extra == 'all'
Requires-Dist: pytest-cov ; (python_version < "3.6.0" and python_version >= "3.5.0") and extra == 'all'
Requires-Dist: pandas ; (python_version < "3.6.1" and python_version >= "3.5.3") and extra == 'all'
Requires-Dist: matplotlib ; (python_version < "3.7" and python_version >= "3.6") and extra == 'all'
Requires-Dist: pytest ; (python_version < "3.7.0" and python_version >= "3.6.0") and extra == 'all'
Requires-Dist: pandas ; (python_version < "3.7.1" and python_version >= "3.6.1") and extra == 'all'
Requires-Dist: pytest ; (python_version >= "3.10.0") and extra == 'all'
Requires-Dist: pytest-cov ; (python_version >= "3.6.0") and extra == 'all'
Requires-Dist: matplotlib ; (python_version >= "3.7") and extra == 'all'
Requires-Dist: pandas ; (python_version >= "3.7.1") and extra == 'all'
Provides-Extra: graphics
Requires-Dist: opencv-python ; (python_version < "3.10" and python_version >= "3.9") and extra == 'graphics'
Requires-Dist: opencv-python ; (python_version < "3.4" and python_version >= "2.7") and extra == 'graphics'
Requires-Dist: opencv-python ; (python_version < "3.5" and python_version >= "3.4") and extra == 'graphics'
Requires-Dist: opencv-python ; (python_version < "3.6" and python_version >= "3.5") and extra == 'graphics'
Requires-Dist: opencv-python ; (python_version < "3.7" and python_version >= "3.6") and extra == 'graphics'
Requires-Dist: opencv-python ; (python_version < "3.8" and python_version >= "3.7") and extra == 'graphics'
Requires-Dist: opencv-python ; (python_version < "3.9" and python_version >= "3.8") and extra == 'graphics'
Requires-Dist: opencv-python ; (python_version >= "3.10") and extra == 'graphics'
Provides-Extra: headless
Requires-Dist: opencv-python-headless ; (python_version < "3.10" and python_version >= "3.9") and extra == 'headless'
Requires-Dist: opencv-python-headless ; (python_version < "3.4" and python_version >= "2.7") and extra == 'headless'
Requires-Dist: opencv-python-headless ; (python_version < "3.5" and python_version >= "3.4") and extra == 'headless'
Requires-Dist: opencv-python-headless ; (python_version < "3.6" and python_version >= "3.5") and extra == 'headless'
Requires-Dist: opencv-python-headless ; (python_version < "3.7" and python_version >= "3.6") and extra == 'headless'
Requires-Dist: opencv-python-headless ; (python_version < "3.8" and python_version >= "3.7") and extra == 'headless'
Requires-Dist: opencv-python-headless ; (python_version < "3.9" and python_version >= "3.8") and extra == 'headless'
Requires-Dist: opencv-python-headless ; (python_version >= "3.10") and extra == 'headless'
Provides-Extra: optional
Requires-Dist: seaborn ; extra == 'optional'
Requires-Dist: pandas ; (python_version < "3.5.3" and python_version >= "2.7") and extra == 'optional'
Requires-Dist: pandas ; (python_version < "3.6.1" and python_version >= "3.5.3") and extra == 'optional'
Requires-Dist: pandas ; (python_version < "3.7.1" and python_version >= "3.6.1") and extra == 'optional'
Requires-Dist: pandas ; (python_version >= "3.7.1") and extra == 'optional'
Provides-Extra: tests
Requires-Dist: coverage ; extra == 'tests'
Requires-Dist: xdoctest ; extra == 'tests'
Requires-Dist: pytest ; (python_version < "2.8.0" and python_version >= "2.7.0") and extra == 'tests'
Requires-Dist: pytest-cov ; (python_version < "2.8.0" and python_version >= "2.7.0") and extra == 'tests'
Requires-Dist: pytest ; (python_version < "3.10.0" and python_version >= "3.7.0") and extra == 'tests'
Requires-Dist: pytest ; (python_version < "3.5.0" and python_version >= "3.4.0") and extra == 'tests'
Requires-Dist: pytest-cov ; (python_version < "3.5.0" and python_version >= "3.4.0") and extra == 'tests'
Requires-Dist: pytest ; (python_version < "3.6.0" and python_version >= "3.5.0") and extra == 'tests'
Requires-Dist: pytest-cov ; (python_version < "3.6.0" and python_version >= "3.5.0") and extra == 'tests'
Requires-Dist: pytest ; (python_version < "3.7.0" and python_version >= "3.6.0") and extra == 'tests'
Requires-Dist: pytest ; (python_version >= "3.10.0") and extra == 'tests'
Requires-Dist: pytest-cov ; (python_version >= "3.6.0") and extra == 'tests'

The Kitware Plot Module
=======================

|GitlabCIPipeline| |GitlabCICoverage| |Appveyor| |Pypi| |Downloads| 

The main webpage for this project is: https://gitlab.kitware.com/computer-vision/kwplot

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

The top-level API is:

.. code:: python

    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``.

The ``kwplot.multi_plot`` function is able to create line and bar plots with
multiple lines/bars in a labeled axes using only a single function call. This
can dramatically reduce the code size needed to perform simple plot
visualizations as well as ensure that the code that produces the data is
decoupled from the code that does the visualization.

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).


.. |Pypi| image:: https://img.shields.io/pypi/v/kwplot.svg
   :target: https://pypi.python.org/pypi/kwplot

.. |Downloads| image:: https://img.shields.io/pypi/dm/kwplot.svg
   :target: https://pypistats.org/packages/kwplot

.. |ReadTheDocs| image:: https://readthedocs.org/projects/kwplot/badge/?version=latest
    :target: http://kwplot.readthedocs.io/en/latest/

.. # See: https://ci.appveyor.com/project/jon.crall/kwplot/settings/badges
.. |Appveyor| image:: https://ci.appveyor.com/api/projects/status/py3s2d6tyfjc8lm3/branch/master?svg=true
   :target: https://ci.appveyor.com/project/jon.crall/kwplot/branch/master

.. |GitlabCIPipeline| image:: https://gitlab.kitware.com/computer-vision/kwplot/badges/master/pipeline.svg
   :target: https://gitlab.kitware.com/computer-vision/kwplot/-/jobs

.. |GitlabCICoverage| image:: https://gitlab.kitware.com/computer-vision/kwplot/badges/master/coverage.svg?job=coverage
    :target: https://gitlab.kitware.com/computer-vision/kwplot/commits/master


