ComplexImageView: Plot a 2D array of complex

This module provides a widget to view 2D complex data.

The ComplexImageView widget is dedicated to visualize a single 2D dataset of complex data.

ComplexImageView class

class silx.gui.plot.ComplexImageView.ComplexImageView(parent=None)

Display an image of complex data and allow to choose the visualization.

Parameters:parent – See QMainWindow

class Mode

Also expose the modes inside the class

ComplexImageView.sigDataChanged

Signal emitted when data has changed.

ComplexImageView.sigVisualizationModeChanged

Signal emitted when the visualization mode has changed.

It provides the new visualization mode.

ComplexImageView.getPlot()

Return the PlotWidget displaying the data

ComplexImageView.setData(data=None, copy=True)

Set the complex data to display.

Parameters:

• data (numpy.ndarray) – 2D complex data
• copy (bool) – True (default) to copy the data, False to use provided data (do not modify!).

ComplexImageView.getData(copy=True)

Get the currently displayed complex data.

Parameters:copy (bool) – True (default) to return a copy of the data, False to return internal data (do not modify!). Returns:The complex data array. Return type:numpy.ndarray of complex with 2 dimensions

ComplexImageView.getDisplayedData(copy=True)

Returns the displayed data depending on the visualization mode

WARNING: The returned data can be a uint8 RGBA image

Parameters:copy (bool) – True (default) to return a copy of the data, False to return internal data (do not modify!) Return type:numpy.ndarray of float with 2 dims or RGBA image (uint8).

static ComplexImageView.getSupportedVisualizationModes()

Returns the supported visualization modes.

Supported visualization modes are:

• amplitude: The absolute value provided by numpy.absolute
• phase: The phase (or argument) provided by numpy.angle
• real: Real part
• imaginary: Imaginary part
• amplitude_phase: Color-coded phase with amplitude as alpha.
• log10_amplitude_phase: Color-coded phase with log10(amplitude) as alpha.

Return type:tuple of str

ComplexImageView.setVisualizationMode(mode)

Set the mode of visualization of the complex data.

See getSupportedVisualizationModes() for the list of supported modes.

Parameters:mode (str) – The mode to use.

ComplexImageView.getVisualizationMode()

Get the current visualization mode of the complex data.

Return type:Mode

ComplexImageView.setColormap(colormap, mode=None)

Set the colormap to use for amplitude, phase, real or imaginary.

WARNING: This colormap is not used when displaying both amplitude and phase.

Parameters:

• colormap (Colormap) – The colormap
• mode (Mode) – If specified, set the colormap of this specific mode

ComplexImageView.getColormap(mode=None)

Returns the colormap used to display the data.

Parameters:mode (Mode) – If specified, set the colormap of this specific mode Return type:Colormap

ComplexImageView.getOrigin()

Returns the offset from origin at which to display the image.

Return type:2-tuple of float

ComplexImageView.setOrigin(origin)

Set the offset from origin at which to display the image.

Parameters:origin (float or 2-tuple of float) – (ox, oy) Offset from origin

ComplexImageView.getScale()

Returns the scale of the image in data coordinates.

Return type:2-tuple of float

ComplexImageView.setScale(scale)

Set the scale of the image

Parameters:scale (float or 2-tuple of float) – (sx, sy) Scale of the image

ComplexImageView.getXAxis()

Returns the X axis

Return type:items.Axis

ComplexImageView.getYAxis()

Returns an Y axis

Return type:items.Axis

ComplexImageView.getGraphTitle()

Return the plot main title as a str.

ComplexImageView.setGraphTitle(title='')

Set the plot main title.

Parameters:title (str) – Main title of the plot (default: ‘’)

ComplexImageView.setKeepDataAspectRatio(flag)

Set whether the plot keeps data aspect ratio or not.

Parameters:flag (bool) – True to respect data aspect ratio

ComplexImageView.isKeepDataAspectRatio()

Returns whether the plot is keeping data aspect ratio or not.