summaryrefslogtreecommitdiff
path: root/doc/source/modules
diff options
context:
space:
mode:
authorPicca Frédéric-Emmanuel <picca@debian.org>2021-01-06 14:10:12 +0100
committerPicca Frédéric-Emmanuel <picca@debian.org>2021-01-06 14:10:12 +0100
commitb3bea947efa55d2c0f198b6c6795b3177be27f45 (patch)
tree4116758aafe4483bf472c1d54b519e685737fd77 /doc/source/modules
parent5ad425ff4e62f5e003178813ebd073577679a00e (diff)
New upstream version 0.14.0+dfsg
Diffstat (limited to 'doc/source/modules')
-rw-r--r--doc/source/modules/gui/data/img/ArrayTableWidget.pngbin42383 -> 41977 bytes
-rw-r--r--doc/source/modules/gui/data/img/DataViewer.pngbin38670 -> 37500 bytes
-rw-r--r--doc/source/modules/gui/icons.rst9
-rw-r--r--doc/source/modules/gui/plot/img/BasicGridStatsWidget.pngbin12081 -> 20668 bytes
-rw-r--r--doc/source/modules/gui/plot/img/LimitsToolBar.pngbin21697 -> 21679 bytes
-rw-r--r--doc/source/modules/gui/plot/img/ROIStatsWidget.pngbin0 -> 9659 bytes
-rw-r--r--doc/source/modules/gui/plot/img/logColorbar.pngbin11461 -> 12390 bytes
-rw-r--r--doc/source/modules/gui/plot/index.rst1
-rw-r--r--doc/source/modules/gui/plot/plotwidget.rst3
-rw-r--r--doc/source/modules/gui/plot/roistatswidget.rst24
-rw-r--r--doc/source/modules/gui/plot3d/img/SceneWidget.pngbin65009 -> 73947 bytes
-rw-r--r--doc/source/modules/gui/widgets/img/FrameBrowser.pngbin3186 -> 4538 bytes
-rw-r--r--doc/source/modules/gui/widgets/img/PeriodicCombo.pngbin2607 -> 3124 bytes
-rw-r--r--doc/source/modules/gui/widgets/img/PeriodicList.pngbin25731 -> 38615 bytes
-rw-r--r--doc/source/modules/gui/widgets/img/PeriodicTable.pngbin33564 -> 61338 bytes
-rw-r--r--doc/source/modules/gui/widgets/img/TableWidget.pngbin3789 -> 3624 bytes
-rw-r--r--doc/source/modules/gui/widgets/img/ThreadPoolPushButton.pngbin2151 -> 2566 bytes
-rw-r--r--doc/source/modules/gui/widgets/img/WaitingPushButton.pngbin1068 -> 1187 bytes
-rw-r--r--doc/source/modules/io/specfile.rst3
19 files changed, 38 insertions, 2 deletions
diff --git a/doc/source/modules/gui/data/img/ArrayTableWidget.png b/doc/source/modules/gui/data/img/ArrayTableWidget.png
index c879427..e7bb2a9 100644
--- a/doc/source/modules/gui/data/img/ArrayTableWidget.png
+++ b/doc/source/modules/gui/data/img/ArrayTableWidget.png
Binary files differ
diff --git a/doc/source/modules/gui/data/img/DataViewer.png b/doc/source/modules/gui/data/img/DataViewer.png
index a1fabb9..7980de9 100644
--- a/doc/source/modules/gui/data/img/DataViewer.png
+++ b/doc/source/modules/gui/data/img/DataViewer.png
Binary files differ
diff --git a/doc/source/modules/gui/icons.rst b/doc/source/modules/gui/icons.rst
index 8a939ea..67235c2 100644
--- a/doc/source/modules/gui/icons.rst
+++ b/doc/source/modules/gui/icons.rst
@@ -53,10 +53,14 @@ Available icons
- add-shape-unknown
* - |add-shape-vertical|
- add-shape-vertical
+ * - |add|
+ - add
* - |arrow-keys|
- arrow-keys
* - |axis|
- axis
+ * - |backend-opengl|
+ - backend-opengl
* - |camera|
- camera
* - |clipboard|
@@ -303,6 +307,8 @@ Available icons
- profile2D
* - |remove|
- remove
+ * - |rm|
+ - rm
* - |rotate-3d|
- rotate-3d
* - |rudder|
@@ -413,8 +419,10 @@ Available icons
.. |add-shape-rectangle| image:: ../../../../silx/resources/gui/icons/add-shape-rectangle.png
.. |add-shape-unknown| image:: ../../../../silx/resources/gui/icons/add-shape-unknown.png
.. |add-shape-vertical| image:: ../../../../silx/resources/gui/icons/add-shape-vertical.png
+.. |add| image:: ../../../../silx/resources/gui/icons/add.png
.. |arrow-keys| image:: ../../../../silx/resources/gui/icons/arrow-keys.png
.. |axis| image:: ../../../../silx/resources/gui/icons/axis.png
+.. |backend-opengl| image:: ../../../../silx/resources/gui/icons/backend-opengl.png
.. |camera| image:: ../../../../silx/resources/gui/icons/camera.png
.. |clipboard| image:: ../../../../silx/resources/gui/icons/clipboard.png
.. |close| image:: ../../../../silx/resources/gui/icons/close.png
@@ -538,6 +546,7 @@ Available icons
.. |profile1D| image:: ../../../../silx/resources/gui/icons/profile1D.png
.. |profile2D| image:: ../../../../silx/resources/gui/icons/profile2D.png
.. |remove| image:: ../../../../silx/resources/gui/icons/remove.png
+.. |rm| image:: ../../../../silx/resources/gui/icons/rm.png
.. |rotate-3d| image:: ../../../../silx/resources/gui/icons/rotate-3d.png
.. |rudder| image:: ../../../../silx/resources/gui/icons/rudder.png
.. |selected| image:: ../../../../silx/resources/gui/icons/selected.png
diff --git a/doc/source/modules/gui/plot/img/BasicGridStatsWidget.png b/doc/source/modules/gui/plot/img/BasicGridStatsWidget.png
index bc675f0..261909a 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/LimitsToolBar.png b/doc/source/modules/gui/plot/img/LimitsToolBar.png
index ede66c8..b360fe0 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/ROIStatsWidget.png b/doc/source/modules/gui/plot/img/ROIStatsWidget.png
new file mode 100644
index 0000000..7a634fe
--- /dev/null
+++ b/doc/source/modules/gui/plot/img/ROIStatsWidget.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 cde1ad9..49282e7 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 b6c2000..7f60ba4 100644
--- a/doc/source/modules/gui/plot/index.rst
+++ b/doc/source/modules/gui/plot/index.rst
@@ -59,6 +59,7 @@ Additionnal plot tool widgets:
roi.rst
printpreviewtoolbutton.rst
statswidget.rst
+ roistatswidget.rst
stats/index.rst
Utilities
diff --git a/doc/source/modules/gui/plot/plotwidget.rst b/doc/source/modules/gui/plot/plotwidget.rst
index 9978479..d16c4ab 100644
--- a/doc/source/modules/gui/plot/plotwidget.rst
+++ b/doc/source/modules/gui/plot/plotwidget.rst
@@ -82,7 +82,10 @@ The following methods handle plot limits, aspect ratio, grid and axes display:
.. automethod:: PlotWidget.setKeepDataAspectRatio
.. automethod:: PlotWidget.getGraphGrid
.. automethod:: PlotWidget.setGraphGrid
+.. automethod:: PlotWidget.isAxesDisplayed
.. automethod:: PlotWidget.setAxesDisplayed
+.. automethod:: PlotWidget.getAxesMargins
+.. automethod:: PlotWidget.setAxesMargins
Reset zoom
..........
diff --git a/doc/source/modules/gui/plot/roistatswidget.rst b/doc/source/modules/gui/plot/roistatswidget.rst
new file mode 100644
index 0000000..d9563b5
--- /dev/null
+++ b/doc/source/modules/gui/plot/roistatswidget.rst
@@ -0,0 +1,24 @@
+
+.. currentmodule:: silx.gui.plot.ROIStatsWidget
+
+:mod:`ROIStatsWidget`: Display a set of statistics for couples (plot items, roi)
+================================================================================
+
+An example of the usage is given in examples/plotRoiStats.py
+
+.. automodule:: silx.gui.plot.ROIStatsWidget
+
+
+:class:`ROIStatsWidget` class
+-----------------------------
+
+.. autoclass:: ROIStatsWidget
+ :show-inheritance:
+ :members:
+
+:class:`ROIStatsItemHelper` class
+---------------------------------
+
+.. autoclass:: ROIStatsItemHelper
+ :show-inheritance:
+ :members:
diff --git a/doc/source/modules/gui/plot3d/img/SceneWidget.png b/doc/source/modules/gui/plot3d/img/SceneWidget.png
index dbe7791..4ddc0a8 100644
--- a/doc/source/modules/gui/plot3d/img/SceneWidget.png
+++ b/doc/source/modules/gui/plot3d/img/SceneWidget.png
Binary files differ
diff --git a/doc/source/modules/gui/widgets/img/FrameBrowser.png b/doc/source/modules/gui/widgets/img/FrameBrowser.png
index 17b355a..1d4ebcf 100644
--- a/doc/source/modules/gui/widgets/img/FrameBrowser.png
+++ b/doc/source/modules/gui/widgets/img/FrameBrowser.png
Binary files differ
diff --git a/doc/source/modules/gui/widgets/img/PeriodicCombo.png b/doc/source/modules/gui/widgets/img/PeriodicCombo.png
index 644e502..7534805 100644
--- a/doc/source/modules/gui/widgets/img/PeriodicCombo.png
+++ b/doc/source/modules/gui/widgets/img/PeriodicCombo.png
Binary files differ
diff --git a/doc/source/modules/gui/widgets/img/PeriodicList.png b/doc/source/modules/gui/widgets/img/PeriodicList.png
index 5ec741f..74ce7d6 100644
--- a/doc/source/modules/gui/widgets/img/PeriodicList.png
+++ b/doc/source/modules/gui/widgets/img/PeriodicList.png
Binary files differ
diff --git a/doc/source/modules/gui/widgets/img/PeriodicTable.png b/doc/source/modules/gui/widgets/img/PeriodicTable.png
index a521bd7..bada39a 100644
--- a/doc/source/modules/gui/widgets/img/PeriodicTable.png
+++ b/doc/source/modules/gui/widgets/img/PeriodicTable.png
Binary files differ
diff --git a/doc/source/modules/gui/widgets/img/TableWidget.png b/doc/source/modules/gui/widgets/img/TableWidget.png
index de78687..a614ae7 100644
--- a/doc/source/modules/gui/widgets/img/TableWidget.png
+++ b/doc/source/modules/gui/widgets/img/TableWidget.png
Binary files differ
diff --git a/doc/source/modules/gui/widgets/img/ThreadPoolPushButton.png b/doc/source/modules/gui/widgets/img/ThreadPoolPushButton.png
index 5bdebee..eb55b14 100644
--- a/doc/source/modules/gui/widgets/img/ThreadPoolPushButton.png
+++ b/doc/source/modules/gui/widgets/img/ThreadPoolPushButton.png
Binary files differ
diff --git a/doc/source/modules/gui/widgets/img/WaitingPushButton.png b/doc/source/modules/gui/widgets/img/WaitingPushButton.png
index 9bab0fa..97bd14a 100644
--- a/doc/source/modules/gui/widgets/img/WaitingPushButton.png
+++ b/doc/source/modules/gui/widgets/img/WaitingPushButton.png
Binary files differ
diff --git a/doc/source/modules/io/specfile.rst b/doc/source/modules/io/specfile.rst
index a937ca8..9b26e31 100644
--- a/doc/source/modules/io/specfile.rst
+++ b/doc/source/modules/io/specfile.rst
@@ -5,8 +5,7 @@
----------------------------------
.. automodule:: silx.io.specfile
- :members:
- :undoc-members:
+
.. autoclass:: silx.io.specfile.SpecFile
:members: