plotpy.image ¶

ImagePlot.setToolTip(str)¶

ImagePlot.setUpdatesEnabled(bool)¶

ImagePlot.setVisible(bool)¶

ImagePlot.setWhatsThis(str)¶

ImagePlot.setWindowFilePath(str)¶

ImagePlot.setWindowFlags(Qt.WindowFlags)¶

ImagePlot.setWindowIcon(QIcon)¶

ImagePlot.setWindowIconText(str)¶

ImagePlot.setWindowModality(Qt.WindowModality)¶

ImagePlot.setWindowModified(bool)¶

ImagePlot.setWindowOpacity(float)¶

ImagePlot.setWindowRole(str)¶

ImagePlot.setWindowState(Qt.WindowStates)¶

ImagePlot.setWindowTitle(str)¶

ImagePlot.set_antialiasing(checked)¶: Toggle curve antialiasing

ImagePlot.set_axis_color(axis_id, color)¶: Set axis color color: color name (string) or QColor instance

ImagePlot.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

ImagePlot.set_axis_font(axis_id, font)¶: Set axis font

ImagePlot.set_axis_limits(axis_id, vmin, vmax, stepsize=0)¶: Set axis limits (minimum and maximum values)

ImagePlot.set_axis_scale(axis_id, scale, autoscale=True)¶: Set axis scale Example: self.set_axis_scale(curve.yAxis(), ‘lin’)

ImagePlot.set_axis_ticks(axis_id, nmajor=None, nminor=None)¶: Set axis maximum number of major ticks and maximum of minor ticks

ImagePlot.set_axis_title(axis_id, text)¶: Set axis title

ImagePlot.set_axis_unit(axis_id, text)¶: Set axis unit

ImagePlot.set_item_visible(item, state, notify=True, replot=True)¶: Show/hide item and emit a SIG_ITEMS_CHANGED signal

ImagePlot.set_items(*args)¶: Utility function used to quickly setup a plot with a set of items

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

ImagePlot.set_manager(manager, plot_id)¶: Set the associated plotpy.plot.PlotManager instance

ImagePlot.set_plot_limits(x0, x1, y0, y1, xaxis='bottom', yaxis='left')¶: Set plot scale limits

ImagePlot.set_pointer(pointer_type)¶

Set pointer.

Valid values of pointer_type:

None: disable pointer

“canvas”: enable canvas pointer

“curve”: enable on-curve pointer

ImagePlot.set_scales(xscale, yscale)¶: Set active curve scales Example: self.set_scales(‘lin’, ‘lin’)

ImagePlot.set_title(title)¶: Set plot title

ImagePlot.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

ImagePlot.show()¶

ImagePlot.showFullScreen()¶

ImagePlot.showMaximized()¶

ImagePlot.showMinimized()¶

ImagePlot.showNormal()¶

ImagePlot.show_items(items=None, item_type=None)¶: Show items (if items is None, show all items)

ImagePlot.signalsBlocked() → bool¶

ImagePlot.size() → QSize¶

ImagePlot.sizeHint()¶: Preferred size

ImagePlot.sizeIncrement() → QSize¶

ImagePlot.sizePolicy() → QSizePolicy¶

ImagePlot.stackUnder(QWidget)¶

ImagePlot.startTimer(int) → int¶

ImagePlot.statusTip() → str¶

ImagePlot.style() → QStyle¶

ImagePlot.styleSheet() → str¶

ImagePlot.testAttribute(Qt.WidgetAttribute) → bool¶

ImagePlot.thread() → QThread¶

ImagePlot.title()¶

Returns:	Title of the plot

See also

ImagePlot.titleLabel()¶

Returns:	Title label widget.

ImagePlot.toolTip() → str¶

ImagePlot.topLevelWidget() → QWidget¶

ImagePlot.tr(str, str disambiguation=None, int n=-1) → str¶

ImagePlot.trUtf8(str, str disambiguation=None, int n=-1) → str¶

ImagePlot.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.

ImagePlot.underMouse() → bool¶

ImagePlot.ungrabGesture(Qt.GestureType)¶

ImagePlot.unselect_all()¶: Unselect all selected items

ImagePlot.unselect_item(item)¶: Unselect item

ImagePlot.unsetCursor()¶

ImagePlot.unsetLayoutDirection()¶

ImagePlot.unsetLocale()¶

ImagePlot.update()¶: QWidget.update(QRect) QWidget.update(QRegion) QWidget.update(int, int, int, int)

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

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

ImagePlot.updateGeometry()¶

ImagePlot.updateLayout()¶: Adjust plot content to its current size.

See also

resizeEvent()

ImagePlot.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

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

ImagePlot.update_all_axes_styles()¶: Update all axes styles

ImagePlot.update_axis_style(axis_id)¶: Update axis style

ImagePlot.updatesEnabled() → bool¶

ImagePlot.visibleRegion() → QRegion¶

ImagePlot.whatsThis() → str¶

ImagePlot.width() → int¶

ImagePlot.widthMM() → int¶

ImagePlot.winId() → sip.voidptr¶

ImagePlot.window() → QWidget¶

ImagePlot.windowFilePath() → str¶

ImagePlot.windowFlags() → Qt.WindowFlags¶

ImagePlot.windowIcon() → QIcon¶

ImagePlot.windowIconText() → str¶

ImagePlot.windowModality() → Qt.WindowModality¶

ImagePlot.windowOpacity() → float¶

ImagePlot.windowRole() → str¶

ImagePlot.windowState() → Qt.WindowStates¶

ImagePlot.windowTitle() → str¶

ImagePlot.windowType() → Qt.WindowType¶

ImagePlot.x() → int¶

ImagePlot.y() → int¶

ImagePlot.set_active_item(item)[source]¶: Override base set_active_item to change the grid’s axes according to the selected item

ImagePlot.disable_unused_axes()[source]¶: Disable unused axes

ImagePlot.do_autoscale(replot=True, axis_id=None)[source]¶: Do autoscale on all axes

ImagePlot.get_axesparam_class(item)[source]¶: Return AxesParam dataset class associated to item’s type

ImagePlot.edit_axis_parameters(axis_id)[source]¶: Edit axis parameters

class plotpy.image.BaseImageItem(data=None, param=None)[source]¶

get_default_param()[source]¶: Return instance of the default imageparam DataSet

get_filter(filterobj, filterparam)[source]¶: Provides a filter object over this image’s content

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

align_rectangular_shape(shape)[source]¶: Align rectangular shape to image pixels

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)

get_closest_coordinates(x, y)[source]¶: Return closest image pixel coordinates

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

get_interpolation()[source]¶: Get interpolation mode

set_lut_range(lut_range)[source]¶: Set LUT transform range lut_range is a tuple: (min, max)

get_lut_range()[source]¶: Return the LUT transform range tuple: (min, max)

get_lut_range_full()[source]¶: Return full dynamic range

get_lut_range_max()[source]¶: Get maximum range for this dataset

update_border()[source]¶: Update image border rectangle to fit image shape

draw_border(painter, xMap, yMap, canvasRect)[source]¶: Draw image border rectangle

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

set_readonly(state)[source]¶: Set object readonly state

is_readonly()[source]¶: Return object readonly state

set_private(state)[source]¶: Set object as private

is_private()[source]¶: Return True if object is private

select()[source]¶: Select item

unselect()[source]¶: Unselect item

is_empty()[source]¶: Return True if item data is empty

set_selectable(state)[source]¶: Set item selectable state

set_resizable(state)[source]¶: Set item resizable state (or any action triggered when moving an handle, e.g. rotation)

set_movable(state)[source]¶: Set item movable state

set_rotatable(state)[source]¶: Set item rotatable state

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_histogram(nbins)[source]¶: interface de IHistDataSource

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_xsection(y0, apply_lut=False)[source]¶: Return cross section along x-axis at y=y0

get_ysection(x0, apply_lut=False)[source]¶: Return cross section along y-axis at x=x0

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

defaultIcon(brush, size)¶

Return a default icon from a brush

The default icon is a filled rectangle used in several derived classes as legendIcon().

Parameters:	brush (QBrush) – Fill brush size (QSizeF) – Icon size
Returns:	A filled rectangle

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

setVisible(), show(), hide()

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

See also

QwtPlot.legendChanged(), QwtPlot.autoRefresh()

legendChanged()¶: Update the legend of the parent plot.

See also

QwtPlot.updateLegend(), itemChanged()

legendData()¶

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

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

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

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

See also

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

legendIcon(index, size)¶

Parameters:	index (int) – Index of the legend entry (usually there is only one) size (QSizeF) – Icon size
Returns:	Icon representing the item on the legend

The default implementation returns an invalid icon

See also

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)

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)

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)

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

z()¶

Plot items are painted in increasing z-order.

Returns:	item z order

See also

setZ(), QwtPlotDict.itemList()

class plotpy.image.RawImageItem(data=None, param=None)[source]¶

Construct a simple image item

data: 2D NumPy array

param (optional): image parameters (plotpy.styles.RawImageParam instance)

get_default_param()[source]¶: Return instance of the default imageparam DataSet

serialize(writer)[source]¶: Serialize object to HDF5 writer

deserialize(reader)[source]¶: Deserialize object from HDF5 reader

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

defaultIcon(brush, size)¶

Return a default icon from a brush

The default icon is a filled rectangle used in several derived classes as legendIcon().

Parameters:	brush (QBrush) – Fill brush size (QSizeF) – Icon size
Returns:	A filled rectangle

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

setVisible(), show(), hide()

is_empty()¶: Return True if item data is empty

is_private()¶: Return True if object is private

is_readonly()¶: Return object readonly state

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

See also

QwtPlot.legendChanged(), QwtPlot.autoRefresh()

legendChanged()¶: Update the legend of the parent plot.

See also

QwtPlot.updateLegend(), itemChanged()

legendData()¶

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

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

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

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

See also

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

legendIcon(index, size)¶

Parameters:	index (int) – Index of the legend entry (usually there is only one) size (QSizeF) – Icon size
Returns:	Icon representing the item on the legend

The default implementation returns an invalid icon

See also

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)

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)

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)

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

z()¶

Plot items are painted in increasing z-order.

Returns:	item z order

See also

setZ(), QwtPlotDict.itemList()

class plotpy.image.ImageItem(data=None, param=None)[source]¶

Construct a simple image item

data: 2D NumPy array

param (optional): image parameters (plotpy.styles.ImageParam instance)

get_default_param()[source]¶: Return instance of the default imageparam DataSet

serialize(writer)[source]¶: Serialize object to HDF5 writer

deserialize(reader)[source]¶: Deserialize object from HDF5 reader

get_xdata()[source]¶: Return (xmin, xmax)

get_ydata()[source]¶: Return (ymin, ymax)

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)

get_closest_coordinates(x, y)[source]¶: Return closest image pixel coordinates

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

defaultIcon(brush, size)¶

Return a default icon from a brush

The default icon is a filled rectangle used in several derived classes as legendIcon().

Parameters:	brush (QBrush) – Fill brush size (QSizeF) – Icon size
Returns:	A filled rectangle

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

setVisible(), show(), hide()

is_empty()¶: Return True if item data is empty

is_private()¶: Return True if object is private

is_readonly()¶: Return object readonly state

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

See also

QwtPlot.legendChanged(), QwtPlot.autoRefresh()

legendChanged()¶: Update the legend of the parent plot.

See also

QwtPlot.updateLegend(), itemChanged()

legendData()¶

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

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

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

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

See also

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

legendIcon(index, size)¶

Parameters:	index (int) – Index of the legend entry (usually there is only one) size (QSizeF) – Icon size
Returns:	Icon representing the item on the legend

The default implementation returns an invalid icon

See also

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)

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)

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)

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

z()¶

Plot items are painted in increasing z-order.

Returns:	item z order

See also

setZ(), QwtPlotDict.itemList()

class plotpy.image.TrImageItem(data=None, param=None)[source]¶

Construct a transformable image item

data: 2D NumPy array

param (optional): image parameters (plotpy.styles.TrImageParam instance)

get_default_param()[source]¶: Return instance of the default imageparam DataSet

get_crop_coordinates()[source]¶: Return crop rectangle coordinates

get_filter(filterobj, filterparam)[source]¶: Provides a filter object over this image’s content

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)

get_closest_coordinates(x, y)[source]¶: Return closest image pixel coordinates

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

defaultIcon(brush, size)¶

Return a default icon from a brush

The default icon is a filled rectangle used in several derived classes as legendIcon().

Parameters:	brush (QBrush) – Fill brush size (QSizeF) – Icon size
Returns:	A filled rectangle

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

setVisible(), show(), hide()

is_empty()¶: Return True if item data is empty

is_private()¶: Return True if object is private

is_readonly()¶: Return object readonly state

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

See also

QwtPlot.legendChanged(), QwtPlot.autoRefresh()

legendChanged()¶: Update the legend of the parent plot.

See also

QwtPlot.updateLegend(), itemChanged()

legendData()¶

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

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

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

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

See also

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

legendIcon(index, size)¶

Parameters:	index (int) – Index of the legend entry (usually there is only one) size (QSizeF) – Icon size
Returns:	Icon representing the item on the legend

The default implementation returns an invalid icon

See also

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)

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)

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)

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

z()¶

Plot items are painted in increasing z-order.

Returns:	item z order

See also

setZ(), QwtPlotDict.itemList()

class plotpy.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 (plotpy.styles.XYImageParam instance)

get_default_param()[source]¶: Return instance of the default imageparam DataSet

serialize(writer)[source]¶: Serialize object to HDF5 writer

deserialize(reader)[source]¶: Deserialize object from HDF5 reader

get_filter(filterobj, filterparam)[source]¶: Provides a filter object over this image’s content

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)

get_closest_coordinates(x, y)[source]¶: Return closest image pixel coordinates

align_rectangular_shape(shape)¶: Align rectangular shape to image pixels

attach(plot)¶

Attach the item to a plot.

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

Parameters:	plot (qwt.plot.QwtPlot) – Plot widget

See also

defaultIcon(brush, size)¶

Return a default icon from a brush

The default icon is a filled rectangle used in several derived classes as legendIcon().

Parameters:	brush (QBrush) – Fill brush size (QSizeF) – Icon size
Returns:	A filled rectangle

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

setVisible(), show(), hide()

is_empty()¶: Return True if item data is empty

is_private()¶: Return True if object is private

is_readonly()¶: Return object readonly state

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

See also

QwtPlot.legendChanged(), QwtPlot.autoRefresh()

legendChanged()¶: Update the legend of the parent plot.

See also

QwtPlot.updateLegend(), itemChanged()

legendData()¶

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

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

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

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

See also

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

legendIcon(index, size)¶

Parameters:	index (int) – Index of the legend entry (usually there is only one) size (QSizeF) – Icon size
Returns:	Icon representing the item on the legend

The default implementation returns an invalid icon

See also

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)

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)

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)

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

z()¶

Plot items are painted in increasing z-order.

Returns:	item z order

See also

setZ(), QwtPlotDict.itemList()

class plotpy.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 (plotpy.styles.RGBImageParam instance)

get_default_param()[source]¶: Return instance of the default imageparam DataSet

load_data()[source]¶: Load data from filename filename has been set using method ‘set_filename’

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

defaultIcon(brush, size)¶

Return a default icon from a brush

The default icon is a filled rectangle used in several derived classes as legendIcon().

Parameters:	brush (QBrush) – Fill brush size (QSizeF) – Icon size
Returns:	A filled rectangle

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

export_roi(src_rect, dst_rect, dst_image, apply_lut=False, apply_interpolation=False, original_resolution=False)¶: Export Region Of Interest to array

getCanvasMarginHint(xMap, yMap, canvasRect)¶

Calculate a hint for the canvas margin

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

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

Parameters:	xMap (qwt.scale_map.QwtScaleMap) – Maps x-values into pixel coordinates. yMap (qwt.scale_map.QwtScaleMap) – Maps y-values into pixel coordinates. canvasRect (QRectF) – Contents rectangle of the canvas in painter coordinates

See also

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

get_average_xsection(x0, y0, x1, y1, apply_lut=False)¶: Return average cross section along x-axis

get_average_ysection(x0, y0, x1, y1, apply_lut=False)¶: Return average cross section along y-axis

get_closest_coordinates(x, y)¶: Return closest image pixel coordinates

get_closest_index_rect(x0, y0, x1, y1)¶: Return closest image rectangular pixel area index bounds Avoid returning empty rectangular area (return 1x1 pixel area instead) Handle reversed/not-reversed Y-axis orientation

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

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

Note

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

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

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

If x1,y1 are specified:

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

get_filter(filterobj, filterparam)¶: Provides a filter object over this image’s content

get_histogram(nbins)¶: interface de IHistDataSource

get_interpolation()¶: Get interpolation mode

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

get_lut_range_full()¶: Return full dynamic range

get_lut_range_max()¶: Get maximum range for this dataset

get_pixel_coordinates(xplot, yplot)¶: Return (image) pixel coordinates (from plot coordinates)

get_plot_coordinates(xpixel, ypixel)¶: Return plot coordinates (from image pixel coordinates)

get_stats(x0, y0, x1, y1)¶: Return formatted string with stats on image rectangular area (output should be compatible with AnnotatedShape.get_infos)

get_xdata()¶: Return (xmin, xmax)

get_xsection(y0, apply_lut=False)¶: Return cross section along x-axis at y=y0

get_ydata()¶: Return (ymin, ymax)

get_ysection(x0, apply_lut=False)¶: Return cross section along y-axis at x=x0

hide()¶: Hide the item

isVisible()¶

Returns:	True if visible

See also

setVisible(), show(), hide()

is_empty()¶: Return True if item data is empty

is_private()¶: Return True if object is private

is_readonly()¶: Return object readonly state

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

See also

QwtPlot.legendChanged(), QwtPlot.autoRefresh()

legendChanged()¶: Update the legend of the parent plot.

See also

QwtPlot.updateLegend(), itemChanged()

legendData()¶

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

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

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

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

See also

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

legendIcon(index, size)¶

Parameters:	index (int) – Index of the legend entry (usually there is only one) size (QSizeF) – Icon size
Returns:	Icon representing the item on the legend

The default implementation returns an invalid icon

See also

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)

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)

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)

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

z()¶

Plot items are painted in increasing z-order.

Returns:	item z order

See also

setZ(), QwtPlotDict.itemList()

class plotpy.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 (plotpy.styles.MaskedImageParam instance)

get_default_param()[source]¶: Return instance of the default imageparam DataSet

serialize(writer)[source]¶: Serialize object to HDF5 writer

deserialize(reader)[source]¶: Deserialize object from HDF5 reader

set_mask(mask)[source]¶: Set image mask

get_mask()[source]¶: Return image mask

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.

set_masked_areas(areas)[source]¶: Set masked areas (see set_mask_filename)

apply_masked_areas()[source]¶: Apply masked areas

mask_all()[source]¶: Mask all pixels

unmask_all()[source]¶: Unmask all pixels

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

is_mask_visible()[source]¶: Return mask visibility

set_mask_visible(state)[source]¶: Set mask visibility

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

defaultIcon(brush, size)¶

Return a default icon from a brush

The default icon is a filled rectangle used in several derived classes as legendIcon().

Parameters:	brush (QBrush) – Fill brush size (QSizeF) – Icon size
Returns:	A filled rectangle

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()¶: Return (xmin, xmax)

get_xsection(y0, apply_lut=False)¶: Return cross section along x-axis at y=y0

get_ydata()¶: Return (ymin, ymax)

get_ysection(x0, apply_lut=False)¶: Return cross section along y-axis at x=x0

hide()¶: Hide the item

isVisible()¶

Returns:	True if visible

See also

setVisible(), show(), hide()

is_empty()¶: Return True if item data is empty

is_private()¶: Return True if object is private

is_readonly()¶: Return object readonly state

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

See also

QwtPlot.legendChanged(), QwtPlot.autoRefresh()

legendChanged()¶: Update the legend of the parent plot.

See also

QwtPlot.updateLegend(), itemChanged()

legendData()¶

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

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

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

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

See also

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

legendIcon(index, size)¶

Parameters:	index (int) – Index of the legend entry (usually there is only one) size (QSizeF) – Icon size
Returns:	Icon representing the item on the legend

The default implementation returns an invalid icon

See also

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)

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)

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)

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

z()¶

Plot items are painted in increasing z-order.

Returns:	item z order

See also

setZ(), QwtPlotDict.itemList()

class plotpy.image.ImageFilterItem(image, filter, param)[source]¶

Construct a rectangular area image filter item

image: plotpy.image.RawImageItem instance

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

param: image filter parameters (plotpy.styles.ImageFilterParam instance)

set_image(image)[source]¶

Set the image item on which the filter will be applied

image: plotpy.image.RawImageItem instance

set_filter(filter)[source]¶

Set the filter function

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

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

defaultIcon(brush, size)¶

Return a default icon from a brush

The default icon is a filled rectangle used in several derived classes as legendIcon().

Parameters:	brush (QBrush) – Fill brush size (QSizeF) – Icon size
Returns:	A filled rectangle

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

setVisible(), show(), hide()

is_empty()¶: Return True if item data is empty

is_private()¶: Return True if object is private

is_readonly()¶: Return object readonly state

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

See also

QwtPlot.legendChanged(), QwtPlot.autoRefresh()

legendChanged()¶: Update the legend of the parent plot.

See also

QwtPlot.updateLegend(), itemChanged()

legendData()¶

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

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

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

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

See also

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

legendIcon(index, size)¶

Parameters:	index (int) – Index of the legend entry (usually there is only one) size (QSizeF) – Icon size
Returns:	Icon representing the item on the legend

The default implementation returns an invalid icon

See also

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)

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)

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)

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

z()¶

Plot items are painted in increasing z-order.

Returns:	item z order

See also

setZ(), QwtPlotDict.itemList()

class plotpy.image.XYImageFilterItem(image, filter, param)[source]¶

Construct a rectangular area image filter item

image: plotpy.image.XYImageItem instance

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

param: image filter parameters (plotpy.styles.ImageFilterParam instance)

set_image(image)[source]¶

Set the image item on which the filter will be applied

image: plotpy.image.XYImageItem instance

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

defaultIcon(brush, size)¶

Return a default icon from a brush

The default icon is a filled rectangle used in several derived classes as legendIcon().

Parameters:	brush (QBrush) – Fill brush size (QSizeF) – Icon size
Returns:	A filled rectangle

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_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

setVisible(), show(), hide()

is_empty()¶: Return True if item data is empty

is_private()¶: Return True if object is private

is_readonly()¶: Return object readonly state

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

See also

QwtPlot.legendChanged(), QwtPlot.autoRefresh()

legendChanged()¶: Update the legend of the parent plot.

See also

QwtPlot.updateLegend(), itemChanged()

legendData()¶

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

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

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

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

See also

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

legendIcon(index, size)¶

Parameters:	index (int) – Index of the legend entry (usually there is only one) size (QSizeF) – Icon size
Returns:	Icon representing the item on the legend

The default implementation returns an invalid icon

See also

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)

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)

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)

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_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

z()¶

Plot items are painted in increasing z-order.

Returns:	item z order

See also

setZ(), QwtPlotDict.itemList()

class plotpy.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 (plotpy.styles.Histogram2DParam instance)

set_bins(NX, NY)[source]¶: Set histogram bins

set_data(X, Y, Z=None)[source]¶: Set histogram data

get_histogram(nbins)[source]¶: interface de IHistDataSource

align_rectangular_shape(shape)¶: Align rectangular shape to image pixels

attach(plot)¶

Attach the item to a plot.

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

Parameters:	plot (qwt.plot.QwtPlot) – Plot widget

See also

defaultIcon(brush, size)¶

Return a default icon from a brush

The default icon is a filled rectangle used in several derived classes as legendIcon().

Parameters:	brush (QBrush) – Fill brush size (QSizeF) – Icon size
Returns:	A filled rectangle

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

setVisible(), show(), hide()

is_empty()¶: Return True if item data is empty

is_private()¶: Return True if object is private

is_readonly()¶: Return object readonly state

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

See also

QwtPlot.legendChanged(), QwtPlot.autoRefresh()

legendChanged()¶: Update the legend of the parent plot.

See also

QwtPlot.updateLegend(), itemChanged()

legendData()¶

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

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

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

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

See also

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

legendIcon(index, size)¶

Parameters:	index (int) – Index of the legend entry (usually there is only one) size (QSizeF) – Icon size
Returns:	Icon representing the item on the legend

The default implementation returns an invalid icon

See also

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)

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)

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)

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