summaryrefslogtreecommitdiff
path: root/doc/source/modules/gui/plot
diff options
context:
space:
mode:
Diffstat (limited to 'doc/source/modules/gui/plot')
-rw-r--r--doc/source/modules/gui/plot/getting_started.rst16
-rw-r--r--doc/source/modules/gui/plot/img/BasicGridStatsWidget.pngbin5702 -> 12081 bytes
-rw-r--r--doc/source/modules/gui/plot/img/BasicStatsWidget.pngbin6575 -> 8699 bytes
-rw-r--r--doc/source/modules/gui/plot/img/LimitsToolBar.pngbin21499 -> 21697 bytes
-rw-r--r--doc/source/modules/gui/plot/img/logColorbar.pngbin5240 -> 11461 bytes
-rw-r--r--doc/source/modules/gui/plot/index.rst2
-rw-r--r--doc/source/modules/gui/plot/tools/img/CurveLegendsWidget.png (renamed from doc/source/modules/gui/plot/img/CurveLegendsWidget.png)bin30043 -> 30043 bytes
-rw-r--r--doc/source/modules/gui/plot/tools/img/linearColorbar.png (renamed from doc/source/modules/gui/plot/img/linearColorbar.png)bin6585 -> 6585 bytes
-rw-r--r--doc/source/modules/gui/plot/tools/index.rst (renamed from doc/source/modules/gui/plot/tools.rst)32
-rw-r--r--doc/source/modules/gui/plot/tools/profile.rst84
10 files changed, 101 insertions, 33 deletions
diff --git a/doc/source/modules/gui/plot/getting_started.rst b/doc/source/modules/gui/plot/getting_started.rst
index 899d262..c105395 100644
--- a/doc/source/modules/gui/plot/getting_started.rst
+++ b/doc/source/modules/gui/plot/getting_started.rst
@@ -20,7 +20,7 @@ For a complete description of the API, see :mod:`silx.gui.plot`.
Use :mod:`silx.gui.plot` from (I)Python console
-----------------------------------------------
-We recommend to use (I)Python 3.x and PyQt5.
+We recommend to use (I)Python >=3.5 and PyQt5.
From a Python or IPython interpreter, the simplest way is to import the :mod:`silx.sx` module:
@@ -48,10 +48,6 @@ the way silx loads Qt and the way IPython is doing it through the ``--gui`` opti
`%pylab <http://ipython.org/ipython-doc/stable/interactive/magics.html#magic-pylab>`_ magics.
In this case, IPython magics that initialize Qt might not work after importing modules from silx.gui.
-When using Python2.7 and PyQt4, there is another incompatibility to deal with as
-silx requires PyQt4 API version 2 (See note below for explanation).
-In this case, start IPython with the ``QT_API`` environment variable set to ``pyqt``.
-
On Linux and MacOS X, run from the command line::
QT_API=pyqt ipython
@@ -61,16 +57,6 @@ On Windows, run from the command line::
set QT_API=pyqt&&ipython
-.. note:: PyQt4 used from Python 2.x provides 2 incompatible versions of QString and QVariant:
-
- - 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, 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>`_.
-
-
Plot functions
++++++++++++++
diff --git a/doc/source/modules/gui/plot/img/BasicGridStatsWidget.png b/doc/source/modules/gui/plot/img/BasicGridStatsWidget.png
index 53ddc0e..bc675f0 100644
--- a/doc/source/modules/gui/plot/img/BasicGridStatsWidget.png
+++ b/doc/source/modules/gui/plot/img/BasicGridStatsWidget.png
Binary files differ
diff --git a/doc/source/modules/gui/plot/img/BasicStatsWidget.png b/doc/source/modules/gui/plot/img/BasicStatsWidget.png
index c9ed2cd..b0d815d 100644
--- a/doc/source/modules/gui/plot/img/BasicStatsWidget.png
+++ b/doc/source/modules/gui/plot/img/BasicStatsWidget.png
Binary files differ
diff --git a/doc/source/modules/gui/plot/img/LimitsToolBar.png b/doc/source/modules/gui/plot/img/LimitsToolBar.png
index 54b6c2b..ede66c8 100644
--- a/doc/source/modules/gui/plot/img/LimitsToolBar.png
+++ b/doc/source/modules/gui/plot/img/LimitsToolBar.png
Binary files differ
diff --git a/doc/source/modules/gui/plot/img/logColorbar.png b/doc/source/modules/gui/plot/img/logColorbar.png
index c677a9b..cde1ad9 100644
--- a/doc/source/modules/gui/plot/img/logColorbar.png
+++ b/doc/source/modules/gui/plot/img/logColorbar.png
Binary files differ
diff --git a/doc/source/modules/gui/plot/index.rst b/doc/source/modules/gui/plot/index.rst
index 01cb29b..b6c2000 100644
--- a/doc/source/modules/gui/plot/index.rst
+++ b/doc/source/modules/gui/plot/index.rst
@@ -54,7 +54,7 @@ Additionnal plot tool widgets:
actions/index.rst
plottoolbuttons.rst
- tools.rst
+ tools/index.rst
profile.rst
roi.rst
printpreviewtoolbutton.rst
diff --git a/doc/source/modules/gui/plot/img/CurveLegendsWidget.png b/doc/source/modules/gui/plot/tools/img/CurveLegendsWidget.png
index e7fa9f8..e7fa9f8 100644
--- a/doc/source/modules/gui/plot/img/CurveLegendsWidget.png
+++ b/doc/source/modules/gui/plot/tools/img/CurveLegendsWidget.png
Binary files differ
diff --git a/doc/source/modules/gui/plot/img/linearColorbar.png b/doc/source/modules/gui/plot/tools/img/linearColorbar.png
index 26621ce..26621ce 100644
--- a/doc/source/modules/gui/plot/img/linearColorbar.png
+++ b/doc/source/modules/gui/plot/tools/img/linearColorbar.png
Binary files differ
diff --git a/doc/source/modules/gui/plot/tools.rst b/doc/source/modules/gui/plot/tools/index.rst
index d7c96b5..c75aea5 100644
--- a/doc/source/modules/gui/plot/tools.rst
+++ b/doc/source/modules/gui/plot/tools/index.rst
@@ -1,10 +1,23 @@
+.. currentmodule:: silx.gui.plot.tools
+
:mod:`~silx.gui.plot.tools`: Tool widgets for PlotWidget
========================================================
-.. currentmodule:: silx.gui.plot.tools
-
.. automodule:: silx.gui.plot.tools
+Tools API
+---------
+
+Tools are divided into the following sub-modules:
+
+.. toctree::
+ :maxdepth: 1
+
+ profile.rst
+
+Other tools API
+---------------
+
:class:`PositionInfo` class
---------------------------
@@ -91,21 +104,6 @@
.. autoclass:: RegionOfInterestTableWidget
:members:
-:mod:`~silx.gui.plot.tools.profile`: Profile Tools
---------------------------------------------------
-
-.. automodule:: silx.gui.plot.tools.profile
-
-.. currentmodule:: silx.gui.plot.tools.profile
-
-:class:`ScatterProfileToolBar`
-++++++++++++++++++++++++++++++
-
-.. autoclass:: ScatterProfileToolBar
- :members: sigProfileChanged, getProfilePoints, getProfileValues, getProfileTitle, getPlotWidget, isDefaultProfileWindowEnabled, setDefaultProfileWindowEnabled, getDefaultProfileWindow, getColor, setColor, clearProfile, getNPoints, setNPoints
-
-.. currentmodule:: silx.gui.plot
-
:mod:`ColorBar`: ColorBar Widget
================================
diff --git a/doc/source/modules/gui/plot/tools/profile.rst b/doc/source/modules/gui/plot/tools/profile.rst
new file mode 100644
index 0000000..32d8a26
--- /dev/null
+++ b/doc/source/modules/gui/plot/tools/profile.rst
@@ -0,0 +1,84 @@
+.. currentmodule:: silx.gui.plot.tools.profile
+
+:mod:`~silx.gui.plot.tools.profile`: Profile tool for PlotWidget
+================================================================
+
+.. automodule:: silx.gui.plot.tools.profile
+
+The profile package is divided into several sub-modules.
+
+:mod:`~silx.gui.plot.tools.profile.manager` module
+--------------------------------------------------
+
+.. automodule:: silx.gui.plot.tools.profile.manager
+
+:class:`ProfileManager` class
++++++++++++++++++++++++++++++
+
+.. autoclass:: ProfileManager
+ :show-inheritance:
+ :members:
+
+:class:`ProfileWindow` class
+++++++++++++++++++++++++++++
+
+.. autoclass:: ProfileWindow
+ :show-inheritance:
+ :members:
+
+:mod:`~silx.gui.plot.tools.profile.editors` module
+--------------------------------------------------
+
+.. automodule:: silx.gui.plot.tools.profile.editors
+
+:class:`ProfileRoiEditorAction` class
++++++++++++++++++++++++++++++++++++++
+
+.. autoclass:: ProfileRoiEditorAction
+ :show-inheritance:
+ :members:
+
+:mod:`~silx.gui.plot.tools.profile.core` module
+-----------------------------------------------
+
+.. automodule:: silx.gui.plot.tools.profile.core
+
+:class:`ProfileRoiMixIn` class
+++++++++++++++++++++++++++++++
+
+.. autoclass:: ProfileRoiMixIn
+ :show-inheritance:
+ :members:
+
+:class:`CurveProfileData` class
++++++++++++++++++++++++++++++++
+
+.. autoclass:: CurveProfileData
+ :show-inheritance:
+ :members:
+
+
+:class:`ImageProfileData` class
++++++++++++++++++++++++++++++++
+
+.. autoclass:: ImageProfileData
+ :show-inheritance:
+ :members:
+
+:mod:`~silx.gui.plot.tools.profile.ScatterProfileToolBar` module
+----------------------------------------------------------------
+
+.. automodule:: silx.gui.plot.tools.profile.ScatterProfileToolBar
+
+:class:`ScatterProfileToolBar`
+++++++++++++++++++++++++++++++
+
+.. autoclass:: ScatterProfileToolBar
+ :show-inheritance:
+ :members:
+
+:mod:`~silx.gui.plot.tools.profile.rois` module
+-----------------------------------------------
+
+.. automodule:: silx.gui.plot.tools.profile.rois
+