diff options
Diffstat (limited to 'doc/source/sample_code/index.rst')
| -rw-r--r-- | doc/source/sample_code/index.rst | 91 |
1 files changed, 40 insertions, 51 deletions
diff --git a/doc/source/sample_code/index.rst b/doc/source/sample_code/index.rst index a5cbf11..409391f 100644 --- a/doc/source/sample_code/index.rst +++ b/doc/source/sample_code/index.rst @@ -25,8 +25,7 @@ All sample codes can be downloaded as a zip file: |sample_code_archive|. - Description * - :download:`icons.py <../../../examples/icons.py>` - .. image:: img/icons.png - :height: 150px - :align: center + :width: 150px - Display icons and animated icons provided by silx. :mod:`silx.gui.data` and :mod:`silx.gui.hdf5` @@ -41,18 +40,15 @@ All sample codes can be downloaded as a zip file: |sample_code_archive|. - Description * - :download:`customHdf5TreeModel.py <../../../examples/customHdf5TreeModel.py>` - .. image:: img/customHdf5TreeModel.png - :height: 150px - :align: center + :width: 150px - Qt Hdf5 widget examples * - :download:`customDataView.py <../../../examples/customDataView.py>` - .. image:: img/customDataView.png - :height: 150px - :align: center + :width: 150px - Qt data view example * - :download:`hdf5widget.py <../../../examples/hdf5widget.py>` - .. image:: img/hdf5widget.png - :height: 150px - :align: center + :width: 150px - Qt Hdf5 widget examples .. note:: This module has a dependency on the `h5py <http://www.h5py.org/>`_ @@ -71,8 +67,7 @@ All sample codes can be downloaded as a zip file: |sample_code_archive|. - Description * - :download:`fileDialog.py <../../../examples/fileDialog.py>` - .. image:: img/fileDialog.png - :height: 150px - :align: center + :width: 150px - Example for the use of the ImageFileDialog. :mod:`silx.gui.widgets` @@ -87,14 +82,13 @@ All sample codes can be downloaded as a zip file: |sample_code_archive|. - Description * - :download:`periodicTable.py <../../../examples/periodicTable.py>` - .. image:: img/periodicTable.png - :height: 150px + :width: 150px :align: center - This script is a simple example of how to use the periodic table widgets, select elements and connect signals. * - :download:`simplewidget.py <../../../examples/simplewidget.py>` - .. image:: img/simplewidget.png - :height: 150px - :align: center + :width: 150px - This script shows a gallery of simple widgets provided by silx. It shows the following widgets: @@ -117,8 +111,7 @@ Widgets - Description * - :download:`imageview.py <../../../examples/imageview.py>` - .. image:: img/imageview.png - :height: 150px - :align: center + :width: 150px - Example to show the use of :mod:`~silx.gui.plot.ImageView` widget. It can be used to open an EDF or TIFF file from the shell command line. @@ -134,14 +127,12 @@ Widgets ``./bootstrap.py python examples/imageview.py <file to open>`` * - :download:`stackView.py <../../../examples/stackView.py>` - .. image:: img/stackView.png - :height: 150px - :align: center + :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 - :height: 150px - :align: center + :width: 150px - This script shows the features of a :mod:`~silx.gui.dialog.ColormapDialog`. :class:`silx.gui.plot.actions.PlotAction` @@ -158,16 +149,14 @@ Sample code that adds buttons to the toolbar of a silx plot widget. - Description * - :download:`plotClearAction.py <../../../examples/plotClearAction.py>` - .. image:: img/plotClearAction.png - :height: 150px - :align: center + :width: 150px - This script shows how to create a minimalistic :class:`~silx.gui.plot.actions.PlotAction` that clear the plot. This illustrates how to add more buttons in a plot widget toolbar. * - :download:`shiftPlotAction.py <../../../examples/shiftPlotAction.py>` - .. image:: img/shiftPlotAction.png - :height: 150px - :align: center + :width: 150px - This script is a simple (trivial) example of how to create a :class:`~silx.gui.plot.PlotWindow`, create a custom :class:`~silx.gui.plot.actions.PlotAction` and add it to the toolbar. @@ -176,8 +165,7 @@ Sample code that adds buttons to the toolbar of a silx plot widget. * - :download:`fftPlotAction.py <../../../examples/fftPlotAction.py>`, :download:`fft.png <../../../examples/fft.png>` - .. image:: img/fftPlotAction.png - :height: 150px - :align: center + :width: 150px - This script is a simple example of how to create a :class:`~silx.gui.plot.PlotWindow` with a custom :class:`~silx.gui.plot.actions.PlotAction` added to the toolbar. @@ -206,8 +194,7 @@ Sample code that adds specific tools or functions to plot widgets. - Description * - :download:`plotWidget.py <../../../examples/plotWidget.py>` - .. image:: img/plotWidget.png - :height: 150px - :align: center + :width: 150px - This script shows how to create a custom window around a PlotWidget. It subclasses :class:`QMainWindow`, uses a :class:`~silx.gui.plot.PlotWidget` @@ -220,8 +207,7 @@ Sample code that adds specific tools or functions to plot widgets. - :class:`silx.gui.plot.ColorBar.ColorBarWidget` * - :download:`plotContextMenu.py <../../../examples/plotContextMenu.py>` - .. image:: img/plotContextMenu.png - :height: 150px - :align: center + :width: 150px - This script illustrates the addition of a context menu to a :class:`~silx.gui.plot.PlotWidget`. @@ -237,20 +223,17 @@ Sample code that adds specific tools or functions to plot widgets. For more information on context menus, see Qt documentation. * - :download:`plotItemsSelector.py <../../../examples/plotItemsSelector.py>` - .. image:: img/plotItemsSelector.png - :height: 150px - :align: center + :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 - :height: 150px - :align: center + :width: 150px - This script is an example to illustrate how to use axis synchronization tool. * - :download:`plotUpdateCurveFromThread.py <../../../examples/plotUpdateCurveFromThread.py>` - .. image:: img/plotUpdateCurveFromThread.png - :height: 150px - :align: center + :width: 150px - This script illustrates the update of a :mod:`silx.gui.plot` widget from a thread. The problem is that plot and GUI methods should be called from the main thread. @@ -263,8 +246,7 @@ Sample code that adds specific tools or functions to plot widgets. of a plot. * - :download:`plotUpdateImageFromThread.py <../../../examples/plotUpdateImageFromThread.py>` - .. image:: img/plotUpdateImageFromThread.png - :height: 150px - :align: center + :width: 150px - This script illustrates the update of a :mod:`silx.gui.plot` widget from a thread. The problem is that plot and GUI methods should be called from the main thread. @@ -277,8 +259,7 @@ Sample code that adds specific tools or functions to plot widgets. of a plot. * - :download:`plotInteractiveImageROI.py <../../../examples/plotInteractiveImageROI.py>` - .. image:: img/plotInteractiveImageROI.png - :height: 150px - :align: center + :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 @@ -286,8 +267,7 @@ Sample code that adds specific tools or functions to plot widgets. interactive selection and to display the list of selected ROIs. * - :download:`printPreview.py <../../../examples/printPreview.py>` - .. image:: img/printPreview.png - :height: 150px - :align: center + :width: 150px - This script illustrates how to add a print preview tool button to any plot widget inheriting :class:`~silx.gui.plot.PlotWidget`. @@ -298,14 +278,12 @@ Sample code that adds specific tools or functions to plot widgets. which allows them to send their content to the same print preview page. * - :download:`scatterMask.py <../../../examples/scatterMask.py>` - .. image:: img/scatterMask.png - :height: 150px - :align: center + :width: 150px - This example demonstrates how to use ScatterMaskToolsWidget and NamedScatterAlphaSlider with a PlotWidget. * - :download:`syncaxis.py <../../../examples/syncaxis.py>` - .. image:: img/syncaxis.png - :height: 150px - :align: center + :width: 150px - This script is an example to illustrate how to use axis synchronization tool. @@ -323,8 +301,7 @@ Sample code that adds specific tools or functions to plot widgets. - Description * - :download:`plot3dContextMenu.py <../../../examples/plot3dContextMenu.py>` - .. image:: img/plot3dContextMenu.png - :height: 150px - :align: center + :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`: @@ -335,8 +312,7 @@ Sample code that adds specific tools or functions to plot widgets. For more information on context menus, see Qt documentation. * - :download:`viewer3DVolume.py <../../../examples/viewer3DVolume.py>` - .. image:: img/viewer3DVolume.png - :height: 150px - :align: center + :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 @@ -344,8 +320,7 @@ Sample code that adds specific tools or functions to plot widgets. It can also be started without providing a file. * - :download:`plot3dSceneWindow.py <../../../examples/plot3dSceneWindow.py>` - .. image:: img/plot3dSceneWindow.png - :height: 150px - :align: center + :width: 150px - This script displays the different items of :class:`~silx.gui.plot3d.SceneWindow`. It shows the different visualizations of :class:`~silx.gui.plot3d.SceneWindow` @@ -359,6 +334,20 @@ Sample code that adds specific tools or functions to plot widgets. - 3D scatter plot - 3D scalar field with iso-surface and cutting plane. - A clipping plane. + * - :download:`plot3dUpdateScatterFromThread.py <../../../examples/plot3dUpdateScatterFromThread.py>` + - .. image:: img/plot3dUpdateScatterFromThread.png + :width: 150px + - This script illustrates the update of a + :class:`~silx.gui.plot3d.SceneWindow.SceneWindow` widget from a thread. + + The problem is that GUI methods should be called from the main thread. + To safely update the scene from another thread, one need to execute the update + asynchronously in the main thread. + In this example, this is achieved with + :func:`~silx.gui.utils.concurrent.submitToQtMainThread`. + + In this example a thread calls submitToQtMainThread to append data to a 3D scatter. + :mod:`silx.io` sample code ++++++++++++++++++++++++++ |