summaryrefslogtreecommitdiff
path: root/doc/source/modules
diff options
context:
space:
mode:
authorPicca Frédéric-Emmanuel <picca@debian.org>2021-09-07 14:39:36 +0200
committerPicca Frédéric-Emmanuel <picca@debian.org>2021-09-07 14:39:36 +0200
commitd3194b1a9c4404ba93afac43d97172ab24c57098 (patch)
treea1604130e1401dc1cbd084518ed72869dc92b86f /doc/source/modules
parentb3bea947efa55d2c0f198b6c6795b3177be27f45 (diff)
New upstream version 0.15.2+dfsg
Diffstat (limited to 'doc/source/modules')
-rw-r--r--doc/source/modules/gui/plot3d/items.rst23
-rw-r--r--doc/source/modules/io/h5py_utils.rst8
-rw-r--r--doc/source/modules/io/index.rst1
-rw-r--r--doc/source/modules/utils/index.rst1
-rw-r--r--doc/source/modules/utils/retry.rst7
5 files changed, 40 insertions, 0 deletions
diff --git a/doc/source/modules/gui/plot3d/items.rst b/doc/source/modules/gui/plot3d/items.rst
index 5c4884f..ba39336 100644
--- a/doc/source/modules/gui/plot3d/items.rst
+++ b/doc/source/modules/gui/plot3d/items.rst
@@ -112,6 +112,29 @@ The following classes allows to configure :class:`ScalarField3D` visualization:
getParameters, setParameters,
getDisplayValuesBelowMin, setDisplayValuesBelowMin
+Height map
+----------
+
+.. currentmodule:: silx.gui.plot3d.items.image
+
+:class:`HeightMapData`
+++++++++++++++++++++++
+
+:class:`HeightMapData` inherits from :class:`.DataItem3D` and also provides its API.
+
+.. autoclass:: HeightMapData
+ :members: getData, setData,
+ getColormappedData, setColormappedData
+
+:class:`HeightMapRGBA`
+++++++++++++++++++++++
+
+:class:`HeightMapRGBA` inherits from :class:`.DataItem3D` and also provides its API.
+
+.. autoclass:: HeightMapRGBA
+ :members: getData, setData,
+ getColorData, setColorData
+
Clipping plane
--------------
diff --git a/doc/source/modules/io/h5py_utils.rst b/doc/source/modules/io/h5py_utils.rst
new file mode 100644
index 0000000..b6461b1
--- /dev/null
+++ b/doc/source/modules/io/h5py_utils.rst
@@ -0,0 +1,8 @@
+
+.. currentmodule:: silx.io
+
+:mod:`h5py_utils`: HDF5 I/O utilities
+-------------------------------------
+
+.. automodule:: silx.io.h5py_utils
+ :members:
diff --git a/doc/source/modules/io/index.rst b/doc/source/modules/io/index.rst
index b504695..581f763 100644
--- a/doc/source/modules/io/index.rst
+++ b/doc/source/modules/io/index.rst
@@ -18,6 +18,7 @@
spech5.rst
url.rst
utils.rst
+ h5py_utils.rst
Top-level functions
-------------------
diff --git a/doc/source/modules/utils/index.rst b/doc/source/modules/utils/index.rst
index 7dd10dd..db18422 100644
--- a/doc/source/modules/utils/index.rst
+++ b/doc/source/modules/utils/index.rst
@@ -9,3 +9,4 @@
html.rst
testutils.rst
weakref.rst
+ retry.rst
diff --git a/doc/source/modules/utils/retry.rst b/doc/source/modules/utils/retry.rst
new file mode 100644
index 0000000..e176bc0
--- /dev/null
+++ b/doc/source/modules/utils/retry.rst
@@ -0,0 +1,7 @@
+.. currentmodule:: silx.utils
+
+:mod:`weakref`
+---------------
+
+.. automodule:: silx.utils.retry
+ :members: \ No newline at end of file