ROI editor#

The cdl.core.gui.roieditor module provides the ROI editor widgets for signals and images.

Signal ROI editor#

class cdl.core.gui.roieditor.SignalROIEditor(parent: PlotDialog, obj: TypeObj, extract: bool, item: TypePlotItem | None = None)[source]#

Signal ROI Editor

get_obj_roi_class() → type[SignalROI][source]#: Get object ROI class

add_tools_to_plot_dialog() → None[source]#: Add tools to plot dialog

manually_add_roi() → None[source]#: Manually add segment ROI

create_coordinate_based_roi_actions() → list[QAction][source]#: Create coordinate-based ROI actions

setup_widget() → None[source]#: Setup ROI editor widget

update_roi_titles()[source]#: Update ROI annotation titles

Image ROI editor#

class cdl.core.gui.roieditor.ImageROIEditor(parent: PlotDialog, obj: TypeObj, extract: bool, item: TypePlotItem | None = None)[source]#

Image ROI Editor

get_obj_roi_class() → type[ImageROI][source]#: Get object ROI class

add_tools_to_plot_dialog() → None[source]#: Add tools to plot dialog

manually_add_roi(roi_type: Literal['rectangle', 'circle', 'polygon']) → None[source]#: Manually add image ROI

create_coordinate_based_roi_actions() → list[QAction][source]#: Create coordinate-based ROI actions

setup_widget() → None[source]#: Setup ROI editor widget

update_roi_titles() → None[source]#: Update ROI annotation titles