Reference

Base features

The panels base module provides PanelWidget (the panel widget class from which all panels must derived from) and identifiers for each kind of panel.

plotpy.constants.ID_ITEMLIST = 'itemlist'

ID of the item list panel

plotpy.constants.ID_CONTRAST = 'contrast'

ID of the contrast adjustment panel

plotpy.constants.ID_XCS = 'x_cross_section'

ID of the X-axis cross section panel

plotpy.constants.ID_YCS = 'y_cross_section'

ID of the Y-axis cross section panel

plotpy.constants.ID_OCS = 'oblique_cross_section'

ID of the oblique averaged cross section panel

plotpy.constants.ID_LCS = 'line_cross_section'

ID of the line cross section panel

class plotpy.panels.base.PanelWidget(parent=None)[source]

Panel Widget base class

SIG_VISIBILITY_CHANGED(bool)

Signal emitted by PanelWidget when its visibility has changed

Parameters:

enable (bool) – True if the panel is visible

showEvent(event)[source]
Parameters:

event

hideEvent(event)[source]
Parameters:

event

visibility_changed(enable)[source]

DockWidget visibility has changed

Plot Item list

The plot item list panel is a widget which displays the list of items attached to the plot.

class plotpy.panels.itemlist.PlotItemList(parent)[source]

Construct the plot item list panel

Contrast adjustment

The contrast adjustment panel is a widget which displays the image levels histogram and allows to manipulate it in order to adjust the image contrast.

class plotpy.panels.contrastadjustment.ContrastAdjustment(parent: QWidget | None = None)[source]

Contrast adjustment tool

Parameters:

parent – parent widget

Cross-sections

The cross-section panels are used to display cross-sections of 2D data, either along the X or Y axis, or along an oblique rectangle (average of the data along an oblique rectangle).

class plotpy.panels.csection.XCrossSection(parent=None)[source]

X-axis cross section panel

Parameters:

parent – parent widget

class plotpy.panels.csection.YCrossSection(parent=None, position='right', xsection_pos='top')[source]

Y-axis cross section panel

Parameters:

  • parent – parent widget

  • position – position of the panel (‘left’ or ‘right’)

  • xsection_pos – position of the cross section plot (‘top’ or ‘bottom’)

class plotpy.panels.csection.ObliqueCrossSection(parent=None)[source]

Oblique averaged cross section panel

Parameters:

parent – parent widget

class plotpy.panels.csection.LineCrossSection(parent=None)[source]

Line cross section panel

Parameters:

parent – parent widget