guiqwt.image¶
The image module provides image-related objects and functions:
guiqwt.image.ImagePlot
: a 2D curve and image plotting widget, derived fromguiqwt.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.get_plot_source_rect()
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')[source]¶
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
IImageItemType
- add_item(item, z=None, autoscale=True)[source]¶
Add a plot item instance to this plot widget
item:
qwt.QwtPlotItem
object implementing theguiqwt.interfaces.IBasePlotItem
interfacez: item’s z order (None -> z = max(self.get_items())+1) autoscale: True -> rescale plot to fit image bounds
- set_active_item(item)[source]¶
Override base set_active_item to change the grid’s axes according to the selected item
- class PaintDeviceMetric¶
- class RenderFlag¶
- class RenderFlags¶
- class RenderFlags(f: QWidget.RenderFlags | QWidget.RenderFlag)
- class RenderFlags(a0: QWidget.RenderFlags)
- SIG_ACTIVE_ITEM_CHANGED¶
Signal emitted by plot when selected item has changed
- SIG_ANNOTATION_CHANGED¶
Signal emitted by plot when an annotation.AnnotatedShape position changes
- SIG_AXES_CHANGED¶
Signal emitted by plot when a shapes.Axes position (or the angle) changes
- SIG_AXIS_DIRECTION_CHANGED¶
Signal emitted by plot when any plot axis direction has changed
- SIG_CS_CURVE_CHANGED¶
Signal emitted by cross section plot when cross section curve data has changed
- SIG_ITEMS_CHANGED¶
Signal emitted by plot when item list has changed (item removed, added, …)
- SIG_ITEM_HANDLE_MOVED¶
Signal emitted by plot when an IBasePlotItem handle was moved
- SIG_ITEM_MOVED¶
Signal emitted by plot when an IBasePlotItem object was moved (args: x0, y0, x1, y1)
- SIG_ITEM_REMOVED¶
Signal emitted by plot when an item was deleted from the item list or using the delete item tool
- SIG_ITEM_SELECTION_CHANGED¶
Signal emitted by plot when an item is selected
- SIG_LUT_CHANGED¶
Signal emitted by plot when LUT has been changed by the user
- SIG_MARKER_CHANGED¶
Signal emitted by plot when a shapes.Marker position changes
- SIG_MASK_CHANGED¶
Signal emitted by plot when image mask has changed
- SIG_PLOT_AXIS_CHANGED¶
Signal emitted by plot when plot axis has changed, e.g. when panning/zooming (arg: plot))
- SIG_PLOT_LABELS_CHANGED¶
Signal emitted by plot when plot’s title or any axis label has changed
- SIG_RANGE_CHANGED¶
Signal emitted by plot when the a shapes.XRangeSelection range changes
- class Shadow¶
- class Shape¶
- class StyleMask¶
- acceptDrops(self) bool ¶
- accessibleDescription(self) str ¶
- accessibleName(self) str ¶
- actionEvent(self, a0: QActionEvent | None)¶
- actions(self) List[QAction] ¶
- activateWindow(self)¶
- addAction(self, action: QAction | None)¶
- addActions(self, actions: 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
- autoFillBackground(self) bool ¶
- autoRefresh()¶
Replots the plot if
autoReplot()
is True.
- autoReplot()¶
- Returns:
True if the autoReplot option is set.
See also
- 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
- 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, b: bool) bool ¶
- canvas()¶
- Returns:
the plot’s canvas
- canvasBackground()¶
- Returns:
Background brush of the plotting area.
See also
- 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, a0: QEvent | None)¶
- childAt(self, p: QPoint) QWidget | None ¶
- childAt(self, ax: int, ay: int) QWidget | None
- childEvent(self, a0: QChildEvent | None)¶
- children(self) List[QObject] ¶
- childrenRect(self) QRect ¶
- childrenRegion(self) QRegion ¶
- clearFocus(self)¶
- clearMask(self)¶
- close(self) bool ¶
- closeEvent(self, a0: QCloseEvent | None)¶
- colorCount(self) int ¶
- connectNotify(self, signal: QMetaMethod)¶
- contentsMargins(self) QMargins ¶
- contentsRect(self) QRect ¶
- contextMenuEvent(self, a0: QContextMenuEvent | None)¶
- contextMenuPolicy(self) Qt.ContextMenuPolicy ¶
- copy_to_clipboard()¶
Copy widget’s window to clipboard
- create(self, window: PyQt5.sip.voidptr = None, initializeWindow: bool = True, destroyOldWindow: bool = True)¶
- createWindowContainer(window: QWindow | None, parent: QWidget | None = None, flags: Qt.WindowFlags | Qt.WindowType = 0) QWidget ¶
- cursor(self) QCursor ¶
- customEvent(self, a0: QEvent | None)¶
- 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.dataset.io.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.
Note
This was a member of QwtPlotDict in older versions.
- 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(a0: QMetaObject.Connection) bool ¶
- disconnect(self) None
- disconnectNotify(self, signal: 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, a0: QDragEnterEvent | None)¶
- dragLeaveEvent(self, a0: QDragLeaveEvent | None)¶
- dragMoveEvent(self, a0: QDragMoveEvent | None)¶
- 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, a0: QPainter | None)¶
- 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, a0: QDropEvent | None)¶
- dumpObjectInfo(self)¶
- dumpObjectTree(self)¶
- dynamicPropertyNames(self) List[QByteArray] ¶
- 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, a0: QEvent | None)¶
- event(self, e: QEvent | None) bool ¶
- eventFilter(self, a0: QObject | None, a1: QEvent | None) bool ¶
- exportTo(filename, size=(800, 600), size_mm=None, resolution=85, 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 (int) – Resolution in dots per Inch (dpi)
format (str) – File format (PDF, SVG, PNG, …)
- find(a0: PyQt5.sip.voidptr) QWidget | None ¶
- findChild(self, type: Type[QObjectT], name: str | None = '', options: Qt.FindChildOptions | Qt.FindChildOption = Qt.FindChildrenRecursively) QObjectT ¶
- findChild(self, types: Tuple[Type[QObjectT], ...], name: str | None = '', options: Qt.FindChildOptions | Qt.FindChildOption = Qt.FindChildrenRecursively) QObjectT
- findChildren(self, type: Type[QObjectT], name: str | None = '', options: Qt.FindChildOptions | Qt.FindChildOption = Qt.FindChildrenRecursively) List[QObjectT] ¶
- findChildren(self, types: Tuple[Type[QObjectT], ...], name: str | None = '', options: Qt.FindChildOptions | Qt.FindChildOption = Qt.FindChildrenRecursively) List[QObjectT]
- findChildren(self, type: Type[QObjectT], regExp: QRegExp, options: Qt.FindChildOptions | Qt.FindChildOption = Qt.FindChildrenRecursively) List[QObjectT]
- findChildren(self, types: Tuple[Type[QObjectT], ...], regExp: QRegExp, options: Qt.FindChildOptions | Qt.FindChildOption = Qt.FindChildrenRecursively) List[QObjectT]
- findChildren(self, type: Type[QObjectT], re: QRegularExpression, options: Qt.FindChildOptions | Qt.FindChildOption = Qt.FindChildrenRecursively) List[QObjectT]
- findChildren(self, types: Tuple[Type[QObjectT], ...], re: QRegularExpression, options: Qt.FindChildOptions | Qt.FindChildOption = Qt.FindChildrenRecursively) List[QObjectT]
- flatStyle()¶
- Returns:
True if the flatStyle option is set.
See also
- focusInEvent(self, a0: QFocusEvent | None)¶
- focusNextChild(self) bool ¶
- focusNextPrevChild(self, next: bool) bool ¶
- focusOutEvent(self, a0: QFocusEvent | None)¶
- focusPolicy(self) Qt.FocusPolicy ¶
- focusPreviousChild(self) bool ¶
- focusProxy(self) QWidget | None ¶
- focusWidget(self) QWidget | None ¶
- font(self) QFont ¶
- fontInfo(self) QFontInfo ¶
- fontMetrics(self) QFontMetrics ¶
- Returns:
Text of the footer
See also
- 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)¶
- 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
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, type: Qt.GestureType, flags: Qt.GestureFlags | Qt.GestureFlag = Qt.GestureFlags())¶
- grabKeyboard(self)¶
- grabMouse(self)¶
- grabMouse(self, a0: QCursor | Qt.CursorShape) None
- grabShortcut(self, key: QKeySequence | QKeySequence.StandardKey | str | None | int, context: Qt.ShortcutContext = Qt.WindowShortcut) int ¶
- graphicsEffect(self) QGraphicsEffect | None ¶
- graphicsProxyWidget(self) QGraphicsProxyWidget | None ¶
- hasFocus(self) bool ¶
- hasHeightForWidth(self) bool ¶
- hasMouseTracking(self) bool ¶
- hasTabletTracking(self) bool ¶
- height(self) int ¶
- heightForWidth(self, a0: int) int ¶
- heightMM(self) int ¶
- hide(self)¶
- hideEvent(self, a0: QHideEvent | None)¶
- hide_items(items=None, item_type=None)¶
Hide items (if items is None, hide all items)
- inherits(self, classname: str | None) bool ¶
- initAxesData()¶
Initialize axes
- initPainter(self, painter: QPainter | None)¶
- initStyleOption(self, option: QStyleOptionFrame | None)¶
- inputMethodEvent(self, a0: QInputMethodEvent | None)¶
- inputMethodHints(self) Qt.InputMethodHints ¶
- inputMethodQuery(self, a0: Qt.InputMethodQuery) Any ¶
- insertAction(self, before: QAction | None, action: QAction | None)¶
- insertActions(self, before: QAction | None, actions: Iterable[QAction])¶
- insertItem(item)¶
Insert a plot item
- Parameters:
item (qwt.plot.QwtPlotItem) – PlotItem
See also
Note
This was a member of QwtPlotDict in older versions.
- 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, a0: QObject | None)¶
- 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, child: QWidget | None) bool ¶
- isEnabled(self) bool ¶
- isEnabledTo(self, a0: QWidget | None) bool ¶
- isFullScreen(self) bool ¶
- isHidden(self) bool ¶
- isLeftToRight(self) bool ¶
- isMaximized(self) bool ¶
- isMinimized(self) bool ¶
- isModal(self) bool ¶
- isRightToLeft(self) bool ¶
- isSignalConnected(self, signal: QMetaMethod) bool ¶
- isVisible(self) bool ¶
- isVisibleTo(self, a0: QWidget | None) 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.
Note
This was a member of QwtPlotDict in older versions.
- keyPressEvent(self, a0: QKeyEvent | None)¶
- keyReleaseEvent(self, a0: QKeyEvent | None)¶
- keyboardGrabber() QWidget | None ¶
- killTimer(self, id: int)¶
- layout(self) QLayout | None ¶
- layoutDirection(self) Qt.LayoutDirection ¶
- leaveEvent(self, a0: QEvent | None)¶
- legend()¶
- Returns:
the plot’s legend
See also
- lineWidth(self) int ¶
- locale(self) QLocale ¶
- logicalDpiX(self) int ¶
- logicalDpiY(self) int ¶
- lower(self)¶
- mapFrom(self, a0: QWidget | None, a1: QPoint) QPoint ¶
- mapFromGlobal(self, a0: QPoint) QPoint ¶
- mapFromParent(self, a0: QPoint) QPoint ¶
- mapTo(self, a0: QWidget | None, a1: QPoint) QPoint ¶
- mapToGlobal(self, a0: QPoint) QPoint ¶
- mapToParent(self, a0: QPoint) QPoint ¶
- mask(self) QRegion ¶
- maximumHeight(self) int ¶
- maximumSize(self) QSize ¶
- maximumWidth(self) int ¶
- metaObject(self) QMetaObject | None ¶
- metric(self, a0: 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 | None ¶
- mouseMoveEvent(self, a0: QMouseEvent | None)¶
- mousePressEvent(self, a0: QMouseEvent | None)¶
- mouseReleaseEvent(self, a0: QMouseEvent | None)¶
- move(self, a0: QPoint)¶
- move(self, ax: int, ay: int) None
- moveEvent(self, a0: QMoveEvent | None)¶
- moveToThread(self, thread: QThread | None)¶
- 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, eventType: QByteArray | bytes | bytearray, message: PyQt5.sip.voidptr | None)¶
- nativeParentWidget(self) QWidget | None ¶
- nextInFocusChain(self) QWidget | None ¶
- normalGeometry(self) QRect ¶
- objectName(self) str ¶
- overrideWindowFlags(self, type: Qt.WindowFlags | Qt.WindowType)¶
- overrideWindowState(self, state: Qt.WindowStates | Qt.WindowState)¶
- paintEngine(self) QPaintEngine | None ¶
- paintEvent(self, a0: QPaintEvent | None)¶
- paintingActive(self) bool ¶
- palette(self) QPalette ¶
- parent(self) QObject | None ¶
- parentWidget(self) QWidget | None ¶
- physicalDpiX(self) int ¶
- physicalDpiY(self) int ¶
- plotLayout()¶
- Returns:
the plot’s layout
See also
- pos(self) QPoint ¶
- previousInFocusChain(self) QWidget | None ¶
- print_(printer)¶
Print plot to printer
- Parameters:
printer (QPaintDevice or QPrinter or QSvgGenerator) – Printer
- property(self, name: str | None) 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, signal: PYQT_SIGNAL) int ¶
- rect(self) QRect ¶
- releaseKeyboard(self)¶
- releaseMouse(self)¶
- releaseShortcut(self, id: int)¶
- removeAction(self, action: QAction | None)¶
- removeEventFilter(self, a0: QObject | None)¶
- removeItem(item)¶
Remove a plot item
- Parameters:
item (qwt.plot.QwtPlotItem) – PlotItem
See also
Note
This was a member of QwtPlotDict in older versions.
- render(self, target: QPaintDevice | None, targetOffset: QPoint = QPoint(), sourceRegion: QRegion = QRegion(), flags: QWidget.RenderFlags | QWidget.RenderFlag = QWidget.RenderFlags(QWidget.RenderFlag.DrawWindowBackground | QWidget.RenderFlag.DrawChildren))¶
- render(self, painter: QPainter | None, targetOffset: QPoint = QPoint(), sourceRegion: QRegion = QRegion(), flags: QWidget.RenderFlags | QWidget.RenderFlag = QWidget.RenderFlags(QWidget.RenderFlag.DrawWindowBackground | QWidget.RenderFlag.DrawChildren)) None
- repaint(self)¶
- repaint(self, x: int, y: int, w: int, h: int) None
- repaint(self, a0: QRect) None
- repaint(self, a0: 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
- resize(self, a0: QSize)¶
- resize(self, w: int, h: int) None
- restoreGeometry(self, geometry: QByteArray | bytes | bytearray) bool ¶
- restore_items(iofile)¶
- Restore items from file using the
pickle
protocol iofile: file object or filename
- Restore items from file using the
- 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
- Save (serializable) items to file using the
- save_widget(fname)¶
Grab widget’s window and save it to filename (*.png, *.pdf)
- screen(self) QScreen | None ¶
- scroll(self, dx: int, dy: int)¶
- scroll(self, dx: int, dy: int, a2: QRect) None
- select_all()¶
Select all selectable items
- select_item(item)¶
Select item
- select_some_items(items)¶
Select items
- sender(self) QObject | None ¶
- senderSignalIndex(self) int ¶
- serialize(writer, selected=False)¶
- Save (serializable) items to HDF5 file:
writer:
guidata.dataset.io.HDF5Writer
objectselected=False: if True, will save only selected items
See also
guiqwt.baseplot.BasePlot.restore_items_from_hdf5()
- setAcceptDrops(self, on: bool)¶
- setAccessibleDescription(self, description: str | None)¶
- setAccessibleName(self, name: str | None)¶
- setAttribute(self, attribute: Qt.WidgetAttribute, on: bool = True)¶
- setAutoFillBackground(self, enabled: 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
- 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
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
- 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
- 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
- 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
- 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, a0: QPalette.ColorRole)¶
- setBaseSize(self, basew: int, baseh: int)¶
- setBaseSize(self, s: 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
- 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
- setContentsMargins(self, left: int, top: int, right: int, bottom: int)¶
- setContentsMargins(self, margins: QMargins) None
- setContextMenuPolicy(self, policy: Qt.ContextMenuPolicy)¶
- setCursor(self, a0: QCursor | Qt.CursorShape)¶
- setDisabled(self, a0: bool)¶
- setEnabled(self, a0: bool)¶
- setFixedHeight(self, h: int)¶
- setFixedSize(self, a0: QSize)¶
- setFixedSize(self, w: int, h: int) None
- setFixedWidth(self, w: 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
- setFocus(self)¶
- setFocus(self, reason: Qt.FocusReason) None
- setFocusPolicy(self, policy: Qt.FocusPolicy)¶
- setFocusProxy(self, a0: QWidget | None)¶
- setFont(self, a0: QFont)¶
Change the text the footer
- Parameters:
text (str or qwt.text.QwtText) – New text of the footer
See also
- setForegroundRole(self, a0: QPalette.ColorRole)¶
- setFrameRect(self, a0: QRect)¶
- setFrameShadow(self, a0: QFrame.Shadow)¶
- setFrameShape(self, a0: QFrame.Shape)¶
- setFrameStyle(self, a0: int)¶
- setGeometry(self, a0: QRect)¶
- setGeometry(self, ax: int, ay: int, aw: int, ah: int) None
- setGraphicsEffect(self, effect: QGraphicsEffect | None)¶
- setHidden(self, hidden: bool)¶
- setInputMethodHints(self, hints: Qt.InputMethodHints | Qt.InputMethodHint)¶
- setLayout(self, a0: QLayout | None)¶
- setLayoutDirection(self, direction: Qt.LayoutDirection)¶
- setLineWidth(self, a0: int)¶
- setLocale(self, locale: QLocale)¶
- setMask(self, a0: QBitmap)¶
- setMask(self, a0: QRegion) None
- setMaximumHeight(self, maxh: int)¶
- setMaximumSize(self, maxw: int, maxh: int)¶
- setMaximumSize(self, s: QSize) None
- setMaximumWidth(self, maxw: int)¶
- setMidLineWidth(self, a0: int)¶
- setMinimumHeight(self, minh: int)¶
- setMinimumSize(self, minw: int, minh: int)¶
- setMinimumSize(self, s: QSize) None
- setMinimumWidth(self, minw: int)¶
- setMouseTracking(self, enable: bool)¶
- setObjectName(self, name: str | None)¶
- setPalette(self, a0: QPalette)¶
- setParent(self, parent: QWidget | None)¶
- setParent(self, parent: QWidget | None, f: Qt.WindowFlags | Qt.WindowType) None
- setPlotLayout(layout)¶
Assign a new plot layout
- Parameters:
layout (qwt.plot_layout.QwtPlotLayout) – Layout
See also
- setProperty(self, name: str | None, value: Any) bool ¶
- setShortcutAutoRepeat(self, id: int, enabled: bool = True)¶
- setShortcutEnabled(self, id: int, enabled: bool = True)¶
- setSizeIncrement(self, w: int, h: int)¶
- setSizeIncrement(self, s: QSize) None
- setSizePolicy(self, a0: QSizePolicy)¶
- setSizePolicy(self, hor: QSizePolicy.Policy, ver: QSizePolicy.Policy) None
- setStatusTip(self, a0: str | None)¶
- setStyle(self, a0: QStyle | None)¶
- setStyleSheet(self, styleSheet: str | None)¶
- setTabOrder(a0: QWidget | None, a1: QWidget | None)¶
- setTabletTracking(self, enable: bool)¶
- setTitle(title)¶
Change the plot’s title
- Parameters:
title (str or qwt.text.QwtText) – New title
See also
- setToolTip(self, a0: str | None)¶
- setToolTipDuration(self, msec: int)¶
- setUpdatesEnabled(self, enable: bool)¶
- setVisible(self, visible: bool)¶
- setWhatsThis(self, a0: str | None)¶
- setWindowFilePath(self, filePath: str | None)¶
- setWindowFlag(self, a0: Qt.WindowType, on: bool = True)¶
- setWindowFlags(self, type: Qt.WindowFlags | Qt.WindowType)¶
- setWindowIcon(self, icon: QIcon)¶
- setWindowIconText(self, a0: str | None)¶
- setWindowModality(self, windowModality: Qt.WindowModality)¶
- setWindowModified(self, a0: bool)¶
- setWindowOpacity(self, level: float)¶
- setWindowRole(self, a0: str | None)¶
- setWindowState(self, state: Qt.WindowStates | Qt.WindowState)¶
- setWindowTitle(self, a0: str | None)¶
- 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
- 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, a0: QWidget | None)¶
- startTimer(self, interval: int, timerType: Qt.TimerType = Qt.CoarseTimer) int ¶
- statusTip(self) str ¶
- style(self) QStyle | None ¶
- styleSheet(self) str ¶
- tabletEvent(self, a0: QTabletEvent | None)¶
- testAttribute(self, attribute: Qt.WidgetAttribute) bool ¶
- thread(self) QThread | None ¶
- timerEvent(self, a0: QTimerEvent | None)¶
- title()¶
- Returns:
Title of the plot
See also
- titleLabel()¶
- Returns:
Title label widget.
- toolTip(self) str ¶
- toolTipDuration(self) int ¶
- tr(self, sourceText: str | None, disambiguation: str | None = 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, type: Qt.GestureType)¶
- unselect_all()¶
Unselect all selected items
- unselect_item(item)¶
Unselect item
- unsetCursor(self)¶
- unsetLayoutDirection(self)¶
- unsetLocale(self)¶
- update(self)¶
- update(self, a0: QRect) None
- update(self, a0: QRegion) None
- update(self, ax: int, ay: int, aw: int, ah: 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
- 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, a0: QWheelEvent | None)¶
- width(self) int ¶
- widthMM(self) int ¶
- winId(self) PyQt5.sip.voidptr ¶
- window(self) QWidget | None ¶
- windowFilePath(self) str ¶
- windowFlags(self) Qt.WindowFlags ¶
- windowHandle(self) QWindow | None ¶
- 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)[source]¶
-
- get_pixel_coordinates(xplot, yplot)[source]¶
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)[source]¶
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)[source]¶
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)[source]¶
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_pixel_indexes(x, y)[source]¶
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)[source]¶
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)
- set_interpolation(interp_mode, size=None)[source]¶
Set image interpolation mode
interp_mode: INTERP_NEAREST, INTERP_LINEAR, INTERP_AA size (integer): (for anti-aliasing only) AA matrix size
- draw_image(painter, canvasRect, src_rect, dst_rect, xMap, yMap)[source]¶
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)[source]¶
Export Region Of Interest to array
- boundingRect()[source]¶
- 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)[source]¶
Show/Hide the item
- Parameters:
on (bool) – Show if True, otherwise hide
See also
- set_resizable(state)[source]¶
Set item resizable state (or any action triggered when moving an handle, e.g. rotation)
- move_local_point_to(handle, pos, ctrl=None)[source]¶
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)[source]¶
Translate the shape such that old_pos becomes new_pos in canvas coordinates
- move_with_selection(delta_x, delta_y)[source]¶
Translate the shape together with other selected items delta_x, delta_y: translation in plot coordinates
- get_stats(x0, y0, x1, y1)[source]¶
Return formatted string with stats on image rectangular area (output should be compatible with AnnotatedShape.get_infos)
- get_average_xsection(x0, y0, x1, y1, apply_lut=False)[source]¶
Return average cross section along x-axis
- get_average_ysection(x0, y0, x1, y1, apply_lut=False)[source]¶
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 the item from a plot.
This method detaches a QwtPlotItem from any QwtPlot it has been associated with.
See also
- 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
- isVisible()¶
- Returns:
True if visible
See also
- 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
- legendIconSize()¶
- Returns:
Legend icon size
See also
- 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
- setAxis(xAxis, yAxis)¶
Set X and Y axis
Warning
setAxis has been removed in Qwt6: please use
setAxes()
instead
- setItemAttribute(attribute, on=True)¶
Toggle an item attribute
- Parameters:
attribute (int) – Attribute type
on (bool) – True/False
See also
- setItemInterest(interest, on=True)¶
Toggle an item interest
- Parameters:
attribute (int) – Interest type
on (bool) – True/False
See also
- setLegendIconSize(size)¶
Set the size of the legend icon
The default setting is 8x8 pixels
- Parameters:
size (QSize) – Size
See also
- setRenderHint(hint, on=True)¶
Toggle a render hint
- Parameters:
hint (int) – Render hint
on (bool) – True/False
See also
- setTitle(title)¶
Set a new title
- Parameters:
title (qwt.text.QwtText or str) – Title
See also
- 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
- 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
- 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
- testItemInterest(interest)¶
Test an item interest
- Parameters:
attribute (int) – Interest type
- Returns:
True/False
See also
- testRenderHint(hint)¶
Test a render hint
- Parameters:
attribute (int) – Render hint
- Returns:
True/False
See also
- title()¶
- Returns:
Title of the item
See also
- 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
- class guiqwt.image.RawImageItem(data=None, param=None)[source]¶
Construct a simple image item
data: 2D NumPy array
param (optional): image parameters (
guiqwt.styles.RawImageParam
instance)
- load_data(lut_range=None)[source]¶
Load data from filename and eventually apply specified lut_range filename has been set using method ‘set_filename’
- set_data(data, lut_range=None)[source]¶
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
- 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
- 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
- isVisible()¶
- Returns:
True if visible
See also
- 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
- legendIconSize()¶
- Returns:
Legend icon size
See also
- 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
- setAxis(xAxis, yAxis)¶
Set X and Y axis
Warning
setAxis has been removed in Qwt6: please use
setAxes()
instead
- setItemAttribute(attribute, on=True)¶
Toggle an item attribute
- Parameters:
attribute (int) – Attribute type
on (bool) – True/False
See also
- setItemInterest(interest, on=True)¶
Toggle an item interest
- Parameters:
attribute (int) – Interest type
on (bool) – True/False
See also
- setLegendIconSize(size)¶
Set the size of the legend icon
The default setting is 8x8 pixels
- Parameters:
size (QSize) – Size
See also
- setRenderHint(hint, on=True)¶
Toggle a render hint
- Parameters:
hint (int) – Render hint
on (bool) – True/False
See also
- setTitle(title)¶
Set a new title
- Parameters:
title (qwt.text.QwtText or str) – Title
See also
- setVisible(enable)¶
Show/Hide the item
- Parameters:
on (bool) – Show if True, otherwise hide
See also
- 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
- 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
- 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
- testItemInterest(interest)¶
Test an item interest
- Parameters:
attribute (int) – Interest type
- Returns:
True/False
See also
- testRenderHint(hint)¶
Test a render hint
- Parameters:
attribute (int) – Render hint
- Returns:
True/False
See also
- title()¶
- Returns:
Title of the item
See also
- 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
- class guiqwt.image.ImageItem(data=None, param=None)[source]¶
Construct a simple image item
data: 2D NumPy array
param (optional): image parameters (
guiqwt.styles.ImageParam
instance)
- get_pixel_coordinates(xplot, yplot)[source]¶
Return (image) pixel coordinates (from plot coordinates)
- get_plot_coordinates(xpixel, ypixel)[source]¶
Return plot coordinates (from image pixel coordinates)
- draw_image(painter, canvasRect, src_rect, dst_rect, xMap, yMap)[source]¶
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)[source]¶
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
- 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
- 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
- isVisible()¶
- Returns:
True if visible
See also
- 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
- legendIconSize()¶
- Returns:
Legend icon size
See also
- 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
- setAxis(xAxis, yAxis)¶
Set X and Y axis
Warning
setAxis has been removed in Qwt6: please use
setAxes()
instead
- setItemAttribute(attribute, on=True)¶
Toggle an item attribute
- Parameters:
attribute (int) – Attribute type
on (bool) – True/False
See also
- setItemInterest(interest, on=True)¶
Toggle an item interest
- Parameters:
attribute (int) – Interest type
on (bool) – True/False
See also
- setLegendIconSize(size)¶
Set the size of the legend icon
The default setting is 8x8 pixels
- Parameters:
size (QSize) – Size
See also
- setRenderHint(hint, on=True)¶
Toggle a render hint
- Parameters:
hint (int) – Render hint
on (bool) – True/False
See also
- setTitle(title)¶
Set a new title
- Parameters:
title (qwt.text.QwtText or str) – Title
See also
- setVisible(enable)¶
Show/Hide the item
- Parameters:
on (bool) – Show if True, otherwise hide
See also
- 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
- 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
- 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
- testItemInterest(interest)¶
Test an item interest
- Parameters:
attribute (int) – Interest type
- Returns:
True/False
See also
- testRenderHint(hint)¶
Test a render hint
- Parameters:
attribute (int) – Render hint
- Returns:
True/False
See also
- title()¶
- Returns:
Title of the item
See also
- 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
- class guiqwt.image.TrImageItem(data=None, param=None)[source]¶
Construct a transformable image item
data: 2D NumPy array
param (optional): image parameters (
guiqwt.styles.TrImageParam
instance)
- set_data(data, lut_range=None)[source]¶
Set Image item data
data: 2D NumPy array
lut_range: LUT range – tuple (levelmin, levelmax)
- get_pixel_coordinates(xplot, yplot)[source]¶
Return (image) pixel coordinates (from plot coordinates)
- get_plot_coordinates(xpixel, ypixel)[source]¶
Return plot coordinates (from image pixel coordinates)
- draw_image(painter, canvasRect, src_rect, dst_rect, xMap, yMap)[source]¶
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)[source]¶
Export Region Of Interest to array
- move_local_point_to(handle, pos, ctrl=None)[source]¶
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)[source]¶
Translate the shape such that old_pos becomes new_pos in canvas coordinates
- move_with_selection(delta_x, delta_y)[source]¶
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
- 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
- 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
- isVisible()¶
- Returns:
True if visible
See also
- 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
- legendIconSize()¶
- Returns:
Legend icon size
See also
- 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
- setAxis(xAxis, yAxis)¶
Set X and Y axis
Warning
setAxis has been removed in Qwt6: please use
setAxes()
instead
- setItemAttribute(attribute, on=True)¶
Toggle an item attribute
- Parameters:
attribute (int) – Attribute type
on (bool) – True/False
See also
- setItemInterest(interest, on=True)¶
Toggle an item interest
- Parameters:
attribute (int) – Interest type
on (bool) – True/False
See also
- setLegendIconSize(size)¶
Set the size of the legend icon
The default setting is 8x8 pixels
- Parameters:
size (QSize) – Size
See also
- setRenderHint(hint, on=True)¶
Toggle a render hint
- Parameters:
hint (int) – Render hint
on (bool) – True/False
See also
- setTitle(title)¶
Set a new title
- Parameters:
title (qwt.text.QwtText or str) – Title
See also
- setVisible(enable)¶
Show/Hide the item
- Parameters:
on (bool) – Show if True, otherwise hide
See also
- 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
- 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
- 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
- testItemInterest(interest)¶
Test an item interest
- Parameters:
attribute (int) – Interest type
- Returns:
True/False
See also
- testRenderHint(hint)¶
Test a render hint
- Parameters:
attribute (int) – Render hint
- Returns:
True/False
See also
- title()¶
- Returns:
Title of the item
See also
- 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
- class guiqwt.image.XYImageItem(x=None, y=None, data=None, param=None)[source]¶
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)
- draw_image(painter, canvasRect, src_rect, dst_rect, xMap, yMap)[source]¶
Draw image with painter on canvasRect
Warning
src_rect and dst_rect are coordinates tuples (xleft, ytop, xright, ybottom)
- get_pixel_coordinates(xplot, yplot)[source]¶
Return (image) pixel coordinates (from plot coordinates)
- get_plot_coordinates(xpixel, ypixel)[source]¶
Return plot coordinates (from 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
- 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
- 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
- isVisible()¶
- Returns:
True if visible
See also
- 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
- legendIconSize()¶
- Returns:
Legend icon size
See also
- 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
- setAxis(xAxis, yAxis)¶
Set X and Y axis
Warning
setAxis has been removed in Qwt6: please use
setAxes()
instead
- setItemAttribute(attribute, on=True)¶
Toggle an item attribute
- Parameters:
attribute (int) – Attribute type
on (bool) – True/False
See also
- setItemInterest(interest, on=True)¶
Toggle an item interest
- Parameters:
attribute (int) – Interest type
on (bool) – True/False
See also
- setLegendIconSize(size)¶
Set the size of the legend icon
The default setting is 8x8 pixels
- Parameters:
size (QSize) – Size
See also
- setRenderHint(hint, on=True)¶
Toggle a render hint
- Parameters:
hint (int) – Render hint
on (bool) – True/False
See also
- setTitle(title)¶
Set a new title
- Parameters:
title (qwt.text.QwtText or str) – Title
See also
- setVisible(enable)¶
Show/Hide the item
- Parameters:
on (bool) – Show if True, otherwise hide
See also
- 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
- 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
- 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
- testItemInterest(interest)¶
Test an item interest
- Parameters:
attribute (int) – Interest type
- Returns:
True/False
See also
- testRenderHint(hint)¶
Test a render hint
- Parameters:
attribute (int) – Render hint
- Returns:
True/False
See also
- title()¶
- Returns:
Title of the item
See also
- 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
- class guiqwt.image.RGBImageItem(data=None, param=None)[source]¶
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)
- set_data(data)[source]¶
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
- 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
- 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(aligned=True)¶
Return (xmin, xmax)
- get_xsection(y0, apply_lut=False)¶
Return cross section along x-axis at y=y0
- get_ydata(aligned=True)¶
Return (ymin, ymax)
- get_ysection(x0, apply_lut=False)¶
Return cross section along y-axis at x=x0
- hide()¶
Hide the item
- isVisible()¶
- Returns:
True if visible
See also
- 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
- legendIconSize()¶
- Returns:
Legend icon size
See also
- 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
- setAxis(xAxis, yAxis)¶
Set X and Y axis
Warning
setAxis has been removed in Qwt6: please use
setAxes()
instead
- setItemAttribute(attribute, on=True)¶
Toggle an item attribute
- Parameters:
attribute (int) – Attribute type
on (bool) – True/False
See also
- setItemInterest(interest, on=True)¶
Toggle an item interest
- Parameters:
attribute (int) – Interest type
on (bool) – True/False
See also
- setLegendIconSize(size)¶
Set the size of the legend icon
The default setting is 8x8 pixels
- Parameters:
size (QSize) – Size
See also
- setRenderHint(hint, on=True)¶
Toggle a render hint
- Parameters:
hint (int) – Render hint
on (bool) – True/False
See also
- setTitle(title)¶
Set a new title
- Parameters:
title (qwt.text.QwtText or str) – Title
See also
- setVisible(enable)¶
Show/Hide the item
- Parameters:
on (bool) – Show if True, otherwise hide
See also
- 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
- 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
- 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
- testItemInterest(interest)¶
Test an item interest
- Parameters:
attribute (int) – Interest type
- Returns:
True/False
See also
- testRenderHint(hint)¶
Test a render hint
- Parameters:
attribute (int) – Render hint
- Returns:
True/False
See also
- title()¶
- Returns:
Title of the item
See also
- 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
- class guiqwt.image.MaskedImageItem(data=None, mask=None, param=None)[source]¶
Construct a masked image item
data: 2D NumPy array
mask (optional): 2D NumPy array
param (optional): image parameters (
guiqwt.styles.MaskedImageParam
instance)
- set_mask_filename(fname)[source]¶
Set mask filename
There are two ways for pickling mask data of MaskedImageItem objects:
using the mask filename (as for data itself)
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.
- mask_rectangular_area(x0, y0, x1, y1, inside=True, trace=True, do_signal=True)[source]¶
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)[source]¶
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
- draw_image(painter, canvasRect, src_rect, dst_rect, xMap, yMap)[source]¶
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)[source]¶
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
- 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
- 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(aligned=True)¶
Return (xmin, xmax)
- get_xsection(y0, apply_lut=False)¶
Return cross section along x-axis at y=y0
- get_ydata(aligned=True)¶
Return (ymin, ymax)
- get_ysection(x0, apply_lut=False)¶
Return cross section along y-axis at x=x0
- hide()¶
Hide the item
- isVisible()¶
- Returns:
True if visible
See also
- 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
- legendIconSize()¶
- Returns:
Legend icon size
See also
- 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
- setAxis(xAxis, yAxis)¶
Set X and Y axis
Warning
setAxis has been removed in Qwt6: please use
setAxes()
instead
- setItemAttribute(attribute, on=True)¶
Toggle an item attribute
- Parameters:
attribute (int) – Attribute type
on (bool) – True/False
See also
- setItemInterest(interest, on=True)¶
Toggle an item interest
- Parameters:
attribute (int) – Interest type
on (bool) – True/False
See also
- setLegendIconSize(size)¶
Set the size of the legend icon
The default setting is 8x8 pixels
- Parameters:
size (QSize) – Size
See also
- setRenderHint(hint, on=True)¶
Toggle a render hint
- Parameters:
hint (int) – Render hint
on (bool) – True/False
See also
- setTitle(title)¶
Set a new title
- Parameters:
title (qwt.text.QwtText or str) – Title
See also
- setVisible(enable)¶
Show/Hide the item
- Parameters:
on (bool) – Show if True, otherwise hide
See also
- 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
- 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
- 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
- testItemInterest(interest)¶
Test an item interest
- Parameters:
attribute (int) – Interest type
- Returns:
True/False
See also
- testRenderHint(hint)¶
Test a render hint
- Parameters:
attribute (int) – Render hint
- Returns:
True/False
See also
- title()¶
- Returns:
Title of the item
See also
- 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
- class guiqwt.image.ImageFilterItem(image, filter, param)[source]¶
Construct a rectangular area image filter item
image:
guiqwt.image.RawImageItem
instancefilter: function (x, y, data) –> data
param: image filter parameters (
guiqwt.styles.ImageFilterParam
instance)
- set_image(image)[source]¶
Set the image item on which the filter will be applied
image:
guiqwt.image.RawImageItem
instance
- boundingRect()[source]¶
- 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)[source]¶
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)[source]¶
Translate the shape such that old_pos becomes new_pos in canvas coordinates
- move_with_selection(delta_x, delta_y)[source]¶
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()¶
Detach the item from a plot.
This method detaches a QwtPlotItem from any QwtPlot it has been associated with.
See also
- 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
- isVisible()¶
- Returns:
True if visible
See also
- 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
- legendIconSize()¶
- Returns:
Legend icon size
See also
- 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
- setAxis(xAxis, yAxis)¶
Set X and Y axis
Warning
setAxis has been removed in Qwt6: please use
setAxes()
instead
- setItemAttribute(attribute, on=True)¶
Toggle an item attribute
- Parameters:
attribute (int) – Attribute type
on (bool) – True/False
See also
- setItemInterest(interest, on=True)¶
Toggle an item interest
- Parameters:
attribute (int) – Interest type
on (bool) – True/False
See also
- setLegendIconSize(size)¶
Set the size of the legend icon
The default setting is 8x8 pixels
- Parameters:
size (QSize) – Size
See also
- setRenderHint(hint, on=True)¶
Toggle a render hint
- Parameters:
hint (int) – Render hint
on (bool) – True/False
See also
- setTitle(title)¶
Set a new title
- Parameters:
title (qwt.text.QwtText or str) – Title
See also
- setVisible(enable)¶
Show/Hide the item
- Parameters:
on (bool) – Show if True, otherwise hide
See also
- 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
- 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
- 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
- testItemInterest(interest)¶
Test an item interest
- Parameters:
attribute (int) – Interest type
- Returns:
True/False
See also
- testRenderHint(hint)¶
Test a render hint
- Parameters:
attribute (int) – Render hint
- Returns:
True/False
See also
- title()¶
- Returns:
Title of the item
See also
- 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
- class guiqwt.image.XYImageFilterItem(image, filter, param)[source]¶
Construct a rectangular area image filter item
image:
guiqwt.image.XYImageItem
instancefilter: function (x, y, data) –> data
param: image filter parameters (
guiqwt.styles.ImageFilterParam
instance)
- set_image(image)[source]¶
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)[source]¶
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
- 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
- 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
- isVisible()¶
- Returns:
True if visible
See also
- 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
- legendIconSize()¶
- Returns:
Legend icon size
See also
- 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
- setAxis(xAxis, yAxis)¶
Set X and Y axis
Warning
setAxis has been removed in Qwt6: please use
setAxes()
instead
- setItemAttribute(attribute, on=True)¶
Toggle an item attribute
- Parameters:
attribute (int) – Attribute type
on (bool) – True/False
See also
- setItemInterest(interest, on=True)¶
Toggle an item interest
- Parameters:
attribute (int) – Interest type
on (bool) – True/False
See also
- setLegendIconSize(size)¶
Set the size of the legend icon
The default setting is 8x8 pixels
- Parameters:
size (QSize) – Size
See also
- setRenderHint(hint, on=True)¶
Toggle a render hint
- Parameters:
hint (int) – Render hint
on (bool) – True/False
See also
- setTitle(title)¶
Set a new title
- Parameters:
title (qwt.text.QwtText or str) – Title
See also
- setVisible(enable)¶
Show/Hide the item
- Parameters:
on (bool) – Show if True, otherwise hide
See also
- 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
- 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
- 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
- testItemInterest(interest)¶
Test an item interest
- Parameters:
attribute (int) – Interest type
- Returns:
True/False
See also
- testRenderHint(hint)¶
Test a render hint
- Parameters:
attribute (int) – Render hint
- Returns:
True/False
See also
- title()¶
- Returns:
Title of the item
See also
- 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
- class guiqwt.image.Histogram2DItem(X, Y, param=None, Z=None)[source]¶
Construct a 2D histogram item
X: data (1-D array)
Y: data (1-D array)
param (optional): style parameters (
guiqwt.styles.Histogram2DParam
instance)
- draw_image(painter, canvasRect, src_rect, dst_rect, xMap, yMap)[source]¶
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
- 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
- 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
- isVisible()¶
- Returns:
True if visible
See also
- 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
- legendIconSize()¶
- Returns:
Legend icon size
See also
- 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
- setAxis(xAxis, yAxis)¶
Set X and Y axis
Warning
setAxis has been removed in Qwt6: please use
setAxes()
instead
- setItemAttribute(attribute, on=True)¶
Toggle an item attribute
- Parameters:
attribute (int) – Attribute type
on (bool) – True/False
See also
- setItemInterest(interest, on=True)¶
Toggle an item interest
- Parameters:
attribute (int) – Interest type
on (bool) – True/False
See also
- setLegendIconSize(size)¶
Set the size of the legend icon
The default setting is 8x8 pixels
- Parameters:
size (QSize) – Size
See also
- setRenderHint(hint, on=True)¶
Toggle a render hint
- Parameters:
hint (int) – Render hint
on (bool) – True/False
See also
- setTitle(title)¶
Set a new title
- Parameters:
title (qwt.text.QwtText or str) – Title
See also
- setVisible(enable)¶
Show/Hide the item
- Parameters:
on (bool) – Show if True, otherwise hide
See also
- 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
- 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
- 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
- testItemInterest(interest)¶
Test an item interest
- Parameters:
attribute (int) – Interest type
- Returns:
True/False
See also
- testRenderHint(hint)¶
Test a render hint
- Parameters:
attribute (int) – Render hint
- Returns:
True/False
See also
- title()¶
- Returns:
Title of the item
See also
- 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
- guiqwt.image.assemble_imageitems(items, src_qrect, destw, desth, align=None, add_images=False, apply_lut=False, apply_interpolation=False, original_resolution=False)[source]¶
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)[source]¶
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)[source]¶
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