Package structure
=================

The :mod:`silx.gui.plot` package provides a 1D, 2D plot widget that supports multiple backends.
This package is structured as follows.

.. currentmodule:: silx.gui.plot

:mod:`.PlotWidget` and :mod:`.PlotWindow` provides the user API.
:class:`PlotWidget` is a Qt widget (actually a :class:`QMainWindow`) displaying a 1D, 2D plot area.
It provides different interaction modes.
:class:`PlotWindow` is a Qt widget (actually a :class:`QMainWindow`) which adds a set of toolbar buttons and associated functionalities to :class:`PlotWidget`.
The toolbar QActions are implemented in :class:`PlotActions`.

:mod:`.Plot`, :mod:`.PlotEvents` and :mod:`.PlotInteraction` implement the plotting API regardless of the rendering backend and regardless of its integration in Qt.
The plotting API in defined in :mod:`.Plot`.
The different interaction modes (zoom, drawing, pan) are implemented in :mod:`.PlotInteraction`.
Each interaction mode is implemented with a state machine structure (implemented in :mod:`.Interaction`).
The different events emitted by :class:`Plot` and by the interaction modes are created with helper functions defined in :mod:`.PlotEvents`.

:mod:`.BackendBase` defines the API any plot backend should provide in :class:`BackendBase`.
:mod:`.BackendMatplotlib` implements a `matplotlib <http://matplotlib.org/>`_ backend.
It is splitted in two classes:

.. currentmodule:: silx.gui.plot.BackendMatplotlib

- :class:`BackendMatplotlib` that provides a matplotlib backend without a specific canvas.
- :class:`BackendMatplotlibQt` which inherits from :class:`BackendMatplotlib` and adds a Qt canvas, and Qt specific functionalities.

Modules
=======

.. currentmodule:: silx.gui.plot

For :mod:`.PlotWidget` and :mod:`.Plot` modules, see their respective documentations: :mod:`.PlotWidget`, :mod:`.Plot`.

The following modules are the modules used internally by the plot package.

:mod:`BackendBase`
++++++++++++++++++

.. currentmodule:: silx.gui.plot.BackendBase

.. automodule:: silx.gui.plot.BackendBase
   :members:

:mod:`BackendMatplotlib`
++++++++++++++++++++++++

.. currentmodule:: silx.gui.plot.BackendMatplotlib

.. automodule:: silx.gui.plot.BackendMatplotlib
   :members:

:mod:`ColormapDialog`
+++++++++++++++++++++

.. currentmodule:: silx.gui.plot.ColormapDialog

.. automodule:: silx.gui.plot.ColormapDialog
   :members:

:mod:`Colors`
+++++++++++++

.. currentmodule:: silx.gui.plot.Colors

.. automodule:: silx.gui.plot.Colors
   :members: rgba

:mod:`Interaction`
++++++++++++++++++

.. currentmodule:: silx.gui.plot.Interaction

.. automodule:: silx.gui.plot.Interaction
   :members:

:mod:`ModestImage`
++++++++++++++++++

.. currentmodule:: silx.gui.plot.ModestImage

.. automodule:: silx.gui.plot.ModestImage
   :members:
   :undoc-members:

:mod:`PlotActions`
++++++++++++++++++

.. currentmodule:: silx.gui.plot.PlotActions

.. automodule:: silx.gui.plot.PlotActions
   :members:

:mod:`PlotEvents`
+++++++++++++++++

.. currentmodule:: silx.gui.plot.PlotEvents

.. automodule:: silx.gui.plot.PlotEvents
   :members:
   :undoc-members:

:mod:`PlotInteraction`
++++++++++++++++++++++

.. currentmodule:: silx.gui.plot.PlotInteraction

.. automodule:: silx.gui.plot.PlotInteraction
   :members: