summaryrefslogtreecommitdiff
path: root/doc/source/modules/sx.rst
blob: d5e02889bc4239febc2cb1e0adf9218ae4b97323 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
:mod:`silx.sx`: Using silx from Python Interpreter
==================================================

.. currentmodule:: silx.sx

.. automodule:: silx.sx

Plot functions
--------------

The following functions plot curves and images with silx widgets:

- :func:`plot` for curves
- :func:`imshow` for images

The :func:`ginput` function handles user selection on those widgets.


.. note:: Those functions are not available from a notebook.

:func:`plot`
++++++++++++

.. autofunction:: plot

:func:`imshow`
++++++++++++++

.. autofunction:: imshow


:func:`ginput`
++++++++++++++

.. autofunction:: ginput

3D plot functions
-----------------

The following functions plot 3D data with silx widgets (it requires OpenGL):

- :func:`contour3d` for isosurfaces (and cut plane) in a 3D scalar field
- :func:`points3d` for 2D/3D scatter plots

.. note:: Those functions are not available from a notebook.

:func:`contour3d`
+++++++++++++++++

.. autofunction:: contour3d

:func:`points3d`
++++++++++++++++

.. autofunction:: points3d

Widgets
-------

The widgets of the :mod:`silx.gui.plot` package are also exposed in this package.
See :mod:`silx.gui.plot` for documentation.

Input/Output
------------

The content of the :mod:`silx.io` package is also exposed in this package.
See :mod:`silx.io` for documentation.

Math
----

The following classes from :mod:`silx.math` are exposed in this package:

- :class:`~silx.math.histogram.Histogramnd`
- :class:`~silx.math.histogram.HistogramndLut`
- :class:`~silx.math.fit.leastsq`