8.6.6.4.3. pymodaq_gui.plotting.utils.lineout module

Created the 03/11/2022

@author: Sebastien Weber

class pymodaq_gui.plotting.utils.lineout.LineoutPlotter(graph_widgets, roi_manager, crosshair)

Bases: QObject

Base class to manage and display data filtered out into lineouts (1D, 0D)

Should be inherited and subclass some methods as appropriate

Parameters:

• graph_widgets (OrderedDict) – Includes plotwidgets to display data

• roi_manager (ROIViewerManager) – The ROIViewerManager to create ROIs and manage their properties

• crosshair (Crosshair) – The Crosshair object

Methods

add_lineout_items(*curve_items)	Add Curve items sequentially to lineouts widgets: (hor, ver and int) :type curve_items: (PlotCurveItem) at most 3 of them :param curve_items: :type curve_items: (PlotCurveItem) at most 3 of them
add_roi_lineout_items(index, pen)	Add specifics lineouts generated from ROIs :type index: (int) index of the ROI generating these lineouts :param index: :type index: (int) index of the ROI generating these lineouts :type pen: (str, tuple) any argument able to generate a QPen, see pyqtgraph.functions.mkPen :param pen: :type pen: (str, tuple) any argument able to generate a QPen, see pyqtgraph.functions.mkPen
get_crosshair_curves_triplet()	Get the dictionary (one key by ImageItem, see IMAGE_TYPES) containing dicts with PlotCurveItem
get_roi_curves_triplet()	Get the dictionary (one key by ROI) containing dicts with ROI PlotCurveItem
remove_lineout_items(*curve_items)	Remove Curve items sequentially to lineouts widgets: (hor, ver and int) :type curve_items: (PlotCurveItem) at most 3 of them :param curve_items: :type curve_items: (PlotCurveItem) at most 3 of them
remove_roi_lineout_items(index)	Remove specifics lineouts generated from ROI referenced by a unique integer :type index: (int) index of the ROI generating these lineouts :param index: :type index: (int) index of the ROI generating these lineouts
setup_crosshair()	to reimplement if needed
show_crosshair_curves(curve_key[, show])	to reimplement if needed

add_ROI
crosshair_clicked
crosshair_lineout_plotted
get_crosshair_curve_triplet
get_lineout_widget
plot_crosshair_lineouts
plot_other_crosshair_lineouts
plot_other_lineouts
plot_roi_lineouts
remove_ROI
roi_changed
roi_clicked
roi_lineout_plotted
update_roi

add_ROI(newindex, roi_type)

add_lineout_items(*curve_items)

Add Curve items sequentially to lineouts widgets: (hor, ver and int) :type curve_items: (PlotCurveItem) at most 3 of them :param curve_items: :type curve_items: (PlotCurveItem) at most 3 of them

add_roi_lineout_items(index, pen)

Add specifics lineouts generated from ROIs :type index: (int) index of the ROI generating these lineouts :param index: :type index: (int) index of the ROI generating these lineouts :type pen: (str, tuple) any argument able to generate a QPen, see pyqtgraph.functions.mkPen :param pen: :type pen: (str, tuple) any argument able to generate a QPen, see pyqtgraph.functions.mkPen

crosshair_clicked(iscrosshairchecked=True)

get_crosshair_curve_triplet(curve_name)

get_crosshair_curves_triplet()

Get the dictionary (one key by ImageItem, see IMAGE_TYPES) containing dicts with PlotCurveItem

get_lineout_widget(name)

get_roi_curves_triplet()

Get the dictionary (one key by ROI) containing dicts with ROI PlotCurveItem

plot_crosshair_lineouts(crosshair_dict)

plot_other_crosshair_lineouts(crosshair_dict)

plot_other_lineouts(roi_dicts)

plot_roi_lineouts(roi_dicts)

remove_ROI(roi_name)

remove_lineout_items(*curve_items)

Remove Curve items sequentially to lineouts widgets: (hor, ver and int) :type curve_items: (PlotCurveItem) at most 3 of them :param curve_items: :type curve_items: (PlotCurveItem) at most 3 of them

remove_roi_lineout_items(index)

Remove specifics lineouts generated from ROI referenced by a unique integer :type index: (int) index of the ROI generating these lineouts :param index: :type index: (int) index of the ROI generating these lineouts

roi_clicked(isroichecked=True)

setup_crosshair()

to reimplement if needed

show_crosshair_curves(curve_key, show=True)

to reimplement if needed

update_roi(roi_key, param_changed)

crosshair_lineout_plotted

lineout_widgets = [Lineouts.INT]

roi_changed

roi_lineout_plotted

staticMetaObject = PySide6.QtCore.QMetaObject("LineoutPlotter" inherits "QObject": Methods:   #4 type=Signal, signature=roi_changed(QVariantMap), parameters=QVariantMap   #5 type=Signal, signature=crosshair_lineout_plotted(QVariantMap), parameters=QVariantMap   #6 type=Signal, signature=roi_lineout_plotted(QVariantMap), parameters=QVariantMap   #7 type=Slot, signature=update_roi(QString,PyObject), parameters=QString, PyObject   #8 type=Slot, signature=remove_ROI(QString), parameters=QString   #9 type=Slot, signature=add_ROI(int,QString), parameters=int, QString   #10 type=Slot, signature=roi_clicked(bool), parameters=bool   #11 type=Slot, signature=crosshair_clicked(bool), parameters=bool )

class pymodaq_gui.plotting.utils.lineout.Lineouts(*values)

Bases: StrEnum

HOR = 'hor'

INT = 'int'

VER = 'ver'

pymodaq_gui.plotting.utils.lineout.curve_item_factory(pen='red')

Create a PlotCurveItem with the given pen :type pen: any type of arguments accepted by pyqtgraph.function.mkColor or one of the COLORS_DICT key :param pen: :type pen: any type of arguments accepted by pyqtgraph.function.mkColor or one of the COLORS_DICT key

Return type:

PlotCurveItem