8.6.4.7. pymodaq_gui.managers.roi_viewer_manager module

class pymodaq_gui.managers.roi_viewer_manager.ROIMeta(param)[source]: Bases: object

class pymodaq_gui.managers.roi_viewer_manager.ROIParameterManager(roi_dim=ROIDim.ROI1D)[source]

Bases: ParameterManager

Attributes:

rois_setting

Methods

set_settings(settings)

If empty create the standard structure otherwise empty the ROIs and readd them one by one for the ROI to reflects the param changes

clear_settings_slot

clear_settings_slot()[source]

set_settings(settings)[source]: If empty create the standard structure otherwise empty the ROIs and readd them one by one for the ROI to reflects the param changes

property rois_setting: ROIScalableGroup

class pymodaq_gui.managers.roi_viewer_manager.ROIScalableGroup(roi_dim=ROIDim.ROI1D, **opts)[source]

Bases: GroupParameter

Methods

addNew([descriptor])

addNew(descriptor='')[source]

staticMetaObject = PySide6.QtCore.QMetaObject("ROIScalableGroup" inherits "GroupParameter": )

class pymodaq_gui.managers.roi_viewer_manager.ROIViewerManager(view_box=None, roi_dim=ROIDim.ROI1D)[source]

Bases: ROIParameterManager, QObject

Attributes:

ROIs
roiwidget: For backcompatibility

Methods

`child_added`(param, data)
`copy_ROI`(roi_meta)	Method to copy a ROI and add it to the parameter tree and to the viewer widget The method extracts the parameters of the copied ROI, create a new parameter, a new ROI and update it with the settings from the copied parameter :param roi: the ROI to be copied :type roi: `ROI`
`menu_changed`(param, data)
`param_deleted`(param)
`update_use_channel`(channels[, index])	Function to update the selected channels.
`value_changed`(param)

add_roi_programmatically
color_signal
create_and_add
emit_colors
expand_roi_tree
get_ROI_indexes
get_roi_from_index
new_ROI_signal
remove_ROI
remove_ROI_signal
remove_roi_programmatically
roi_changed
set_roi

add_roi_programmatically(descriptor='CircularROI')[source]

child_added(param, data)[source]

copy_ROI(roi_meta)[source]: Method to copy a ROI and add it to the parameter tree and to the viewer widget The method extracts the parameters of the copied ROI, create a new parameter, a new ROI and update it with the settings from the copied parameter :param roi: the ROI to be copied :type roi: ROI

create_and_add(param)[source]

emit_colors()[source]

expand_roi_tree(roi)[source]

get_ROI_indexes()[source]

get_roi_from_index(index)[source]

Return type:: ROIMeta

menu_changed(param, data)[source]

param_deleted(param)[source]

remove_ROI(roi_meta)[source]

remove_roi_programmatically(index)[source]

set_roi(roi_params, roi_params_new)[source]

update_use_channel(channels, index=None)[source]

Function to update the selected channels. If no index is given, the channels are applied to all ROIs.

Parameters:

channels (List[str]) – channels list from a viewer
index (int, optional) – ROI index. Defaults to None.

value_changed(param)[source]

property ROIs: list[ROIMeta]

color_signal

new_ROI_signal

params = []

remove_ROI_signal

roi_changed

property roiwidget: For backcompatibility

staticMetaObject = PySide6.QtCore.QMetaObject("ROIViewerManager" inherits "QObject": Methods: #4 type=Signal, signature=new_ROI_signal(int), parameters=int #5 type=Signal, signature=remove_ROI_signal(int), parameters=int #6 type=Signal, signature=color_signal(QVariantList), parameters=QVariantList #7 type=Signal, signature=roi_changed() )

view_box: ViewBox