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
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
|
.. currentmodule:: silx.gui.plot3d
:mod:`items`: SceneWidget items
===============================
The following classes are items that describes the content of a :class:`SceneWidget`:
.. currentmodule:: silx.gui.plot3d.items
- :class:`~silx.gui.plot3d.items.image.ImageData`
- :class:`~silx.gui.plot3d.items.image.ImageRgba`
- :class:`~silx.gui.plot3d.items.scatter.Scatter2D`
- :class:`~silx.gui.plot3d.items.scatter.Scatter3D`
- :class:`~silx.gui.plot3d.items.volume.ScalarField3D`
- :class:`~silx.gui.plot3d.items.clipplane.ClipPlane`
- :class:`~silx.gui.plot3d.items.mesh.Mesh`
- :class:`~silx.gui.plot3d.items.core.GroupItem`
2D images
---------
.. currentmodule:: silx.gui.plot3d.core
.. currentmodule:: silx.gui.plot3d.items.image
:class:`ImageData`
++++++++++++++++++
:class:`ImageData` inherits from :class:`.DataItem3D` and also provides its API.
.. autoclass:: ImageData
:members: getData, setData,
getColormap, setColormap,
getInterpolation, setInterpolation
:class:`ImageRgba`
++++++++++++++++++
:class:`ImageRgba` inherits from :class:`.DataItem3D` and also provides its API.
.. autoclass:: ImageRgba
:members: getData, setData,
getInterpolation, setInterpolation
2D/3D scatter data
------------------
.. currentmodule:: silx.gui.plot3d.items.scatter
:class:`Scatter2D`
++++++++++++++++++
:class:`Scatter2D` inherits from :class:`.DataItem3D` and also provides its API.
.. autoclass:: Scatter2D
:members: getData, setData, getXData, getYData, getValueData,
supportedVisualizations, isPropertyEnabled,
getVisualization, setVisualization,
isHeightMap, setHeightMap,
getLineWidth, setLineWidth,
getColormap, setColormap,
getSupportedSymbols, getSymbol, setSymbol
:class:`Scatter3D`
++++++++++++++++++
:class:`Scatter3D` inherits from :class:`.DataItem3D` and also provides its API.
.. autoclass:: Scatter3D
:members: getData, setData, getXData, getYData, getZData, getValueData,
getColormap, setColormap,
getSupportedSymbols, getSymbol, setSymbol
3D volume
---------
.. currentmodule:: silx.gui.plot3d.items.volume
:class:`ScalarField3D`
++++++++++++++++++++++
:class:`ScalarField3D` inherits from :class:`.DataItem3D` and also provides its API.
.. autoclass:: ScalarField3D
:members: getData, setData,
getCutPlanes,
sigIsosurfaceAdded, sigIsosurfaceRemoved,
addIsosurface, getIsosurfaces, removeIsosurface, clearIsosurfaces
The following classes allows to configure :class:`ScalarField3D` visualization:
:class:`IsoSurface`
+++++++++++++++++++
:class:`IsoSurface` inherits from :class:`.Item3D` and also provides its API.
.. autoclass:: Isosurface
:show-inheritance:
:members:
:class:`CutPlane`
+++++++++++++++++
:class:`CutPlane` inherits from :class:`.Item3D` and also provides its API.
.. autoclass:: CutPlane
:members: getColormap, setColormap,
getInterpolation, setInterpolation,
moveToCenter, isValid,
getNormal, setNormal,
getPoint, setPoint,
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
--------------
.. currentmodule:: silx.gui.plot3d.items.clipplane
:class:`ClipPlane`
++++++++++++++++++
:class:`ClipPlane` inherits from :class:`.Item3D` and also provides its API.
.. autoclass:: ClipPlane
:show-inheritance:
:members:
3D mesh
-------
.. currentmodule:: silx.gui.plot3d.items.mesh
:class:`Mesh`
+++++++++++++
:class:`Mesh` inherits from :class:`.DataItem3D` and also provides its API.
.. autoclass:: Mesh
:show-inheritance:
:members:
Item base classes
-----------------
The following classes provides the base classes for other items.
.. currentmodule:: silx.gui.plot3d.items.core
:class:`Item3D`
+++++++++++++++
.. autoclass:: Item3D
:show-inheritance:
:members:
:class:`DataItem3D`
+++++++++++++++++++
:class:`DataItem3D` inherits from :class:`.Item3D` and also provides its API.
.. autoclass:: DataItem3D
:show-inheritance:
:members:
:class:`GroupItem`
++++++++++++++++++
:class:`GroupItem` inherits from :class:`.DataItem3D` and also provides its API.
.. autoclass:: GroupItem
:show-inheritance:
:members:
|
