NumpyAxesSelector:Widget to select a view from a numpy array

This module defines a widget able to convert a numpy array from n-dimensions to a numpy array with less dimensions.

class silx.gui.data.NumpyAxesSelector.NumpyAxesSelector(parent=None)

Widget to select a view from a numpy array.

The widget is set with an input data using setData(), and a requested output dimension using setAxisNames().

Widgets are provided to selected expected input axis, and a slice on the non-selected axis.

The final selected array can be reached using the getter selectedData(), and the event selectionChanged.

If the input data is a HDF5 Dataset, the selected output data will be a new numpy array.

dataChanged

Emitted when the input data change

selectedAxisChanged

Emitted when the selected axis change

selectionChanged

Emitted when the selected data change

customAxisChanged

Emitted when a custom axis change

clear()

Clear the widget.

setAxisNames(axesNames)

Set the axis names of the output selected data.

Axis names are defined from slower to faster axis.

The size of the list will constrain the dimension of the resulting array.

Parameters:axesNames (list[str]) – List of string identifying axis names

setCustomAxis(axesNames)

Set the available list of named axis which can be set to a value.

Parameters:axesNames (list[str]) – List of customable axis names

setData(data)

Set the input data unsed by the widget.

Parameters:data (numpy.ndarray) – The input data

data()

Returns the input data.

Return type:numpy.ndarray

selectedData()

Returns the output data.

Return type:numpy.ndarray

selection()

Returns the selection tuple used to slice the data.

Return type:tuple

setNamedAxesSelectorVisibility(visible)

Show or hide the combo-boxes allowing to map the plot axes to the data dimension.

Parameters:visible – Boolean