summaryrefslogtreecommitdiff
path: root/doc/source/sample_code/index.rst
diff options
context:
space:
mode:
authorAlexandre Marie <alexandre.marie@synchrotron-soleil.fr>2020-07-21 14:45:14 +0200
committerAlexandre Marie <alexandre.marie@synchrotron-soleil.fr>2020-07-21 14:45:14 +0200
commit328032e2317e3ac4859196bbf12bdb71795302fe (patch)
tree8cd13462beab109e3cb53410c42335b6d1e00ee6 /doc/source/sample_code/index.rst
parent33ed2a64c92b0311ae35456c016eb284e426afc2 (diff)
New upstream version 0.13.0+dfsg
Diffstat (limited to 'doc/source/sample_code/index.rst')
-rw-r--r--doc/source/sample_code/index.rst35
1 files changed, 34 insertions, 1 deletions
diff --git a/doc/source/sample_code/index.rst b/doc/source/sample_code/index.rst
index 082579b..15bd4c7 100644
--- a/doc/source/sample_code/index.rst
+++ b/doc/source/sample_code/index.rst
@@ -151,6 +151,15 @@ Widgets
--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)
+ * - :download:`imageStack.py <../../../examples/imageStack.py>`
+ - .. image:: img/imageStack.png
+ :width: 150px
+ - Simple example for using the ImageStack.
+
+ In this example we want to display images from different source: .h5, .edf
+ and .npy files.
+
+ To do so we simple reimplement the thread managing the loading of data.
:class:`silx.gui.plot.actions.PlotAction`
@@ -274,6 +283,11 @@ Sample code that adds specific tools or functions to :class:`~silx.gui.plot.Plot
.. note:: for now the possible types manged by the Stats are ('curve', 'image',
'scatter' and 'histogram')
+ * - :download:`plotProfile.py <../../../examples/plotProfile.py>`
+ - .. image:: img/plotProfile.png
+ :width: 150px
+ - Example illustrating the different profile tools.
+
:class:`~silx.gui.plot.PlotWidget` features
...........................................
@@ -346,7 +360,11 @@ Sample code that illustrates some functionalities of :class:`~silx.gui.plot.Plot
* - :download:`dropZones.py <../../../examples/dropZones.py>`
- .. image:: img/dropZones.png
:width: 150px
- - Example of drop zone supporting application/x-silx-uri
+ - Example of drop zone supporting application/x-silx-uri.
+
+ This example illustrates the support of drag&drop of silx URLs.
+ It provides 2 URLs (corresponding to 2 datasets) that can be dragged to
+ either a :class:`PlotWidget` or a QLable displaying the URL information.
* - :download:`exampleBaseline.py <../../../examples/exampleBaseline.py>`
- .. image:: img/exampleBaseline.png
:width: 150px
@@ -453,3 +471,18 @@ Sample code that illustrates some functionalities of :class:`~silx.gui.plot.Plot
.. 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.
+
+:mod:`silx.app` sample code
++++++++++++++++++++++++++++
+
+.. list-table::
+ :widths: 1 1 4
+ :header-rows: 1
+
+ * - Source
+ - Screenshot
+ - Description
+ * - :download:`customSilxView.py <../../../examples/customSilxView.py>`
+ - .. image:: img/customSilxView.png
+ :width: 150px
+ - Sample code illustrating how to custom silx view into another application.