diff options
author | Picca Frédéric-Emmanuel <picca@debian.org> | 2021-01-06 14:10:12 +0100 |
---|---|---|
committer | Picca Frédéric-Emmanuel <picca@debian.org> | 2021-01-06 14:10:12 +0100 |
commit | b3bea947efa55d2c0f198b6c6795b3177be27f45 (patch) | |
tree | 4116758aafe4483bf472c1d54b519e685737fd77 /doc | |
parent | 5ad425ff4e62f5e003178813ebd073577679a00e (diff) |
New upstream version 0.14.0+dfsg
Diffstat (limited to 'doc')
23 files changed, 51 insertions, 6 deletions
diff --git a/doc/source/Tutorials/fit.rst b/doc/source/Tutorials/fit.rst index b1b28e5..d9671f4 100644 --- a/doc/source/Tutorials/fit.rst +++ b/doc/source/Tutorials/fit.rst @@ -234,7 +234,7 @@ the previous tutorial (See `Weighted fit`_) from silx.math.fit.fitmanager import FitManager # Create synthetic data with a sum of gaussian functions - x = numpy.arange(1000).astype(numpy.float) + x = numpy.arange(1000).astype(numpy.float64) y = 2.4 * x**4 - 10. * x**3 + 15.2 * x**2 - 24.6 * x + 150. # define our fit function: a generic polynomial of degree 4 @@ -304,7 +304,7 @@ data, generated using another *silx* module: :mod:`silx.math.fit.functions`. from silx.math.fit.fitmanager import FitManager # Create synthetic data with a sum of gaussian functions - x = numpy.arange(1000).astype(numpy.float) + x = numpy.arange(1000).astype(numpy.float64) # height, center x, fwhm p = [1000, 100., 250, # 1st peak @@ -526,7 +526,7 @@ Simple usage from silx.gui.fit import FitWidget from silx.math.fit.functions import sum_gauss - x = numpy.arange(2000).astype(numpy.float) + x = numpy.arange(2000).astype(numpy.float64) constant_bg = 3.14 # gaussian parameters: height, position, fwhm diff --git a/doc/source/applications/view.rst b/doc/source/applications/view.rst index 694f95d..d4145c2 100644 --- a/doc/source/applications/view.rst +++ b/doc/source/applications/view.rst @@ -48,7 +48,8 @@ Options -h, --help Show this help message and exit --debug Set logging system in debug mode --use-opengl-plot Use OpenGL for plots (instead of matplotlib) - + -f, --fresh Start the application using new fresh user preferences + --hdf5-file-locking Start the application with HDF5 file locking enabled (it is disabled by default) Examples of usage ----------------- diff --git a/doc/source/modules/gui/data/img/ArrayTableWidget.png b/doc/source/modules/gui/data/img/ArrayTableWidget.png Binary files differindex c879427..e7bb2a9 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 a1fabb9..7980de9 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/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 Binary files differindex bc675f0..261909a 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/LimitsToolBar.png b/doc/source/modules/gui/plot/img/LimitsToolBar.png Binary files differindex ede66c8..b360fe0 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/ROIStatsWidget.png b/doc/source/modules/gui/plot/img/ROIStatsWidget.png Binary files differnew file mode 100644 index 0000000..7a634fe --- /dev/null +++ b/doc/source/modules/gui/plot/img/ROIStatsWidget.png diff --git a/doc/source/modules/gui/plot/img/logColorbar.png b/doc/source/modules/gui/plot/img/logColorbar.png Binary files differindex cde1ad9..49282e7 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 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 Binary files differindex dbe7791..4ddc0a8 100644 --- a/doc/source/modules/gui/plot3d/img/SceneWidget.png +++ b/doc/source/modules/gui/plot3d/img/SceneWidget.png diff --git a/doc/source/modules/gui/widgets/img/FrameBrowser.png b/doc/source/modules/gui/widgets/img/FrameBrowser.png Binary files differindex 17b355a..1d4ebcf 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/PeriodicCombo.png b/doc/source/modules/gui/widgets/img/PeriodicCombo.png Binary files differindex 644e502..7534805 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 5ec741f..74ce7d6 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 a521bd7..bada39a 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/TableWidget.png b/doc/source/modules/gui/widgets/img/TableWidget.png Binary files differindex de78687..a614ae7 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 5bdebee..eb55b14 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 9bab0fa..97bd14a 100644 --- a/doc/source/modules/gui/widgets/img/WaitingPushButton.png +++ b/doc/source/modules/gui/widgets/img/WaitingPushButton.png 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: diff --git a/doc/source/sample_code/img/plotROIStats.png b/doc/source/sample_code/img/plotROIStats.png Binary files differnew file mode 100644 index 0000000..18446aa --- /dev/null +++ b/doc/source/sample_code/img/plotROIStats.png diff --git a/doc/source/sample_code/index.rst b/doc/source/sample_code/index.rst index 15bd4c7..0aade4c 100644 --- a/doc/source/sample_code/index.rst +++ b/doc/source/sample_code/index.rst @@ -283,6 +283,14 @@ 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:`plotROIStats.py <../../../examples/plotROIStats.py>` + - .. image:: img/plotROIStats.png + :width: 150px + - This script is a simple example of how to display statistics on a specific + region of interest. + + An example on how to define your own statistic is given in the 'plotStats.py' + script. * - :download:`plotProfile.py <../../../examples/plotProfile.py>` - .. image:: img/plotProfile.png :width: 150px |