8.6.6.2.5. pymodaq_gui.plotting.items.roi_sync module

class pymodaq_gui.plotting.items.roi_sync.ROIParameterOptions(color=(255, 255, 255), zlevel=1, x=0.0, y=0.0, width=10.0, height=10.0, angle=0.0)[source]

Bases: object

angle: float = 0.0

color: QColor | tuple[int, int, int] = (255, 255, 255)

height: float = 10.0

width: float = 10.0

x: float = 0.0

y: float = 0.0

zlevel: int = 1

class pymodaq_gui.plotting.items.roi_sync.ROISync(roi_dim, roi_options=ROIParameterOptions(color=(255, 255, 255), zlevel=1, x=0.0, y=0.0, width=10.0, height=10.0, angle=0.0))[source]

Bases: QObject

Methods

sync_entries_with
sync_from_param
validator

classmethod sync_from_param(param)[source]

sync_entries_with(roi, roi_parameter)[source]

validator(value)[source]

Return type:: dict

staticMetaObject = PySide6.QtCore.QMetaObject("ROISync" inherits "QObject": )

class pymodaq_gui.plotting.items.roi_sync.RoiParameter(dim, descriptor, index=0, **kwargs)[source]

Bases: GroupParameter

Methods

`make_ROI1D`(index, pos[, compute])	Convenience function to make custom ROI_1D
`make_ROI2D`(descriptor, index, pos, size[, ...])	Convenience function to make custom ROI_2D

makeChannelsParam
makeDisplayParam
makeMathParam
make_ROI
make_ROIParam1D
make_ROIParam2D
roi_from_param
to_options

static makeChannelsParam(dim=ROIDim.ROI2D)[source]

static makeDisplayParam(index=0, roi_dim=ROIDim.ROI1D)[source]

static makeMathParam(dim=ROIDim.ROI2D)[source]

static make_ROIParam1D(descriptor, index)[source]

static make_ROIParam2D(descriptor, index)[source]

make_ROI(index, roi_type, roi_descriptor, pos=(0.0, 0.0), size=(10.0, 10.0), **kwargs)[source]

Return type:: ROI

make_ROI1D(index, pos, compute=True, **kwargs)[source]

Convenience function to make custom ROI_1D

Parameters:

index (int) – Current index of ROI
pos – Initial position of ROI

Returns:

LinearROI

Return type:

ROI

make_ROI2D(descriptor, index, pos, size, compute=True, **kwargs)[source]

Convenience function to make custom ROI_2D

Parameters:

descriptor (str) – name of 2D ROI
index (int) – Current index of ROI
pos – Initial position of ROI
size – Initial size of ROI

Returns:

pg.ROI

Return type:

ROI

roi_from_param(index)[source]

Return type:: ROI

to_options()[source]

Return type:: ROIParameterOptions

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