SceneWidget: 3D data viewer widget

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

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

SceneWidget

class SceneWidget(parent=None)

Bases: silx.gui.plot3d.Plot3DWidget.Plot3DWidget

Widget displaying data sets in 3D

model()

Returns the model corresponding the scene of this widget

Return type

SceneModel

selection()

Returns the object managing selection in the scene

Return type

SceneSelection

getSceneGroup()

Returns the root group of the scene

Return type

GroupItem

pickItems(x, y, condition=None)

Iterator over picked items in the scene at given position.

Each picked item yield a PickingResult object holding the picking information.

It traverses the scene tree in a left-to-right top-down way.

Parameters

• x (int) – X widget coordinate

• y (int) – Y widget coordinate

• condition (callable) – Optional test called for each item checking whether to process it or not.

setInteractiveMode(mode)

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()

Returns the interactive mode in use.

Return type

str

addVolume(data, copy=True, index=None)

Add 3D data volume of scalar or complex to SceneWidget content.

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

Parameters

• data (numpy.ndarray[Union[numpy.complex64,numpy.float32]]) – 3D array of complex with shape at least (2, 2, 2)

• 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 3D volume item

Return type

Union[ScalarField3D,ComplexField3D]

add3DScatter(x, y, z, value, copy=True, index=None)

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

Scatter3D

add2DScatter(x, y, value, copy=True, index=None)

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

Scatter2D

addImage(data, copy=True, index=None)

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

ImageData or ImageRgba

Raises

ValueError – For arrays of unsupported dimensions

addItem(item, index=None)

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)

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()

Returns the list of SceneWidget items.

Only items in the top-level group are returned.

Return type

tuple

clearItems()

Remove all item from SceneWidget.

getTextColor()

Return color used for text

Return type

QColor

setTextColor(color)

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()

Return color used for bounding box

Return type

QColor

setForegroundColor(color)

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()

Return color used for highlighted item bounding box

Return type

QColor

setHighlightColor(color)

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

SceneWidget items

• items: SceneWidget items
  • 2D images
  • 2D/3D scatter data
  • 3D volume
  • Clipping plane
  • 3D mesh
  • Item base classes

PickingResult

class PickingResult(item, positions, indices=None, fetchdata=None)

Class to access picking information in a 3D scene.

getItem()

Returns the item this results corresponds to.

Return type

Item3D

getIndices(copy=True)

Returns indices of picked data.

If data is 1D, it returns a numpy.ndarray, otherwise it returns a tuple with as many numpy.ndarray as there are dimensions in the data.

Parameters

copy (bool) – True (default) to get a copy, False to return internal arrays

Return type

Union[None,numpy.ndarray,List[numpy.ndarray]]

getData(copy=True)

Returns picked data values

Parameters

copy (bool) – True (default) to get a copy, False to return internal arrays

Return type

Union[None,numpy.ndarray]

getPositions(frame='scene', copy=True)

Returns picking positions in item coordinates.

Parameters

• frame (str) – The frame in which the positions are returned Either ‘scene’ for world space, ‘ndc’ for normalized device coordinates or ‘object’ for item frame.

• copy (bool) – True (default) to get a copy, False to return internal arrays

Returns

Nx3 array of (x, y, z) coordinates

Return type

numpy.ndarray