summaryrefslogtreecommitdiff
path: root/doc/source/modules/gui/plot3d/scalarfieldview.rst
diff options
context:
space:
mode:
Diffstat (limited to 'doc/source/modules/gui/plot3d/scalarfieldview.rst')
-rw-r--r--doc/source/modules/gui/plot3d/scalarfieldview.rst50
1 files changed, 50 insertions, 0 deletions
diff --git a/doc/source/modules/gui/plot3d/scalarfieldview.rst b/doc/source/modules/gui/plot3d/scalarfieldview.rst
new file mode 100644
index 0000000..763c18e
--- /dev/null
+++ b/doc/source/modules/gui/plot3d/scalarfieldview.rst
@@ -0,0 +1,50 @@
+.. currentmodule:: silx.gui.plot3d
+
+:mod:`ScalarFieldView`: 3D volume scalar data viewer
+====================================================
+
+.. automodule:: silx.gui.plot3d.ScalarFieldView
+
+For sample code using ScalarFieldView, see :doc:`viewer3dvolume_example`
+
+.. currentmodule:: silx.gui.plot3d.ScalarFieldView
+
+:class:`ScalarFieldView`
+------------------------
+
+.. autoclass:: ScalarFieldView
+ :show-inheritance:
+ :members:
+
+Helper classes
+--------------
+
+Those classes are used by :class:`ScalarFieldView`.
+
+:class:`Colormap`
++++++++++++++++++
+
+.. autoclass:: Colormap
+ :show-inheritance:
+ :members:
+
+:class:`CutPlane`
++++++++++++++++++
+
+.. autoclass:: CutPlane
+ :show-inheritance:
+ :members:
+
+:class:`IsoSurface`
++++++++++++++++++++
+
+.. autoclass:: Isosurface
+ :show-inheritance:
+ :members:
+
+:class:`SelectedRegion`
++++++++++++++++++++++++
+
+.. autoclass:: SelectedRegion
+ :show-inheritance:
+ :members: