summaryrefslogtreecommitdiff
path: root/doc/source/modules/gui/plot/tools
diff options
context:
space:
mode:
Diffstat (limited to 'doc/source/modules/gui/plot/tools')
-rw-r--r--doc/source/modules/gui/plot/tools/img/CurveLegendsWidget.pngbin0 -> 30043 bytes
-rw-r--r--doc/source/modules/gui/plot/tools/img/linearColorbar.pngbin0 -> 6585 bytes
-rw-r--r--doc/source/modules/gui/plot/tools/index.rst118
-rw-r--r--doc/source/modules/gui/plot/tools/profile.rst84
4 files changed, 202 insertions, 0 deletions
diff --git a/doc/source/modules/gui/plot/tools/img/CurveLegendsWidget.png b/doc/source/modules/gui/plot/tools/img/CurveLegendsWidget.png
new file mode 100644
index 0000000..e7fa9f8
--- /dev/null
+++ b/doc/source/modules/gui/plot/tools/img/CurveLegendsWidget.png
Binary files differ
diff --git a/doc/source/modules/gui/plot/tools/img/linearColorbar.png b/doc/source/modules/gui/plot/tools/img/linearColorbar.png
new file mode 100644
index 0000000..26621ce
--- /dev/null
+++ b/doc/source/modules/gui/plot/tools/img/linearColorbar.png
Binary files differ
diff --git a/doc/source/modules/gui/plot/tools/index.rst b/doc/source/modules/gui/plot/tools/index.rst
new file mode 100644
index 0000000..c75aea5
--- /dev/null
+++ b/doc/source/modules/gui/plot/tools/index.rst
@@ -0,0 +1,118 @@
+.. currentmodule:: silx.gui.plot.tools
+
+:mod:`~silx.gui.plot.tools`: Tool widgets for PlotWidget
+========================================================
+
+.. 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
+---------------------------
+
+.. autoclass:: PositionInfo
+ :show-inheritance:
+ :members:
+
+:class:`LimitsToolBar` class
+----------------------------
+
+.. autoclass:: LimitsToolBar
+ :show-inheritance:
+ :members:
+
+:class:`InteractiveModeToolBar` class
+-------------------------------------
+
+.. autoclass:: InteractiveModeToolBar
+ :show-inheritance:
+ :members:
+
+:class:`OutputToolBar` class
+----------------------------
+
+.. autoclass:: OutputToolBar
+ :show-inheritance:
+ :members:
+
+:class:`ImageToolBar` class
+----------------------------
+
+.. autoclass:: ImageToolBar
+ :show-inheritance:
+ :members:
+
+:class:`CurveToolBar` class
+----------------------------
+
+.. autoclass:: CurveToolBar
+ :show-inheritance:
+ :members:
+
+:class:`ScatterToolBar` class
+-----------------------------
+
+.. autoclass:: ScatterToolBar
+ :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
+---------------------------------------------------
+
+.. automodule:: silx.gui.plot.tools.roi
+
+.. currentmodule:: silx.gui.plot.tools.roi
+
+:class:`RegionOfInterestManager` class
+++++++++++++++++++++++++++++++++++++++
+
+.. autoclass:: RegionOfInterestManager
+ :members:
+
+:class:`InteractiveRegionOfInterestManager` class
++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. autoclass:: InteractiveRegionOfInterestManager
+ :members:
+
+:class:`RegionOfInterestTableWidget` class
+++++++++++++++++++++++++++++++++++++++++++
+
+.. autoclass:: RegionOfInterestTableWidget
+ :members:
+
+:mod:`ColorBar`: ColorBar Widget
+================================
+
+.. currentmodule:: silx.gui.plot.ColorBar
+
+.. automodule:: silx.gui.plot.ColorBar
+
+:class:`ColorBarWidget` class
+-----------------------------
+
+.. autoclass:: ColorBarWidget
+ :members:
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
+