diff options
Diffstat (limited to 'doc/source/modules')
-rw-r--r-- | doc/source/modules/gui/icons.rst | 9 | ||||
-rw-r--r-- | doc/source/modules/gui/plot/index.rst | 7 | ||||
-rw-r--r-- | doc/source/modules/gui/plot/statswidget.rst | 8 | ||||
-rw-r--r-- | doc/source/modules/gui/plot/utils.rst | 12 | ||||
-rw-r--r-- | doc/source/modules/gui/plot3d/glutils.rst | 10 | ||||
-rw-r--r-- | doc/source/modules/opencl/convolution.rst | 10 | ||||
-rw-r--r-- | doc/source/modules/opencl/index.rst | 3 | ||||
-rw-r--r-- | doc/source/modules/opencl/processing.rst | 10 | ||||
-rw-r--r-- | doc/source/modules/opencl/statistics.rst | 10 |
9 files changed, 72 insertions, 7 deletions
diff --git a/doc/source/modules/gui/icons.rst b/doc/source/modules/gui/icons.rst index 659bc4c..dbd58b4 100644 --- a/doc/source/modules/gui/icons.rst +++ b/doc/source/modules/gui/icons.rst @@ -75,6 +75,8 @@ Available icons - compare-align-stretch * - |compare-keypoints| - compare-keypoints + * - |compare-mode-a-minus-b| + - compare-mode-a-minus-b * - |compare-mode-a| - compare-mode-a * - |compare-mode-b| @@ -121,6 +123,8 @@ Available icons - draw-rubber * - |edit-copy| - edit-copy + * - |eye| + - eye * - |first| - first * - |folder| @@ -251,6 +255,8 @@ Available icons - plot-ylog * - |plot-yup| - plot-yup + * - |pointing-hand| + - pointing-hand * - |previous| - previous * - |profile-clear| @@ -370,6 +376,7 @@ Available icons .. |compare-align-origin| image:: ../../../../silx/resources/gui/icons/compare-align-origin.png .. |compare-align-stretch| image:: ../../../../silx/resources/gui/icons/compare-align-stretch.png .. |compare-keypoints| image:: ../../../../silx/resources/gui/icons/compare-keypoints.png +.. |compare-mode-a-minus-b| image:: ../../../../silx/resources/gui/icons/compare-mode-a-minus-b.png .. |compare-mode-a| image:: ../../../../silx/resources/gui/icons/compare-mode-a.png .. |compare-mode-b| image:: ../../../../silx/resources/gui/icons/compare-mode-b.png .. |compare-mode-hline| image:: ../../../../silx/resources/gui/icons/compare-mode-hline.png @@ -393,6 +400,7 @@ Available icons .. |draw-pencil| image:: ../../../../silx/resources/gui/icons/draw-pencil.png .. |draw-rubber| image:: ../../../../silx/resources/gui/icons/draw-rubber.png .. |edit-copy| image:: ../../../../silx/resources/gui/icons/edit-copy.png +.. |eye| image:: ../../../../silx/resources/gui/icons/eye.png .. |first| image:: ../../../../silx/resources/gui/icons/first.png .. |folder| image:: ../../../../silx/resources/gui/icons/folder.png .. |image-mask| image:: ../../../../silx/resources/gui/icons/image-mask.png @@ -458,6 +466,7 @@ Available icons .. |plot-ydown| image:: ../../../../silx/resources/gui/icons/plot-ydown.png .. |plot-ylog| image:: ../../../../silx/resources/gui/icons/plot-ylog.png .. |plot-yup| image:: ../../../../silx/resources/gui/icons/plot-yup.png +.. |pointing-hand| image:: ../../../../silx/resources/gui/icons/pointing-hand.png .. |previous| image:: ../../../../silx/resources/gui/icons/previous.png .. |profile-clear| image:: ../../../../silx/resources/gui/icons/profile-clear.png .. |profile1D| image:: ../../../../silx/resources/gui/icons/profile1D.png diff --git a/doc/source/modules/gui/plot/index.rst b/doc/source/modules/gui/plot/index.rst index 6f06830..01cb29b 100644 --- a/doc/source/modules/gui/plot/index.rst +++ b/doc/source/modules/gui/plot/index.rst @@ -61,6 +61,13 @@ Additionnal plot tool widgets: statswidget.rst stats/index.rst +Utilities + +.. toctree:: + :maxdepth: 2 + + utils.rst + Internals --------- diff --git a/doc/source/modules/gui/plot/statswidget.rst b/doc/source/modules/gui/plot/statswidget.rst index 6cd8ecf..1574abc 100644 --- a/doc/source/modules/gui/plot/statswidget.rst +++ b/doc/source/modules/gui/plot/statswidget.rst @@ -32,18 +32,18 @@ :members: -:class:`BasicGridStatsWidget` class +:class:`BasicLineStatsWidget` class ----------------------------------- -.. autoclass:: BasicGridStatsWidget +.. autoclass:: BasicLineStatsWidget :show-inheritance: :members: -:class:`BasicLineStatsWidget` class +:class:`BasicGridStatsWidget` class ----------------------------------- -.. autoclass:: BasicLineStatsWidget +.. autoclass:: BasicGridStatsWidget :show-inheritance: :members: diff --git a/doc/source/modules/gui/plot/utils.rst b/doc/source/modules/gui/plot/utils.rst new file mode 100644 index 0000000..e930208 --- /dev/null +++ b/doc/source/modules/gui/plot/utils.rst @@ -0,0 +1,12 @@ +.. currentmodule:: silx.gui.plot.utils + + +:mod:`axis`: utilities for plots +================================ + +SyncAxes +-------- + +.. autoclass:: silx.gui.plot.utils.axis.SyncAxes + :members: + diff --git a/doc/source/modules/gui/plot3d/glutils.rst b/doc/source/modules/gui/plot3d/glutils.rst index 2c36e83..21781d9 100644 --- a/doc/source/modules/gui/plot3d/glutils.rst +++ b/doc/source/modules/gui/plot3d/glutils.rst @@ -13,13 +13,17 @@ Utility functions ----------------- -.. currentmodule:: silx.gui._glutils +.. currentmodule:: silx.gui._glutils.Context For OpenGL context management: -.. autofunction:: getGLContext +.. autofunction:: getCurrent + +.. autofunction:: setCurrent -.. autofunction:: setGLContextGetter +.. autofunction:: current + +.. currentmodule:: silx.gui._glutils For type checking and conversion: diff --git a/doc/source/modules/opencl/convolution.rst b/doc/source/modules/opencl/convolution.rst new file mode 100644 index 0000000..225d016 --- /dev/null +++ b/doc/source/modules/opencl/convolution.rst @@ -0,0 +1,10 @@ + +.. currentmodule:: silx.opencl + +:mod:`convolution`: Convolution +------------------------------- + +.. automodule:: silx.opencl.convolution + :members: Convolution, gaussian_kernel + :show-inheritance: + :undoc-members: diff --git a/doc/source/modules/opencl/index.rst b/doc/source/modules/opencl/index.rst index 20a3a01..ef8b9e6 100644 --- a/doc/source/modules/opencl/index.rst +++ b/doc/source/modules/opencl/index.rst @@ -11,6 +11,9 @@ sift/index.rst fbp.rst sinofilter.rst + processing.rst + convolution.rst + statistics.rst medfilt.rst codec_cbf.rst diff --git a/doc/source/modules/opencl/processing.rst b/doc/source/modules/opencl/processing.rst new file mode 100644 index 0000000..a246cc6 --- /dev/null +++ b/doc/source/modules/opencl/processing.rst @@ -0,0 +1,10 @@ + +.. currentmodule:: silx.opencl + +:mod:`processing`: Processing +------------------------------- + +.. automodule:: silx.opencl.processing + :members: OpenclProcessing, KernelContainer + :show-inheritance: + :undoc-members: diff --git a/doc/source/modules/opencl/statistics.rst b/doc/source/modules/opencl/statistics.rst new file mode 100644 index 0000000..0db7566 --- /dev/null +++ b/doc/source/modules/opencl/statistics.rst @@ -0,0 +1,10 @@ + +.. currentmodule:: silx.opencl + +:mod:`statistics`: Statistics +------------------------------- + +.. automodule:: silx.opencl.statistics + :members: Statistics + :show-inheritance: + :undoc-members: |