SceneWidget: 3D data viewer widget

This module provides a widget to view data sets in 3D.

../../../_images/SceneWidget.png

For sample code using SceneWidget, see plot3dSceneWindow.py in silx.gui.plot3d sample code.

SceneWidget

class silx.gui.plot3d.SceneWidget.SceneWidget(parent=None)[source]

Bases: silx.gui.plot3d.Plot3DWidget.Plot3DWidget

Widget displaying data sets in 3D

model()[source]

Returns the model corresponding the scene of this widget

Return type:SceneModel
selection()[source]

Returns the object managing selection in the scene

Return type:SceneSelection
getSceneGroup()[source]

Returns the root group of the scene

Return type:GroupItem
setInteractiveMode(mode)[source]

Set the interactive mode.

‘panSelectedPlane’ mode set plane panning if a plane is selected, otherwise it fall backs to ‘rotate’.

Parameters:mode (str) – The interactive mode: ‘rotate’, ‘pan’, ‘panSelectedPlane’ or None
getInteractiveMode()[source]

Returns the interactive mode in use.

Return type:str
add3DScalarField(data, copy=True, index=None)[source]

Add 3D scalar data volume to SceneWidget content.

Dataset order is zyx (i.e., first dimension is z).

Parameters:
  • data (3D numpy.ndarray of float32 with shape at least (2, 2, 2)) – 3D array
  • copy (bool) – True (default) to make a copy, False to avoid copy (DO NOT MODIFY data afterwards)
  • index (int) – The index at which to place the item. By default it is appended to the end of the list.
Returns:

The newly created scalar volume item
Return type:

items.ScalarField3D
add3DScatter(x, y, z, value, copy=True, index=None)[source]

Add 3D scatter data to SceneWidget content.

Parameters:
  • x (numpy.ndarray) – Array of X coordinates (single value not accepted)
  • y – Points Y coordinate (array-like or single value)
  • z – Points Z coordinate (array-like or single value)
  • value – Points values (array-like or single value)
  • copy (bool) – True (default) to copy the data, False to use provided data (do not modify!)
  • index (int) – The index at which to place the item. By default it is appended to the end of the list.
Returns:

The newly created 3D scatter item
Return type:

items.Scatter3D
add2DScatter(x, y, value, copy=True, index=None)[source]

Add 2D scatter data to SceneWidget content.

Provided arrays must have the same length.

Parameters:
  • x (numpy.ndarray) – X coordinates (array-like)
  • y (numpy.ndarray) – Y coordinates (array-like)
  • value – Points value: array-like or single scalar
  • copy (bool) – True (default) to copy the data, False to use as is (do not modify!).
  • index (int) – The index at which to place the item. By default it is appended to the end of the list.
Returns:

The newly created 2D scatter item
Return type:

items.Scatter2D
addImage(data, copy=True, index=None)[source]

Add a 2D data or RGB(A) image to SceneWidget content.

2D data is casted to float32. RGBA supported formats are: float32 in [0, 1] and uint8.

Parameters:
  • data (numpy.ndarray) – Image as a 2D data array or RGBA image as a 3D array (height, width, channels)
  • copy (bool) – True (default) to copy the data, False to use as is (do not modify!).
  • index (int) – The index at which to place the item. By default it is appended to the end of the list.
Returns:

The newly created image item
Return type:

items.ImageData or items.ImageRgba
Raises:

ValueError – For arrays of unsupported dimensions
addItem(item, index=None)[source]

Add an item to SceneWidget content

Parameters:
  • item (Item3D) – The item to add
  • index (int) – The index at which to place the item. By default it is appended to the end of the list.
Raises:

ValueError – If the item is already in the SceneWidget.
removeItem(item)[source]

Remove an item from SceneWidget content.

Parameters:item (Item3D) – The item to remove from the scene
Raises:ValueError – If the item does not belong to the group
getItems()[source]

Returns the list of SceneWidget items.

Only items in the top-level group are returned.

Return type:tuple
clearItems()[source]

Remove all item from SceneWidget.

getTextColor()[source]

Return color used for text

Return type:QColor
setTextColor(color)[source]

Set the text color.

Parameters:color (QColor, str or array-like of 3 or 4 float in [0., 1.] or uint8) – RGB color: name, #RRGGBB or RGB values
getForegroundColor()[source]

Return color used for bounding box

Return type:QColor
setForegroundColor(color)[source]

Set the foreground color.

Parameters:color (QColor, str or array-like of 3 or 4 float in [0., 1.] or uint8) – RGB color: name, #RRGGBB or RGB values
getHighlightColor()[source]

Return color used for highlighted item bounding box

Return type:QColor
setHighlightColor(color)[source]

Set highlighted item color.

Parameters:color (QColor, str or array-like of 3 or 4 float in [0., 1.] or uint8) – RGB color: name, #RRGGBB or RGB values