guiqwt.image

The image module provides image-related objects and functions:

• guiqwt.image.ImagePlot: a 2D curve and image plotting widget, derived from guiqwt.curve.CurvePlot

• guiqwt.image.ImageItem: simple images

• guiqwt.image.TrImageItem: images supporting arbitrary affine transform

• guiqwt.image.XYImageItem: images with non-linear X/Y axes

• guiqwt.image.Histogram2DItem: 2D histogram

• guiqwt.image.ImageFilterItem: rectangular filtering area that may be resized and moved onto the processed image

• guiqwt.image.assemble_imageitems()

• guiqwt.image.get_plot_source_rect()

• guiqwt.image.get_image_from_plot()

ImageItem, TrImageItem, XYImageItem, Histogram2DItem and ImageFilterItem objects are plot items (derived from QwtPlotItem) that may be displayed on a guiqwt.image.ImagePlot plotting widget.

See also

Module guiqwt.curve

Module providing curve-related plot items and plotting widgets

Module guiqwt.plot

Module providing ready-to-use curve and image plotting widgets and dialog boxes

Examples

Create a basic image plotting widget:

• before creating any widget, a QApplication must be instantiated (that is a Qt internal requirement):

>>> import guidata
>>> app = guidata.qapplication()

• that is mostly equivalent to the following (the only difference is that the guidata helper function also installs the Qt translation corresponding to the system locale):

>>> from PyQt5.QtGui import QApplication
>>> app = QApplication([])

• now that a QApplication object exists, we may create the plotting widget:

>>> from guiqwt.image import ImagePlot
>>> plot = ImagePlot(title="Example")

Generate random data for testing purpose:

>>> import numpy as np
>>> data = np.random.rand(100, 100)

Create a simple image item:

• from the associated plot item class (e.g. XYImageItem to create an image with non-linear X/Y axes): the item properties are then assigned by creating the appropriate style parameters object (e.g. guiqwt.styles.ImageParam)

>>> from guiqwt.curve import ImageItem
>>> from guiqwt.styles import ImageParam
>>> param = ImageParam()
>>> param.label = 'My image'
>>> image = ImageItem(param)
>>> image.set_data(data)

• or using the plot item builder (see guiqwt.builder.make()):

>>> from guiqwt.builder import make
>>> image = make.image(data, title='My image')

Attach the image to the plotting widget:

>>> plot.add_item(image)

Display the plotting widget:

>>> plot.show()
>>> app.exec_()

Reference

class guiqwt.image.ImagePlot(parent=None, title=None, xlabel=None, ylabel=None, zlabel=None, xunit=None, yunit=None, zunit=None, yreverse=True, aspect_ratio=1.0, lock_aspect_ratio=True, gridparam=None, section='plot')

Construct a 2D curve and image plotting widget (this class inherits guiqwt.curve.CurvePlot)

• parent: parent widget

• title: plot title (string)

• xlabel, ylabel, zlabel: resp. bottom, left and right axis titles (strings)

• xunit, yunit, zunit: resp. bottom, left and right axis units (strings)

• yreverse: reversing y-axis direction of increasing values (bool)

• aspect_ratio: height to width ratio (float)

• lock_aspect_ratio: locking aspect ratio (bool)

DEFAULT_ITEM_TYPE

alias of guiqwt.interfaces.IImageItemType

showEvent(event)

Override BasePlot method

do_zoom_view(dx, dy)

Reimplement CurvePlot method

do_zoom_rect_view(start, end)

Reimplement CurvePlot method

update_lut_range(_min, _max)

update the LUT scale

get_current_aspect_ratio()

Return current aspect ratio

get_aspect_ratio()

Return aspect ratio

set_aspect_ratio(ratio=None, lock=None)

Set aspect ratio

notify_colormap_changed()

Levels histogram range has changed

resizeEvent(event)

Reimplement Qt method to resize widget

add_item(item, z=None, autoscale=True)

Add a plot item instance to this plot widget

• item: qwt.QwtPlotItem object implementing the guiqwt.interfaces.IBasePlotItem interface

• z: item’s z order (None -> z = max(self.get_items())+1) autoscale: True -> rescale plot to fit image bounds

set_active_item(item)

Override base set_active_item to change the grid’s axes according to the selected item

disable_unused_axes()

Disable unused axes

do_autoscale(replot=True, axis_id=None)

Do autoscale on all axes

get_axesparam_class(item)

Return AxesParam dataset class associated to item’s type

class PaintDeviceMetric

class RenderFlag

class RenderFlags

class RenderFlags(Union[QWidget.RenderFlags, QWidget.RenderFlag]) → None

class RenderFlags(QWidget.RenderFlags) → None

class Shadow

class Shape

class StyleMask

acceptDrops(self) → bool

accessibleDescription(self) → str

accessibleName(self) → str

actionEvent(self, QActionEvent)

actions(self) → List[QAction]

activateWindow(self)

addAction(self, QAction)

addActions(self, Iterable[QAction])

add_item_with_z_offset(item, zoffset)

Add a plot item instance within a specified z range, over zmin

adjustSize(self)

attachItem(plotItem, on)

Attach/Detach a plot item

Parameters

• plotItem (qwt.plot.QwtPlotItem) – Plot item

• on (bool) – When true attach the item, otherwise detach it

autoDelete()

Returns

true if auto deletion is enabled

See also

setAutoDelete(), insertItem()

autoFillBackground(self) → bool

autoRefresh()

Replots the plot if autoReplot() is True.

autoReplot()

Returns

True if the autoReplot option is set.

See also

setAutoReplot()

axisAutoScale(axisId)

Parameters

axisId (int) – Axis index

Returns

True, if autoscaling is enabled

axisEnabled(axisId)

Parameters

axisId (int) – Axis index

Returns

True, if a specified axis is enabled

axisFont(axisId)

Parameters

axisId (int) – Axis index

Returns

The font of the scale labels for a specified axis

axisInterval(axisId)

Parameters

axisId (int) – Axis index

Returns

The current interval of the specified axis

This is only a convenience function for axisScaleDiv(axisId).interval()

See also

qwt.scale_div.QwtScaleDiv, axisScaleDiv()

axisMaxMajor(axisId)

Parameters

axisId (int) – Axis index

Returns

The maximum number of major ticks for a specified axis

See also

setAxisMaxMajor(), qwt.scale_engine.QwtScaleEngine.divideScale()

axisMaxMinor(axisId)

Parameters

axisId (int) – Axis index

Returns

The maximum number of minor ticks for a specified axis

See also

setAxisMaxMinor(), qwt.scale_engine.QwtScaleEngine.divideScale()

axisScaleDiv(axisId)

Parameters

axisId (int) – Axis index

Returns

The scale division of a specified axis

axisScaleDiv(axisId).lowerBound(), axisScaleDiv(axisId).upperBound() are the current limits of the axis scale.

See also

qwt.scale_div.QwtScaleDiv, setAxisScaleDiv(), qwt.scale_engine.QwtScaleEngine.divideScale()

axisScaleDraw(axisId)

Parameters

axisId (int) – Axis index

Returns

Specified scaleDraw for axis, or NULL if axis is invalid.

axisScaleEngine(axisId)

Parameters

axisId (int) – Axis index

Returns

Scale engine for a specific axis

See also

setAxisScaleEngine()

axisStepSize(axisId)

Parameters

axisId (int) – Axis index

Returns

step size parameter value

This doesn’t need to be the step size of the current scale.

See also

setAxisScale(), qwt.scale_engine.QwtScaleEngine.divideScale()

axisTitle(axisId)

Parameters

axisId (int) – Axis index

Returns

Title of a specified axis

axisValid(axis_id)

Parameters

axis_id (int) – Axis

Returns

True if the specified axis exists, otherwise False

axisWidget(axisId)

Parameters

axisId (int) – Axis index

Returns

Scale widget of the specified axis, or None if axisId is invalid.

backgroundRole(self) → QPalette.ColorRole

baseSize(self) → QSize

blockSignals(self, bool) → bool

canvas()

Returns

the plot’s canvas

canvasBackground()

Returns

Background brush of the plotting area.

See also

setCanvasBackground()

canvasMap(axisId)

Parameters

axisId (int) – Axis

Returns

Map for the axis on the canvas. With this map pixel coordinates can translated to plot coordinates and vice versa.

See also

qwt.scale_map.QwtScaleMap, transform(), invTransform()

changeEvent(self, QEvent)

childAt(self, QPoint) → QWidget

ImagePlot.childAt(self, int, int) -> QWidget

childEvent(self, QChildEvent)

children(self) → List[QObject]

childrenRect(self) → QRect

childrenRegion(self) → QRegion

clearFocus(self)

clearMask(self)

close(self) → bool

closeEvent(self, QCloseEvent)

colorCount(self) → int

connectNotify(self, QMetaMethod)

contentsMargins(self) → QMargins

contentsRect(self) → QRect

contextMenuEvent(self, QContextMenuEvent)

contextMenuPolicy(self) → Qt.ContextMenuPolicy

copy_to_clipboard()

Copy widget’s window to clipboard

create(self, window: PyQt5.sip.voidptr = 0, initializeWindow: bool = True, destroyOldWindow: bool = True)

createWindowContainer(QWindow, parent: QWidget = None, flags: Union[Qt.WindowFlags, Qt.WindowType] = 0) → QWidget

cursor(self) → QCursor

customEvent(self, QEvent)

del_all_items(except_grid=True)

Del all items, eventually (default) except grid

del_item(item)

Remove item from widget Convenience function (see ‘del_items’)

del_items(items)

Remove item from widget

deleteLater(self)

depth(self) → int

deserialize(reader)

Restore items from HDF5 file:

• reader: guidata.hdf5io.HDF5Reader object

See also guiqwt.baseplot.BasePlot.save_items_to_hdf5()

destroy(self, destroyWindow: bool = True, destroySubWindows: bool = True)

detachItems(rtti=None)

Detach items from the dictionary

Parameters

rtti (int or None) – In case of QwtPlotItem.Rtti_PlotItem or None (default) detach all items otherwise only those items of the type rtti.

devType(self) → int

devicePixelRatio(self) → int

devicePixelRatioF(self) → float

devicePixelRatioFScale() → float

disable_autoscale()

Re-apply the axis scales so as to disable autoscaling without changing the view

disconnect(QMetaObject.Connection) → bool

disconnect(self) → None

disconnectNotify(self, QMetaMethod)

do_pan_view(dx, dy)

Translate the active axes by dx, dy dx, dy are tuples composed of (initial pos, dest pos)

dragEnterEvent(self, QDragEnterEvent)

dragLeaveEvent(self, QDragLeaveEvent)

dragMoveEvent(self, QDragMoveEvent)

drawCanvas(painter)

Redraw the canvas.

Parameters

painter (QPainter) – Painter used for drawing

Warning

drawCanvas calls drawItems what is also used for printing. Applications that like to add individual plot items better overload drawItems()

See also

getCanvasMarginsHint(), QwtPlotItem.getCanvasMarginHint()

drawFrame(self, QPainter)

drawItems(painter, canvasRect, maps)

Redraw the canvas.

Parameters

• painter (QPainter) – Painter used for drawing

• canvasRect (QRectF) – Bounding rectangle where to paint

• maps (list) – QwtPlot.axisCnt maps, mapping between plot and paint device coordinates

Note

Usually canvasRect is contentsRect() of the plot canvas. Due to a bug in Qt this rectangle might be wrong for certain frame styles ( f.e QFrame.Box ) and it might be necessary to fix the margins manually using QWidget.setContentsMargins()

dropEvent(self, QDropEvent)

dumpObjectInfo(self)

dumpObjectTree(self)

dynamicPropertyNames(self) → List[QByteArray]

edit_axis_parameters(axis_id)

Edit axis parameters

edit_plot_parameters(key)

Edit plot parameters

effectiveWinId(self) → PyQt5.sip.voidptr

enableAxis(axisId, tf=True)

Enable or disable a specified axis

When an axis is disabled, this only means that it is not visible on the screen. Curves, markers and can be attached to disabled axes, and transformation of screen coordinates into values works as normal.

Only xBottom and yLeft are enabled by default.

Parameters

• axisId (int) – Axis index

• tf (bool) – True (enabled) or False (disabled)

enable_used_axes()

Enable only used axes For now, this is needed only by the pyplot interface

ensurePolished(self)

enterEvent(self, QEvent)

event(self, QEvent) → bool

eventFilter(self, QObject, QEvent) → bool

exportTo(filename, size=(800, 600), size_mm=None, resolution=72.0, format_=None)

Export plot to PDF or image file (SVG, PNG, …)

Parameters

• filename (str) – Filename

• size (tuple) – (width, height) size in pixels

• size_mm (tuple) – (width, height) size in millimeters

• resolution (float) – Image resolution

• format (str) – File format (PDF, SVG, PNG, …)

find(PyQt5.sip.voidptr) → QWidget

findChild(self, type, name: str = '', options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) → QObject

findChild(self, Tuple, name: str = '', options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) → QObject

findChildren(self, type, name: str = '', options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) → List[QObject]

findChildren(self, Tuple, name: str = '', options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) → List[QObject]

findChildren(self, type, QRegExp, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) → List[QObject]

findChildren(self, Tuple, QRegExp, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) → List[QObject]

findChildren(self, type, QRegularExpression, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) → List[QObject]

findChildren(self, Tuple, QRegularExpression, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) → List[QObject]

flatStyle()

Returns

True if the flatStyle option is set.

See also

setFlatStyle()

focusInEvent(self, QFocusEvent)

focusNextChild(self) → bool

focusNextPrevChild(self, bool) → bool

focusOutEvent(self, QFocusEvent)

focusPolicy(self) → Qt.FocusPolicy

focusPreviousChild(self) → bool

focusProxy(self) → QWidget

focusWidget(self) → QWidget

font(self) → QFont

fontInfo(self) → QFontInfo

fontMetrics(self) → QFontMetrics

footer()

Returns

Text of the footer

See also

setFooter()

footerLabel()

Returns

Footer label widget.

foregroundRole(self) → QPalette.ColorRole

frameGeometry(self) → QRect

frameRect(self) → QRect

frameShadow(self) → QFrame.Shadow

frameShape(self) → QFrame.Shape

frameSize(self) → QSize

frameStyle(self) → int

frameWidth(self) → int

geometry(self) → QRect

getCanvasMarginsHint(maps, canvasRect)

Calculate the canvas margins

Parameters

• maps (list) – QwtPlot.axisCnt maps, mapping between plot and paint device coordinates

• canvasRect (QRectF) – Bounding rectangle where to paint

Plot items might indicate, that they need some extra space at the borders of the canvas by the QwtPlotItem.Margins flag.

See also

updateCanvasMargins(), getCanvasMarginHint()

getContentsMargins(self) → Tuple[int, int, int, int]

get_active_axes()

Return active axes

get_active_item(force=False)

Return active item Force item activation if there is no active item

get_axis_color(axis_id)

Get axis color (color name, i.e. string)

get_axis_direction(axis_id)

Return axis direction of increasing values

• axis_id: axis id (BasePlot.Y_LEFT, BasePlot.X_BOTTOM, …) or string: ‘bottom’, ‘left’, ‘top’ or ‘right’

get_axis_font(axis_id)

Get axis font

get_axis_id(axis_name)

Return axis ID from axis name If axis ID is passed directly, check the ID

get_axis_limits(axis_id)

Return axis limits (minimum and maximum values)

get_axis_scale(axis_id)

Return the name (‘lin’ or ‘log’) of the scale used by axis

get_axis_title(axis_id)

Get axis title

get_axis_unit(axis_id)

Get axis unit

get_context_menu()

Return widget context menu

get_default_item()

Return default item, depending on plot’s default item type (e.g. for a curve plot, this is a curve item type).

Return nothing if there is more than one item matching the default item type.

get_items(z_sorted=False, item_type=None)

Return widget’s item list (items are based on IBasePlotItem’s interface)

get_last_active_item(item_type)

Return last active item corresponding to passed item_type

get_max_z()

Return maximum z-order for all items registered in plot If there is no item, return 0

get_nearest_object(pos, close_dist=0)

Return nearest item from position ‘pos’

If close_dist > 0:

Return the first found item (higher z) which distance to ‘pos’ is less than close_dist

else:

Return the closest item

get_nearest_object_in_z(pos)

Return nearest item for which position ‘pos’ is inside of it (iterate over items with respect to their ‘z’ coordinate)

get_plot_limits(xaxis='bottom', yaxis='left')

Return plot scale limits

get_plot_parameters(key, itemparams)

Return a list of DataSets for a given parameter key the datasets will be edited and passed back to set_plot_parameters

this is a generic interface to help building context menus using the BasePlotMenuTool

get_private_items(z_sorted=False, item_type=None)

Return widget’s private item list (items are based on IBasePlotItem’s interface)

get_public_items(z_sorted=False, item_type=None)

Return widget’s public item list (items are based on IBasePlotItem’s interface)

get_scales()

Return active curve scales

get_selected_items(z_sorted=False, item_type=None)

Return selected items

get_title()

Get plot title

grab(self, rectangle: QRect = QRect(QPoint(0, 0), QSize(- 1, - 1))) → QPixmap

grabGesture(self, Qt.GestureType, flags: Union[Qt.GestureFlags, Qt.GestureFlag] = Qt.GestureFlags())

grabKeyboard(self)

grabMouse(self)

grabMouse(self, Union[QCursor, Qt.CursorShape]) → None

grabShortcut(self, Union[QKeySequence, QKeySequence.StandardKey, str, int], context: Qt.ShortcutContext = Qt.WindowShortcut) → int

graphicsEffect(self) → QGraphicsEffect

graphicsProxyWidget(self) → QGraphicsProxyWidget

hasFocus(self) → bool

hasHeightForWidth(self) → bool

hasMouseTracking(self) → bool

hasTabletTracking(self) → bool

height(self) → int

heightForWidth(self, int) → int

heightMM(self) → int

hide(self)

hideEvent(self, QHideEvent)

hide_items(items=None, item_type=None)

Hide items (if items is None, hide all items)

inherits(self, str) → bool

initAxesData()

Initialize axes

initPainter(self, QPainter)

initStyleOption(self, QStyleOptionFrame)

inputMethodEvent(self, QInputMethodEvent)

inputMethodHints(self) → Qt.InputMethodHints

inputMethodQuery(self, Qt.InputMethodQuery) → Any

ImagePlot.insertAction(self, QAction, QAction)

insertActions(self, QAction, Iterable[QAction])

insertItem(item)

Insert a plot item

Parameters

item (qwt.plot.QwtPlotItem) – PlotItem

See also

removeItem()

insertLegend(legend, pos=None, ratio=- 1)

Insert a legend

If the position legend is QwtPlot.LeftLegend or QwtPlot.RightLegend the legend will be organized in one column from top to down. Otherwise the legend items will be placed in a table with a best fit number of columns from left to right.

insertLegend() will set the plot widget as parent for the legend. The legend will be deleted in the destructor of the plot or when another legend is inserted.

Legends, that are not inserted into the layout of the plot widget need to connect to the legendDataChanged() signal. Calling updateLegend() initiates this signal for an initial update. When the application code wants to implement its own layout this also needs to be done for rendering plots to a document ( see QwtPlotRenderer ).

Parameters

• legend (qwt.legend.QwtAbstractLegend) – Legend

• pos (QwtPlot.LegendPosition) – The legend’s position.

• ratio (float) – Ratio between legend and the bounding rectangle of title, canvas and axes

Note

For top/left position the number of columns will be limited to 1, otherwise it will be set to unlimited.

Note

The legend will be shrunk if it would need more space than the given ratio. The ratio is limited to ]0.0 .. 1.0]. In case of <= 0.0 it will be reset to the default ratio. The default vertical/horizontal ratio is 0.33/0.5.

See also

legend(), qwt.plot_layout.QwtPlotLayout.legendPosition(), qwt.plot_layout.QwtPlotLayout.setLegendPosition()

installEventFilter(self, QObject)

invTransform(axisId, pos)

Transform the x or y coordinate of a position in the drawing region into a value.

Parameters

• axisId (int) – Axis index

• pos (int) – position

Warning

The position can be an x or a y coordinate, depending on the specified axis.

invalidate()

Invalidate paint cache and schedule redraw use instead of replot when only the content of the canvas needs redrawing (axes, shouldn’t change)

isActiveWindow(self) → bool

isAncestorOf(self, QWidget) → bool

isEnabled(self) → bool

isEnabledTo(self, QWidget) → bool

isFullScreen(self) → bool

isHidden(self) → bool

isLeftToRight(self) → bool

isMaximized(self) → bool

isMinimized(self) → bool

isModal(self) → bool

isRightToLeft(self) → bool

isSignalConnected(self, QMetaMethod) → bool

isVisible(self) → bool

isVisibleTo(self, QWidget) → bool

isWidgetType(self) → bool

isWindow(self) → bool

isWindowModified(self) → bool

isWindowType(self) → bool

itemList(rtti=None)

A list of attached plot items.

Use caution when iterating these lists, as removing/detaching an item will invalidate the iterator. Instead you can place pointers to objects to be removed in a removal list, and traverse that list later.

Parameters

rtti (int) – In case of QwtPlotItem.Rtti_PlotItem detach all items otherwise only those items of the type rtti.

Returns

List of all attached plot items of a specific type. If rtti is None, return a list of all attached plot items.

keyPressEvent(self, QKeyEvent)

keyReleaseEvent(self, QKeyEvent)

keyboardGrabber() → QWidget

killTimer(self, int)

layout(self) → QLayout

layoutDirection(self) → Qt.LayoutDirection

leaveEvent(self, QEvent)

legend()

Returns

the plot’s legend

See also

insertLegend()

lineWidth(self) → int

locale(self) → QLocale

logicalDpiX(self) → int

logicalDpiY(self) → int

lower(self)

mapFrom(self, QWidget, QPoint) → QPoint

mapFromGlobal(self, QPoint) → QPoint

mapFromParent(self, QPoint) → QPoint

mapTo(self, QWidget, QPoint) → QPoint

mapToGlobal(self, QPoint) → QPoint

mapToParent(self, QPoint) → QPoint

mask(self) → QRegion

maximumHeight(self) → int

maximumSize(self) → QSize

maximumWidth(self) → int

metaObject(self) → QMetaObject

metric(self, QPaintDevice.PaintDeviceMetric) → int

midLineWidth(self) → int

minimumHeight(self) → int

minimumSize(self) → QSize

minimumSizeHint()

Returns

Return a minimum size hint

minimumWidth(self) → int

mouseDoubleClickEvent(event)

Reimplement QWidget method

mouseGrabber() → QWidget

mouseMoveEvent(self, QMouseEvent)

mousePressEvent(self, QMouseEvent)

mouseReleaseEvent(self, QMouseEvent)

move(self, QPoint)

ImagePlot.move(self, int, int) -> None

moveEvent(self, QMoveEvent)

moveToThread(self, QThread)

move_down(item_list)

Move item(s) down, i.e. to the background (swap item with the previous item in z-order)

item: plot item or list of plot items

Return True if items have been moved effectively

move_up(item_list)

Move item(s) up, i.e. to the foreground (swap item with the next item in z-order)

item: plot item or list of plot items

Return True if items have been moved effectively

nativeEvent(self, Union[QByteArray, bytes, bytearray], PyQt5.sip.voidptr) → Tuple[bool, int]

nativeParentWidget(self) → QWidget

nextInFocusChain(self) → QWidget

normalGeometry(self) → QRect

objectName(self) → str

overrideWindowFlags(self, Union[Qt.WindowFlags, Qt.WindowType])

overrideWindowState(self, Union[Qt.WindowStates, Qt.WindowState])

paintEngine(self) → QPaintEngine

paintEvent(self, QPaintEvent)

paintingActive(self) → bool

palette(self) → QPalette

parent(self) → QObject

parentWidget(self) → QWidget

physicalDpiX(self) → int

physicalDpiY(self) → int

plotLayout()

Returns

the plot’s layout

See also

setPlotLayout()

pos(self) → QPoint

previousInFocusChain(self) → QWidget

print_(printer)

Print plot to printer

Parameters

printer (QPaintDevice or QPrinter or QSvgGenerator) – Printer

property(self, str) → Any

pyqtConfigure(...)

Each keyword argument is either the name of a Qt property or a Qt signal. For properties the property is set to the given value which should be of an appropriate type. For signals the signal is connected to the given value which should be a callable.

raise_(self)

read_axes_styles(section, options)

Read axes styles from section and options (one option for each axis in the order left, right, bottom, top)

Skip axis if option is None

receivers(self, PYQT_SIGNAL) → int

rect(self) → QRect

releaseKeyboard(self)

releaseMouse(self)

releaseShortcut(self, int)

removeAction(self, QAction)

removeEventFilter(self, QObject)

removeItem(item)

Remove a plot item

Parameters

item (qwt.plot.QwtPlotItem) – PlotItem

See also

insertItem()

render(self, QPaintDevice, targetOffset: QPoint = QPoint(), sourceRegion: QRegion = QRegion(), flags: Union[QWidget.RenderFlags, QWidget.RenderFlag] = QWidget.RenderFlags(QWidget.RenderFlag.DrawWindowBackground | QWidget.RenderFlag.DrawChildren))

render(self, QPainter, targetOffset: QPoint = QPoint(), sourceRegion: QRegion = QRegion(), flags: Union[QWidget.RenderFlags, QWidget.RenderFlag] = QWidget.RenderFlags(QWidget.RenderFlag.DrawWindowBackground | QWidget.RenderFlag.DrawChildren)) → None

repaint(self)

ImagePlot.repaint(self, int, int, int, int) -> None

repaint(self, QRect) → None

repaint(self, QRegion) → None

replot()

Redraw the plot

If the autoReplot option is not set (which is the default) or if any curves are attached to raw data, the plot has to be refreshed explicitly in order to make changes visible.

See also

updateAxes(), setAutoReplot()

resize(self, QSize)

ImagePlot.resize(self, int, int) -> None

restoreGeometry(self, Union[QByteArray, bytes, bytearray]) → bool

restore_items(iofile)

Restore items from file using the pickle protocol

• iofile: file object or filename

See also guiqwt.baseplot.BasePlot.save_items()

saveGeometry(self) → QByteArray

save_items(iofile, selected=False)

Save (serializable) items to file using the pickle protocol

• iofile: file object or filename

• selected=False: if True, will save only selected items

See also guiqwt.baseplot.BasePlot.restore_items()

save_widget(fname)

Grab widget’s window and save it to filename (*.png, *.pdf)

screen(self) → QScreen

ImagePlot.scroll(self, int, int)

ImagePlot.scroll(self, int, int, QRect) -> None

select_all()

Select all selectable items

select_item(item)

Select item

select_some_items(items)

Select items

sender(self) → QObject

senderSignalIndex(self) → int

serialize(writer, selected=False)

Save (serializable) items to HDF5 file:

• writer: guidata.hdf5io.HDF5Writer object

• selected=False: if True, will save only selected items

See also guiqwt.baseplot.BasePlot.restore_items_from_hdf5()

setAcceptDrops(self, bool)

setAccessibleDescription(self, str)

setAccessibleName(self, str)

setAttribute(self, Qt.WidgetAttribute, on: bool = True)

setAutoDelete(autoDelete)

En/Disable Auto deletion

If Auto deletion is on all attached plot items will be deleted in the destructor of QwtPlotDict. The default value is on.

Parameters

autoDelete (bool) – enable/disable

See also

autoDelete(), insertItem()

setAutoFillBackground(self, bool)

setAutoReplot(tf=True)

Set or reset the autoReplot option

If the autoReplot option is set, the plot will be updated implicitly by manipulating member functions. Since this may be time-consuming, it is recommended to leave this option switched off and call replot() explicitly if necessary.

The autoReplot option is set to false by default, which means that the user has to call replot() in order to make changes visible.

Parameters

tf (bool) – True or False. Defaults to True.

See also

autoReplot()

setAxisAutoScale(axisId, on=True)

Enable autoscaling for a specified axis

This member function is used to switch back to autoscaling mode after a fixed scale has been set. Autoscaling is enabled by default.

Parameters

• axisId (int) – Axis index

• on (bool) – On/Off

See also

setAxisScale(), setAxisScaleDiv(), updateAxes()

Note

The autoscaling flag has no effect until updateAxes() is executed ( called by replot() ).

setAxisFont(axisId, font)

Change the font of an axis

Parameters

• axisId (int) – Axis index

• font (QFont) – Font

Warning

This function changes the font of the tick labels, not of the axis title.

setAxisLabelAlignment(axisId, alignment)

Change the alignment of the tick labels

Parameters

• axisId (int) – Axis index

• alignment (Qt.Alignment) – Or’d Qt.AlignmentFlags

See also

qwt.scale_draw.QwtScaleDraw.setLabelAlignment()

setAxisLabelAutoSize(axisId, state)

Set tick labels automatic size option (default: on)

Parameters

• axisId (int) – Axis index

• state (bool) – On/off

See also

qwt.scale_draw.QwtScaleDraw.setLabelAutoSize()

setAxisLabelRotation(axisId, rotation)

Rotate all tick labels

Parameters

• axisId (int) – Axis index

• rotation (float) – Angle in degrees. When changing the label rotation, the label alignment might be adjusted too.

See also

setLabelRotation(), setAxisLabelAlignment()

setAxisMaxMajor(axisId, maxMajor)

Set the maximum number of major scale intervals for a specified axis

Parameters

• axisId (int) – Axis index

• maxMajor (int) – Maximum number of major steps

See also

axisMaxMajor()

setAxisMaxMinor(axisId, maxMinor)

Set the maximum number of minor scale intervals for a specified axis

Parameters

• axisId (int) – Axis index

• maxMinor (int) – Maximum number of minor steps

See also

axisMaxMinor()

setAxisScale(axisId, min_, max_, stepSize=0)

Disable autoscaling and specify a fixed scale for a selected axis.

In updateAxes() the scale engine calculates a scale division from the specified parameters, that will be assigned to the scale widget. So updates of the scale widget usually happen delayed with the next replot.

Parameters

• axisId (int) – Axis index

• min (float) – Minimum of the scale

• max (float) – Maximum of the scale

• stepSize (float) – Major step size. If <code>step == 0</code>, the step size is calculated automatically using the maxMajor setting.

See also

setAxisMaxMajor(), setAxisAutoScale(), axisStepSize(), qwt.scale_engine.QwtScaleEngine.divideScale()

setAxisScaleDiv(axisId, scaleDiv)

Disable autoscaling and specify a fixed scale for a selected axis.

The scale division will be stored locally only until the next call of updateAxes(). So updates of the scale widget usually happen delayed with the next replot.

Parameters

• axisId (int) – Axis index

• scaleDiv (qwt.scale_div.QwtScaleDiv) – Scale division

See also

setAxisScale(), setAxisAutoScale()

setAxisScaleDraw(axisId, scaleDraw)

Set a scale draw

Parameters

• axisId (int) – Axis index

• scaleDraw (qwt.scale_draw.QwtScaleDraw) – Object responsible for drawing scales.

By passing scaleDraw it is possible to extend QwtScaleDraw functionality and let it take place in QwtPlot. Please note that scaleDraw has to be created with new and will be deleted by the corresponding QwtScale member ( like a child object ).

See also

qwt.scale_draw.QwtScaleDraw, qwt.scale_widget.QwtScaleWigdet

Warning

The attributes of scaleDraw will be overwritten by those of the previous QwtScaleDraw.

setAxisScaleEngine(axisId, scaleEngine)

Change the scale engine for an axis

Parameters

• axisId (int) – Axis index

• scaleEngine (qwt.scale_engine.QwtScaleEngine) – Scale engine

See also

axisScaleEngine()

setAxisTitle(axisId, title)

Change the title of a specified axis

Parameters

• axisId (int) – Axis index

• title (qwt.text.QwtText or str) – axis title

setBackgroundRole(self, QPalette.ColorRole)

ImagePlot.setBaseSize(self, int, int)

setBaseSize(self, QSize) → None

setCanvas(canvas)

Set the drawing canvas of the plot widget.

The default canvas is a QwtPlotCanvas.

Parameters

canvas (QWidget) – Canvas Widget

See also

canvas()

setCanvasBackground(brush)

Change the background of the plotting area

Sets brush to QPalette.Window of all color groups of the palette of the canvas. Using canvas().setPalette() is a more powerful way to set these colors.

Parameters

brush (QBrush) – New background brush

See also

canvasBackground()

ImagePlot.setContentsMargins(self, int, int, int, int)

setContentsMargins(self, QMargins) → None

setContextMenuPolicy(self, Qt.ContextMenuPolicy)

setCursor(self, Union[QCursor, Qt.CursorShape])

setDisabled(self, bool)

setEnabled(self, bool)

setFixedHeight(self, int)

setFixedSize(self, QSize)

ImagePlot.setFixedSize(self, int, int) -> None

setFixedWidth(self, int)

setFlatStyle(state)

Set or reset the flatStyle option

If the flatStyle option is set, the plot will be rendered without any margin (scales, canvas, layout).

Enabling this option makes the plot look flat and compact.

The flatStyle option is set to True by default.

Parameters

state (bool) – True or False.

See also

flatStyle()

setFocus(self)

setFocus(self, Qt.FocusReason) → None

setFocusPolicy(self, Qt.FocusPolicy)

setFocusProxy(self, QWidget)

setFont(self, QFont)

setFooter(text)

Change the text the footer

Parameters

text (str or qwt.text.QwtText) – New text of the footer

See also

footer()

setForegroundRole(self, QPalette.ColorRole)

setFrameRect(self, QRect)

setFrameShadow(self, QFrame.Shadow)

setFrameShape(self, QFrame.Shape)

setFrameStyle(self, int)

setGeometry(self, QRect)

ImagePlot.setGeometry(self, int, int, int, int) -> None

setGraphicsEffect(self, QGraphicsEffect)

setHidden(self, bool)

setInputMethodHints(self, Union[Qt.InputMethodHints, Qt.InputMethodHint])

setLayout(self, QLayout)

setLayoutDirection(self, Qt.LayoutDirection)

setLineWidth(self, int)

setLocale(self, QLocale)

setMask(self, QBitmap)

setMask(self, QRegion) → None

setMaximumHeight(self, int)

ImagePlot.setMaximumSize(self, int, int)

setMaximumSize(self, QSize) → None

setMaximumWidth(self, int)

setMidLineWidth(self, int)

setMinimumHeight(self, int)

ImagePlot.setMinimumSize(self, int, int)

setMinimumSize(self, QSize) → None

setMinimumWidth(self, int)

setMouseTracking(self, bool)

setObjectName(self, str)

setPalette(self, QPalette)

setParent(self, QWidget)

setParent(self, QWidget, Union[Qt.WindowFlags, Qt.WindowType]) → None

setPlotLayout(layout)

Assign a new plot layout

Parameters

layout (qwt.plot_layout.QwtPlotLayout) – Layout

See also

plotLayout()

setProperty(self, str, Any) → bool

setShortcutAutoRepeat(self, int, enabled: bool = True)

setShortcutEnabled(self, int, enabled: bool = True)

ImagePlot.setSizeIncrement(self, int, int)

setSizeIncrement(self, QSize) → None

setSizePolicy(self, QSizePolicy)

setSizePolicy(self, QSizePolicy.Policy, QSizePolicy.Policy) → None

setStatusTip(self, str)

setStyle(self, QStyle)

setStyleSheet(self, str)

ImagePlot.setTabOrder(QWidget, QWidget)

setTabletTracking(self, bool)

setTitle(title)

Change the plot’s title

Parameters

title (str or qwt.text.QwtText) – New title

See also

title()

setToolTip(self, str)

setToolTipDuration(self, int)

setUpdatesEnabled(self, bool)

setVisible(self, bool)

setWhatsThis(self, str)

setWindowFilePath(self, str)

setWindowFlag(self, Qt.WindowType, on: bool = True)

setWindowFlags(self, Union[Qt.WindowFlags, Qt.WindowType])

setWindowIcon(self, QIcon)

setWindowIconText(self, str)

setWindowModality(self, Qt.WindowModality)

setWindowModified(self, bool)

setWindowOpacity(self, float)

setWindowRole(self, str)

setWindowState(self, Union[Qt.WindowStates, Qt.WindowState])

setWindowTitle(self, str)

set_antialiasing(checked)

Toggle curve antialiasing

set_axis_color(axis_id, color)

Set axis color color: color name (string) or QColor instance

set_axis_direction(axis_id, reverse=False)

Set axis direction of increasing values

• axis_id: axis id (BasePlot.Y_LEFT, BasePlot.X_BOTTOM, …) or string: ‘bottom’, ‘left’, ‘top’ or ‘right’

• reverse: False (default)

  • x-axis values increase from left to right

  • y-axis values increase from bottom to top

• reverse: True

  • x-axis values increase from right to left

  • y-axis values increase from top to bottom

set_axis_font(axis_id, font)

Set axis font

set_axis_limits(axis_id, vmin, vmax, stepsize=0)

Set axis limits (minimum and maximum values)

set_axis_scale(axis_id, scale, autoscale=True)

Set axis scale Example: self.set_axis_scale(curve.yAxis(), ‘lin’)

set_axis_ticks(axis_id, nmajor=None, nminor=None)

Set axis maximum number of major ticks and maximum of minor ticks

set_axis_title(axis_id, text)

Set axis title

set_axis_unit(axis_id, text)

Set axis unit

set_item_parameters(itemparams)

Set item (plot, here) parameters

set_item_visible(item, state, notify=True, replot=True)

Show/hide item and emit a SIG_ITEMS_CHANGED signal

set_items(*args)

Utility function used to quickly setup a plot with a set of items

set_items_readonly(state)

Set all items readonly state to state Default item’s readonly state: False (items may be deleted)

set_manager(manager, plot_id)

Set the associated guiqwt.plot.PlotManager instance

set_plot_limits(x0, x1, y0, y1, xaxis='bottom', yaxis='left')

Set plot scale limits

set_pointer(pointer_type)

Set pointer.

Valid values of pointer_type:

• None: disable pointer

• “canvas”: enable canvas pointer

• “curve”: enable on-curve pointer

set_scales(xscale, yscale)

Set active curve scales Example: self.set_scales(‘lin’, ‘lin’)

set_title(title)

Set plot title

set_titles(title=None, xlabel=None, ylabel=None, xunit=None, yunit=None)

Set plot and axes titles at once

• title: plot title

• xlabel: (bottom axis title, top axis title) or bottom axis title only

• ylabel: (left axis title, right axis title) or left axis title only

• xunit: (bottom axis unit, top axis unit) or bottom axis unit only

• yunit: (left axis unit, right axis unit) or left axis unit only

sharedPainter(self) → QPainter

show(self)

showFullScreen(self)

showMaximized(self)

showMinimized(self)

showNormal(self)

show_items(items=None, item_type=None)

Show items (if items is None, show all items)

signalsBlocked(self) → bool

size(self) → QSize

sizeHint()

Preferred size

sizeIncrement(self) → QSize

sizePolicy(self) → QSizePolicy

stackUnder(self, QWidget)

startTimer(self, int, timerType: Qt.TimerType = Qt.CoarseTimer) → int

statusTip(self) → str

style(self) → QStyle

styleSheet(self) → str

tabletEvent(self, QTabletEvent)

testAttribute(self, Qt.WidgetAttribute) → bool

thread(self) → QThread

timerEvent(self, QTimerEvent)

title()

Returns

Title of the plot

See also

setTitle()

titleLabel()

Returns

Title label widget.

toolTip(self) → str

toolTipDuration(self) → int

tr(self, str, disambiguation: str = None, n: int = - 1) → str

transform(axisId, value)

Transform a value into a coordinate in the plotting region

Parameters

• axisId (int) – Axis index

• value (fload) – Value

Returns

X or Y coordinate in the plotting region corresponding to the value.

underMouse(self) → bool

ungrabGesture(self, Qt.GestureType)

unselect_all()

Unselect all selected items

unselect_item(item)

Unselect item

unsetCursor(self)

unsetLayoutDirection(self)

unsetLocale(self)

update(self)

update(self, QRect) → None

update(self, QRegion) → None

ImagePlot.update(self, int, int, int, int) -> None

updateAxes()

Rebuild the axes scales

In case of autoscaling the boundaries of a scale are calculated from the bounding rectangles of all plot items, having the QwtPlotItem.AutoScale flag enabled (QwtScaleEngine.autoScale()). Then a scale division is calculated (QwtScaleEngine.didvideScale()) and assigned to scale widget.

When the scale boundaries have been assigned with setAxisScale() a scale division is calculated (QwtScaleEngine.didvideScale()) for this interval and assigned to the scale widget.

When the scale has been set explicitly by setAxisScaleDiv() the locally stored scale division gets assigned to the scale widget.

The scale widget indicates modifications by emitting a QwtScaleWidget.scaleDivChanged() signal.

updateAxes() is usually called by replot().

See also

setAxisAutoScale(), setAxisScale(), setAxisScaleDiv(), replot(), QwtPlotItem.boundingRect()

updateCanvasMargins()

Update the canvas margins

Plot items might indicate, that they need some extra space at the borders of the canvas by the QwtPlotItem.Margins flag.

See also

getCanvasMarginsHint(), QwtPlotItem.getCanvasMarginHint()

updateGeometry(self)

updateLayout()

Adjust plot content to its current size.

See also

resizeEvent()

updateLegend(plotItem=None)

If plotItem is None, emit QwtPlot.legendDataChanged for all plot item. Otherwise, emit the signal for passed plot item.

Parameters

plotItem (qwt.plot.QwtPlotItem) – Plot item

See also

QwtPlotItem.legendData(), QwtPlot.legendDataChanged

updateLegendItems(plotItem, legendData)

Update all plot items interested in legend attributes

Call QwtPlotItem.updateLegend(), when the QwtPlotItem.LegendInterest flag is set.

Parameters

• plotItem (qwt.plot.QwtPlotItem) – Plot item

• legendData (list) – Entries to be displayed for the plot item ( usually 1 )

See also

QwtPlotItem.LegendInterest(), QwtPlotItem.updateLegend()

updateMicroFocus(self)

update_all_axes_styles()

Update all axes styles

update_axis_style(axis_id)

Update axis style

updatesEnabled(self) → bool

visibleRegion(self) → QRegion

whatsThis(self) → str

wheelEvent(self, QWheelEvent)

width(self) → int

widthMM(self) → int

winId(self) → PyQt5.sip.voidptr

window(self) → QWidget

windowFilePath(self) → str

windowFlags(self) → Qt.WindowFlags

windowHandle(self) → QWindow

windowIcon(self) → QIcon

windowIconText(self) → str

windowModality(self) → Qt.WindowModality

windowOpacity(self) → float

windowRole(self) → str

windowState(self) → Qt.WindowStates

windowTitle(self) → str

windowType(self) → Qt.WindowType

x(self) → int

y(self) → int

class guiqwt.image.BaseImageItem(data=None, param=None)

get_default_param()

Return instance of the default imageparam DataSet

get_filter(filterobj, filterparam)

Provides a filter object over this image’s content

get_pixel_coordinates(xplot, yplot)

Return (image) pixel coordinates Transform the plot coordinates (arbitrary plot Z-axis unit) into the image coordinates (pixel unit)

Rounding is necessary to obtain array indexes from these coordinates

get_plot_coordinates(xpixel, ypixel)

Return plot coordinates Transform the image coordinates (pixel unit) into the plot coordinates (arbitrary plot Z-axis unit)

get_closest_indexes(x, y, corner=None)

Return closest image pixel indexes corner: None (not a corner), ‘TL’ (top-left corner), ‘BR’ (bottom-right corner)

get_closest_index_rect(x0, y0, x1, y1)

Return closest image rectangular pixel area index bounds Avoid returning empty rectangular area (return 1x1 pixel area instead) Handle reversed/not-reversed Y-axis orientation

align_rectangular_shape(shape)

Align rectangular shape to image pixels

get_closest_pixel_indexes(x, y)

Return closest pixel indexes Instead of returning indexes of an image pixel like the method ‘get_closest_indexes’, this method returns the indexes of the closest pixel which is not necessarily on the image itself (i.e. indexes may be outside image index bounds: negative or superior than the image dimension)

Note

This is not the same as retrieving the canvas pixel coordinates (which depends on the zoom level)

get_data(x0, y0, x1=None, y1=None)

Return image data Arguments: x0, y0 [, x1, y1] Return image level at coordinates (x0,y0)

If x1,y1 are specified:

Return image levels (np.ndarray) in rectangular area (x0,y0,x1,y1)

get_closest_coordinates(x, y)

Return closest image pixel coordinates

set_interpolation(interp_mode, size=None)

Set image interpolation mode

interp_mode: INTERP_NEAREST, INTERP_LINEAR, INTERP_AA size (integer): (for anti-aliasing only) AA matrix size

get_interpolation()

Get interpolation mode

set_lut_range(lut_range)

Set LUT transform range lut_range is a tuple: (min, max)

get_lut_range()

Return the LUT transform range tuple: (min, max)

get_lut_range_full()

Return full dynamic range

get_lut_range_max()

Get maximum range for this dataset

update_border()

Update image border rectangle to fit image shape

draw_border(painter, xMap, yMap, canvasRect)

Draw image border rectangle

draw_image(painter, canvasRect, src_rect, dst_rect, xMap, yMap)

Draw image with painter on canvasRect

Warning

src_rect and dst_rect are coordinates tuples (xleft, ytop, xright, ybottom)

export_roi(src_rect, dst_rect, dst_image, apply_lut=False, apply_interpolation=False, original_resolution=False)

Export Region Of Interest to array

boundingRect()

Returns

An invalid bounding rect: QRectF(1.0, 1.0, -2.0, -2.0)

Note

A width or height < 0.0 is ignored by the autoscaler

setVisible(enable)

Show/Hide the item

Parameters

on (bool) – Show if True, otherwise hide

See also

isVisible(), show(), hide()

set_readonly(state)

Set object readonly state

is_readonly()

Return object readonly state

set_private(state)

Set object as private

is_private()

Return True if object is private

select()

Select item

unselect()

Unselect item

is_empty()

Return True if item data is empty

set_selectable(state)

Set item selectable state

set_resizable(state)

Set item resizable state (or any action triggered when moving an handle, e.g. rotation)

set_movable(state)

Set item movable state

set_rotatable(state)

Set item rotatable state

move_local_point_to(handle, pos, ctrl=None)

Move a handle as returned by hit_test to the new position pos ctrl: True if <Ctrl> button is being pressed, False otherwise

move_local_shape(old_pos, new_pos)

Translate the shape such that old_pos becomes new_pos in canvas coordinates

move_with_selection(delta_x, delta_y)

Translate the shape together with other selected items delta_x, delta_y: translation in plot coordinates

get_histogram(nbins)

interface de IHistDataSource

get_stats(x0, y0, x1, y1)

Return formatted string with stats on image rectangular area (output should be compatible with AnnotatedShape.get_infos)

get_xsection(y0, apply_lut=False)

Return cross section along x-axis at y=y0

get_ysection(x0, apply_lut=False)

Return cross section along y-axis at x=x0

get_average_xsection(x0, y0, x1, y1, apply_lut=False)

Return average cross section along x-axis

get_average_ysection(x0, y0, x1, y1, apply_lut=False)

Return average cross section along y-axis

attach(plot)

Attach the item to a plot.

This method will attach a QwtPlotItem to the QwtPlot argument. It will first detach the QwtPlotItem from any plot from a previous call to attach (if necessary). If a None argument is passed, it will detach from any QwtPlot it was attached to.

Parameters

plot (qwt.plot.QwtPlot) – Plot widget

See also

detach()

detach()

Detach the item from a plot.

This method detaches a QwtPlotItem from any QwtPlot it has been associated with.

See also

attach()

getCanvasMarginHint(xMap, yMap, canvasRect)

Calculate a hint for the canvas margin

When the QwtPlotItem::Margins flag is enabled the plot item indicates, that it needs some margins at the borders of the canvas. This is f.e. used by bar charts to reserve space for displaying the bars.

The margins are in target device coordinates ( pixels on screen )

Parameters

• xMap (qwt.scale_map.QwtScaleMap) – Maps x-values into pixel coordinates.

• yMap (qwt.scale_map.QwtScaleMap) – Maps y-values into pixel coordinates.

• canvasRect (QRectF) – Contents rectangle of the canvas in painter coordinates

See also

QwtPlot.getCanvasMarginsHint(), QwtPlot.updateCanvasMargins(),

hide()

Hide the item

icon()

Returns

Icon of the item

See also

setIcon()

isVisible()

Returns

True if visible

See also

setVisible(), show(), hide()

itemChanged()

Update the legend and call QwtPlot.autoRefresh() for the parent plot.

See also

QwtPlot.legendChanged(), QwtPlot.autoRefresh()

legendChanged()

Update the legend of the parent plot.

See also

QwtPlot.updateLegend(), itemChanged()

legendData()

Return all information, that is needed to represent the item on the legend

QwtLegendData is basically a list of QVariants that makes it possible to overload and reimplement legendData() to return almost any type of information, that is understood by the receiver that acts as the legend.

The default implementation returns one entry with the title() of the item and the legendIcon().

Returns

Data, that is needed to represent the item on the legend

See also

title(), legendIcon(), qwt.legend.QwtLegend

legendIcon(index, size)

Parameters

• index (int) – Index of the legend entry (usually there is only one)

• size (QSizeF) – Icon size

Returns

Icon representing the item on the legend

The default implementation returns an invalid icon

See also

setLegendIconSize(), legendData()

legendIconSize()

Returns

Legend icon size

See also

setLegendIconSize(), legendIcon()

paintRect(xMap, yMap)

Calculate the bounding paint rectangle of 2 maps

Parameters

• xMap (qwt.scale_map.QwtScaleMap) – Maps x-values into pixel coordinates.

• yMap (qwt.scale_map.QwtScaleMap) – Maps y-values into pixel coordinates.

Returns

Bounding paint rectangle of the scale maps, not normalized

plot()

Returns

attached plot

rtti()

Return rtti for the specific class represented. QwtPlotItem is simply a virtual interface class, and base classes will implement this method with specific rtti values so a user can differentiate them.

Returns

rtti value

scaleRect(xMap, yMap)

Calculate the bounding scale rectangle of 2 maps

Parameters

• xMap (qwt.scale_map.QwtScaleMap) – Maps x-values into pixel coordinates.

• yMap (qwt.scale_map.QwtScaleMap) – Maps y-values into pixel coordinates.

Returns

Bounding scale rect of the scale maps, not normalized

setAxes(xAxis, yAxis)

Set X and Y axis

The item will painted according to the coordinates of its Axes.

Parameters

• xAxis (int) – X Axis (QwtPlot.xBottom or QwtPlot.xTop)

• yAxis (int) – Y Axis (QwtPlot.yLeft or QwtPlot.yRight)

See also

setXAxis(), setYAxis(), xAxis(), yAxis()

setAxis(xAxis, yAxis)

Set X and Y axis

Warning

setAxis has been removed in Qwt6: please use setAxes() instead

setIcon(icon)

Set item icon

Parameters

icon (QIcon) – Icon

See also

icon()

setItemAttribute(attribute, on=True)

Toggle an item attribute

Parameters

• attribute (int) – Attribute type

• on (bool) – True/False

See also

testItemAttribute()

setItemInterest(interest, on=True)

Toggle an item interest

Parameters

• attribute (int) – Interest type

• on (bool) – True/False

See also

testItemInterest()

setLegendIconSize(size)

Set the size of the legend icon

The default setting is 8x8 pixels

Parameters

size (QSize) – Size

See also

legendIconSize(), legendIcon()

setRenderHint(hint, on=True)

Toggle a render hint

Parameters

• hint (int) – Render hint

• on (bool) – True/False

See also

testRenderHint()

setTitle(title)

Set a new title

Parameters

title (qwt.text.QwtText or str) – Title

See also

title()

setXAxis(axis)

Set the X axis

The item will painted according to the coordinates its Axes.

Parameters

axis (int) – X Axis (QwtPlot.xBottom or QwtPlot.xTop)

See also

setAxes(), setYAxis(), xAxis(), yAxis()

setYAxis(axis)

Set the Y axis

The item will painted according to the coordinates its Axes.

Parameters

axis (int) – Y Axis (QwtPlot.yLeft or QwtPlot.yRight)

See also

setAxes(), setXAxis(), xAxis(), yAxis()

setZ(z)

Set the z value

Plot items are painted in increasing z-order.

Parameters

z (float) – Z-value

See also

z(), QwtPlotDict.itemList()

show()

Show the item

testItemAttribute(attribute)

Test an item attribute

Parameters

attribute (int) – Attribute type

Returns

True/False

See also

setItemAttribute()

testItemInterest(interest)

Test an item interest

Parameters

attribute (int) – Interest type

Returns

True/False

See also

setItemInterest()

testRenderHint(hint)

Test a render hint

Parameters

attribute (int) – Render hint

Returns

True/False

See also

setRenderHint()

title()

Returns

Title of the item

See also

setTitle()

updateLegend(item, data)

Update the item to changes of the legend info

Plot items that want to display a legend ( not those, that want to be displayed on a legend ! ) will have to implement updateLegend().

updateLegend() is only called when the LegendInterest interest is enabled. The default implementation does nothing.

Parameters

• item (qwt.plot.QwtPlotItem) – Plot item to be displayed on a legend

• data (list) – Attributes how to display item on the legend

Note

Plot items, that want to be displayed on a legend need to enable the QwtPlotItem.Legend flag and to implement legendData() and legendIcon()

xAxis()

Returns

xAxis

yAxis()

Returns

yAxis

z()

Plot items are painted in increasing z-order.

Returns

item z order

See also

setZ(), QwtPlotDict.itemList()

class guiqwt.image.RawImageItem(data=None, param=None)

Construct a simple image item

• data: 2D NumPy array

• param (optional): image parameters (guiqwt.styles.RawImageParam instance)

get_default_param()

Return instance of the default imageparam DataSet

serialize(writer)

Serialize object to HDF5 writer

deserialize(reader)

Deserialize object from HDF5 reader

load_data(lut_range=None)

Load data from filename and eventually apply specified lut_range filename has been set using method ‘set_filename’

set_data(data, lut_range=None)

Set Image item data

• data: 2D NumPy array

• lut_range: LUT range – tuple (levelmin, levelmax)

align_rectangular_shape(shape)

Align rectangular shape to image pixels

attach(plot)

Attach the item to a plot.

This method will attach a QwtPlotItem to the QwtPlot argument. It will first detach the QwtPlotItem from any plot from a previous call to attach (if necessary). If a None argument is passed, it will detach from any QwtPlot it was attached to.

Parameters

plot (qwt.plot.QwtPlot) – Plot widget

See also

detach()

boundingRect()

Returns

An invalid bounding rect: QRectF(1.0, 1.0, -2.0, -2.0)

Note

A width or height < 0.0 is ignored by the autoscaler

detach()

Detach the item from a plot.

This method detaches a QwtPlotItem from any QwtPlot it has been associated with.

See also

attach()

draw_border(painter, xMap, yMap, canvasRect)

Draw image border rectangle

draw_image(painter, canvasRect, src_rect, dst_rect, xMap, yMap)

Draw image with painter on canvasRect

Warning

src_rect and dst_rect are coordinates tuples (xleft, ytop, xright, ybottom)

export_roi(src_rect, dst_rect, dst_image, apply_lut=False, apply_interpolation=False, original_resolution=False)

Export Region Of Interest to array

getCanvasMarginHint(xMap, yMap, canvasRect)

Calculate a hint for the canvas margin

When the QwtPlotItem::Margins flag is enabled the plot item indicates, that it needs some margins at the borders of the canvas. This is f.e. used by bar charts to reserve space for displaying the bars.

The margins are in target device coordinates ( pixels on screen )

Parameters

• xMap (qwt.scale_map.QwtScaleMap) – Maps x-values into pixel coordinates.

• yMap (qwt.scale_map.QwtScaleMap) – Maps y-values into pixel coordinates.

• canvasRect (QRectF) – Contents rectangle of the canvas in painter coordinates

See also

QwtPlot.getCanvasMarginsHint(), QwtPlot.updateCanvasMargins(),

get_average_xsection(x0, y0, x1, y1, apply_lut=False)

Return average cross section along x-axis

get_average_ysection(x0, y0, x1, y1, apply_lut=False)

Return average cross section along y-axis

get_closest_coordinates(x, y)

Return closest image pixel coordinates

get_closest_index_rect(x0, y0, x1, y1)

Return closest image rectangular pixel area index bounds Avoid returning empty rectangular area (return 1x1 pixel area instead) Handle reversed/not-reversed Y-axis orientation

get_closest_indexes(x, y, corner=None)

Return closest image pixel indexes corner: None (not a corner), ‘TL’ (top-left corner), ‘BR’ (bottom-right corner)

get_closest_pixel_indexes(x, y)

Return closest pixel indexes Instead of returning indexes of an image pixel like the method ‘get_closest_indexes’, this method returns the indexes of the closest pixel which is not necessarily on the image itself (i.e. indexes may be outside image index bounds: negative or superior than the image dimension)

Note

This is not the same as retrieving the canvas pixel coordinates (which depends on the zoom level)

get_data(x0, y0, x1=None, y1=None)

Return image data Arguments: x0, y0 [, x1, y1] Return image level at coordinates (x0,y0)

If x1,y1 are specified:

Return image levels (np.ndarray) in rectangular area (x0,y0,x1,y1)

get_filter(filterobj, filterparam)

Provides a filter object over this image’s content

get_histogram(nbins)

interface de IHistDataSource

get_interpolation()

Get interpolation mode

get_lut_range()

Return the LUT transform range tuple: (min, max)

get_lut_range_full()

Return full dynamic range

get_lut_range_max()

Get maximum range for this dataset

get_pixel_coordinates(xplot, yplot)

Return (image) pixel coordinates Transform the plot coordinates (arbitrary plot Z-axis unit) into the image coordinates (pixel unit)

Rounding is necessary to obtain array indexes from these coordinates

get_plot_coordinates(xpixel, ypixel)

Return plot coordinates Transform the image coordinates (pixel unit) into the plot coordinates (arbitrary plot Z-axis unit)

get_stats(x0, y0, x1, y1)

Return formatted string with stats on image rectangular area (output should be compatible with AnnotatedShape.get_infos)

get_xsection(y0, apply_lut=False)

Return cross section along x-axis at y=y0

get_ysection(x0, apply_lut=False)

Return cross section along y-axis at x=x0

hide()

Hide the item

icon()

Returns

Icon of the item

See also

setIcon()

isVisible()

Returns

True if visible

See also

setVisible(), show(), hide()

is_empty()

Return True if item data is empty

is_private()

Return True if object is private

is_readonly()

Return object readonly state

itemChanged()

Update the legend and call QwtPlot.autoRefresh() for the parent plot.

See also

QwtPlot.legendChanged(), QwtPlot.autoRefresh()

legendChanged()

Update the legend of the parent plot.

See also

QwtPlot.updateLegend(), itemChanged()

legendData()

Return all information, that is needed to represent the item on the legend

QwtLegendData is basically a list of QVariants that makes it possible to overload and reimplement legendData() to return almost any type of information, that is understood by the receiver that acts as the legend.

The default implementation returns one entry with the title() of the item and the legendIcon().

Returns

Data, that is needed to represent the item on the legend

See also

title(), legendIcon(), qwt.legend.QwtLegend

legendIcon(index, size)

Parameters

• index (int) – Index of the legend entry (usually there is only one)

• size (QSizeF) – Icon size

Returns

Icon representing the item on the legend

The default implementation returns an invalid icon

See also

setLegendIconSize(), legendData()

legendIconSize()

Returns

Legend icon size

See also

setLegendIconSize(), legendIcon()

move_local_point_to(handle, pos, ctrl=None)

Move a handle as returned by hit_test to the new position pos ctrl: True if <Ctrl> button is being pressed, False otherwise

move_local_shape(old_pos, new_pos)

Translate the shape such that old_pos becomes new_pos in canvas coordinates

move_with_selection(delta_x, delta_y)

Translate the shape together with other selected items delta_x, delta_y: translation in plot coordinates

paintRect(xMap, yMap)

Calculate the bounding paint rectangle of 2 maps

Parameters

• xMap (qwt.scale_map.QwtScaleMap) – Maps x-values into pixel coordinates.

• yMap (qwt.scale_map.QwtScaleMap) – Maps y-values into pixel coordinates.

Returns

Bounding paint rectangle of the scale maps, not normalized

plot()

Returns

attached plot

rtti()

Return rtti for the specific class represented. QwtPlotItem is simply a virtual interface class, and base classes will implement this method with specific rtti values so a user can differentiate them.

Returns

rtti value

scaleRect(xMap, yMap)

Calculate the bounding scale rectangle of 2 maps

Parameters

• xMap (qwt.scale_map.QwtScaleMap) – Maps x-values into pixel coordinates.

• yMap (qwt.scale_map.QwtScaleMap) – Maps y-values into pixel coordinates.

Returns

Bounding scale rect of the scale maps, not normalized

select()

Select item

setAxes(xAxis, yAxis)

Set X and Y axis

The item will painted according to the coordinates of its Axes.

Parameters

• xAxis (int) – X Axis (QwtPlot.xBottom or QwtPlot.xTop)

• yAxis (int) – Y Axis (QwtPlot.yLeft or QwtPlot.yRight)

See also

setXAxis(), setYAxis(), xAxis(), yAxis()

setAxis(xAxis, yAxis)

Set X and Y axis

Warning

setAxis has been removed in Qwt6: please use setAxes() instead

setIcon(icon)

Set item icon

Parameters

icon (QIcon) – Icon

See also

icon()

setItemAttribute(attribute, on=True)

Toggle an item attribute

Parameters

• attribute (int) – Attribute type

• on (bool) – True/False

See also

testItemAttribute()

setItemInterest(interest, on=True)

Toggle an item interest

Parameters

• attribute (int) – Interest type

• on (bool) – True/False

See also

testItemInterest()

setLegendIconSize(size)

Set the size of the legend icon

The default setting is 8x8 pixels

Parameters

size (QSize) – Size

See also

legendIconSize(), legendIcon()

setRenderHint(hint, on=True)

Toggle a render hint

Parameters

• hint (int) – Render hint

• on (bool) – True/False

See also

testRenderHint()

setTitle(title)

Set a new title

Parameters

title (qwt.text.QwtText or str) – Title

See also

title()

setVisible(enable)

Show/Hide the item

Parameters

on (bool) – Show if True, otherwise hide

See also

isVisible(), show(), hide()

setXAxis(axis)

Set the X axis

The item will painted according to the coordinates its Axes.

Parameters

axis (int) – X Axis (QwtPlot.xBottom or QwtPlot.xTop)

See also

setAxes(), setYAxis(), xAxis(), yAxis()

setYAxis(axis)

Set the Y axis

The item will painted according to the coordinates its Axes.

Parameters

axis (int) – Y Axis (QwtPlot.yLeft or QwtPlot.yRight)

See also

setAxes(), setXAxis(), xAxis(), yAxis()

setZ(z)

Set the z value

Plot items are painted in increasing z-order.

Parameters

z (float) – Z-value

See also

z(), QwtPlotDict.itemList()

set_interpolation(interp_mode, size=None)

Set image interpolation mode

interp_mode: INTERP_NEAREST, INTERP_LINEAR, INTERP_AA size (integer): (for anti-aliasing only) AA matrix size

set_lut_range(lut_range)

Set LUT transform range lut_range is a tuple: (min, max)

set_movable(state)

Set item movable state

set_private(state)

Set object as private

set_readonly(state)

Set object readonly state

set_resizable(state)

Set item resizable state (or any action triggered when moving an handle, e.g. rotation)

set_rotatable(state)

Set item rotatable state

set_selectable(state)

Set item selectable state

show()

Show the item

testItemAttribute(attribute)

Test an item attribute

Parameters

attribute (int) – Attribute type

Returns

True/False

See also

setItemAttribute()

testItemInterest(interest)

Test an item interest

Parameters

attribute (int) – Interest type

Returns

True/False

See also

setItemInterest()

testRenderHint(hint)

Test a render hint

Parameters

attribute (int) – Render hint

Returns

True/False

See also

setRenderHint()

title()

Returns

Title of the item

See also

setTitle()

unselect()

Unselect item

updateLegend(item, data)

Update the item to changes of the legend info

Plot items that want to display a legend ( not those, that want to be displayed on a legend ! ) will have to implement updateLegend().

updateLegend() is only called when the LegendInterest interest is enabled. The default implementation does nothing.

Parameters

• item (qwt.plot.QwtPlotItem) – Plot item to be displayed on a legend

• data (list) – Attributes how to display item on the legend

Note

Plot items, that want to be displayed on a legend need to enable the QwtPlotItem.Legend flag and to implement legendData() and legendIcon()

update_border()

Update image border rectangle to fit image shape

xAxis()

Returns

xAxis

yAxis()

Returns

yAxis

z()

Plot items are painted in increasing z-order.

Returns

item z order

See also

setZ(), QwtPlotDict.itemList()

class guiqwt.image.ImageItem(data=None, param=None)

Construct a simple image item

• data: 2D NumPy array

• param (optional): image parameters (guiqwt.styles.ImageParam instance)

get_default_param()

Return instance of the default imageparam DataSet

serialize(writer)

Serialize object to HDF5 writer

deserialize(reader)

Deserialize object from HDF5 reader

get_xdata()

Return (xmin, xmax)

get_ydata()

Return (ymin, ymax)

get_pixel_coordinates(xplot, yplot)

Return (image) pixel coordinates (from plot coordinates)

get_plot_coordinates(xpixel, ypixel)

Return plot coordinates (from image pixel coordinates)

get_closest_coordinates(x, y)

Return closest image pixel coordinates

draw_image(painter, canvasRect, src_rect, dst_rect, xMap, yMap)

Draw image with painter on canvasRect

Warning

src_rect and dst_rect are coordinates tuples (xleft, ytop, xright, ybottom)

export_roi(src_rect, dst_rect, dst_image, apply_lut=False, apply_interpolation=False, original_resolution=False)

Export Region Of Interest to array

align_rectangular_shape(shape)

Align rectangular shape to image pixels

attach(plot)

Attach the item to a plot.

This method will attach a QwtPlotItem to the QwtPlot argument. It will first detach the QwtPlotItem from any plot from a previous call to attach (if necessary). If a None argument is passed, it will detach from any QwtPlot it was attached to.

Parameters

plot (qwt.plot.QwtPlot) – Plot widget

See also

detach()

boundingRect()

Returns

An invalid bounding rect: QRectF(1.0, 1.0, -2.0, -2.0)

Note

A width or height < 0.0 is ignored by the autoscaler

detach()

Detach the item from a plot.

This method detaches a QwtPlotItem from any QwtPlot it has been associated with.

See also

attach()

draw_border(painter, xMap, yMap, canvasRect)

Draw image border rectangle

getCanvasMarginHint(xMap, yMap, canvasRect)

Calculate a hint for the canvas margin

When the QwtPlotItem::Margins flag is enabled the plot item indicates, that it needs some margins at the borders of the canvas. This is f.e. used by bar charts to reserve space for displaying the bars.

The margins are in target device coordinates ( pixels on screen )

Parameters

• xMap (qwt.scale_map.QwtScaleMap) – Maps x-values into pixel coordinates.

• yMap (qwt.scale_map.QwtScaleMap) – Maps y-values into pixel coordinates.

• canvasRect (QRectF) – Contents rectangle of the canvas in painter coordinates

See also

QwtPlot.getCanvasMarginsHint(), QwtPlot.updateCanvasMargins(),

get_average_xsection(x0, y0, x1, y1, apply_lut=False)

Return average cross section along x-axis

get_average_ysection(x0, y0, x1, y1, apply_lut=False)

Return average cross section along y-axis

get_closest_index_rect(x0, y0, x1, y1)

Return closest image rectangular pixel area index bounds Avoid returning empty rectangular area (return 1x1 pixel area instead) Handle reversed/not-reversed Y-axis orientation

get_closest_indexes(x, y, corner=None)

Return closest image pixel indexes corner: None (not a corner), ‘TL’ (top-left corner), ‘BR’ (bottom-right corner)

get_closest_pixel_indexes(x, y)

Return closest pixel indexes Instead of returning indexes of an image pixel like the method ‘get_closest_indexes’, this method returns the indexes of the closest pixel which is not necessarily on the image itself (i.e. indexes may be outside image index bounds: negative or superior than the image dimension)

Note

This is not the same as retrieving the canvas pixel coordinates (which depends on the zoom level)

get_data(x0, y0, x1=None, y1=None)

Return image data Arguments: x0, y0 [, x1, y1] Return image level at coordinates (x0,y0)

If x1,y1 are specified:

Return image levels (np.ndarray) in rectangular area (x0,y0,x1,y1)

get_filter(filterobj, filterparam)

Provides a filter object over this image’s content

get_histogram(nbins)

interface de IHistDataSource

get_interpolation()

Get interpolation mode

get_lut_range()

Return the LUT transform range tuple: (min, max)

get_lut_range_full()

Return full dynamic range

get_lut_range_max()

Get maximum range for this dataset

get_stats(x0, y0, x1, y1)

Return formatted string with stats on image rectangular area (output should be compatible with AnnotatedShape.get_infos)

get_xsection(y0, apply_lut=False)

Return cross section along x-axis at y=y0

get_ysection(x0, apply_lut=False)

Return cross section along y-axis at x=x0

hide()

Hide the item

icon()

Returns

Icon of the item

See also

setIcon()

isVisible()

Returns

True if visible

See also

setVisible(), show(), hide()

is_empty()

Return True if item data is empty

is_private()

Return True if object is private

is_readonly()

Return object readonly state

itemChanged()

Update the legend and call QwtPlot.autoRefresh() for the parent plot.

See also

QwtPlot.legendChanged(), QwtPlot.autoRefresh()

legendChanged()

Update the legend of the parent plot.

See also

QwtPlot.updateLegend(), itemChanged()

legendData()

Return all information, that is needed to represent the item on the legend

QwtLegendData is basically a list of QVariants that makes it possible to overload and reimplement legendData() to return almost any type of information, that is understood by the receiver that acts as the legend.

The default implementation returns one entry with the title() of the item and the legendIcon().

Returns

Data, that is needed to represent the item on the legend

See also

title(), legendIcon(), qwt.legend.QwtLegend

legendIcon(index, size)

Parameters

• index (int) – Index of the legend entry (usually there is only one)

• size (QSizeF) – Icon size

Returns

Icon representing the item on the legend

The default implementation returns an invalid icon

See also

setLegendIconSize(), legendData()

legendIconSize()

Returns

Legend icon size

See also

setLegendIconSize(), legendIcon()

load_data(lut_range=None)

Load data from filename and eventually apply specified lut_range filename has been set using method ‘set_filename’

move_local_point_to(handle, pos, ctrl=None)

Move a handle as returned by hit_test to the new position pos ctrl: True if <Ctrl> button is being pressed, False otherwise

move_local_shape(old_pos, new_pos)

Translate the shape such that old_pos becomes new_pos in canvas coordinates

move_with_selection(delta_x, delta_y)

Translate the shape together with other selected items delta_x, delta_y: translation in plot coordinates

paintRect(xMap, yMap)

Calculate the bounding paint rectangle of 2 maps

Parameters

• xMap (qwt.scale_map.QwtScaleMap) – Maps x-values into pixel coordinates.

• yMap (qwt.scale_map.QwtScaleMap) – Maps y-values into pixel coordinates.

Returns

Bounding paint rectangle of the scale maps, not normalized

plot()

Returns

attached plot

rtti()

Return rtti for the specific class represented. QwtPlotItem is simply a virtual interface class, and base classes will implement this method with specific rtti values so a user can differentiate them.

Returns

rtti value

scaleRect(xMap, yMap)

Calculate the bounding scale rectangle of 2 maps

Parameters

• xMap (qwt.scale_map.QwtScaleMap) – Maps x-values into pixel coordinates.

• yMap (qwt.scale_map.QwtScaleMap) – Maps y-values into pixel coordinates.

Returns

Bounding scale rect of the scale maps, not normalized

select()

Select item

setAxes(xAxis, yAxis)

Set X and Y axis

The item will painted according to the coordinates of its Axes.

Parameters

• xAxis (int) – X Axis (QwtPlot.xBottom or QwtPlot.xTop)

• yAxis (int) – Y Axis (QwtPlot.yLeft or QwtPlot.yRight)

See also

setXAxis(), setYAxis(), xAxis(), yAxis()

setAxis(xAxis, yAxis)

Set X and Y axis

Warning

setAxis has been removed in Qwt6: please use setAxes() instead

setIcon(icon)

Set item icon

Parameters

icon (QIcon) – Icon

See also

icon()

setItemAttribute(attribute, on=True)

Toggle an item attribute

Parameters

• attribute (int) – Attribute type

• on (bool) – True/False

See also

testItemAttribute()

setItemInterest(interest, on=True)

Toggle an item interest

Parameters

• attribute (int) – Interest type

• on (bool) – True/False

See also

testItemInterest()

setLegendIconSize(size)

Set the size of the legend icon

The default setting is 8x8 pixels

Parameters

size (QSize) – Size

See also

legendIconSize(), legendIcon()

setRenderHint(hint, on=True)

Toggle a render hint

Parameters

• hint (int) – Render hint

• on (bool) – True/False

See also

testRenderHint()

setTitle(title)

Set a new title

Parameters

title (qwt.text.QwtText or str) – Title

See also

title()

setVisible(enable)

Show/Hide the item

Parameters

on (bool) – Show if True, otherwise hide

See also

isVisible(), show(), hide()

setXAxis(axis)

Set the X axis

The item will painted according to the coordinates its Axes.

Parameters

axis (int) – X Axis (QwtPlot.xBottom or QwtPlot.xTop)

See also

setAxes(), setYAxis(), xAxis(), yAxis()

setYAxis(axis)

Set the Y axis

The item will painted according to the coordinates its Axes.

Parameters

axis (int) – Y Axis (QwtPlot.yLeft or QwtPlot.yRight)

See also

setAxes(), setXAxis(), xAxis(), yAxis()

setZ(z)

Set the z value

Plot items are painted in increasing z-order.

Parameters

z (float) – Z-value

See also

z(), QwtPlotDict.itemList()

set_data(data, lut_range=None)

Set Image item data

• data: 2D NumPy array

• lut_range: LUT range – tuple (levelmin, levelmax)

set_interpolation(interp_mode, size=None)

Set image interpolation mode

interp_mode: INTERP_NEAREST, INTERP_LINEAR, INTERP_AA size (integer): (for anti-aliasing only) AA matrix size

set_lut_range(lut_range)

Set LUT transform range lut_range is a tuple: (min, max)

set_movable(state)

Set item movable state

set_private(state)

Set object as private

set_readonly(state)

Set object readonly state

set_resizable(state)

Set item resizable state (or any action triggered when moving an handle, e.g. rotation)

set_rotatable(state)

Set item rotatable state

set_selectable(state)

Set item selectable state

show()

Show the item

testItemAttribute(attribute)

Test an item attribute

Parameters

attribute (int) – Attribute type

Returns

True/False

See also

setItemAttribute()

testItemInterest(interest)

Test an item interest

Parameters

attribute (int) – Interest type

Returns

True/False

See also

setItemInterest()

testRenderHint(hint)

Test a render hint

Parameters

attribute (int) – Render hint

Returns

True/False

See also

setRenderHint()

title()

Returns

Title of the item

See also

setTitle()

unselect()

Unselect item

updateLegend(item, data)

Update the item to changes of the legend info

Plot items that want to display a legend ( not those, that want to be displayed on a legend ! ) will have to implement updateLegend().

updateLegend() is only called when the LegendInterest interest is enabled. The default implementation does nothing.

Parameters

• item (qwt.plot.QwtPlotItem) – Plot item to be displayed on a legend

• data (list) – Attributes how to display item on the legend

Note

Plot items, that want to be displayed on a legend need to enable the QwtPlotItem.Legend flag and to implement legendData() and legendIcon()

update_border()

Update image border rectangle to fit image shape

xAxis()

Returns

xAxis

yAxis()

Returns

yAxis

z()

Plot items are painted in increasing z-order.

Returns

item z order

See also

setZ(), QwtPlotDict.itemList()

class guiqwt.image.TrImageItem(data=None, param=None)

Construct a transformable image item

• data: 2D NumPy array

• param (optional): image parameters (guiqwt.styles.TrImageParam instance)

get_default_param()

Return instance of the default imageparam DataSet

get_crop_coordinates()

Return crop rectangle coordinates

set_data(data, lut_range=None)

Set Image item data

• data: 2D NumPy array

• lut_range: LUT range – tuple (levelmin, levelmax)

get_filter(filterobj, filterparam)

Provides a filter object over this image’s content

get_pixel_coordinates(xplot, yplot)

Return (image) pixel coordinates (from plot coordinates)

get_plot_coordinates(xpixel, ypixel)

Return plot coordinates (from image pixel coordinates)

get_closest_coordinates(x, y)

Return closest image pixel coordinates

update_border()

Update image border rectangle to fit image shape

draw_border(painter, xMap, yMap, canvasRect)

Draw image border rectangle

draw_image(painter, canvasRect, src_rect, dst_rect, xMap, yMap)

Draw image with painter on canvasRect

Warning

src_rect and dst_rect are coordinates tuples (xleft, ytop, xright, ybottom)

export_roi(src_rect, dst_rect, dst_image, apply_lut=False, apply_interpolation=False, original_resolution=False)

Export Region Of Interest to array

move_local_point_to(handle, pos, ctrl=None)

Move a handle as returned by hit_test to the new position pos ctrl: True if <Ctrl> button is being pressed, False otherwise

move_local_shape(old_pos, new_pos)

Translate the shape such that old_pos becomes new_pos in canvas coordinates

move_with_selection(delta_x, delta_y)

Translate the shape together with other selected items delta_x, delta_y: translation in plot coordinates

align_rectangular_shape(shape)

Align rectangular shape to image pixels

attach(plot)

Attach the item to a plot.

This method will attach a QwtPlotItem to the QwtPlot argument. It will first detach the QwtPlotItem from any plot from a previous call to attach (if necessary). If a None argument is passed, it will detach from any QwtPlot it was attached to.

Parameters

plot (qwt.plot.QwtPlot) – Plot widget

See also

detach()

boundingRect()

Returns

An invalid bounding rect: QRectF(1.0, 1.0, -2.0, -2.0)

Note

A width or height < 0.0 is ignored by the autoscaler

deserialize(reader)

Deserialize object from HDF5 reader

detach()

Detach the item from a plot.

This method detaches a QwtPlotItem from any QwtPlot it has been associated with.

See also

attach()

getCanvasMarginHint(xMap, yMap, canvasRect)

Calculate a hint for the canvas margin

When the QwtPlotItem::Margins flag is enabled the plot item indicates, that it needs some margins at the borders of the canvas. This is f.e. used by bar charts to reserve space for displaying the bars.

The margins are in target device coordinates ( pixels on screen )

Parameters

• xMap (qwt.scale_map.QwtScaleMap) – Maps x-values into pixel coordinates.

• yMap (qwt.scale_map.QwtScaleMap) – Maps y-values into pixel coordinates.

• canvasRect (QRectF) – Contents rectangle of the canvas in painter coordinates

See also

QwtPlot.getCanvasMarginsHint(), QwtPlot.updateCanvasMargins(),

get_average_xsection(x0, y0, x1, y1, apply_lut=False)

Return average cross section along x-axis

get_average_ysection(x0, y0, x1, y1, apply_lut=False)

Return average cross section along y-axis

get_closest_index_rect(x0, y0, x1, y1)

Return closest image rectangular pixel area index bounds Avoid returning empty rectangular area (return 1x1 pixel area instead) Handle reversed/not-reversed Y-axis orientation

get_closest_indexes(x, y, corner=None)

Return closest image pixel indexes corner: None (not a corner), ‘TL’ (top-left corner), ‘BR’ (bottom-right corner)

get_closest_pixel_indexes(x, y)

Return closest pixel indexes Instead of returning indexes of an image pixel like the method ‘get_closest_indexes’, this method returns the indexes of the closest pixel which is not necessarily on the image itself (i.e. indexes may be outside image index bounds: negative or superior than the image dimension)

Note

This is not the same as retrieving the canvas pixel coordinates (which depends on the zoom level)

get_data(x0, y0, x1=None, y1=None)

Return image data Arguments: x0, y0 [, x1, y1] Return image level at coordinates (x0,y0)

If x1,y1 are specified:

Return image levels (np.ndarray) in rectangular area (x0,y0,x1,y1)

get_histogram(nbins)

interface de IHistDataSource

get_interpolation()

Get interpolation mode

get_lut_range()

Return the LUT transform range tuple: (min, max)

get_lut_range_full()

Return full dynamic range

get_lut_range_max()

Get maximum range for this dataset

get_stats(x0, y0, x1, y1)

Return formatted string with stats on image rectangular area (output should be compatible with AnnotatedShape.get_infos)

get_xsection(y0, apply_lut=False)

Return cross section along x-axis at y=y0

get_ysection(x0, apply_lut=False)

Return cross section along y-axis at x=x0

hide()

Hide the item

icon()

Returns

Icon of the item

See also

setIcon()

isVisible()

Returns

True if visible

See also

setVisible(), show(), hide()

is_empty()

Return True if item data is empty

is_private()

Return True if object is private

is_readonly()

Return object readonly state

itemChanged()

Update the legend and call QwtPlot.autoRefresh() for the parent plot.

See also

QwtPlot.legendChanged(), QwtPlot.autoRefresh()

legendChanged()

Update the legend of the parent plot.

See also

QwtPlot.updateLegend(), itemChanged()

legendData()

Return all information, that is needed to represent the item on the legend

QwtLegendData is basically a list of QVariants that makes it possible to overload and reimplement legendData() to return almost any type of information, that is understood by the receiver that acts as the legend.

The default implementation returns one entry with the title() of the item and the legendIcon().

Returns

Data, that is needed to represent the item on the legend

See also

title(), legendIcon(), qwt.legend.QwtLegend

legendIcon(index, size)

Parameters

• index (int) – Index of the legend entry (usually there is only one)

• size (QSizeF) – Icon size

Returns

Icon representing the item on the legend

The default implementation returns an invalid icon

See also

setLegendIconSize(), legendData()

legendIconSize()

Returns

Legend icon size

See also

setLegendIconSize(), legendIcon()

load_data(lut_range=None)

Load data from filename and eventually apply specified lut_range filename has been set using method ‘set_filename’

paintRect(xMap, yMap)

Calculate the bounding paint rectangle of 2 maps

Parameters

• xMap (qwt.scale_map.QwtScaleMap) – Maps x-values into pixel coordinates.

• yMap (qwt.scale_map.QwtScaleMap) – Maps y-values into pixel coordinates.

Returns

Bounding paint rectangle of the scale maps, not normalized

plot()

Returns

attached plot

rtti()

Return rtti for the specific class represented. QwtPlotItem is simply a virtual interface class, and base classes will implement this method with specific rtti values so a user can differentiate them.

Returns

rtti value

scaleRect(xMap, yMap)

Calculate the bounding scale rectangle of 2 maps

Parameters

• xMap (qwt.scale_map.QwtScaleMap) – Maps x-values into pixel coordinates.

• yMap (qwt.scale_map.QwtScaleMap) – Maps y-values into pixel coordinates.

Returns

Bounding scale rect of the scale maps, not normalized

select()

Select item

serialize(writer)

Serialize object to HDF5 writer

setAxes(xAxis, yAxis)

Set X and Y axis

The item will painted according to the coordinates of its Axes.

Parameters

• xAxis (int) – X Axis (QwtPlot.xBottom or QwtPlot.xTop)

• yAxis (int) – Y Axis (QwtPlot.yLeft or QwtPlot.yRight)

See also

setXAxis(), setYAxis(), xAxis(), yAxis()

setAxis(xAxis, yAxis)

Set X and Y axis

Warning

setAxis has been removed in Qwt6: please use setAxes() instead

setIcon(icon)

Set item icon

Parameters

icon (QIcon) – Icon

See also

icon()

setItemAttribute(attribute, on=True)

Toggle an item attribute

Parameters

• attribute (int) – Attribute type

• on (bool) – True/False

See also

testItemAttribute()

setItemInterest(interest, on=True)

Toggle an item interest

Parameters

• attribute (int) – Interest type

• on (bool) – True/False

See also

testItemInterest()

setLegendIconSize(size)

Set the size of the legend icon

The default setting is 8x8 pixels

Parameters

size (QSize) – Size

See also

legendIconSize(), legendIcon()

setRenderHint(hint, on=True)

Toggle a render hint

Parameters

• hint (int) – Render hint

• on (bool) – True/False

See also

testRenderHint()

setTitle(title)

Set a new title

Parameters

title (qwt.text.QwtText or str) – Title

See also

title()

setVisible(enable)

Show/Hide the item

Parameters

on (bool) – Show if True, otherwise hide

See also

isVisible(), show(), hide()

setXAxis(axis)

Set the X axis

The item will painted according to the coordinates its Axes.

Parameters

axis (int) – X Axis (QwtPlot.xBottom or QwtPlot.xTop)

See also

setAxes(), setYAxis(), xAxis(), yAxis()

setYAxis(axis)

Set the Y axis

The item will painted according to the coordinates its Axes.

Parameters

axis (int) – Y Axis (QwtPlot.yLeft or QwtPlot.yRight)

See also

setAxes(), setXAxis(), xAxis(), yAxis()

setZ(z)

Set the z value

Plot items are painted in increasing z-order.

Parameters

z (float) – Z-value

See also

z(), QwtPlotDict.itemList()

set_interpolation(interp_mode, size=None)

Set image interpolation mode

interp_mode: INTERP_NEAREST, INTERP_LINEAR, INTERP_AA size (integer): (for anti-aliasing only) AA matrix size

set_lut_range(lut_range)

Set LUT transform range lut_range is a tuple: (min, max)

set_movable(state)

Set item movable state

set_private(state)

Set object as private

set_readonly(state)

Set object readonly state

set_resizable(state)

Set item resizable state (or any action triggered when moving an handle, e.g. rotation)

set_rotatable(state)

Set item rotatable state

set_selectable(state)

Set item selectable state

show()

Show the item

testItemAttribute(attribute)

Test an item attribute

Parameters

attribute (int) – Attribute type

Returns

True/False

See also

setItemAttribute()

testItemInterest(interest)

Test an item interest

Parameters

attribute (int) – Interest type

Returns

True/False

See also

setItemInterest()

testRenderHint(hint)

Test a render hint

Parameters

attribute (int) – Render hint

Returns

True/False

See also

setRenderHint()

title()

Returns

Title of the item

See also

setTitle()

unselect()

Unselect item

updateLegend(item, data)

Update the item to changes of the legend info

Plot items that want to display a legend ( not those, that want to be displayed on a legend ! ) will have to implement updateLegend().

updateLegend() is only called when the LegendInterest interest is enabled. The default implementation does nothing.

Parameters

• item (qwt.plot.QwtPlotItem) – Plot item to be displayed on a legend

• data (list) – Attributes how to display item on the legend

Note

Plot items, that want to be displayed on a legend need to enable the QwtPlotItem.Legend flag and to implement legendData() and legendIcon()

xAxis()

Returns

xAxis

yAxis()

Returns

yAxis

z()

Plot items are painted in increasing z-order.

Returns

item z order

See also

setZ(), QwtPlotDict.itemList()

class guiqwt.image.XYImageItem(x=None, y=None, data=None, param=None)

Construct an image item with non-linear X/Y axes

• x: 1D NumPy array, must be increasing

• y: 1D NumPy array, must be increasing

• data: 2D NumPy array

• param (optional): image parameters (guiqwt.styles.XYImageParam instance)

get_default_param()

Return instance of the default imageparam DataSet

serialize(writer)

Serialize object to HDF5 writer

deserialize(reader)

Deserialize object from HDF5 reader

get_filter(filterobj, filterparam)

Provides a filter object over this image’s content

draw_image(painter, canvasRect, src_rect, dst_rect, xMap, yMap)

Draw image with painter on canvasRect

Warning

src_rect and dst_rect are coordinates tuples (xleft, ytop, xright, ybottom)

get_pixel_coordinates(xplot, yplot)

Return (image) pixel coordinates (from plot coordinates)

get_plot_coordinates(xpixel, ypixel)

Return plot coordinates (from image pixel coordinates)

get_closest_coordinates(x, y)

Return closest image pixel coordinates

align_rectangular_shape(shape)

Align rectangular shape to image pixels

attach(plot)

Attach the item to a plot.

This method will attach a QwtPlotItem to the QwtPlot argument. It will first detach the QwtPlotItem from any plot from a previous call to attach (if necessary). If a None argument is passed, it will detach from any QwtPlot it was attached to.

Parameters

plot (qwt.plot.QwtPlot) – Plot widget

See also

detach()

boundingRect()

Returns

An invalid bounding rect: QRectF(1.0, 1.0, -2.0, -2.0)

Note

A width or height < 0.0 is ignored by the autoscaler

detach()

Detach the item from a plot.

This method detaches a QwtPlotItem from any QwtPlot it has been associated with.

See also

attach()

draw_border(painter, xMap, yMap, canvasRect)

Draw image border rectangle

export_roi(src_rect, dst_rect, dst_image, apply_lut=False, apply_interpolation=False, original_resolution=False)

Export Region Of Interest to array

getCanvasMarginHint(xMap, yMap, canvasRect)

Calculate a hint for the canvas margin

When the QwtPlotItem::Margins flag is enabled the plot item indicates, that it needs some margins at the borders of the canvas. This is f.e. used by bar charts to reserve space for displaying the bars.

The margins are in target device coordinates ( pixels on screen )

Parameters

• xMap (qwt.scale_map.QwtScaleMap) – Maps x-values into pixel coordinates.

• yMap (qwt.scale_map.QwtScaleMap) – Maps y-values into pixel coordinates.

• canvasRect (QRectF) – Contents rectangle of the canvas in painter coordinates

See also

QwtPlot.getCanvasMarginsHint(), QwtPlot.updateCanvasMargins(),

get_average_xsection(x0, y0, x1, y1, apply_lut=False)

Return average cross section along x-axis

get_average_ysection(x0, y0, x1, y1, apply_lut=False)

Return average cross section along y-axis

get_closest_index_rect(x0, y0, x1, y1)

Return closest image rectangular pixel area index bounds Avoid returning empty rectangular area (return 1x1 pixel area instead) Handle reversed/not-reversed Y-axis orientation

get_closest_indexes(x, y, corner=None)

Return closest image pixel indexes corner: None (not a corner), ‘TL’ (top-left corner), ‘BR’ (bottom-right corner)

get_closest_pixel_indexes(x, y)

Return closest pixel indexes Instead of returning indexes of an image pixel like the method ‘get_closest_indexes’, this method returns the indexes of the closest pixel which is not necessarily on the image itself (i.e. indexes may be outside image index bounds: negative or superior than the image dimension)

Note

This is not the same as retrieving the canvas pixel coordinates (which depends on the zoom level)

get_data(x0, y0, x1=None, y1=None)

Return image data Arguments: x0, y0 [, x1, y1] Return image level at coordinates (x0,y0)

If x1,y1 are specified:

Return image levels (np.ndarray) in rectangular area (x0,y0,x1,y1)

get_histogram(nbins)

interface de IHistDataSource

get_interpolation()

Get interpolation mode

get_lut_range()

Return the LUT transform range tuple: (min, max)

get_lut_range_full()

Return full dynamic range

get_lut_range_max()

Get maximum range for this dataset

get_stats(x0, y0, x1, y1)

Return formatted string with stats on image rectangular area (output should be compatible with AnnotatedShape.get_infos)

get_xsection(y0, apply_lut=False)

Return cross section along x-axis at y=y0

get_ysection(x0, apply_lut=False)

Return cross section along y-axis at x=x0

hide()

Hide the item

icon()

Returns

Icon of the item

See also

setIcon()

isVisible()

Returns

True if visible

See also

setVisible(), show(), hide()

is_empty()

Return True if item data is empty

is_private()

Return True if object is private

is_readonly()

Return object readonly state

itemChanged()

Update the legend and call QwtPlot.autoRefresh() for the parent plot.

See also

QwtPlot.legendChanged(), QwtPlot.autoRefresh()

legendChanged()

Update the legend of the parent plot.

See also

QwtPlot.updateLegend(), itemChanged()

legendData()

Return all information, that is needed to represent the item on the legend

QwtLegendData is basically a list of QVariants that makes it possible to overload and reimplement legendData() to return almost any type of information, that is understood by the receiver that acts as the legend.

The default implementation returns one entry with the title() of the item and the legendIcon().

Returns

Data, that is needed to represent the item on the legend

See also

title(), legendIcon(), qwt.legend.QwtLegend

legendIcon(index, size)

Parameters

• index (int) – Index of the legend entry (usually there is only one)

• size (QSizeF) – Icon size

Returns

Icon representing the item on the legend

The default implementation returns an invalid icon

See also

setLegendIconSize(), legendData()

legendIconSize()

Returns

Legend icon size

See also

setLegendIconSize(), legendIcon()

load_data(lut_range=None)

Load data from filename and eventually apply specified lut_range filename has been set using method ‘set_filename’

move_local_point_to(handle, pos, ctrl=None)

Move a handle as returned by hit_test to the new position pos ctrl: True if <Ctrl> button is being pressed, False otherwise

move_local_shape(old_pos, new_pos)

Translate the shape such that old_pos becomes new_pos in canvas coordinates

move_with_selection(delta_x, delta_y)

Translate the shape together with other selected items delta_x, delta_y: translation in plot coordinates

paintRect(xMap, yMap)

Calculate the bounding paint rectangle of 2 maps

Parameters

• xMap (qwt.scale_map.QwtScaleMap) – Maps x-values into pixel coordinates.

• yMap (qwt.scale_map.QwtScaleMap) – Maps y-values into pixel coordinates.

Returns

Bounding paint rectangle of the scale maps, not normalized

plot()

Returns

attached plot

rtti()

Return rtti for the specific class represented. QwtPlotItem is simply a virtual interface class, and base classes will implement this method with specific rtti values so a user can differentiate them.

Returns

rtti value

scaleRect(xMap, yMap)

Calculate the bounding scale rectangle of 2 maps

Parameters

• xMap (qwt.scale_map.QwtScaleMap) – Maps x-values into pixel coordinates.

• yMap (qwt.scale_map.QwtScaleMap) – Maps y-values into pixel coordinates.

Returns

Bounding scale rect of the scale maps, not normalized

select()

Select item

setAxes(xAxis, yAxis)

Set X and Y axis

The item will painted according to the coordinates of its Axes.

Parameters

• xAxis (int) – X Axis (QwtPlot.xBottom or QwtPlot.xTop)

• yAxis (int) – Y Axis (QwtPlot.yLeft or QwtPlot.yRight)

See also

setXAxis(), setYAxis(), xAxis(), yAxis()

setAxis(xAxis, yAxis)

Set X and Y axis

Warning

setAxis has been removed in Qwt6: please use setAxes() instead

setIcon(icon)

Set item icon

Parameters

icon (QIcon) – Icon

See also

icon()

setItemAttribute(attribute, on=True)

Toggle an item attribute

Parameters

• attribute (int) – Attribute type

• on (bool) – True/False

See also

testItemAttribute()

setItemInterest(interest, on=True)

Toggle an item interest

Parameters

• attribute (int) – Interest type

• on (bool) – True/False

See also

testItemInterest()

setLegendIconSize(size)

Set the size of the legend icon

The default setting is 8x8 pixels

Parameters

size (QSize) – Size

See also

legendIconSize(), legendIcon()

setRenderHint(hint, on=True)

Toggle a render hint

Parameters

• hint (int) – Render hint

• on (bool) – True/False

See also

testRenderHint()

setTitle(title)

Set a new title

Parameters

title (qwt.text.QwtText or str) – Title

See also

title()

setVisible(enable)

Show/Hide the item

Parameters

on (bool) – Show if True, otherwise hide

See also

isVisible(), show(), hide()

setXAxis(axis)

Set the X axis

The item will painted according to the coordinates its Axes.

Parameters

axis (int) – X Axis (QwtPlot.xBottom or QwtPlot.xTop)

See also

setAxes(), setYAxis(), xAxis(), yAxis()

setYAxis(axis)

Set the Y axis

The item will painted according to the coordinates its Axes.

Parameters

axis (int) – Y Axis (QwtPlot.yLeft or QwtPlot.yRight)

See also

setAxes(), setXAxis(), xAxis(), yAxis()

setZ(z)

Set the z value

Plot items are painted in increasing z-order.

Parameters

z (float) – Z-value

See also

z(), QwtPlotDict.itemList()

set_data(data, lut_range=None)

Set Image item data

• data: 2D NumPy array

• lut_range: LUT range – tuple (levelmin, levelmax)

set_interpolation(interp_mode, size=None)

Set image interpolation mode

interp_mode: INTERP_NEAREST, INTERP_LINEAR, INTERP_AA size (integer): (for anti-aliasing only) AA matrix size

set_lut_range(lut_range)

Set LUT transform range lut_range is a tuple: (min, max)

set_movable(state)

Set item movable state

set_private(state)

Set object as private

set_readonly(state)

Set object readonly state

set_resizable(state)

Set item resizable state (or any action triggered when moving an handle, e.g. rotation)

set_rotatable(state)

Set item rotatable state

set_selectable(state)

Set item selectable state

show()

Show the item

testItemAttribute(attribute)

Test an item attribute

Parameters

attribute (int) – Attribute type

Returns

True/False

See also

setItemAttribute()

testItemInterest(interest)

Test an item interest

Parameters

attribute (int) – Interest type

Returns

True/False

See also

setItemInterest()

testRenderHint(hint)

Test a render hint

Parameters

attribute (int) – Render hint

Returns

True/False

See also

setRenderHint()

title()

Returns

Title of the item

See also

setTitle()

unselect()

Unselect item

updateLegend(item, data)

Update the item to changes of the legend info

Plot items that want to display a legend ( not those, that want to be displayed on a legend ! ) will have to implement updateLegend().

updateLegend() is only called when the LegendInterest interest is enabled. The default implementation does nothing.

Parameters

• item (qwt.plot.QwtPlotItem) – Plot item to be displayed on a legend

• data (list) – Attributes how to display item on the legend

Note

Plot items, that want to be displayed on a legend need to enable the QwtPlotItem.Legend flag and to implement legendData() and legendIcon()

update_border()

Update image border rectangle to fit image shape

xAxis()

Returns

xAxis

yAxis()

Returns

yAxis

z()

Plot items are painted in increasing z-order.

Returns

item z order

See also

setZ(), QwtPlotDict.itemList()

class guiqwt.image.RGBImageItem(data=None, param=None)

Construct a RGB/RGBA image item

• data: NumPy array of uint8 (shape: NxMx[34] – 3: RGB, 4: RGBA) (last dimension: 0: Red, 1: Green, 2: Blue {, 3:Alpha})

• param (optional): image parameters (guiqwt.styles.RGBImageParam instance)

get_default_param()

Return instance of the default imageparam DataSet

set_lut_range(range)

Set LUT transform range lut_range is a tuple: (min, max)

load_data()

Load data from filename filename has been set using method ‘set_filename’

set_data(data)

Set Image item data

• data: 2D NumPy array

• lut_range: LUT range – tuple (levelmin, levelmax)

align_rectangular_shape(shape)

Align rectangular shape to image pixels

attach(plot)

Attach the item to a plot.

This method will attach a QwtPlotItem to the QwtPlot argument. It will first detach the QwtPlotItem from any plot from a previous call to attach (if necessary). If a None argument is passed, it will detach from any QwtPlot it was attached to.

Parameters

plot (qwt.plot.QwtPlot) – Plot widget

See also

detach()

boundingRect()

Returns

An invalid bounding rect: QRectF(1.0, 1.0, -2.0, -2.0)

Note

A width or height < 0.0 is ignored by the autoscaler

deserialize(reader)

Deserialize object from HDF5 reader

detach()

Detach the item from a plot.

This method detaches a QwtPlotItem from any QwtPlot it has been associated with.

See also

attach()

draw_border(painter, xMap, yMap, canvasRect)

Draw image border rectangle

draw_image(painter, canvasRect, src_rect, dst_rect, xMap, yMap)

Draw image with painter on canvasRect

Warning

src_rect and dst_rect are coordinates tuples (xleft, ytop, xright, ybottom)

export_roi(src_rect, dst_rect, dst_image, apply_lut=False, apply_interpolation=False, original_resolution=False)

Export Region Of Interest to array

getCanvasMarginHint(xMap, yMap, canvasRect)

Calculate a hint for the canvas margin

When the QwtPlotItem::Margins flag is enabled the plot item indicates, that it needs some margins at the borders of the canvas. This is f.e. used by bar charts to reserve space for displaying the bars.

The margins are in target device coordinates ( pixels on screen )

Parameters

• xMap (qwt.scale_map.QwtScaleMap) – Maps x-values into pixel coordinates.

• yMap (qwt.scale_map.QwtScaleMap) – Maps y-values into pixel coordinates.

• canvasRect (QRectF) – Contents rectangle of the canvas in painter coordinates

See also

QwtPlot.getCanvasMarginsHint(), QwtPlot.updateCanvasMargins(),

get_average_xsection(x0, y0, x1, y1, apply_lut=False)

Return average cross section along x-axis

get_average_ysection(x0, y0, x1, y1, apply_lut=False)

Return average cross section along y-axis

get_closest_coordinates(x, y)

Return closest image pixel coordinates

get_closest_index_rect(x0, y0, x1, y1)

Return closest image rectangular pixel area index bounds Avoid returning empty rectangular area (return 1x1 pixel area instead) Handle reversed/not-reversed Y-axis orientation

get_closest_indexes(x, y, corner=None)

Return closest image pixel indexes corner: None (not a corner), ‘TL’ (top-left corner), ‘BR’ (bottom-right corner)

get_closest_pixel_indexes(x, y)

Return closest pixel indexes Instead of returning indexes of an image pixel like the method ‘get_closest_indexes’, this method returns the indexes of the closest pixel which is not necessarily on the image itself (i.e. indexes may be outside image index bounds: negative or superior than the image dimension)

Note

This is not the same as retrieving the canvas pixel coordinates (which depends on the zoom level)

get_data(x0, y0, x1=None, y1=None)

Return image data Arguments: x0, y0 [, x1, y1] Return image level at coordinates (x0,y0)

If x1,y1 are specified:

Return image levels (np.ndarray) in rectangular area (x0,y0,x1,y1)

get_filter(filterobj, filterparam)

Provides a filter object over this image’s content

get_histogram(nbins)

interface de IHistDataSource

get_interpolation()

Get interpolation mode

get_lut_range()

Return the LUT transform range tuple: (min, max)

get_lut_range_full()

Return full dynamic range

get_lut_range_max()

Get maximum range for this dataset

get_pixel_coordinates(xplot, yplot)

Return (image) pixel coordinates (from plot coordinates)

get_plot_coordinates(xpixel, ypixel)

Return plot coordinates (from image pixel coordinates)

get_stats(x0, y0, x1, y1)

Return formatted string with stats on image rectangular area (output should be compatible with AnnotatedShape.get_infos)

get_xdata()

Return (xmin, xmax)

get_xsection(y0, apply_lut=False)

Return cross section along x-axis at y=y0

get_ydata()

Return (ymin, ymax)

get_ysection(x0, apply_lut=False)

Return cross section along y-axis at x=x0

hide()

Hide the item

icon()

Returns

Icon of the item

See also

setIcon()

isVisible()

Returns

True if visible

See also

setVisible(), show(), hide()

is_empty()

Return True if item data is empty

is_private()

Return True if object is private

is_readonly()

Return object readonly state

itemChanged()

Update the legend and call QwtPlot.autoRefresh() for the parent plot.

See also

QwtPlot.legendChanged(), QwtPlot.autoRefresh()

legendChanged()

Update the legend of the parent plot.

See also

QwtPlot.updateLegend(), itemChanged()

legendData()

Return all information, that is needed to represent the item on the legend

QwtLegendData is basically a list of QVariants that makes it possible to overload and reimplement legendData() to return almost any type of information, that is understood by the receiver that acts as the legend.

The default implementation returns one entry with the title() of the item and the legendIcon().

Returns

Data, that is needed to represent the item on the legend

See also

title(), legendIcon(), qwt.legend.QwtLegend

legendIcon(index, size)

Parameters

• index (int) – Index of the legend entry (usually there is only one)

• size (QSizeF) – Icon size

Returns

Icon representing the item on the legend

The default implementation returns an invalid icon

See also

setLegendIconSize(), legendData()

legendIconSize()

Returns

Legend icon size

See also

setLegendIconSize(), legendIcon()

move_local_point_to(handle, pos, ctrl=None)

Move a handle as returned by hit_test to the new position pos ctrl: True if <Ctrl> button is being pressed, False otherwise

move_local_shape(old_pos, new_pos)

Translate the shape such that old_pos becomes new_pos in canvas coordinates

move_with_selection(delta_x, delta_y)

Translate the shape together with other selected items delta_x, delta_y: translation in plot coordinates

paintRect(xMap, yMap)

Calculate the bounding paint rectangle of 2 maps

Parameters

• xMap (qwt.scale_map.QwtScaleMap) – Maps x-values into pixel coordinates.

• yMap (qwt.scale_map.QwtScaleMap) – Maps y-values into pixel coordinates.

Returns

Bounding paint rectangle of the scale maps, not normalized

plot()

Returns

attached plot

rtti()

Return rtti for the specific class represented. QwtPlotItem is simply a virtual interface class, and base classes will implement this method with specific rtti values so a user can differentiate them.

Returns

rtti value

scaleRect(xMap, yMap)

Calculate the bounding scale rectangle of 2 maps

Parameters

• xMap (qwt.scale_map.QwtScaleMap) – Maps x-values into pixel coordinates.

• yMap (qwt.scale_map.QwtScaleMap) – Maps y-values into pixel coordinates.

Returns

Bounding scale rect of the scale maps, not normalized

select()

Select item

serialize(writer)

Serialize object to HDF5 writer

setAxes(xAxis, yAxis)

Set X and Y axis

The item will painted according to the coordinates of its Axes.

Parameters

• xAxis (int) – X Axis (QwtPlot.xBottom or QwtPlot.xTop)

• yAxis (int) – Y Axis (QwtPlot.yLeft or QwtPlot.yRight)

See also

setXAxis(), setYAxis(), xAxis(), yAxis()

setAxis(xAxis, yAxis)

Set X and Y axis

Warning

setAxis has been removed in Qwt6: please use setAxes() instead

setIcon(icon)

Set item icon

Parameters

icon (QIcon) – Icon

See also

icon()

setItemAttribute(attribute, on=True)

Toggle an item attribute

Parameters

• attribute (int) – Attribute type

• on (bool) – True/False

See also

testItemAttribute()

setItemInterest(interest, on=True)

Toggle an item interest

Parameters

• attribute (int) – Interest type

• on (bool) – True/False

See also

testItemInterest()

setLegendIconSize(size)

Set the size of the legend icon

The default setting is 8x8 pixels

Parameters

size (QSize) – Size

See also

legendIconSize(), legendIcon()

setRenderHint(hint, on=True)

Toggle a render hint

Parameters

• hint (int) – Render hint

• on (bool) – True/False

See also

testRenderHint()

setTitle(title)

Set a new title

Parameters

title (qwt.text.QwtText or str) – Title

See also

title()

setVisible(enable)

Show/Hide the item

Parameters

on (bool) – Show if True, otherwise hide

See also

isVisible(), show(), hide()

setXAxis(axis)

Set the X axis

The item will painted according to the coordinates its Axes.

Parameters

axis (int) – X Axis (QwtPlot.xBottom or QwtPlot.xTop)

See also

setAxes(), setYAxis(), xAxis(), yAxis()

setYAxis(axis)

Set the Y axis

The item will painted according to the coordinates its Axes.

Parameters

axis (int) – Y Axis (QwtPlot.yLeft or QwtPlot.yRight)

See also

setAxes(), setXAxis(), xAxis(), yAxis()

setZ(z)

Set the z value

Plot items are painted in increasing z-order.

Parameters

z (float) – Z-value

See also

z(), QwtPlotDict.itemList()

set_interpolation(interp_mode, size=None)

Set image interpolation mode

interp_mode: INTERP_NEAREST, INTERP_LINEAR, INTERP_AA size (integer): (for anti-aliasing only) AA matrix size

set_movable(state)

Set item movable state

set_private(state)

Set object as private

set_readonly(state)

Set object readonly state

set_resizable(state)

Set item resizable state (or any action triggered when moving an handle, e.g. rotation)

set_rotatable(state)

Set item rotatable state

set_selectable(state)

Set item selectable state

show()

Show the item

testItemAttribute(attribute)

Test an item attribute

Parameters

attribute (int) – Attribute type

Returns

True/False

See also

setItemAttribute()

testItemInterest(interest)

Test an item interest

Parameters

attribute (int) – Interest type

Returns

True/False

See also

setItemInterest()

testRenderHint(hint)

Test a render hint

Parameters

attribute (int) – Render hint

Returns

True/False

See also

setRenderHint()

title()

Returns

Title of the item

See also

setTitle()

unselect()

Unselect item

updateLegend(item, data)

Update the item to changes of the legend info

Plot items that want to display a legend ( not those, that want to be displayed on a legend ! ) will have to implement updateLegend().

updateLegend() is only called when the LegendInterest interest is enabled. The default implementation does nothing.

Parameters

• item (qwt.plot.QwtPlotItem) – Plot item to be displayed on a legend

• data (list) – Attributes how to display item on the legend

Note

Plot items, that want to be displayed on a legend need to enable the QwtPlotItem.Legend flag and to implement legendData() and legendIcon()

update_border()

Update image border rectangle to fit image shape

xAxis()

Returns

xAxis

yAxis()

Returns

yAxis

z()

Plot items are painted in increasing z-order.

Returns

item z order

See also

setZ(), QwtPlotDict.itemList()

class guiqwt.image.MaskedImageItem(data=None, mask=None, param=None)

Construct a masked image item

• data: 2D NumPy array

• mask (optional): 2D NumPy array

• param (optional): image parameters (guiqwt.styles.MaskedImageParam instance)

get_default_param()

Return instance of the default imageparam DataSet

serialize(writer)

Serialize object to HDF5 writer

deserialize(reader)

Deserialize object from HDF5 reader

set_mask(mask)

Set image mask

get_mask()

Return image mask

set_mask_filename(fname)

Set mask filename

There are two ways for pickling mask data of MaskedImageItem objects:

1. using the mask filename (as for data itself)

2. using the mask areas (MaskedAreas instance, see set_mask_areas)

When saving objects, the first method is tried and then, if no filename has been defined for mask data, the second method is used.

set_masked_areas(areas)

Set masked areas (see set_mask_filename)

apply_masked_areas()

Apply masked areas

mask_all()

Mask all pixels

unmask_all()

Unmask all pixels

mask_rectangular_area(x0, y0, x1, y1, inside=True, trace=True, do_signal=True)

Mask rectangular area If inside is True (default), mask the inside of the area Otherwise, mask the outside

mask_circular_area(x0, y0, x1, y1, inside=True, trace=True, do_signal=True)

Mask circular area, inside the rectangle (x0, y0, x1, y1), i.e. circle with a radius of .5\*(x1-x0) If inside is True (default), mask the inside of the area Otherwise, mask the outside

is_mask_visible()

Return mask visibility

set_mask_visible(state)

Set mask visibility

draw_image(painter, canvasRect, src_rect, dst_rect, xMap, yMap)

Draw image with painter on canvasRect

Warning

src_rect and dst_rect are coordinates tuples (xleft, ytop, xright, ybottom)

set_data(data, lut_range=None)

Set Image item data

• data: 2D NumPy array

• lut_range: LUT range – tuple (levelmin, levelmax)

align_rectangular_shape(shape)

Align rectangular shape to image pixels

attach(plot)

Attach the item to a plot.

This method will attach a QwtPlotItem to the QwtPlot argument. It will first detach the QwtPlotItem from any plot from a previous call to attach (if necessary). If a None argument is passed, it will detach from any QwtPlot it was attached to.

Parameters

plot (qwt.plot.QwtPlot) – Plot widget

See also

detach()

boundingRect()

Returns

An invalid bounding rect: QRectF(1.0, 1.0, -2.0, -2.0)

Note

A width or height < 0.0 is ignored by the autoscaler

detach()

Detach the item from a plot.

This method detaches a QwtPlotItem from any QwtPlot it has been associated with.

See also

attach()

draw_border(painter, xMap, yMap, canvasRect)

Draw image border rectangle

export_roi(src_rect, dst_rect, dst_image, apply_lut=False, apply_interpolation=False, original_resolution=False)

Export Region Of Interest to array

getCanvasMarginHint(xMap, yMap, canvasRect)

Calculate a hint for the canvas margin

When the QwtPlotItem::Margins flag is enabled the plot item indicates, that it needs some margins at the borders of the canvas. This is f.e. used by bar charts to reserve space for displaying the bars.

The margins are in target device coordinates ( pixels on screen )

Parameters

• xMap (qwt.scale_map.QwtScaleMap) – Maps x-values into pixel coordinates.

• yMap (qwt.scale_map.QwtScaleMap) – Maps y-values into pixel coordinates.

• canvasRect (QRectF) – Contents rectangle of the canvas in painter coordinates

See also

QwtPlot.getCanvasMarginsHint(), QwtPlot.updateCanvasMargins(),

get_average_xsection(x0, y0, x1, y1, apply_lut=False)

Return average cross section along x-axis

get_average_ysection(x0, y0, x1, y1, apply_lut=False)

Return average cross section along y-axis

get_closest_coordinates(x, y)

Return closest image pixel coordinates

get_closest_index_rect(x0, y0, x1, y1)

Return closest image rectangular pixel area index bounds Avoid returning empty rectangular area (return 1x1 pixel area instead) Handle reversed/not-reversed Y-axis orientation

get_closest_indexes(x, y, corner=None)

Return closest image pixel indexes corner: None (not a corner), ‘TL’ (top-left corner), ‘BR’ (bottom-right corner)

get_closest_pixel_indexes(x, y)

Return closest pixel indexes Instead of returning indexes of an image pixel like the method ‘get_closest_indexes’, this method returns the indexes of the closest pixel which is not necessarily on the image itself (i.e. indexes may be outside image index bounds: negative or superior than the image dimension)

Note

This is not the same as retrieving the canvas pixel coordinates (which depends on the zoom level)

get_data(x0, y0, x1=None, y1=None)

Return image data Arguments: x0, y0 [, x1, y1] Return image level at coordinates (x0,y0)

If x1,y1 are specified:

Return image levels (np.ndarray) in rectangular area (x0,y0,x1,y1)

get_filter(filterobj, filterparam)

Provides a filter object over this image’s content

get_histogram(nbins)

interface de IHistDataSource

get_interpolation()

Get interpolation mode

get_lut_range()

Return the LUT transform range tuple: (min, max)

get_lut_range_full()

Return full dynamic range

get_lut_range_max()

Get maximum range for this dataset

get_pixel_coordinates(xplot, yplot)

Return (image) pixel coordinates (from plot coordinates)

get_plot_coordinates(xpixel, ypixel)

Return plot coordinates (from image pixel coordinates)

get_stats(x0, y0, x1, y1)

Return formatted string with stats on image rectangular area (output should be compatible with AnnotatedShape.get_infos)

get_xdata()

Return (xmin, xmax)

get_xsection(y0, apply_lut=False)

Return cross section along x-axis at y=y0

get_ydata()

Return (ymin, ymax)

get_ysection(x0, apply_lut=False)

Return cross section along y-axis at x=x0

hide()

Hide the item

icon()

Returns

Icon of the item

See also

setIcon()

isVisible()

Returns

True if visible

See also

setVisible(), show(), hide()

is_empty()

Return True if item data is empty

is_private()

Return True if object is private

is_readonly()

Return object readonly state

itemChanged()

Update the legend and call QwtPlot.autoRefresh() for the parent plot.

See also

QwtPlot.legendChanged(), QwtPlot.autoRefresh()

legendChanged()

Update the legend of the parent plot.

See also

QwtPlot.updateLegend(), itemChanged()

legendData()

Return all information, that is needed to represent the item on the legend

QwtLegendData is basically a list of QVariants that makes it possible to overload and reimplement legendData() to return almost any type of information, that is understood by the receiver that acts as the legend.

The default implementation returns one entry with the title() of the item and the legendIcon().

Returns

Data, that is needed to represent the item on the legend

See also

title(), legendIcon(), qwt.legend.QwtLegend

legendIcon(index, size)

Parameters

• index (int) – Index of the legend entry (usually there is only one)

• size (QSizeF) – Icon size

Returns

Icon representing the item on the legend

The default implementation returns an invalid icon

See also

setLegendIconSize(), legendData()

legendIconSize()

Returns

Legend icon size

See also

setLegendIconSize(), legendIcon()

load_data(lut_range=None)

Load data from filename and eventually apply specified lut_range filename has been set using method ‘set_filename’

move_local_point_to(handle, pos, ctrl=None)

Move a handle as returned by hit_test to the new position pos ctrl: True if <Ctrl> button is being pressed, False otherwise

move_local_shape(old_pos, new_pos)

Translate the shape such that old_pos becomes new_pos in canvas coordinates

move_with_selection(delta_x, delta_y)

Translate the shape together with other selected items delta_x, delta_y: translation in plot coordinates

paintRect(xMap, yMap)

Calculate the bounding paint rectangle of 2 maps

Parameters

• xMap (qwt.scale_map.QwtScaleMap) – Maps x-values into pixel coordinates.

• yMap (qwt.scale_map.QwtScaleMap) – Maps y-values into pixel coordinates.

Returns

Bounding paint rectangle of the scale maps, not normalized

plot()

Returns

attached plot

rtti()

Return rtti for the specific class represented. QwtPlotItem is simply a virtual interface class, and base classes will implement this method with specific rtti values so a user can differentiate them.

Returns

rtti value

scaleRect(xMap, yMap)

Calculate the bounding scale rectangle of 2 maps

Parameters

• xMap (qwt.scale_map.QwtScaleMap) – Maps x-values into pixel coordinates.

• yMap (qwt.scale_map.QwtScaleMap) – Maps y-values into pixel coordinates.

Returns

Bounding scale rect of the scale maps, not normalized

select()

Select item

setAxes(xAxis, yAxis)

Set X and Y axis

The item will painted according to the coordinates of its Axes.

Parameters

• xAxis (int) – X Axis (QwtPlot.xBottom or QwtPlot.xTop)

• yAxis (int) – Y Axis (QwtPlot.yLeft or QwtPlot.yRight)

See also

setXAxis(), setYAxis(), xAxis(), yAxis()

setAxis(xAxis, yAxis)

Set X and Y axis

Warning

setAxis has been removed in Qwt6: please use setAxes() instead

setIcon(icon)

Set item icon

Parameters

icon (QIcon) – Icon

See also

icon()

setItemAttribute(attribute, on=True)

Toggle an item attribute

Parameters

• attribute (int) – Attribute type

• on (bool) – True/False

See also

testItemAttribute()

setItemInterest(interest, on=True)

Toggle an item interest

Parameters

• attribute (int) – Interest type

• on (bool) – True/False

See also

testItemInterest()

setLegendIconSize(size)

Set the size of the legend icon

The default setting is 8x8 pixels

Parameters

size (QSize) – Size

See also

legendIconSize(), legendIcon()

setRenderHint(hint, on=True)

Toggle a render hint

Parameters

• hint (int) – Render hint

• on (bool) – True/False

See also

testRenderHint()

setTitle(title)

Set a new title

Parameters

title (qwt.text.QwtText or str) – Title

See also

title()

setVisible(enable)

Show/Hide the item

Parameters

on (bool) – Show if True, otherwise hide

See also

isVisible(), show(), hide()

setXAxis(axis)

Set the X axis

The item will painted according to the coordinates its Axes.

Parameters

axis (int) – X Axis (QwtPlot.xBottom or QwtPlot.xTop)

See also

setAxes(), setYAxis(), xAxis(), yAxis()

setYAxis(axis)

Set the Y axis

The item will painted according to the coordinates its Axes.

Parameters

axis (int) – Y Axis (QwtPlot.yLeft or QwtPlot.yRight)

See also

setAxes(), setXAxis(), xAxis(), yAxis()

setZ(z)

Set the z value

Plot items are painted in increasing z-order.

Parameters

z (float) – Z-value

See also

z(), QwtPlotDict.itemList()

set_interpolation(interp_mode, size=None)

Set image interpolation mode

interp_mode: INTERP_NEAREST, INTERP_LINEAR, INTERP_AA size (integer): (for anti-aliasing only) AA matrix size

set_lut_range(lut_range)

Set LUT transform range lut_range is a tuple: (min, max)

set_movable(state)

Set item movable state

set_private(state)

Set object as private

set_readonly(state)

Set object readonly state

set_resizable(state)

Set item resizable state (or any action triggered when moving an handle, e.g. rotation)

set_rotatable(state)

Set item rotatable state

set_selectable(state)

Set item selectable state

show()

Show the item

testItemAttribute(attribute)

Test an item attribute

Parameters

attribute (int) – Attribute type

Returns

True/False

See also

setItemAttribute()

testItemInterest(interest)

Test an item interest

Parameters

attribute (int) – Interest type

Returns

True/False

See also

setItemInterest()

testRenderHint(hint)

Test a render hint

Parameters

attribute (int) – Render hint

Returns

True/False

See also

setRenderHint()

title()

Returns

Title of the item

See also

setTitle()

unselect()

Unselect item

updateLegend(item, data)

Update the item to changes of the legend info

Plot items that want to display a legend ( not those, that want to be displayed on a legend ! ) will have to implement updateLegend().

updateLegend() is only called when the LegendInterest interest is enabled. The default implementation does nothing.

Parameters

• item (qwt.plot.QwtPlotItem) – Plot item to be displayed on a legend

• data (list) – Attributes how to display item on the legend

Note

Plot items, that want to be displayed on a legend need to enable the QwtPlotItem.Legend flag and to implement legendData() and legendIcon()

update_border()

Update image border rectangle to fit image shape

xAxis()

Returns

xAxis

yAxis()

Returns

yAxis

z()

Plot items are painted in increasing z-order.

Returns

item z order

See also

setZ(), QwtPlotDict.itemList()

class guiqwt.image.ImageFilterItem(image, filter, param)

Construct a rectangular area image filter item

• image: guiqwt.image.RawImageItem instance

• filter: function (x, y, data) –> data

• param: image filter parameters (guiqwt.styles.ImageFilterParam instance)

set_image(image)

Set the image item on which the filter will be applied

• image: guiqwt.image.RawImageItem instance

set_filter(filter)

Set the filter function

• filter: function (x, y, data) –> data

boundingRect()

Returns

An invalid bounding rect: QRectF(1.0, 1.0, -2.0, -2.0)

Note

A width or height < 0.0 is ignored by the autoscaler

move_local_point_to(handle, pos, ctrl=None)

Move a handle as returned by hit_test to the new position pos ctrl: True if <Ctrl> button is being pressed, False otherwise

move_local_shape(old_pos, new_pos)

Translate the shape such that old_pos becomes new_pos in canvas coordinates

move_with_selection(delta_x, delta_y)

Translate the shape together with other selected items delta_x, delta_y: translation in plot coordinates

get_lut_range()

Return the LUT transform range tuple: (min, max)

set_lut_range(lut_range)

Set LUT transform range lut_range is a tuple: (min, max)

align_rectangular_shape(shape)

Align rectangular shape to image pixels

attach(plot)

Attach the item to a plot.

This method will attach a QwtPlotItem to the QwtPlot argument. It will first detach the QwtPlotItem from any plot from a previous call to attach (if necessary). If a None argument is passed, it will detach from any QwtPlot it was attached to.

Parameters

plot (qwt.plot.QwtPlot) – Plot widget

See also

detach()

detach()

Detach the item from a plot.

This method detaches a QwtPlotItem from any QwtPlot it has been associated with.

See also

attach()

draw_border(painter, xMap, yMap, canvasRect)

Draw image border rectangle

draw_image(painter, canvasRect, src_rect, dst_rect, xMap, yMap)

Draw image with painter on canvasRect

Warning

src_rect and dst_rect are coordinates tuples (xleft, ytop, xright, ybottom)

export_roi(src_rect, dst_rect, dst_image, apply_lut=False, apply_interpolation=False, original_resolution=False)

Export Region Of Interest to array

getCanvasMarginHint(xMap, yMap, canvasRect)

Calculate a hint for the canvas margin

When the QwtPlotItem::Margins flag is enabled the plot item indicates, that it needs some margins at the borders of the canvas. This is f.e. used by bar charts to reserve space for displaying the bars.

The margins are in target device coordinates ( pixels on screen )

Parameters

• xMap (qwt.scale_map.QwtScaleMap) – Maps x-values into pixel coordinates.

• yMap (qwt.scale_map.QwtScaleMap) – Maps y-values into pixel coordinates.

• canvasRect (QRectF) – Contents rectangle of the canvas in painter coordinates

See also

QwtPlot.getCanvasMarginsHint(), QwtPlot.updateCanvasMargins(),

get_average_xsection(x0, y0, x1, y1, apply_lut=False)

Return average cross section along x-axis

get_average_ysection(x0, y0, x1, y1, apply_lut=False)

Return average cross section along y-axis

get_closest_coordinates(x, y)

Return closest image pixel coordinates

get_closest_index_rect(x0, y0, x1, y1)

Return closest image rectangular pixel area index bounds Avoid returning empty rectangular area (return 1x1 pixel area instead) Handle reversed/not-reversed Y-axis orientation

get_closest_indexes(x, y, corner=None)

Return closest image pixel indexes corner: None (not a corner), ‘TL’ (top-left corner), ‘BR’ (bottom-right corner)

get_closest_pixel_indexes(x, y)

Return closest pixel indexes Instead of returning indexes of an image pixel like the method ‘get_closest_indexes’, this method returns the indexes of the closest pixel which is not necessarily on the image itself (i.e. indexes may be outside image index bounds: negative or superior than the image dimension)

Note

This is not the same as retrieving the canvas pixel coordinates (which depends on the zoom level)

get_data(x0, y0, x1=None, y1=None)

Return image data Arguments: x0, y0 [, x1, y1] Return image level at coordinates (x0,y0)

If x1,y1 are specified:

Return image levels (np.ndarray) in rectangular area (x0,y0,x1,y1)

get_default_param()

Return instance of the default imageparam DataSet

get_filter(filterobj, filterparam)

Provides a filter object over this image’s content

get_histogram(nbins)

interface de IHistDataSource

get_interpolation()

Get interpolation mode

get_lut_range_full()

Return full dynamic range

get_lut_range_max()

Get maximum range for this dataset

get_pixel_coordinates(xplot, yplot)

Return (image) pixel coordinates Transform the plot coordinates (arbitrary plot Z-axis unit) into the image coordinates (pixel unit)

Rounding is necessary to obtain array indexes from these coordinates

get_plot_coordinates(xpixel, ypixel)

Return plot coordinates Transform the image coordinates (pixel unit) into the plot coordinates (arbitrary plot Z-axis unit)

get_stats(x0, y0, x1, y1)

Return formatted string with stats on image rectangular area (output should be compatible with AnnotatedShape.get_infos)

get_xsection(y0, apply_lut=False)

Return cross section along x-axis at y=y0

get_ysection(x0, apply_lut=False)

Return cross section along y-axis at x=x0

hide()

Hide the item

icon()

Returns

Icon of the item

See also

setIcon()

isVisible()

Returns

True if visible

See also

setVisible(), show(), hide()

is_empty()

Return True if item data is empty

is_private()

Return True if object is private

is_readonly()

Return object readonly state

itemChanged()

Update the legend and call QwtPlot.autoRefresh() for the parent plot.

See also

QwtPlot.legendChanged(), QwtPlot.autoRefresh()

legendChanged()

Update the legend of the parent plot.

See also

QwtPlot.updateLegend(), itemChanged()

legendData()

Return all information, that is needed to represent the item on the legend

QwtLegendData is basically a list of QVariants that makes it possible to overload and reimplement legendData() to return almost any type of information, that is understood by the receiver that acts as the legend.

The default implementation returns one entry with the title() of the item and the legendIcon().

Returns

Data, that is needed to represent the item on the legend

See also

title(), legendIcon(), qwt.legend.QwtLegend

legendIcon(index, size)

Parameters

• index (int) – Index of the legend entry (usually there is only one)

• size (QSizeF) – Icon size

Returns

Icon representing the item on the legend

The default implementation returns an invalid icon

See also

setLegendIconSize(), legendData()

legendIconSize()

Returns

Legend icon size

See also

setLegendIconSize(), legendIcon()

paintRect(xMap, yMap)

Calculate the bounding paint rectangle of 2 maps

Parameters

• xMap (qwt.scale_map.QwtScaleMap) – Maps x-values into pixel coordinates.

• yMap (qwt.scale_map.QwtScaleMap) – Maps y-values into pixel coordinates.

Returns

Bounding paint rectangle of the scale maps, not normalized

plot()

Returns

attached plot

rtti()

Return rtti for the specific class represented. QwtPlotItem is simply a virtual interface class, and base classes will implement this method with specific rtti values so a user can differentiate them.

Returns

rtti value

scaleRect(xMap, yMap)

Calculate the bounding scale rectangle of 2 maps

Parameters

• xMap (qwt.scale_map.QwtScaleMap) – Maps x-values into pixel coordinates.

• yMap (qwt.scale_map.QwtScaleMap) – Maps y-values into pixel coordinates.

Returns

Bounding scale rect of the scale maps, not normalized

select()

Select item

setAxes(xAxis, yAxis)

Set X and Y axis

The item will painted according to the coordinates of its Axes.

Parameters

• xAxis (int) – X Axis (QwtPlot.xBottom or QwtPlot.xTop)

• yAxis (int) – Y Axis (QwtPlot.yLeft or QwtPlot.yRight)

See also

setXAxis(), setYAxis(), xAxis(), yAxis()

setAxis(xAxis, yAxis)

Set X and Y axis

Warning

setAxis has been removed in Qwt6: please use setAxes() instead

setIcon(icon)

Set item icon

Parameters

icon (QIcon) – Icon

See also

icon()

setItemAttribute(attribute, on=True)

Toggle an item attribute

Parameters

• attribute (int) – Attribute type

• on (bool) – True/False

See also

testItemAttribute()

setItemInterest(interest, on=True)

Toggle an item interest

Parameters

• attribute (int) – Interest type

• on (bool) – True/False

See also

testItemInterest()

setLegendIconSize(size)

Set the size of the legend icon

The default setting is 8x8 pixels

Parameters

size (QSize) – Size

See also

legendIconSize(), legendIcon()

setRenderHint(hint, on=True)

Toggle a render hint

Parameters

• hint (int) – Render hint

• on (bool) – True/False

See also

testRenderHint()

setTitle(title)

Set a new title

Parameters

title (qwt.text.QwtText or str) – Title

See also

title()

setVisible(enable)

Show/Hide the item

Parameters

on (bool) – Show if True, otherwise hide

See also

isVisible(), show(), hide()

setXAxis(axis)

Set the X axis

The item will painted according to the coordinates its Axes.

Parameters

axis (int) – X Axis (QwtPlot.xBottom or QwtPlot.xTop)

See also

setAxes(), setYAxis(), xAxis(), yAxis()

setYAxis(axis)

Set the Y axis

The item will painted according to the coordinates its Axes.

Parameters

axis (int) – Y Axis (QwtPlot.yLeft or QwtPlot.yRight)

See also

setAxes(), setXAxis(), xAxis(), yAxis()

setZ(z)

Set the z value

Plot items are painted in increasing z-order.

Parameters

z (float) – Z-value

See also

z(), QwtPlotDict.itemList()

set_interpolation(interp_mode, size=None)

Set image interpolation mode

interp_mode: INTERP_NEAREST, INTERP_LINEAR, INTERP_AA size (integer): (for anti-aliasing only) AA matrix size

set_movable(state)

Set item movable state

set_private(state)

Set object as private

set_readonly(state)

Set object readonly state

set_resizable(state)

Set item resizable state (or any action triggered when moving an handle, e.g. rotation)

set_rotatable(state)

Set item rotatable state

set_selectable(state)

Set item selectable state

show()

Show the item

testItemAttribute(attribute)

Test an item attribute

Parameters

attribute (int) – Attribute type

Returns

True/False

See also

setItemAttribute()

testItemInterest(interest)

Test an item interest

Parameters

attribute (int) – Interest type

Returns

True/False

See also

setItemInterest()

testRenderHint(hint)

Test a render hint

Parameters

attribute (int) – Render hint

Returns

True/False

See also

setRenderHint()

title()

Returns

Title of the item

See also

setTitle()

unselect()

Unselect item

updateLegend(item, data)

Update the item to changes of the legend info

Plot items that want to display a legend ( not those, that want to be displayed on a legend ! ) will have to implement updateLegend().

updateLegend() is only called when the LegendInterest interest is enabled. The default implementation does nothing.

Parameters

• item (qwt.plot.QwtPlotItem) – Plot item to be displayed on a legend

• data (list) – Attributes how to display item on the legend

Note

Plot items, that want to be displayed on a legend need to enable the QwtPlotItem.Legend flag and to implement legendData() and legendIcon()

update_border()

Update image border rectangle to fit image shape

xAxis()

Returns

xAxis

yAxis()

Returns

yAxis

z()

Plot items are painted in increasing z-order.

Returns

item z order

See also

setZ(), QwtPlotDict.itemList()

class guiqwt.image.XYImageFilterItem(image, filter, param)

Construct a rectangular area image filter item

• image: guiqwt.image.XYImageItem instance

• filter: function (x, y, data) –> data

• param: image filter parameters (guiqwt.styles.ImageFilterParam instance)

set_image(image)

Set the image item on which the filter will be applied

• image: guiqwt.image.XYImageItem instance

draw_image(painter, canvasRect, src_rect, dst_rect, xMap, yMap)

Draw image with painter on canvasRect

Warning

src_rect and dst_rect are coordinates tuples (xleft, ytop, xright, ybottom)

align_rectangular_shape(shape)

Align rectangular shape to image pixels

attach(plot)

Attach the item to a plot.

This method will attach a QwtPlotItem to the QwtPlot argument. It will first detach the QwtPlotItem from any plot from a previous call to attach (if necessary). If a None argument is passed, it will detach from any QwtPlot it was attached to.

Parameters

plot (qwt.plot.QwtPlot) – Plot widget

See also

detach()

boundingRect()

Returns

An invalid bounding rect: QRectF(1.0, 1.0, -2.0, -2.0)

Note

A width or height < 0.0 is ignored by the autoscaler

detach()

Detach the item from a plot.

This method detaches a QwtPlotItem from any QwtPlot it has been associated with.

See also

attach()

draw_border(painter, xMap, yMap, canvasRect)

Draw image border rectangle

export_roi(src_rect, dst_rect, dst_image, apply_lut=False, apply_interpolation=False, original_resolution=False)

Export Region Of Interest to array

getCanvasMarginHint(xMap, yMap, canvasRect)

Calculate a hint for the canvas margin

When the QwtPlotItem::Margins flag is enabled the plot item indicates, that it needs some margins at the borders of the canvas. This is f.e. used by bar charts to reserve space for displaying the bars.

The margins are in target device coordinates ( pixels on screen )

Parameters

• xMap (qwt.scale_map.QwtScaleMap) – Maps x-values into pixel coordinates.

• yMap (qwt.scale_map.QwtScaleMap) – Maps y-values into pixel coordinates.

• canvasRect (QRectF) – Contents rectangle of the canvas in painter coordinates

See also

QwtPlot.getCanvasMarginsHint(), QwtPlot.updateCanvasMargins(),

get_average_xsection(x0, y0, x1, y1, apply_lut=False)

Return average cross section along x-axis

get_average_ysection(x0, y0, x1, y1, apply_lut=False)

Return average cross section along y-axis

get_closest_coordinates(x, y)

Return closest image pixel coordinates

get_closest_index_rect(x0, y0, x1, y1)

Return closest image rectangular pixel area index bounds Avoid returning empty rectangular area (return 1x1 pixel area instead) Handle reversed/not-reversed Y-axis orientation

get_closest_indexes(x, y, corner=None)

Return closest image pixel indexes corner: None (not a corner), ‘TL’ (top-left corner), ‘BR’ (bottom-right corner)

get_closest_pixel_indexes(x, y)

Return closest pixel indexes Instead of returning indexes of an image pixel like the method ‘get_closest_indexes’, this method returns the indexes of the closest pixel which is not necessarily on the image itself (i.e. indexes may be outside image index bounds: negative or superior than the image dimension)

Note

This is not the same as retrieving the canvas pixel coordinates (which depends on the zoom level)

get_data(x0, y0, x1=None, y1=None)

Return image data Arguments: x0, y0 [, x1, y1] Return image level at coordinates (x0,y0)

If x1,y1 are specified:

Return image levels (np.ndarray) in rectangular area (x0,y0,x1,y1)

get_default_param()

Return instance of the default imageparam DataSet

get_filter(filterobj, filterparam)

Provides a filter object over this image’s content

get_histogram(nbins)

interface de IHistDataSource

get_interpolation()

Get interpolation mode

get_lut_range()

Return the LUT transform range tuple: (min, max)

get_lut_range_full()

Return full dynamic range

get_lut_range_max()

Get maximum range for this dataset

get_pixel_coordinates(xplot, yplot)

Return (image) pixel coordinates Transform the plot coordinates (arbitrary plot Z-axis unit) into the image coordinates (pixel unit)

Rounding is necessary to obtain array indexes from these coordinates

get_plot_coordinates(xpixel, ypixel)

Return plot coordinates Transform the image coordinates (pixel unit) into the plot coordinates (arbitrary plot Z-axis unit)

get_stats(x0, y0, x1, y1)

Return formatted string with stats on image rectangular area (output should be compatible with AnnotatedShape.get_infos)

get_xsection(y0, apply_lut=False)

Return cross section along x-axis at y=y0

get_ysection(x0, apply_lut=False)

Return cross section along y-axis at x=x0

hide()

Hide the item

icon()

Returns

Icon of the item

See also

setIcon()

isVisible()

Returns

True if visible

See also

setVisible(), show(), hide()

is_empty()

Return True if item data is empty

is_private()

Return True if object is private

is_readonly()

Return object readonly state

itemChanged()

Update the legend and call QwtPlot.autoRefresh() for the parent plot.

See also

QwtPlot.legendChanged(), QwtPlot.autoRefresh()

legendChanged()

Update the legend of the parent plot.

See also

QwtPlot.updateLegend(), itemChanged()

legendData()

Return all information, that is needed to represent the item on the legend

QwtLegendData is basically a list of QVariants that makes it possible to overload and reimplement legendData() to return almost any type of information, that is understood by the receiver that acts as the legend.

The default implementation returns one entry with the title() of the item and the legendIcon().

Returns

Data, that is needed to represent the item on the legend

See also

title(), legendIcon(), qwt.legend.QwtLegend

legendIcon(index, size)

Parameters

• index (int) – Index of the legend entry (usually there is only one)

• size (QSizeF) – Icon size

Returns

Icon representing the item on the legend

The default implementation returns an invalid icon

See also

setLegendIconSize(), legendData()

legendIconSize()

Returns

Legend icon size

See also

setLegendIconSize(), legendIcon()

move_local_point_to(handle, pos, ctrl=None)

Move a handle as returned by hit_test to the new position pos ctrl: True if <Ctrl> button is being pressed, False otherwise

move_local_shape(old_pos, new_pos)

Translate the shape such that old_pos becomes new_pos in canvas coordinates

move_with_selection(delta_x, delta_y)

Translate the shape together with other selected items delta_x, delta_y: translation in plot coordinates

paintRect(xMap, yMap)

Calculate the bounding paint rectangle of 2 maps

Parameters

• xMap (qwt.scale_map.QwtScaleMap) – Maps x-values into pixel coordinates.

• yMap (qwt.scale_map.QwtScaleMap) – Maps y-values into pixel coordinates.

Returns

Bounding paint rectangle of the scale maps, not normalized

plot()

Returns

attached plot

rtti()

Return rtti for the specific class represented. QwtPlotItem is simply a virtual interface class, and base classes will implement this method with specific rtti values so a user can differentiate them.

Returns

rtti value

scaleRect(xMap, yMap)

Calculate the bounding scale rectangle of 2 maps

Parameters

• xMap (qwt.scale_map.QwtScaleMap) – Maps x-values into pixel coordinates.

• yMap (qwt.scale_map.QwtScaleMap) – Maps y-values into pixel coordinates.

Returns

Bounding scale rect of the scale maps, not normalized

select()

Select item

setAxes(xAxis, yAxis)

Set X and Y axis

The item will painted according to the coordinates of its Axes.

Parameters

• xAxis (int) – X Axis (QwtPlot.xBottom or QwtPlot.xTop)

• yAxis (int) – Y Axis (QwtPlot.yLeft or QwtPlot.yRight)

See also

setXAxis(), setYAxis(), xAxis(), yAxis()

setAxis(xAxis, yAxis)

Set X and Y axis

Warning

setAxis has been removed in Qwt6: please use setAxes() instead

setIcon(icon)

Set item icon

Parameters

icon (QIcon) – Icon

See also

icon()

setItemAttribute(attribute, on=True)

Toggle an item attribute

Parameters

• attribute (int) – Attribute type

• on (bool) – True/False

See also

testItemAttribute()

setItemInterest(interest, on=True)

Toggle an item interest

Parameters

• attribute (int) – Interest type

• on (bool) – True/False

See also

testItemInterest()

setLegendIconSize(size)

Set the size of the legend icon

The default setting is 8x8 pixels

Parameters

size (QSize) – Size

See also

legendIconSize(), legendIcon()

setRenderHint(hint, on=True)

Toggle a render hint

Parameters

• hint (int) – Render hint

• on (bool) – True/False

See also

testRenderHint()

setTitle(title)

Set a new title

Parameters

title (qwt.text.QwtText or str) – Title

See also

title()

setVisible(enable)

Show/Hide the item

Parameters

on (bool) – Show if True, otherwise hide

See also

isVisible(), show(), hide()

setXAxis(axis)

Set the X axis

The item will painted according to the coordinates its Axes.

Parameters

axis (int) – X Axis (QwtPlot.xBottom or QwtPlot.xTop)

See also

setAxes(), setYAxis(), xAxis(), yAxis()

setYAxis(axis)

Set the Y axis

The item will painted according to the coordinates its Axes.

Parameters

axis (int) – Y Axis (QwtPlot.yLeft or QwtPlot.yRight)

See also

setAxes(), setXAxis(), xAxis(), yAxis()

setZ(z)

Set the z value

Plot items are painted in increasing z-order.

Parameters

z (float) – Z-value

See also

z(), QwtPlotDict.itemList()

set_filter(filter)

Set the filter function

• filter: function (x, y, data) –> data

set_interpolation(interp_mode, size=None)

Set image interpolation mode

interp_mode: INTERP_NEAREST, INTERP_LINEAR, INTERP_AA size (integer): (for anti-aliasing only) AA matrix size

set_lut_range(lut_range)

Set LUT transform range lut_range is a tuple: (min, max)

set_movable(state)

Set item movable state

set_private(state)

Set object as private

set_readonly(state)

Set object readonly state

set_resizable(state)

Set item resizable state (or any action triggered when moving an handle, e.g. rotation)

set_rotatable(state)

Set item rotatable state

set_selectable(state)

Set item selectable state

show()

Show the item

testItemAttribute(attribute)

Test an item attribute

Parameters

attribute (int) – Attribute type

Returns

True/False

See also

setItemAttribute()

testItemInterest(interest)

Test an item interest

Parameters

attribute (int) – Interest type

Returns

True/False

See also

setItemInterest()

testRenderHint(hint)

Test a render hint

Parameters

attribute (int) – Render hint

Returns

True/False

See also

setRenderHint()

title()

Returns

Title of the item

See also

setTitle()

unselect()

Unselect item

updateLegend(item, data)

Update the item to changes of the legend info

Plot items that want to display a legend ( not those, that want to be displayed on a legend ! ) will have to implement updateLegend().

updateLegend() is only called when the LegendInterest interest is enabled. The default implementation does nothing.

Parameters

• item (qwt.plot.QwtPlotItem) – Plot item to be displayed on a legend

• data (list) – Attributes how to display item on the legend

Note

Plot items, that want to be displayed on a legend need to enable the QwtPlotItem.Legend flag and to implement legendData() and legendIcon()

update_border()

Update image border rectangle to fit image shape

xAxis()

Returns

xAxis

yAxis()

Returns

yAxis

z()

Plot items are painted in increasing z-order.

Returns

item z order

See also

setZ(), QwtPlotDict.itemList()

class guiqwt.image.Histogram2DItem(X, Y, param=None, Z=None)

Construct a 2D histogram item

• X: data (1-D array)

• Y: data (1-D array)

• param (optional): style parameters (guiqwt.styles.Histogram2DParam instance)

set_bins(NX, NY)

Set histogram bins

set_data(X, Y, Z=None)

Set histogram data

draw_image(painter, canvasRect, src_rect, dst_rect, xMap, yMap)

Draw image with painter on canvasRect

Warning

src_rect and dst_rect are coordinates tuples (xleft, ytop, xright, ybottom)

get_histogram(nbins)

interface de IHistDataSource

align_rectangular_shape(shape)

Align rectangular shape to image pixels

attach(plot)

Attach the item to a plot.

This method will attach a QwtPlotItem to the QwtPlot argument. It will first detach the QwtPlotItem from any plot from a previous call to attach (if necessary). If a None argument is passed, it will detach from any QwtPlot it was attached to.

Parameters

plot (qwt.plot.QwtPlot) – Plot widget

See also

detach()

boundingRect()

Returns

An invalid bounding rect: QRectF(1.0, 1.0, -2.0, -2.0)

Note

A width or height < 0.0 is ignored by the autoscaler

detach()

Detach the item from a plot.

This method detaches a QwtPlotItem from any QwtPlot it has been associated with.

See also

attach()

draw_border(painter, xMap, yMap, canvasRect)

Draw image border rectangle

export_roi(src_rect, dst_rect, dst_image, apply_lut=False, apply_interpolation=False, original_resolution=False)

Export Region Of Interest to array

getCanvasMarginHint(xMap, yMap, canvasRect)

Calculate a hint for the canvas margin

When the QwtPlotItem::Margins flag is enabled the plot item indicates, that it needs some margins at the borders of the canvas. This is f.e. used by bar charts to reserve space for displaying the bars.

The margins are in target device coordinates ( pixels on screen )

Parameters

• xMap (qwt.scale_map.QwtScaleMap) – Maps x-values into pixel coordinates.

• yMap (qwt.scale_map.QwtScaleMap) – Maps y-values into pixel coordinates.

• canvasRect (QRectF) – Contents rectangle of the canvas in painter coordinates

See also

QwtPlot.getCanvasMarginsHint(), QwtPlot.updateCanvasMargins(),

get_average_xsection(x0, y0, x1, y1, apply_lut=False)

Return average cross section along x-axis

get_average_ysection(x0, y0, x1, y1, apply_lut=False)

Return average cross section along y-axis

get_closest_coordinates(x, y)

Return closest image pixel coordinates

get_closest_index_rect(x0, y0, x1, y1)

Return closest image rectangular pixel area index bounds Avoid returning empty rectangular area (return 1x1 pixel area instead) Handle reversed/not-reversed Y-axis orientation

get_closest_indexes(x, y, corner=None)

Return closest image pixel indexes corner: None (not a corner), ‘TL’ (top-left corner), ‘BR’ (bottom-right corner)

get_closest_pixel_indexes(x, y)

Return closest pixel indexes Instead of returning indexes of an image pixel like the method ‘get_closest_indexes’, this method returns the indexes of the closest pixel which is not necessarily on the image itself (i.e. indexes may be outside image index bounds: negative or superior than the image dimension)

Note

This is not the same as retrieving the canvas pixel coordinates (which depends on the zoom level)

get_data(x0, y0, x1=None, y1=None)

Return image data Arguments: x0, y0 [, x1, y1] Return image level at coordinates (x0,y0)

If x1,y1 are specified:

Return image levels (np.ndarray) in rectangular area (x0,y0,x1,y1)

get_default_param()

Return instance of the default imageparam DataSet

get_filter(filterobj, filterparam)

Provides a filter object over this image’s content

get_interpolation()

Get interpolation mode

get_lut_range()

Return the LUT transform range tuple: (min, max)

get_lut_range_full()

Return full dynamic range

get_lut_range_max()

Get maximum range for this dataset

get_pixel_coordinates(xplot, yplot)

Return (image) pixel coordinates Transform the plot coordinates (arbitrary plot Z-axis unit) into the image coordinates (pixel unit)

Rounding is necessary to obtain array indexes from these coordinates

get_plot_coordinates(xpixel, ypixel)

Return plot coordinates Transform the image coordinates (pixel unit) into the plot coordinates (arbitrary plot Z-axis unit)

get_stats(x0, y0, x1, y1)

Return formatted string with stats on image rectangular area (output should be compatible with AnnotatedShape.get_infos)

get_xsection(y0, apply_lut=False)

Return cross section along x-axis at y=y0

get_ysection(x0, apply_lut=False)

Return cross section along y-axis at x=x0

hide()

Hide the item

icon()

Returns

Icon of the item

See also

setIcon()

isVisible()

Returns

True if visible

See also

setVisible(), show(), hide()

is_empty()

Return True if item data is empty

is_private()

Return True if object is private

is_readonly()

Return object readonly state

itemChanged()

Update the legend and call QwtPlot.autoRefresh() for the parent plot.

See also

QwtPlot.legendChanged(), QwtPlot.autoRefresh()

legendChanged()

Update the legend of the parent plot.

See also

QwtPlot.updateLegend(), itemChanged()

legendData()

Return all information, that is needed to represent the item on the legend

QwtLegendData is basically a list of QVariants that makes it possible to overload and reimplement legendData() to return almost any type of information, that is understood by the receiver that acts as the legend.

The default implementation returns one entry with the title() of the item and the legendIcon().

Returns

Data, that is needed to represent the item on the legend

See also

title(), legendIcon(), qwt.legend.QwtLegend

legendIcon(index, size)

Parameters

• index (int) – Index of the legend entry (usually there is only one)

• size (QSizeF) – Icon size

Returns

Icon representing the item on the legend

The default implementation returns an invalid icon

See also

setLegendIconSize(), legendData()

legendIconSize()

Returns

Legend icon size

See also

setLegendIconSize(), legendIcon()

move_local_point_to(handle, pos, ctrl=None)

Move a handle as returned by hit_test to the new position pos ctrl: True if <Ctrl> button is being pressed, False otherwise

move_local_shape(old_pos, new_pos)

Translate the shape such that old_pos becomes new_pos in canvas coordinates

move_with_selection(delta_x, delta_y)

Translate the shape together with other selected items delta_x, delta_y: translation in plot coordinates

paintRect(xMap, yMap)

Calculate the bounding paint rectangle of 2 maps

Parameters

• xMap (qwt.scale_map.QwtScaleMap) – Maps x-values into pixel coordinates.

• yMap (qwt.scale_map.QwtScaleMap) – Maps y-values into pixel coordinates.

Returns

Bounding paint rectangle of the scale maps, not normalized

plot()

Returns

attached plot

rtti()

Return rtti for the specific class represented. QwtPlotItem is simply a virtual interface class, and base classes will implement this method with specific rtti values so a user can differentiate them.

Returns

rtti value

scaleRect(xMap, yMap)

Calculate the bounding scale rectangle of 2 maps

Parameters

• xMap (qwt.scale_map.QwtScaleMap) – Maps x-values into pixel coordinates.

• yMap (qwt.scale_map.QwtScaleMap) – Maps y-values into pixel coordinates.

Returns

Bounding scale rect of the scale maps, not normalized

select()

Select item

setAxes(xAxis, yAxis)

Set X and Y axis

The item will painted according to the coordinates of its Axes.

Parameters

• xAxis (int) – X Axis (QwtPlot.xBottom or QwtPlot.xTop)

• yAxis (int) – Y Axis (QwtPlot.yLeft or QwtPlot.yRight)

See also

setXAxis(), setYAxis(), xAxis(), yAxis()

setAxis(xAxis, yAxis)

Set X and Y axis

Warning

setAxis has been removed in Qwt6: please use setAxes() instead

setIcon(icon)

Set item icon

Parameters

icon (QIcon) – Icon

See also

icon()

setItemAttribute(attribute, on=True)

Toggle an item attribute

Parameters

• attribute (int) – Attribute type

• on (bool) – True/False

See also

testItemAttribute()

setItemInterest(interest, on=True)

Toggle an item interest

Parameters

• attribute (int) – Interest type

• on (bool) – True/False

See also

testItemInterest()

setLegendIconSize(size)

Set the size of the legend icon

The default setting is 8x8 pixels

Parameters

size (QSize) – Size

See also

legendIconSize(), legendIcon()

setRenderHint(hint, on=True)

Toggle a render hint

Parameters

• hint (int) – Render hint

• on (bool) – True/False

See also

testRenderHint()

setTitle(title)

Set a new title

Parameters

title (qwt.text.QwtText or str) – Title

See also

title()

setVisible(enable)

Show/Hide the item

Parameters

on (bool) – Show if True, otherwise hide

See also

isVisible(), show(), hide()

setXAxis(axis)

Set the X axis

The item will painted according to the coordinates its Axes.

Parameters

axis (int) – X Axis (QwtPlot.xBottom or QwtPlot.xTop)

See also

setAxes(), setYAxis(), xAxis(), yAxis()

setYAxis(axis)

Set the Y axis

The item will painted according to the coordinates its Axes.

Parameters

axis (int) – Y Axis (QwtPlot.yLeft or QwtPlot.yRight)

See also

setAxes(), setXAxis(), xAxis(), yAxis()

setZ(z)

Set the z value

Plot items are painted in increasing z-order.

Parameters

z (float) – Z-value

See also

z(), QwtPlotDict.itemList()

set_interpolation(interp_mode, size=None)

Set image interpolation mode

interp_mode: INTERP_NEAREST, INTERP_LINEAR, INTERP_AA size (integer): (for anti-aliasing only) AA matrix size

set_lut_range(lut_range)

Set LUT transform range lut_range is a tuple: (min, max)

set_movable(state)

Set item movable state

set_private(state)

Set object as private

set_readonly(state)

Set object readonly state

set_resizable(state)

Set item resizable state (or any action triggered when moving an handle, e.g. rotation)

set_rotatable(state)

Set item rotatable state

set_selectable(state)

Set item selectable state

show()

Show the item

testItemAttribute(attribute)

Test an item attribute

Parameters

attribute (int) – Attribute type

Returns

True/False

See also

setItemAttribute()

testItemInterest(interest)

Test an item interest

Parameters

attribute (int) – Interest type

Returns

True/False

See also

setItemInterest()

testRenderHint(hint)

Test a render hint

Parameters

attribute (int) – Render hint

Returns

True/False

See also

setRenderHint()

title()

Returns

Title of the item

See also

setTitle()

unselect()

Unselect item

updateLegend(item, data)

Update the item to changes of the legend info

Plot items that want to display a legend ( not those, that want to be displayed on a legend ! ) will have to implement updateLegend().

updateLegend() is only called when the LegendInterest interest is enabled. The default implementation does nothing.

Parameters

• item (qwt.plot.QwtPlotItem) – Plot item to be displayed on a legend

• data (list) – Attributes how to display item on the legend

Note

Plot items, that want to be displayed on a legend need to enable the QwtPlotItem.Legend flag and to implement legendData() and legendIcon()

update_border()

Update image border rectangle to fit image shape

xAxis()

Returns

xAxis

yAxis()

Returns

yAxis

z()

Plot items are painted in increasing z-order.

Returns

item z order

See also

setZ(), QwtPlotDict.itemList()

guiqwt.image.assemble_imageitems(items, src_qrect, destw, desth, align=None, add_images=False, apply_lut=False, apply_interpolation=False, original_resolution=False)

Assemble together image items in qrect (QRectF object) and return resulting pixel data

Warning

Does not support XYImageItem objects

guiqwt.image.get_plot_qrect(plot, p0, p1)

Return QRectF rectangle object in plot coordinates from top-left and bottom-right QPointF objects in canvas coordinates

guiqwt.image.get_image_from_plot(plot, p0, p1, destw=None, desth=None, add_images=False, apply_lut=False, apply_interpolation=False, original_resolution=False)

Return pixel data of a rectangular plot area (image items only) p0, p1: resp. top-left and bottom-right points (QPointF objects) apply_lut: apply contrast settings add_images: add superimposed images (instead of replace by the foreground)

Warning

Support only the image items implementing the IExportROIImageItemType interface, i.e. this does not support XYImageItem objects