The Kitware Plot Module
=======================
|GitlabCIPipeline| |GitlabCICoverage| |Appveyor| |Pypi| |Downloads| |ReadTheDocs|
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 <https://kwplot.readthedocs.io/en/main/kwplot.html#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 <https://kwplot.readthedocs.io/en/main/kwplot.html#kwplot.autoplt>`_ and
`kwplot.autosns <https://kwplot.readthedocs.io/en/main/kwplot.html#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.
.. |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=main
:target: http://kwplot.readthedocs.io/en/main/
.. # 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
Raw data
{
"_id": null,
"home_page": "https://gitlab.kitware.com/computer-vision/kwplot",
"name": "kwplot",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "",
"author": "Kitware Inc., Jon Crall",
"author_email": "kitware@kitware.com, jon.crall@kitware.com",
"download_url": "",
"platform": null,
"description": "The Kitware Plot Module\n=======================\n\n|GitlabCIPipeline| |GitlabCICoverage| |Appveyor| |Pypi| |Downloads| |ReadTheDocs|\n\nThe main webpage for this project is: https://gitlab.kitware.com/computer-vision/kwplot\n\nThe ``kwplot`` module is a wrapper around ``matplotlib`` and can be used for\nvisualizing algorithm results.\n\nThe top-level API is:\n\n.. code:: python\n\n from .auto_backends import (autompl, autoplt, set_mpl_backend,)\n from .draw_conv import (make_conv_images, plot_convolutional_features,)\n from .mpl_3d import (plot_surface3d,)\n from .mpl_color import (Color,)\n from .mpl_core import (distinct_colors, distinct_markers, ensure_fnum, figure,\n imshow, legend, next_fnum, set_figtitle,\n show_if_requested,)\n from .mpl_draw import (draw_boxes, draw_boxes_on_image, draw_clf_on_image,\n draw_line_segments, draw_text_on_image, plot_matrix, draw_points,)\n from .mpl_make import (make_heatmask, make_orimask, make_vector_field,)\n from .mpl_multiplot import (multi_plot,)\n from .mpl_plotnums import (PlotNums,)\n\nOne of the key features is the `kwplot.autompl <https://kwplot.readthedocs.io/en/main/kwplot.html#kwplot.autompl>`_\nfunction, which is able to somewhat intelligently set the notorious matplotlib\nbackend. \nBy default it will attempt to use ``PyQt5`` if it is installed and a\n``DISPLAY`` is available. Otherwise it will ensure the backend is set to\n``Agg``. For convinience, the functions:\n`kwplot.autoplt <https://kwplot.readthedocs.io/en/main/kwplot.html#kwplot.autoplt>`_ and\n`kwplot.autosns <https://kwplot.readthedocs.io/en/main/kwplot.html#kwplot.autosns>`_\nalso execute this auto-backend behavior, but return the pyplot and seaborn\nmodule, respectively. It is recommended to call one of these functions before\nany use of pyplot due to pyplot's import-time side effects (note: pre-importing\nmost other matplotlib modules is ok).\n\nThe ``kwplot.imshow`` and ``kwplot.figure`` functions are extensions of the\n``matplotlib`` versions with slightly extended interfaces (again to help reduce\nthe density of visualization code in research scripts). The ``kwplot.PlotNums``\nhelps manage subplots locations, especially when you are developing /\nreordering them.\n\n\n.. |Pypi| image:: https://img.shields.io/pypi/v/kwplot.svg\n :target: https://pypi.python.org/pypi/kwplot\n\n.. |Downloads| image:: https://img.shields.io/pypi/dm/kwplot.svg\n :target: https://pypistats.org/packages/kwplot\n\n.. |ReadTheDocs| image:: https://readthedocs.org/projects/kwplot/badge/?version=main\n :target: http://kwplot.readthedocs.io/en/main/\n\n.. # See: https://ci.appveyor.com/project/jon.crall/kwplot/settings/badges\n.. |Appveyor| image:: https://ci.appveyor.com/api/projects/status/py3s2d6tyfjc8lm3/branch/master?svg=true\n :target: https://ci.appveyor.com/project/jon.crall/kwplot/branch/master\n\n.. |GitlabCIPipeline| image:: https://gitlab.kitware.com/computer-vision/kwplot/badges/master/pipeline.svg\n :target: https://gitlab.kitware.com/computer-vision/kwplot/-/jobs\n\n.. |GitlabCICoverage| image:: https://gitlab.kitware.com/computer-vision/kwplot/badges/master/coverage.svg?job=coverage\n :target: https://gitlab.kitware.com/computer-vision/kwplot/commits/master\n",
"bugtrack_url": null,
"license": "Apache 2",
"summary": "A wrapper around matplotlib",
"version": "0.4.15",
"project_urls": {
"Homepage": "https://gitlab.kitware.com/computer-vision/kwplot"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "aa3c98bfffd6aee48173dbe2fbccb5e2225b6eb52b3e328721f13099e01e77a5",
"md5": "4bbb4c37e6afea092013d4123c4373d3",
"sha256": "7bce47eac20f7733ada83813bca29dd8ada3aca4be6c095f71783b3e802bd091"
},
"downloads": -1,
"filename": "kwplot-0.4.15-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4bbb4c37e6afea092013d4123c4373d3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 66395,
"upload_time": "2023-06-01T00:10:50",
"upload_time_iso_8601": "2023-06-01T00:10:50.077484Z",
"url": "https://files.pythonhosted.org/packages/aa/3c/98bfffd6aee48173dbe2fbccb5e2225b6eb52b3e328721f13099e01e77a5/kwplot-0.4.15-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-01 00:10:50",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "kwplot"
}
JSON