sdynpy.GUIPlot

• Defined as: sdynpy.core.sdynpy_data.GUIPlot

• Module: sdynpy.core.sdynpy_data

• Source: GitHub

• Parent: PyQt5.QtWidgets.QMainWindow

• Parent: PyQt5.QtWidgets.QWidget

• Parent: PyQt5.QtCore.QObject

• Parent: sip.wrapper

• Parent: PyQt5.QtGui.QPaintDevice

• Parent: sip.simplewrapper

Signature¶

class sdynpy.GUIPlot(*data_to_plot, **labeled_data_to_plot)

An iteractive plot window allowing users to visualize data

Methods¶

__init__¶

• Source: GitHub

def sdynpy.GUIPlot.__init__(self, *data_to_plot, **labeled_data_to_plot)

Create a GUIPlot window to visualize data.

Multiple datasets can be overlaid by providing additional datasets as arguments. Position arguments will be labelled generically in the legend. Keyword arguments will be labelled with their keywords with _ replaced by .

Parameters¶

• *data_to_plot : NDDataArray Data to visualize. Data passed by positional argument will be labeled generically in the legend

• **labeled_data_to_plot : NDDataArray Data to visualize. Data passed by keyword argument will be labeled with its keyword

• abscissa_markers : np.ndarray Abscissa values at which markers will be placed. If not specified, no markers will be added. Markers will be added to all plotted curves if this argument is passed. To add markers to just a specific plotted data, pass the argument abscissa_markers_* where * is replaced with either the index of the data that was passed via a positional argument, or the keyword of the data that was passed via a keyword argument. Must be passed as a keyword argument.

• abscissa_marker_labels : iterable Labels that will be applied to the markers. If not specified, no label will be applied. If a single string is passed, it will be passed to the .format method with keyword arguments index and abscissa. This marker label will be used for all plotted curves if this argument is passed. To add markers to just a specific plotted data, pass the argument abscissa_marker_labels_* where * is replaced with either the index of the data that was passed via a positional argument, or the keyword of the data that was passed via a keyword argument. Must be passed as a keyword argument.

• abscissa_marker_type : str: The type of marker that will be applied. Can be ‘vline’ for a vertical line across the axis, or it can be a pyqtgraph symbol specifier (e.g. ‘x’, ‘o’, ‘star’, etc.) which will be placed on the plotted curves. If not specified, a vertical line will be used. This marker type will be used for all plotted curves if this argument is passed. To add markers to just a specific plotted data, pass the argument abscissa_marker_type_* where * is replaced with either the index of the data that was passed via a positional argument, or the keyword of the data that was passed via a keyword argument. Must be passed as a keyword argument.

Returns¶

• None.

connect_callbacks¶

• Source: GitHub

def sdynpy.GUIPlot.connect_callbacks(self)

Connects the callback functions to events

Returns¶

• None.

deselect_all_complex_types_except¶

• Source: GitHub

def sdynpy.GUIPlot.deselect_all_complex_types_except(self, complex_type)

Deselects all complex types except the specified type.

Makes the checkboxes in the menu act like radiobuttons

Parameters¶

• complex_type : ComplexType Enumeration specifying which complex plot type is selected

Returns¶

• None.

selection_changed¶

• Source: GitHub

def sdynpy.GUIPlot.selection_changed(self)

Called when the selected functions is changed

set_imaginary¶

• Source: GitHub

def sdynpy.GUIPlot.set_imaginary(self)

Sets the complex type to imaginary

set_magnitude¶

• Source: GitHub

def sdynpy.GUIPlot.set_magnitude(self)

Sets the complex type to magnitude

set_magnitude_phase¶

• Source: GitHub

def sdynpy.GUIPlot.set_magnitude_phase(self)

Sets the complex type to magnitude and phase

set_phase¶

• Source: GitHub

def sdynpy.GUIPlot.set_phase(self)

Sets the complex type to phase

set_real¶

• Source: GitHub

def sdynpy.GUIPlot.set_real(self)

Sets the complex type to real

set_real_imag¶

• Source: GitHub

def sdynpy.GUIPlot.set_real_imag(self)

Sets the complex type to real and imaginary

update¶

• Source: GitHub

def sdynpy.GUIPlot.update(self)

Updates the figure in the GUIPlot

Returns¶

• None.

update_abscissa_log¶

• Source: GitHub

def sdynpy.GUIPlot.update_abscissa_log(self)

Updates whether the abscissa should be plotted as log scale

update_checkbox¶

• Source: GitHub

def sdynpy.GUIPlot.update_checkbox(self)

Disables the update button if set to auto-update

update_data¶

• Source: GitHub

def sdynpy.GUIPlot.update_data(self, *data_to_plot, **labeled_data_to_plot)

update_ordinate_log¶

• Source: GitHub

def sdynpy.GUIPlot.update_ordinate_log(self)

Updates whether the ordinate should be plotted as log scale