summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorPicca Frédéric-Emmanuel <picca@synchrotron-soleil.fr>2019-12-23 13:45:09 +0100
committerPicca Frédéric-Emmanuel <picca@synchrotron-soleil.fr>2019-12-23 13:45:09 +0100
commit5d647cf9a6159afd2933da594b9c79ad93d3cd9b (patch)
tree2571025a602f68fc8933b01104dc712d41f84034 /doc
parent654a6ac93513c3cc1ef97cacd782ff674c6f4559 (diff)
New upstream version 0.12.0~b0+dfsg
Diffstat (limited to 'doc')
-rw-r--r--doc/source/ext/snapshotqt_directive.py20
-rw-r--r--doc/source/install.rst2
-rw-r--r--doc/source/modules/opencl/convolution.rst2
-rw-r--r--doc/source/sample_code/img/compareImages.pngbin0 -> 33398 bytes
-rw-r--r--doc/source/sample_code/img/compositeline.pngbin0 -> 23150 bytes
-rw-r--r--doc/source/sample_code/img/dropZones.pngbin0 -> 8182 bytes
-rw-r--r--doc/source/sample_code/img/exampleBaseline.pngbin0 -> 79266 bytes
-rw-r--r--doc/source/sample_code/img/findContours.pngbin0 -> 390630 bytes
-rw-r--r--doc/source/sample_code/img/plotCurveLegendWidget.pngbin0 -> 105797 bytes
-rw-r--r--doc/source/sample_code/img/plotStats.pngbin0 -> 52815 bytes
-rw-r--r--doc/source/sample_code/img/scatterview.pngbin0 -> 73884 bytes
-rw-r--r--doc/source/sample_code/img/syncPlotLocation.pngbin0 -> 178464 bytes
-rw-r--r--doc/source/sample_code/index.rst210
13 files changed, 158 insertions, 76 deletions
diff --git a/doc/source/ext/snapshotqt_directive.py b/doc/source/ext/snapshotqt_directive.py
index 81305e0..582b934 100644
--- a/doc/source/ext/snapshotqt_directive.py
+++ b/doc/source/ext/snapshotqt_directive.py
@@ -185,14 +185,9 @@ else:
_logger.info('generate screenshot for %s from %s, binding is %s'
'' % (filename, script_or_module, qt.BINDING))
- # Probe Qt binding
- if qt.BINDING == 'PyQt4':
- def grabWindow(winID):
- return qt.QPixmap.grabWindow(winID)
- elif qt.BINDING in ('PyQt5', 'PySide2'):
- def grabWindow(winID):
- screen = qt.QApplication.primaryScreen()
- return screen.grabWindow(winID)
+ def grabWindow(winID):
+ screen = qt.QApplication.primaryScreen()
+ return screen.grabWindow(winID)
global _count
_count = 15
@@ -234,9 +229,6 @@ else:
sys.path.append(
os.path.abspath(os.path.dirname(script_or_module)))
qt.QTimer.singleShot(_TIMEOUT, _grabActiveWindowAndClose)
- if sys.version_info < (3, ):
- execfile(script_or_module)
- else:
- with open(script_or_module) as f:
- code = compile(f.read(), script_or_module, 'exec')
- exec(code, globals(), locals())
+ with open(script_or_module) as f:
+ code = compile(f.read(), script_or_module, 'exec')
+ exec(code, globals(), locals())
diff --git a/doc/source/install.rst b/doc/source/install.rst
index 3862e4c..8e5220b 100644
--- a/doc/source/install.rst
+++ b/doc/source/install.rst
@@ -132,7 +132,7 @@ To install it, you need to download this file :
http://www.silx.org/pub/debian/silx.list
-and copy it into the /etc/apt/source.list.d folder.
+and copy it into the /etc/apt/sources.list.d folder.
Then run ``apt-get update`` and ``apt-get install python-silx``
.. code-block:: bash
diff --git a/doc/source/modules/opencl/convolution.rst b/doc/source/modules/opencl/convolution.rst
index 225d016..f33cc5b 100644
--- a/doc/source/modules/opencl/convolution.rst
+++ b/doc/source/modules/opencl/convolution.rst
@@ -5,6 +5,6 @@
-------------------------------
.. automodule:: silx.opencl.convolution
- :members: Convolution, gaussian_kernel
+ :members: Convolution
:show-inheritance:
:undoc-members:
diff --git a/doc/source/sample_code/img/compareImages.png b/doc/source/sample_code/img/compareImages.png
new file mode 100644
index 0000000..49618b5
--- /dev/null
+++ b/doc/source/sample_code/img/compareImages.png
Binary files differ
diff --git a/doc/source/sample_code/img/compositeline.png b/doc/source/sample_code/img/compositeline.png
new file mode 100644
index 0000000..8950286
--- /dev/null
+++ b/doc/source/sample_code/img/compositeline.png
Binary files differ
diff --git a/doc/source/sample_code/img/dropZones.png b/doc/source/sample_code/img/dropZones.png
new file mode 100644
index 0000000..3196c6b
--- /dev/null
+++ b/doc/source/sample_code/img/dropZones.png
Binary files differ
diff --git a/doc/source/sample_code/img/exampleBaseline.png b/doc/source/sample_code/img/exampleBaseline.png
new file mode 100644
index 0000000..fcd5778
--- /dev/null
+++ b/doc/source/sample_code/img/exampleBaseline.png
Binary files differ
diff --git a/doc/source/sample_code/img/findContours.png b/doc/source/sample_code/img/findContours.png
new file mode 100644
index 0000000..06dcf01
--- /dev/null
+++ b/doc/source/sample_code/img/findContours.png
Binary files differ
diff --git a/doc/source/sample_code/img/plotCurveLegendWidget.png b/doc/source/sample_code/img/plotCurveLegendWidget.png
new file mode 100644
index 0000000..d857950
--- /dev/null
+++ b/doc/source/sample_code/img/plotCurveLegendWidget.png
Binary files differ
diff --git a/doc/source/sample_code/img/plotStats.png b/doc/source/sample_code/img/plotStats.png
new file mode 100644
index 0000000..e4fc781
--- /dev/null
+++ b/doc/source/sample_code/img/plotStats.png
Binary files differ
diff --git a/doc/source/sample_code/img/scatterview.png b/doc/source/sample_code/img/scatterview.png
new file mode 100644
index 0000000..32f0235
--- /dev/null
+++ b/doc/source/sample_code/img/scatterview.png
Binary files differ
diff --git a/doc/source/sample_code/img/syncPlotLocation.png b/doc/source/sample_code/img/syncPlotLocation.png
new file mode 100644
index 0000000..0b86f3e
--- /dev/null
+++ b/doc/source/sample_code/img/syncPlotLocation.png
Binary files differ
diff --git a/doc/source/sample_code/index.rst b/doc/source/sample_code/index.rst
index 409391f..082579b 100644
--- a/doc/source/sample_code/index.rst
+++ b/doc/source/sample_code/index.rst
@@ -51,10 +51,6 @@ All sample codes can be downloaded as a zip file: |sample_code_archive|.
:width: 150px
- Qt Hdf5 widget examples
- .. note:: This module has a dependency on the `h5py <http://www.h5py.org/>`_
- library, which is not a mandatory dependency for `silx`. You might need
- to install it if you don't already have it.
-
:mod:`silx.gui.dialog`
......................
@@ -69,6 +65,10 @@ All sample codes can be downloaded as a zip file: |sample_code_archive|.
- .. image:: img/fileDialog.png
:width: 150px
- Example for the use of the ImageFileDialog.
+ * - :download:`colormapDialog.py <../../../examples/colormapDialog.py>`
+ - .. image:: img/colormapDialog.png
+ :width: 150px
+ - This script shows the features of a :mod:`~silx.gui.dialog.ColormapDialog`.
:mod:`silx.gui.widgets`
.......................
@@ -120,20 +120,38 @@ Widgets
``python examples/imageview.py <file to open>``
To get help:
``python examples/imageview.py -h``
-
- For developers with a git clone you can use it with the bootstrap
- To view an image file with the current installed silx library:
-
- ``./bootstrap.py python examples/imageview.py <file to open>``
* - :download:`stackView.py <../../../examples/stackView.py>`
- .. image:: img/stackView.png
:width: 150px
- This script is a simple example to illustrate how to use the
:mod:`~silx.gui.plot.StackView` widget.
- * - :download:`colormapDialog.py <../../../examples/colormapDialog.py>`
- - .. image:: img/colormapDialog.png
+ * - :download:`scatterview.py <../../../examples/scatterview.py>`
+ - .. image:: img/scatterview.png
:width: 150px
- - This script shows the features of a :mod:`~silx.gui.dialog.ColormapDialog`.
+ - Example to show the use of :class:`~silx.gui.plot.ScatterView.ScatterView` widget
+ * - :download:`compareImages.py <../../../examples/compareImages.py>`
+ - .. image:: img/compareImages.png
+ :width: 150px
+ - usage: compareImages.py [-h] [--debug] [--testdata] [--use-opengl-plot]
+ [files [files ...]]
+
+ Example demonstrating the use of the widget CompareImages
+
+ positional arguments:
+ files Image data to compare (HDF5 file with path, EDF files,
+ JPEG/PNG image files). Data from HDF5 files can be
+ accessed using dataset path and slicing as an URL:
+ silx:../my_file.h5?path=/entry/data&slice=10 EDF file
+ frames also can can be accessed using URL:
+ fabio:../my_file.edf?slice=10 Using URL in command like
+ usually have to be quoted: "URL".
+
+ optional arguments:
+ -h, --help show this help message and exit
+ --debug Set logging system in debug mode
+ --testdata Use synthetic images to test the application
+ --use-opengl-plot Use OpenGL for plots (instead of matplotlib)
+
:class:`silx.gui.plot.actions.PlotAction`
.........................................
@@ -183,7 +201,7 @@ Sample code that adds buttons to the toolbar of a silx plot widget.
Add features to :class:`~silx.gui.plot.PlotWidget`
..................................................
-Sample code that adds specific tools or functions to plot widgets.
+Sample code that adds specific tools or functions to :class:`~silx.gui.plot.PlotWidget`.
.. list-table::
:widths: 1 1 4
@@ -205,6 +223,70 @@ Sample code that adds specific tools or functions to plot widgets.
- QAction from :mod:`silx.gui.plot.actions`
- QToolButton from :mod:`silx.gui.plot.PlotToolButtons`
- :class:`silx.gui.plot.ColorBar.ColorBarWidget`
+ * - :download:`plotItemsSelector.py <../../../examples/plotItemsSelector.py>`
+ - .. image:: img/plotItemsSelector.png
+ :width: 150px
+ - This example illustrates how to use a :class:`ItemsSelectionDialog` widget
+ associated with a :class:`~silx.gui.plot.PlotWidget`
+ * - :download:`plotInteractiveImageROI.py <../../../examples/plotInteractiveImageROI.py>`
+ - .. image:: img/plotInteractiveImageROI.png
+ :width: 150px
+ - This script illustrates image ROI selection in a :class:`~silx.gui.plot.PlotWidget`
+
+ It uses :class:`~silx.gui.plot.tools.roi.RegionOfInterestManager` and
+ :class:`~silx.gui.plot.tools.roi.RegionOfInterestTableWidget` to handle the
+ interactive selection and to display the list of selected ROIs.
+ * - :download:`printPreview.py <../../../examples/printPreview.py>`
+ - .. image:: img/printPreview.png
+ :width: 150px
+ - This script illustrates how to add a print preview tool button to any plot
+ widget inheriting :class:`~silx.gui.plot.PlotWidget`.
+
+ Three plot widgets are instantiated. One of them uses a standalone
+ :class:`~silx.gui.plot.PrintPreviewToolButton.PrintPreviewToolButton`,
+ while the other two use a
+ :class:`~silx.gui.plot.PrintPreviewToolButton.SingletonPrintPreviewToolButton`
+ which allows them to send their content to the same print preview page.
+ * - :download:`scatterMask.py <../../../examples/scatterMask.py>`
+ - .. image:: img/scatterMask.png
+ :width: 150px
+ - This example demonstrates how to use ScatterMaskToolsWidget
+ and NamedScatterAlphaSlider with a PlotWidget.
+ * - :download:`plotCurveLegendWidget.py <../../../examples/plotCurveLegendWidget.py>`
+ - .. image:: img/plotCurveLegendWidget.png
+ :width: 150px
+ - This example illustrates the use of :class:`CurveLegendsWidget`.
+
+ :class:`CurveLegendsWidget` display curves style and legend currently visible
+ in a :class:`~silx.gui.plot.PlotWidget`
+ * - :download:`plotStats.py <../../../examples/plotStats.py>`
+ - .. image:: img/plotStats.png
+ :width: 150px
+ - This script is a simple example of how to add your own statistic to a
+ :class:`~silx.gui.plot.statsWidget.StatsWidget` from customs
+ :class:`~silx.gui.plot.stats.Stats` and display it.
+
+ On this example we will:
+
+ - show sum of values for each type
+ - compute curve integrals (only for 'curve').
+ - compute center of mass for all possible items
+
+ .. note:: for now the possible types manged by the Stats are ('curve', 'image',
+ 'scatter' and 'histogram')
+
+:class:`~silx.gui.plot.PlotWidget` features
+...........................................
+
+Sample code that illustrates some functionalities of :class:`~silx.gui.plot.PlotWidget`.
+
+.. list-table::
+ :widths: 1 1 4
+ :header-rows: 1
+
+ * - Source
+ - Screenshot
+ - Description
* - :download:`plotContextMenu.py <../../../examples/plotContextMenu.py>`
- .. image:: img/plotContextMenu.png
:width: 150px
@@ -221,11 +303,6 @@ Sample code that adds specific tools or functions to plot widgets.
inherit from :class:`~silx.gui.plot.PlotWidget`.
For more information on context menus, see Qt documentation.
- * - :download:`plotItemsSelector.py <../../../examples/plotItemsSelector.py>`
- - .. image:: img/plotItemsSelector.png
- :width: 150px
- - This example illustrates how to use a :class:`ItemsSelectionDialog` widget
- associated with a :class:`~silx.gui.plot.PlotWidget`
* - :download:`plotLimits.py <../../../examples/plotLimits.py>`
- .. image:: img/plotLimits.png
:width: 150px
@@ -257,36 +334,30 @@ Sample code that adds specific tools or functions to plot widgets.
In this example a thread calls submitToQtMainThread to update the curve
of a plot.
- * - :download:`plotInteractiveImageROI.py <../../../examples/plotInteractiveImageROI.py>`
- - .. image:: img/plotInteractiveImageROI.png
+ * - :download:`syncaxis.py <../../../examples/syncaxis.py>`
+ - .. image:: img/syncaxis.png
:width: 150px
- - This script illustrates image ROI selection in a :class:`~silx.gui.plot.PlotWidget`
-
- It uses :class:`~silx.gui.plot.tools.roi.RegionOfInterestManager` and
- :class:`~silx.gui.plot.tools.roi.RegionOfInterestTableWidget` to handle the
- interactive selection and to display the list of selected ROIs.
- * - :download:`printPreview.py <../../../examples/printPreview.py>`
- - .. image:: img/printPreview.png
+ - This script is an example to illustrate how to use axis synchronization
+ tool.
+ * - :download:`compositeline.py <../../../examples/compositeline.py>`
+ - .. image:: img/compositeline.png
:width: 150px
- - This script illustrates how to add a print preview tool button to any plot
- widget inheriting :class:`~silx.gui.plot.PlotWidget`.
-
- Three plot widgets are instantiated. One of them uses a standalone
- :class:`~silx.gui.plot.PrintPreviewToolButton.PrintPreviewToolButton`,
- while the other two use a
- :class:`~silx.gui.plot.PrintPreviewToolButton.SingletonPrintPreviewToolButton`
- which allows them to send their content to the same print preview page.
- * - :download:`scatterMask.py <../../../examples/scatterMask.py>`
- - .. image:: img/scatterMask.png
+ - Example to show the use of markers to draw head and tail of lines.
+ * - :download:`dropZones.py <../../../examples/dropZones.py>`
+ - .. image:: img/dropZones.png
:width: 150px
- - This example demonstrates how to use ScatterMaskToolsWidget
- and NamedScatterAlphaSlider with a PlotWidget.
- * - :download:`syncaxis.py <../../../examples/syncaxis.py>`
- - .. image:: img/syncaxis.png
+ - Example of drop zone supporting application/x-silx-uri
+ * - :download:`exampleBaseline.py <../../../examples/exampleBaseline.py>`
+ - .. image:: img/exampleBaseline.png
+ :width: 150px
+ - This example illustrates some usage possible with the baseline parameter
+ * - :download:`syncPlotLocation.py <../../../examples/syncPlotLocation.py>`
+ - .. image:: img/syncPlotLocation.png
:width: 150px
- This script is an example to illustrate how to use axis synchronization
tool.
+
.. _plot3d-sample-code:
:mod:`silx.gui.plot3d` sample code
@@ -299,25 +370,6 @@ Sample code that adds specific tools or functions to plot widgets.
* - Source
- Screenshot
- Description
- * - :download:`plot3dContextMenu.py <../../../examples/plot3dContextMenu.py>`
- - .. image:: img/plot3dContextMenu.png
- :width: 150px
- - This script adds a context menu to a :class:`silx.gui.plot3d.ScalarFieldView`.
-
- This is done by adding a custom context menu to the :class:`Plot3DWidget`:
-
- - set the context menu policy to Qt.CustomContextMenu.
- - connect to the customContextMenuRequested signal.
-
- For more information on context menus, see Qt documentation.
- * - :download:`viewer3DVolume.py <../../../examples/viewer3DVolume.py>`
- - .. image:: img/viewer3DVolume.png
- :width: 150px
- - This script illustrates the use of :class:`silx.gui.plot3d.ScalarFieldView`.
-
- It loads a 3D scalar data set from a file and displays iso-surfaces and
- an interactive cutting plane.
- It can also be started without providing a file.
* - :download:`plot3dSceneWindow.py <../../../examples/plot3dSceneWindow.py>`
- .. image:: img/plot3dSceneWindow.png
:width: 150px
@@ -347,6 +399,25 @@ Sample code that adds specific tools or functions to plot widgets.
:func:`~silx.gui.utils.concurrent.submitToQtMainThread`.
In this example a thread calls submitToQtMainThread to append data to a 3D scatter.
+ * - :download:`plot3dContextMenu.py <../../../examples/plot3dContextMenu.py>`
+ - .. image:: img/plot3dContextMenu.png
+ :width: 150px
+ - This script adds a context menu to a :class:`silx.gui.plot3d.ScalarFieldView`.
+
+ This is done by adding a custom context menu to the :class:`Plot3DWidget`:
+
+ - set the context menu policy to Qt.CustomContextMenu.
+ - connect to the customContextMenuRequested signal.
+
+ For more information on context menus, see Qt documentation.
+ * - :download:`viewer3DVolume.py <../../../examples/viewer3DVolume.py>`
+ - .. image:: img/viewer3DVolume.png
+ :width: 150px
+ - This script illustrates the use of :class:`silx.gui.plot3d.ScalarFieldView`.
+
+ It loads a 3D scalar data set from a file and displays iso-surfaces and
+ an interactive cutting plane.
+ It can also be started without providing a file.
:mod:`silx.io` sample code
@@ -363,3 +434,22 @@ Sample code that adds specific tools or functions to plot widgets.
-
- This script is an example of how to use the :mod:`silx.io.convert` module.
See the following tutorial for more information: :doc:`../Tutorials/convert`
+
+
+:mod:`silx.image` sample code
++++++++++++++++++++++++++++++
+
+.. list-table::
+ :widths: 1 1 4
+ :header-rows: 1
+
+ * - Source
+ - Screenshot
+ - Description
+ * - :download:`findContours.py <../../../examples/findContours.py>`
+ - .. image:: img/findContours.png
+ :width: 150px
+ - Find contours examples
+
+ .. note:: This module has an optional dependency with sci-kit image library.
+ You might need to install it if you don't already have it.