diff options
Diffstat (limited to 'doc/source/modules/gui/plot')
-rw-r--r-- | doc/source/modules/gui/plot/compareimages.rst | 19 | ||||
-rw-r--r-- | doc/source/modules/gui/plot/dev.rst | 1 | ||||
-rw-r--r-- | doc/source/modules/gui/plot/getting_started.rst | 8 | ||||
-rw-r--r-- | doc/source/modules/gui/plot/img/CompareImages.png | bin | 0 -> 169928 bytes | |||
-rw-r--r-- | doc/source/modules/gui/plot/img/CurveLegendsWidget.png | bin | 0 -> 30043 bytes | |||
-rw-r--r-- | doc/source/modules/gui/plot/index.rst | 1 | ||||
-rw-r--r-- | doc/source/modules/gui/plot/items.rst | 7 | ||||
-rw-r--r-- | doc/source/modules/gui/plot/plotsignal.rst | 1 | ||||
-rw-r--r-- | doc/source/modules/gui/plot/plotwidget.rst | 16 | ||||
-rw-r--r-- | doc/source/modules/gui/plot/tools.rst | 12 |
10 files changed, 50 insertions, 15 deletions
diff --git a/doc/source/modules/gui/plot/compareimages.rst b/doc/source/modules/gui/plot/compareimages.rst new file mode 100644 index 0000000..ca85636 --- /dev/null +++ b/doc/source/modules/gui/plot/compareimages.rst @@ -0,0 +1,19 @@ + +.. currentmodule:: silx.gui.plot + +:mod:`CompareImages`: Plot 2 images to compare them +=================================================== + +.. automodule:: silx.gui.plot.CompareImages + +.. currentmodule:: silx.gui.plot.CompareImages + +.. image:: img/CompareImages.png + :height: 400px + :align: center + +:class:`CompareImages` class +---------------------------- + +.. autoclass:: CompareImages + :members: diff --git a/doc/source/modules/gui/plot/dev.rst b/doc/source/modules/gui/plot/dev.rst index d7d4581..8966487 100644 --- a/doc/source/modules/gui/plot/dev.rst +++ b/doc/source/modules/gui/plot/dev.rst @@ -44,7 +44,6 @@ The :mod:`backends` package provide the implementation of the rendering used by It contains: :mod:`.backends.BackendBase` defines the API any plot backend should provide in :class:`BackendBase`. :mod:`.backends.BackendMatplotlib` implements a `matplotlib <http://matplotlib.org/>`_ backend. -It uses :mod:`.backends.ModestImage` to provide a faster matplotlib AxesImage class using nearest values. The :mod:`.backends.BackendMatplotlib` the provides two classes: .. currentmodule:: silx.gui.plot.backends.BackendMatplotlib diff --git a/doc/source/modules/gui/plot/getting_started.rst b/doc/source/modules/gui/plot/getting_started.rst index 412cc11..899d262 100644 --- a/doc/source/modules/gui/plot/getting_started.rst +++ b/doc/source/modules/gui/plot/getting_started.rst @@ -66,7 +66,7 @@ On Windows, run from the command line:: - version 1, the legacy version which is also the default, and - version 2, a more pythonic one, which is the only one supported by *silx*. - All other configurations (i.e., PyQt4 on Python 3.x, PySide, PyQt5, IPython QtConsole widget) uses version 2. + All other configurations (i.e., PyQt4 on Python 3.x, PySide2, PyQt5, IPython QtConsole widget) uses version 2. For more information, see `IPython, PyQt and PySide <http://ipython.org/ipython-doc/stable/interactive/reference.html#pyqt-and-pyside>`_. @@ -103,7 +103,7 @@ A Qt GUI script must have a QApplication initialised before creating widgets: [...] qapp.exec_() -Unless a Qt binding has already been loaded, :mod:`silx.gui.qt` uses one of the supported Qt bindings (PyQt4, PySide or PyQt5). +Unless a Qt binding has already been loaded, :mod:`silx.gui.qt` uses one of the supported Qt bindings (PyQt5, PyQt4, PySide2). If you prefer to choose the Qt binding yourself, import it before importing a module from :mod:`silx.gui`: @@ -295,7 +295,7 @@ When displaying an image, it is possible to define the ``origin`` and the ``scal Colormap ++++++++ -A ``colormap`` is described with a :class:`.Colormap` class as follows: +A ``colormap`` is described with a :class:`~silx.gui.colors.Colormap` class as follows: .. code-block:: python @@ -338,7 +338,7 @@ It is possible to change the default colormap of the plot widget by :meth:`.Plot data = numpy.arange(512 * 512.).reshape(512, -1) plot.addImage(data) # Rendered with the default colormap set before -It is also possible to provide a :class:`.Colormap` to :meth:`.PlotWidget.addImage` to override this default for an image: +It is also possible to provide a :class:`~silx.gui.colors.Colormap` to :meth:`.PlotWidget.addImage` to override this default for an image: .. code-block:: python diff --git a/doc/source/modules/gui/plot/img/CompareImages.png b/doc/source/modules/gui/plot/img/CompareImages.png Binary files differnew file mode 100644 index 0000000..6650f26 --- /dev/null +++ b/doc/source/modules/gui/plot/img/CompareImages.png diff --git a/doc/source/modules/gui/plot/img/CurveLegendsWidget.png b/doc/source/modules/gui/plot/img/CurveLegendsWidget.png Binary files differnew file mode 100644 index 0000000..e7fa9f8 --- /dev/null +++ b/doc/source/modules/gui/plot/img/CurveLegendsWidget.png diff --git a/doc/source/modules/gui/plot/index.rst b/doc/source/modules/gui/plot/index.rst index 5cda6d8..6f06830 100644 --- a/doc/source/modules/gui/plot/index.rst +++ b/doc/source/modules/gui/plot/index.rst @@ -36,6 +36,7 @@ Main plot widgets: imageview.rst stackview.rst scatterview.rst + compareimages.rst Classes describing plot content: diff --git a/doc/source/modules/gui/plot/items.rst b/doc/source/modules/gui/plot/items.rst index eb3ca1a..43eb77e 100644 --- a/doc/source/modules/gui/plot/items.rst +++ b/doc/source/modules/gui/plot/items.rst @@ -29,8 +29,11 @@ Curve isFill, setFill, getXLabel, getYLabel, getLineWidth, setLineWidth, getLineStyle, setLineStyle, - isHighlighted, setHighlighted, getHighlightedColor, setHighlightedColor, - getCurrentColor + isHighlighted, setHighlighted, getHighlightedStyle, setHighlightedStyle, + getCurrentStyle + +.. autoclass:: CurveStyle + :members: getColor, getLineStyle, getLineWidth, getSymbol, getSymbolSize Images ------ diff --git a/doc/source/modules/gui/plot/plotsignal.rst b/doc/source/modules/gui/plot/plotsignal.rst index c4cb003..091f481 100644 --- a/doc/source/modules/gui/plot/plotsignal.rst +++ b/doc/source/modules/gui/plot/plotsignal.rst @@ -132,6 +132,7 @@ Plot state change events These events are deprecated. Use :attr:`PlotWidget.sigSetKeepDataAspectRatio`, :attr:`PlotWidget.sigSetGraphGrid`, :attr:`PlotWidget.sigSetGraphCursor`, + :attr:`PlotWidget.sigItemAdded`,:attr:`PlotWidget.sigItemAboutToBeRemoved`, :attr:`PlotWidget.sigContentChanged`, :attr:`PlotWidget.sigActiveCurveChanged`, :attr:`PlotWidget.sigActiveImageChanged` and :attr:`PlotWidget.sigInteractiveModeChanged` instead. diff --git a/doc/source/modules/gui/plot/plotwidget.rst b/doc/source/modules/gui/plot/plotwidget.rst index 4ce69f7..9978479 100644 --- a/doc/source/modules/gui/plot/plotwidget.rst +++ b/doc/source/modules/gui/plot/plotwidget.rst @@ -37,15 +37,13 @@ Get data Those methods return objects providing access to plotted data: +.. automethod:: PlotWidget.getItems + .. automethod:: PlotWidget.getCurve .. automethod:: PlotWidget.getImage .. automethod:: PlotWidget.getScatter .. automethod:: PlotWidget.getHistogram -.. automethod:: PlotWidget.getAllCurves -.. automethod:: PlotWidget.getAllImages - - Plot markers ............ @@ -134,10 +132,10 @@ Coordinates conversion Active Item ........... -.. automethod:: PlotWidget.isActiveCurveHandling -.. automethod:: PlotWidget.setActiveCurveHandling -.. automethod:: PlotWidget.getActiveCurveColor -.. automethod:: PlotWidget.setActiveCurveColor +.. automethod:: PlotWidget.setActiveCurveSelectionMode +.. automethod:: PlotWidget.getActiveCurveSelectionMode +.. automethod:: PlotWidget.getActiveCurveStyle +.. automethod:: PlotWidget.setActiveCurveStyle .. automethod:: PlotWidget.getActiveCurve .. automethod:: PlotWidget.setActiveCurve .. automethod:: PlotWidget.getActiveImage @@ -159,6 +157,8 @@ The :class:`PlotWidget` provides the following Qt signals: .. autoattribute:: PlotWidget.sigSetGraphGrid .. autoattribute:: PlotWidget.sigSetGraphCursor .. autoattribute:: PlotWidget.sigSetPanWithArrowKeys +.. autoattribute:: PlotWidget.sigItemAdded +.. autoattribute:: PlotWidget.sigItemAboutToBeRemoved .. autoattribute:: PlotWidget.sigContentChanged .. autoattribute:: PlotWidget.sigActiveCurveChanged .. autoattribute:: PlotWidget.sigActiveImageChanged diff --git a/doc/source/modules/gui/plot/tools.rst b/doc/source/modules/gui/plot/tools.rst index 766c8f1..d7c96b5 100644 --- a/doc/source/modules/gui/plot/tools.rst +++ b/doc/source/modules/gui/plot/tools.rst @@ -54,6 +54,18 @@ :show-inheritance: :members: +:mod:`~silx.gui.plot.tools.CurveLegendsWidget` +---------------------------------------------- + +.. automodule:: silx.gui.plot.tools.CurveLegendsWidget + +.. image:: img/CurveLegendsWidget.png + :align: center + +.. autoclass:: silx.gui.plot.tools.CurveLegendsWidget.CurveLegendsWidget + :show-inheritance: + :members: + :mod:`~silx.gui.plot.tools.roi`: Region of interest --------------------------------------------------- |