bec_widgets.widgets.plots.toolbar_components.roi

Classes

RoiConnection

Connection class for the ROI toolbar bundle.

Functions

roi_bundle(...)

Creates a toolbar bundle for ROI and crosshair interaction.

Module Contents

class RoiConnection(components: bec_widgets.utils.toolbars.bundles.ToolbarComponents, target_widget=None)

Bases: bec_widgets.utils.toolbars.connections.BundleConnection

Connection class for the ROI toolbar bundle.

connect()

Connects the bundle to the target widget or application. This method should be implemented by subclasses to define how the bundle interacts with the target.

Subclasses should call connect_property_sync(target_widget) if property sync is needed.

disconnect()

Disconnects the bundle from the target widget or application. This method should be implemented by subclasses to define how to clean up connections.

Subclasses should call disconnect_property_sync(target_widget) if property sync was connected.

bundle_name = 'roi'

components

target_widget = None

roi_bundle(components: bec_widgets.utils.toolbars.bundles.ToolbarComponents) → bec_widgets.utils.toolbars.bundles.ToolbarBundle

Creates a toolbar bundle for ROI and crosshair interaction.

Parameters:

components (ToolbarComponents) – The components to be added to the bundle.

Returns:

The ROI toolbar bundle.

Return type:

ToolbarBundle