diff options
Diffstat (limited to 'doc/source/modules')
23 files changed, 156 insertions, 34 deletions
diff --git a/doc/source/modules/gui/data/img/ArrayTableWidget.png b/doc/source/modules/gui/data/img/ArrayTableWidget.png Binary files differindex 6ae9114..c879427 100644 --- a/doc/source/modules/gui/data/img/ArrayTableWidget.png +++ b/doc/source/modules/gui/data/img/ArrayTableWidget.png diff --git a/doc/source/modules/gui/data/img/DataViewer.png b/doc/source/modules/gui/data/img/DataViewer.png Binary files differindex c2185d3..a1fabb9 100644 --- a/doc/source/modules/gui/data/img/DataViewer.png +++ b/doc/source/modules/gui/data/img/DataViewer.png diff --git a/doc/source/modules/gui/hdf5/getting_started.rst b/doc/source/modules/gui/hdf5/getting_started.rst index 1a81a0a..6951247 100644 --- a/doc/source/modules/gui/hdf5/getting_started.rst +++ b/doc/source/modules/gui/hdf5/getting_started.rst @@ -86,7 +86,7 @@ We can use directly h5py Files, Groups and Datasets. .. code-block:: python import h5py - h5 = h5py.File("test.h5") + h5 = h5py.File("test.h5", mode="r") # We can use file model.insertH5pyObject(h5) diff --git a/doc/source/modules/gui/icons.rst b/doc/source/modules/gui/icons.rst index ba7d89b..8a939ea 100644 --- a/doc/source/modules/gui/icons.rst +++ b/doc/source/modules/gui/icons.rst @@ -29,10 +29,18 @@ Available icons - 3d-plane-pan * - |3d-plane| - 3d-plane + * - |add-range-horizontal| + - add-range-horizontal * - |add-shape-arc| - add-shape-arc + * - |add-shape-circle| + - add-shape-circle + * - |add-shape-cross| + - add-shape-cross * - |add-shape-diagonal| - add-shape-diagonal + * - |add-shape-ellipse| + - add-shape-ellipse * - |add-shape-horizontal| - add-shape-horizontal * - |add-shape-point| @@ -61,6 +69,16 @@ Available icons - colormap-histogram * - |colormap-none| - colormap-none + * - |colormap-norm-arcsinh| + - colormap-norm-arcsinh + * - |colormap-norm-gamma| + - colormap-norm-gamma + * - |colormap-norm-linear| + - colormap-norm-linear + * - |colormap-norm-log| + - colormap-norm-log + * - |colormap-norm-sqrt| + - colormap-norm-sqrt * - |colormap-range| - colormap-range * - |colormap| @@ -173,6 +191,12 @@ Available icons - last * - |layer-nx| - layer-nx + * - |mask-clear-all| + - mask-clear-all + * - |mask-clear| + - mask-clear + * - |mask-invert| + - mask-invert * - |math-amplitude| - math-amplitude * - |math-average| @@ -289,6 +313,10 @@ Available icons - shape-circle-solid * - |shape-circle| - shape-circle + * - |shape-cross| + - shape-cross + * - |shape-diagonal-directed| + - shape-diagonal-directed * - |shape-diagonal| - shape-diagonal * - |shape-ellipse-solid| @@ -307,6 +335,12 @@ Available icons - shape-vertical * - |silx| - silx + * - |slice-cross| + - slice-cross + * - |slice-horizontal| + - slice-horizontal + * - |slice-vertical| + - slice-vertical * - |sliders-off| - sliders-off * - |sliders-on| @@ -325,6 +359,8 @@ Available icons - tree-collapse-all * - |tree-expand-all| - tree-expand-all + * - |tree-sort| + - tree-sort * - |view-1d| - view-1d * - |view-2d-stack| @@ -365,8 +401,12 @@ Available icons .. |3d-plane-normal-z| image:: ../../../../silx/resources/gui/icons/3d-plane-normal-z.png .. |3d-plane-pan| image:: ../../../../silx/resources/gui/icons/3d-plane-pan.png .. |3d-plane| image:: ../../../../silx/resources/gui/icons/3d-plane.png +.. |add-range-horizontal| image:: ../../../../silx/resources/gui/icons/add-range-horizontal.png .. |add-shape-arc| image:: ../../../../silx/resources/gui/icons/add-shape-arc.png +.. |add-shape-circle| image:: ../../../../silx/resources/gui/icons/add-shape-circle.png +.. |add-shape-cross| image:: ../../../../silx/resources/gui/icons/add-shape-cross.png .. |add-shape-diagonal| image:: ../../../../silx/resources/gui/icons/add-shape-diagonal.png +.. |add-shape-ellipse| image:: ../../../../silx/resources/gui/icons/add-shape-ellipse.png .. |add-shape-horizontal| image:: ../../../../silx/resources/gui/icons/add-shape-horizontal.png .. |add-shape-point| image:: ../../../../silx/resources/gui/icons/add-shape-point.png .. |add-shape-polygon| image:: ../../../../silx/resources/gui/icons/add-shape-polygon.png @@ -381,6 +421,11 @@ Available icons .. |colorbar| image:: ../../../../silx/resources/gui/icons/colorbar.png .. |colormap-histogram| image:: ../../../../silx/resources/gui/icons/colormap-histogram.png .. |colormap-none| image:: ../../../../silx/resources/gui/icons/colormap-none.png +.. |colormap-norm-arcsinh| image:: ../../../../silx/resources/gui/icons/colormap-norm-arcsinh.png +.. |colormap-norm-gamma| image:: ../../../../silx/resources/gui/icons/colormap-norm-gamma.png +.. |colormap-norm-linear| image:: ../../../../silx/resources/gui/icons/colormap-norm-linear.png +.. |colormap-norm-log| image:: ../../../../silx/resources/gui/icons/colormap-norm-log.png +.. |colormap-norm-sqrt| image:: ../../../../silx/resources/gui/icons/colormap-norm-sqrt.png .. |colormap-range| image:: ../../../../silx/resources/gui/icons/colormap-range.png .. |colormap| image:: ../../../../silx/resources/gui/icons/colormap.png .. |compare-align-auto| image:: ../../../../silx/resources/gui/icons/compare-align-auto.png @@ -437,6 +482,9 @@ Available icons .. |item-object| image:: ../../../../silx/resources/gui/icons/item-object.png .. |last| image:: ../../../../silx/resources/gui/icons/last.png .. |layer-nx| image:: ../../../../silx/resources/gui/icons/layer-nx.png +.. |mask-clear-all| image:: ../../../../silx/resources/gui/icons/mask-clear-all.png +.. |mask-clear| image:: ../../../../silx/resources/gui/icons/mask-clear.png +.. |mask-invert| image:: ../../../../silx/resources/gui/icons/mask-invert.png .. |math-amplitude| image:: ../../../../silx/resources/gui/icons/math-amplitude.png .. |math-average| image:: ../../../../silx/resources/gui/icons/math-average.png .. |math-derive| image:: ../../../../silx/resources/gui/icons/math-derive.png @@ -495,6 +543,8 @@ Available icons .. |selected| image:: ../../../../silx/resources/gui/icons/selected.png .. |shape-circle-solid| image:: ../../../../silx/resources/gui/icons/shape-circle-solid.png .. |shape-circle| image:: ../../../../silx/resources/gui/icons/shape-circle.png +.. |shape-cross| image:: ../../../../silx/resources/gui/icons/shape-cross.png +.. |shape-diagonal-directed| image:: ../../../../silx/resources/gui/icons/shape-diagonal-directed.png .. |shape-diagonal| image:: ../../../../silx/resources/gui/icons/shape-diagonal.png .. |shape-ellipse-solid| image:: ../../../../silx/resources/gui/icons/shape-ellipse-solid.png .. |shape-ellipse| image:: ../../../../silx/resources/gui/icons/shape-ellipse.png @@ -504,6 +554,9 @@ Available icons .. |shape-square| image:: ../../../../silx/resources/gui/icons/shape-square.png .. |shape-vertical| image:: ../../../../silx/resources/gui/icons/shape-vertical.png .. |silx| image:: ../../../../silx/resources/gui/icons/silx.png +.. |slice-cross| image:: ../../../../silx/resources/gui/icons/slice-cross.png +.. |slice-horizontal| image:: ../../../../silx/resources/gui/icons/slice-horizontal.png +.. |slice-vertical| image:: ../../../../silx/resources/gui/icons/slice-vertical.png .. |sliders-off| image:: ../../../../silx/resources/gui/icons/sliders-off.png .. |sliders-on| image:: ../../../../silx/resources/gui/icons/sliders-on.png .. |spec| image:: ../../../../silx/resources/gui/icons/spec.png @@ -513,6 +566,7 @@ Available icons .. |stats-whole-items| image:: ../../../../silx/resources/gui/icons/stats-whole-items.png .. |tree-collapse-all| image:: ../../../../silx/resources/gui/icons/tree-collapse-all.png .. |tree-expand-all| image:: ../../../../silx/resources/gui/icons/tree-expand-all.png +.. |tree-sort| image:: ../../../../silx/resources/gui/icons/tree-sort.png .. |view-1d| image:: ../../../../silx/resources/gui/icons/view-1d.png .. |view-2d-stack| image:: ../../../../silx/resources/gui/icons/view-2d-stack.png .. |view-2d| image:: ../../../../silx/resources/gui/icons/view-2d.png diff --git a/doc/source/modules/gui/plot/getting_started.rst b/doc/source/modules/gui/plot/getting_started.rst index 899d262..c105395 100644 --- a/doc/source/modules/gui/plot/getting_started.rst +++ b/doc/source/modules/gui/plot/getting_started.rst @@ -20,7 +20,7 @@ For a complete description of the API, see :mod:`silx.gui.plot`. Use :mod:`silx.gui.plot` from (I)Python console ----------------------------------------------- -We recommend to use (I)Python 3.x and PyQt5. +We recommend to use (I)Python >=3.5 and PyQt5. From a Python or IPython interpreter, the simplest way is to import the :mod:`silx.sx` module: @@ -48,10 +48,6 @@ the way silx loads Qt and the way IPython is doing it through the ``--gui`` opti `%pylab <http://ipython.org/ipython-doc/stable/interactive/magics.html#magic-pylab>`_ magics. In this case, IPython magics that initialize Qt might not work after importing modules from silx.gui. -When using Python2.7 and PyQt4, there is another incompatibility to deal with as -silx requires PyQt4 API version 2 (See note below for explanation). -In this case, start IPython with the ``QT_API`` environment variable set to ``pyqt``. - On Linux and MacOS X, run from the command line:: QT_API=pyqt ipython @@ -61,16 +57,6 @@ On Windows, run from the command line:: set QT_API=pyqt&&ipython -.. note:: PyQt4 used from Python 2.x provides 2 incompatible versions of QString and QVariant: - - - version 1, the legacy version which is also the default, and - - version 2, a more pythonic one, which is the only one supported by *silx*. - - All other configurations (i.e., PyQt4 on Python 3.x, PySide2, PyQt5, IPython QtConsole widget) uses version 2. - - For more information, see `IPython, PyQt and PySide <http://ipython.org/ipython-doc/stable/interactive/reference.html#pyqt-and-pyside>`_. - - Plot functions ++++++++++++++ diff --git a/doc/source/modules/gui/plot/img/BasicGridStatsWidget.png b/doc/source/modules/gui/plot/img/BasicGridStatsWidget.png Binary files differindex 53ddc0e..bc675f0 100644 --- a/doc/source/modules/gui/plot/img/BasicGridStatsWidget.png +++ b/doc/source/modules/gui/plot/img/BasicGridStatsWidget.png diff --git a/doc/source/modules/gui/plot/img/BasicStatsWidget.png b/doc/source/modules/gui/plot/img/BasicStatsWidget.png Binary files differindex c9ed2cd..b0d815d 100644 --- a/doc/source/modules/gui/plot/img/BasicStatsWidget.png +++ b/doc/source/modules/gui/plot/img/BasicStatsWidget.png diff --git a/doc/source/modules/gui/plot/img/LimitsToolBar.png b/doc/source/modules/gui/plot/img/LimitsToolBar.png Binary files differindex 54b6c2b..ede66c8 100644 --- a/doc/source/modules/gui/plot/img/LimitsToolBar.png +++ b/doc/source/modules/gui/plot/img/LimitsToolBar.png diff --git a/doc/source/modules/gui/plot/img/logColorbar.png b/doc/source/modules/gui/plot/img/logColorbar.png Binary files differindex c677a9b..cde1ad9 100644 --- a/doc/source/modules/gui/plot/img/logColorbar.png +++ b/doc/source/modules/gui/plot/img/logColorbar.png diff --git a/doc/source/modules/gui/plot/index.rst b/doc/source/modules/gui/plot/index.rst index 01cb29b..b6c2000 100644 --- a/doc/source/modules/gui/plot/index.rst +++ b/doc/source/modules/gui/plot/index.rst @@ -54,7 +54,7 @@ Additionnal plot tool widgets: actions/index.rst plottoolbuttons.rst - tools.rst + tools/index.rst profile.rst roi.rst printpreviewtoolbutton.rst diff --git a/doc/source/modules/gui/plot/img/CurveLegendsWidget.png b/doc/source/modules/gui/plot/tools/img/CurveLegendsWidget.png Binary files differindex e7fa9f8..e7fa9f8 100644 --- a/doc/source/modules/gui/plot/img/CurveLegendsWidget.png +++ b/doc/source/modules/gui/plot/tools/img/CurveLegendsWidget.png diff --git a/doc/source/modules/gui/plot/img/linearColorbar.png b/doc/source/modules/gui/plot/tools/img/linearColorbar.png Binary files differindex 26621ce..26621ce 100644 --- a/doc/source/modules/gui/plot/img/linearColorbar.png +++ b/doc/source/modules/gui/plot/tools/img/linearColorbar.png diff --git a/doc/source/modules/gui/plot/tools.rst b/doc/source/modules/gui/plot/tools/index.rst index d7c96b5..c75aea5 100644 --- a/doc/source/modules/gui/plot/tools.rst +++ b/doc/source/modules/gui/plot/tools/index.rst @@ -1,10 +1,23 @@ +.. currentmodule:: silx.gui.plot.tools + :mod:`~silx.gui.plot.tools`: Tool widgets for PlotWidget ======================================================== -.. currentmodule:: silx.gui.plot.tools - .. 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 --------------------------- @@ -91,21 +104,6 @@ .. autoclass:: RegionOfInterestTableWidget :members: -:mod:`~silx.gui.plot.tools.profile`: Profile Tools --------------------------------------------------- - -.. automodule:: silx.gui.plot.tools.profile - -.. currentmodule:: silx.gui.plot.tools.profile - -:class:`ScatterProfileToolBar` -++++++++++++++++++++++++++++++ - -.. autoclass:: ScatterProfileToolBar - :members: sigProfileChanged, getProfilePoints, getProfileValues, getProfileTitle, getPlotWidget, isDefaultProfileWindowEnabled, setDefaultProfileWindowEnabled, getDefaultProfileWindow, getColor, setColor, clearProfile, getNPoints, setNPoints - -.. currentmodule:: silx.gui.plot - :mod:`ColorBar`: ColorBar Widget ================================ 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 + diff --git a/doc/source/modules/gui/widgets/img/FrameBrowser.png b/doc/source/modules/gui/widgets/img/FrameBrowser.png Binary files differindex 3843e70..17b355a 100644 --- a/doc/source/modules/gui/widgets/img/FrameBrowser.png +++ b/doc/source/modules/gui/widgets/img/FrameBrowser.png diff --git a/doc/source/modules/gui/widgets/img/HorizontalSliderWithBrowser.png b/doc/source/modules/gui/widgets/img/HorizontalSliderWithBrowser.png Binary files differindex 8cfdb25..96edd3c 100644 --- a/doc/source/modules/gui/widgets/img/HorizontalSliderWithBrowser.png +++ b/doc/source/modules/gui/widgets/img/HorizontalSliderWithBrowser.png diff --git a/doc/source/modules/gui/widgets/img/PeriodicCombo.png b/doc/source/modules/gui/widgets/img/PeriodicCombo.png Binary files differindex 4a93e86..644e502 100644 --- a/doc/source/modules/gui/widgets/img/PeriodicCombo.png +++ b/doc/source/modules/gui/widgets/img/PeriodicCombo.png diff --git a/doc/source/modules/gui/widgets/img/PeriodicList.png b/doc/source/modules/gui/widgets/img/PeriodicList.png Binary files differindex 42f432e..5ec741f 100644 --- a/doc/source/modules/gui/widgets/img/PeriodicList.png +++ b/doc/source/modules/gui/widgets/img/PeriodicList.png diff --git a/doc/source/modules/gui/widgets/img/PeriodicTable.png b/doc/source/modules/gui/widgets/img/PeriodicTable.png Binary files differindex ce52262..a521bd7 100644 --- a/doc/source/modules/gui/widgets/img/PeriodicTable.png +++ b/doc/source/modules/gui/widgets/img/PeriodicTable.png diff --git a/doc/source/modules/gui/widgets/img/RangeSlider.png b/doc/source/modules/gui/widgets/img/RangeSlider.png Binary files differindex f552fb3..e7a1011 100644 --- a/doc/source/modules/gui/widgets/img/RangeSlider.png +++ b/doc/source/modules/gui/widgets/img/RangeSlider.png diff --git a/doc/source/modules/gui/widgets/img/TableWidget.png b/doc/source/modules/gui/widgets/img/TableWidget.png Binary files differindex b6a4965..de78687 100644 --- a/doc/source/modules/gui/widgets/img/TableWidget.png +++ b/doc/source/modules/gui/widgets/img/TableWidget.png diff --git a/doc/source/modules/gui/widgets/img/ThreadPoolPushButton.png b/doc/source/modules/gui/widgets/img/ThreadPoolPushButton.png Binary files differindex 18a7416..5bdebee 100644 --- a/doc/source/modules/gui/widgets/img/ThreadPoolPushButton.png +++ b/doc/source/modules/gui/widgets/img/ThreadPoolPushButton.png diff --git a/doc/source/modules/gui/widgets/img/WaitingPushButton.png b/doc/source/modules/gui/widgets/img/WaitingPushButton.png Binary files differindex 4fd3e3c..9bab0fa 100644 --- a/doc/source/modules/gui/widgets/img/WaitingPushButton.png +++ b/doc/source/modules/gui/widgets/img/WaitingPushButton.png |
