magscope.ui

Submodules

• magscope.ui.auto_bead_selection_dialog
• magscope.ui.controls
• magscope.ui.panel_layout
• magscope.ui.plots
• magscope.ui.search
• magscope.ui.theme
• magscope.ui.ui
• magscope.ui.video_viewer
• magscope.ui.widgets

Classes

VideoViewer
PlotWorker
TimeSeriesPlotBase
BeadGraphic
CollapsibleGroupBox	A titled QGroupBox that can optionally collapse its content.
GripSplitter	Simple class for adding '...' to QSplitter handles.
LabeledCheckbox	Horizontally combined QLabel and QCheckbox.
LabeledLineEdit	Horizontally combined QLabel and QLineedit.
LabeledLineEditWithValue	Horizontally combined QLabel, QLineedit, and a second QLabel to show the value.
LabeledStepperLineEdit	Horizontally combined QLabel and QLineedit with a QButton to increment/decrement the value on either side.
ResizableLabel	Custom QLabel that emits a signal when it's resized.
AcquisitionPanel
AllanDeviationPanel
BeadSelectionPanel
CameraPanel
ControlPanelBase
HistogramPanel
PlotSettingsPanel
PreferencesDialog	Modal dialog for global MagScope preferences.
ScriptPanel
StatusPanel
TrackingOptionsPanel
MagScopeSettingsPanel	Allow importing, exporting, and editing MagScope configuration values.
Controls	Adaptive workflow controls with movable tabs and responsive columns.
UIManager	Abstract base class for processes in the MagScope

Package Contents

class magscope.ui.VideoViewer(scale_factor=1.25)

Bases: PyQt6.QtWidgets.QGraphicsView

coordinatesChanged: PyQt6.QtCore.pyqtSignal

clicked: PyQt6.QtCore.pyqtSignal

sceneClicked: PyQt6.QtCore.pyqtSignal

_MINIMAP_MARGIN = 12

_MINIMAP_MIN_SIZE = 120

_MINIMAP_MAX_SIZE = 220

_MINIMAP_LABEL_SPACING = 6

_MINIMAP_ZOOM_HEIGHT = 26

_MINIMAP_BUTTON_SPACING = 6

_mouse_start_pos

_mouse_start_time = 0.0

_zoom = 0

scale_factor = 1.25

_empty = True

scene

_image

_overlay_entries: list[tuple[PyQt6.QtCore.QRectF, PyQt6.QtCore.QPointF, str, bool, str]] = []

_visible_overlay_entries: list[tuple[PyQt6.QtCore.QRectF, str, bool]] | None = None

_visible_label_entries: list[tuple[PyQt6.QtCore.QPointF, PyQt6.QtGui.QStaticText, bool]] | None = None

_overlay_cache_pixmap

_overlay_cache_dirty = True

_overlay_cache_size

_overlay_cache_device_pixel_ratio = 0.0

_static_label_cache: dict[str, PyQt6.QtGui.QStaticText]

_label_metrics

_label_ascent

_marker_x

_marker_y

_marker_size = 0

_minimap_label

_minimap_zoom_label

_minimap_reset_button

_minimap_base

_fit_scale = 1.0

set_bead_overlay(bead_rois: dict[int, tuple[int, int, int, int]], active_bead_id: int | None, selected_bead_id: int | None, reference_bead_id: int | None, label_overrides: dict[int, str] | None = None, state_overrides: dict[int, str] | None = None) → None

_invalidate_overlay_view_cache() → None

_get_static_label(label_text: str) → PyQt6.QtGui.QStaticText

_rebuild_overlay_view_cache() → None

_rebuild_overlay_cache_pixmap() → None

_ensure_overlay_cache_pixmap() → None

plot(x, y, size)

clear_crosshairs()

set_image_to_default()

has_image()

image_scene_rect() → PyQt6.QtCore.QRectF

reset_view(scale=1)

clear_image()

set_pixmap(pixmap)

zoom_level()

zoom(step)

wheelEvent(event)

resizeEvent(event)

toggle_drag_mode()

update_coordinates(pos=None)

mouseMoveEvent(event)

leaveEvent(event)

mousePressEvent(event)

mouseReleaseEvent(event)

scrollContentsBy(dx, dy)

_refresh_minimap()

_layout_minimap()

_compute_highlight_rect(scaled_size, offset_x, offset_y)

_current_zoom_percent()

drawForeground(painter, rect)

class magscope.ui.PlotWorker

Bases: PyQt6.QtCore.QObject

image_signal

limits_signal

selected_bead_signal

reference_bead_signal

stop_signal

figure_size_signal

time_mode_signal

relative_window_signal

axes: matplotlib.axes.Axes

locks: dict[str, multiprocessing.synchronize.Lock]

figure: matplotlib.figure.Figure | None = None

canvas: matplotlib.backends.backend_qtagg.FigureCanvasQTAgg

_is_running: bool = False

plots = []

limits: dict[str, tuple[float, float]]

selected_bead: int | None = 0

reference_bead: int | None = None

n_plots: int

update_on: bool = True

_update_last_time: float

fig_width = 5

fig_height = 4

dpi = 100

device_pixel_ratio = 1.0

time_mode = 'absolute'

relative_window_seconds: float | None = 300

_tracks_snapshot: numpy.ndarray | None = None

mutex: PyQt6.QtCore.QMutex

figure_size_changed = True

setup()

run()

do_main_loop()

add_plot(plot: TimeSeriesPlotBase)

Used to add plots before the process has started

_set_limits(limits: dict[str, list[float, float]])

_set_selected_bead(bead: int)

_set_reference_bead(bead: int | None)

set_locks(locks: dict[str, multiprocessing.synchronize.Lock])

_stop()

dispose() → None

_update_figure_size(width: int, height: int, device_pixel_ratio: float)

Slot: update figure size based on QLabel dimensions.

_recreate_figure_if_needed()

Recreate figure and canvas if size changed.

_set_time_mode(time_mode: str)

_set_relative_window(window_seconds: float | None)

_apply_time_axis_format()

class magscope.ui.TimeSeriesPlotBase(buffer_name: str, ylabel: str)

buffer: magscope.datatypes.MatrixBuffer

buffer_name

parent: PlotWorker

axes: matplotlib.axes.Axes

ylabel

setup()

Called after the parent process is started

set_parent(parent: PlotWorker)

set_axes(axes: matplotlib.axes.Axes)

abstractmethod update()

class magscope.ui.BeadGraphic(parent: magscope.ui.ui.UIManager, id: int, roi: tuple[int, int, int, int], view_scene)

Bases: PyQt6.QtWidgets.QGraphicsRectItem

LABEL_FONT

LABEL_COLOR

LABEL_OFFSET_X = 10

LABEL_OFFSET_Y = 1

BORDER_COLOR_DEFAULT = (0, 255, 255, 255)

FILL_COLOR_DEFAULT = None

BORDER_COLOR_SELECTED = (255, 0, 0, 255)

FILL_COLOR_SELECTED = None

BORDER_COLOR_REFERENCE = (0, 255, 0, 255)

FILL_COLOR_REFERENCE = None

HOVER_BORDER_COLOR = (255, 96, 96, 255)

DRAG_BORDER_COLOR = (255, 255, 255, 255)

IDLE_PEN_WIDTH = 0

HOVER_PEN_WIDTH = 2

SELECTED_PEN_WIDTH = 2

DRAG_PEN_WIDTH = 3

CORNER_GRIP_SIZE = 6.0

_shared_pens: dict[str, PyQt6.QtGui.QPen] | None = None

_shared_brushes: dict[str, PyQt6.QtGui.QBrush] | None = None

_parent: magscope.ui.ui.UIManager

id: int

_initializing: bool = True

_is_moving: bool = False

_is_hovered: bool = False

_locked: bool

_color_state: str = 'default'

_cached_roi: tuple[int, int, int, int] | None = None

pen_width = 0

label

property locked

view_scene

remove()

classmethod roi_from_center(x: float, y: float, width: float) → tuple[int, int, int, int]

classmethod label_scene_position_for_roi(roi: tuple[int, int, int, int]) → PyQt6.QtCore.QPointF

classmethod clamp_roi_to_scene(roi: tuple[int, int, int, int], scene_rect: PyQt6.QtCore.QRectF) → tuple[int, int, int, int]

classmethod move_roi(roi: tuple[int, int, int, int], dx: int, dy: int, scene_rect: PyQt6.QtCore.QRectF) → tuple[int, int, int, int]

set_selection_state(state: str)

Update the bead overlay color to match selection/reference state.

classmethod _ensure_shared_pens_and_brushes() → None

static _create_pen(color: tuple[int, int, int, int]) → PyQt6.QtGui.QPen

static _create_brush(color: tuple[int, int, int, int] | None) → PyQt6.QtGui.QBrush

_apply_color()

_current_visual_state() → str

_current_border_color() → PyQt6.QtGui.QColor

_current_pen_width() → int

_update_cursor() → None

_corner_grip_rects() → list[PyQt6.QtCore.QRectF]

_paint_rect() → PyQt6.QtCore.QRectF

_current_scene_rect() → PyQt6.QtCore.QRectF

paint(painter, option, widget=None)

move(dx, dy)

validate_move(value)

Prevents the graphic from moving outside the scene border

get_label_scene_position() → PyQt6.QtCore.QPointF

set_roi_bounds(roi: tuple[int, int, int, int]) → None

itemChange(change, value)

hoverEnterEvent(event)

hoverLeaveEvent(event)

mousePressEvent(event)

mouseReleaseEvent(event)

on_move_completed()

get_roi_bounds() → tuple[int, int, int, int]

_update_cached_roi()

class magscope.ui.CollapsibleGroupBox(title='', collapsed=False, *, collapsible: bool = True)

Bases: PyQt6.QtWidgets.QGroupBox

A titled QGroupBox that can optionally collapse its content.

_DEFAULT_BORDER_COLOR = 'palette(mid)'

_DEFAULT_BORDER_WIDTH = 1

title = ''

collapsible = True

default_collapsed = False

_border_color = 'palette(mid)'

_border_width = 1

_settings_key = '_Group Box Collapsed'

toggle_button

drag_handle

content_area

animation

collapsed

set_highlight_border(color_name: str | None) → None

_apply_panel_style() → None

_animation_finished() → None

property settings_key: str

toggle(checked)

reset_to_default() → None

_apply_collapsed_state(collapsed: bool, *, animate: bool, persist: bool) → None

setContentLayout(content_layout)

static _get_toggle_text(title, expanded, *, collapsible: bool = True)

class magscope.ui.GripSplitter(orientation, name=None, parent=None)

Bases: PyQt6.QtWidgets.QSplitter

Simple class for adding ‘…’ to QSplitter handles.

name = None

shown_once = False

showEvent(e)

createHandle()

handle_released()

class magscope.ui.LabeledCheckbox(*, label_text: str, widths: tuple[int, int] = (0, 0), default=False, callback: callable = None)

Bases: PyQt6.QtWidgets.QWidget

Horizontally combined QLabel and QCheckbox.

layout

label

checkbox

class magscope.ui.LabeledLineEdit(*, label_text: str, widths: tuple[int, int] = (0, 0), default=None, validator: PyQt6.QtGui.QValidator = None, callback: callable = None)

Bases: PyQt6.QtWidgets.QWidget

Horizontally combined QLabel and QLineedit.

layout

label

lineedit

class magscope.ui.LabeledLineEditWithValue(*, label_text: str, validator: PyQt6.QtGui.QValidator = None, widths: tuple[int, int, int] = (0, 0, 0), default=None, callback: callable = None)

Bases: PyQt6.QtWidgets.QWidget

Horizontally combined QLabel, QLineedit, and a second QLabel to show the value.

layout

label

lineedit

value_label

class magscope.ui.LabeledStepperLineEdit(*, label_text: str, left_button_text: str, right_button_text: str, widths: tuple[int, int, int, int] = (0, 0, 0, 0), default=None, validator: PyQt6.QtGui.QValidator = None, callbacks: tuple[callable, callable, callable] = (None, None, None))

Bases: PyQt6.QtWidgets.QWidget

Horizontally combined QLabel and QLineedit with a QButton to increment/decrement the value on either side.

layout

name_label

left_button

lineedit

right_button

class magscope.ui.ResizableLabel(parent=None, *, ignore_pixmap_size_hint: bool = False)

Bases: PyQt6.QtWidgets.QLabel

Custom QLabel that emits a signal when it’s resized.

resized

_ignore_pixmap_size_hint = False

sizeHint() → PyQt6.QtCore.QSize

minimumSizeHint() → PyQt6.QtCore.QSize

resizeEvent(event)

Override resize event to emit signal with new dimensions.

class magscope.ui.AcquisitionPanel(manager: magscope.ui.ui.UIManager)

Bases: ControlPanelBase

NO_DIRECTORY_SELECTED_TEXT = 'No save folder selected'

acquisition_on_checkbox

acquisition_mode_combobox

acquisition_dir_on_checkbox

acquisition_dir_textedit

acquisition_dir_button

set_acquisition_dir_text(path: str | None) → None

callback_acquisition_on()

callback_acquisition_dir_on()

callback_acquisition_mode()

callback_acquisition_dir()

update_save_highlight(should_save: bool) → None

search_targets() → list[magscope.ui.search.SearchTarget]

class magscope.ui.AllanDeviationPanel(manager: magscope.ui.ui.UIManager)

Bases: MatplotlibCleanupMixin, ControlPanelBase

_SETTINGS_GROUP = 'AllanDeviationPanel'

refresh_button

history_window

history_window_hint

taus_mode

figure

canvas

axes

status_label

_settings() → PyQt6.QtCore.QSettings

_setting_key(name: str) → str

_load_setting(name: str, default: str) → str

_persist_controls() → None

_configure_axes() → None

refresh_plot() → None

clear(message: str = 'Click Refresh to compute Allan deviation') → None

static _parse_window_seconds(value: str) → float | None

static _estimate_sampling_rate(timestamps: numpy.ndarray) → float | None

static _apply_history_window(timestamps: numpy.ndarray, values: numpy.ndarray, window_seconds: float) → tuple[numpy.ndarray, numpy.ndarray]

static _extract_axis_series(tracks: numpy.ndarray, *, axis_name: str, selected_bead: int | None, reference_bead: int | None) → tuple[numpy.ndarray, numpy.ndarray]

class magscope.ui.BeadSelectionPanel(manager: magscope.ui.ui.UIManager)

Bases: ControlPanelBase

next_bead_id_label

reset_id_button

roi_size_label

clear_button

search_targets() → list[magscope.ui.search.SearchTarget]

update_next_bead_id_label(next_bead_id: int) → None

class magscope.ui.CameraPanel(manager: magscope.ui.ui.UIManager)

Bases: ControlPanelBase

_last_settings_update: datetime.datetime | None = None

settings

refresh_button

last_update_label

callback_refresh()

callback_set_camera_setting(name)

update_camera_setting(name: str, value: str)

_format_last_update_text() → str

class magscope.ui.ControlPanelBase(manager: magscope.ui.ui.UIManager, title: str, collapsed_by_default: bool = False, collapsible: bool = False)

Bases: PyQt6.QtWidgets.QWidget

manager: magscope.ui.ui.UIManager

groupbox: magscope.ui.widgets.CollapsibleGroupBox | None = None

_content_layout: PyQt6.QtWidgets.QBoxLayout | None = None

set_title(text: str) → None

setLayout(layout: PyQt6.QtWidgets.QBoxLayout) → None

layout() → PyQt6.QtWidgets.QBoxLayout

set_highlighted(enabled: bool) → None

class magscope.ui.HistogramPanel(manager: magscope.ui.ui.UIManager)

Bases: MatplotlibCleanupMixin, ControlPanelBase

update_interval: float = 1

_update_last_time: float = 0

enable_checkbox

only_beads_checkbox

n_bins = 256

figure

canvas

axes

enabled_callback(enabled: bool) → None

_groupbox_toggled(expanded: bool) → None

_apply_enabled_state(enabled: bool) → None

update_plot(data)

clear()

class magscope.ui.PlotSettingsPanel(manager: magscope.ui.ui.UIManager)

Bases: ControlPanelBase

selected_bead

reference_bead

limits: dict[str, tuple[PyQt6.QtWidgets.QLineEdit, PyQt6.QtWidgets.QLineEdit]]

grid_layout

time_mode

time_label

time_limits_absolute

time_relative_window

time_inputs_stack

beads_in_view_on

beads_in_view_count

beads_in_view_marker_size

search_targets() → list[magscope.ui.search.SearchTarget]

selected_bead_callback(value)

reference_bead_callback(value)

time_mode_callback(value: str)

relative_time_window_callback(_value)

limits_callback(_)

beads_in_view_on_callback()

beads_in_view_count_callback()

beads_in_view_marker_size_callback()

class magscope.ui.PreferencesDialog(manager: magscope.ui.ui.UIManager)

Bases: PyQt6.QtWidgets.QDialog

Modal dialog for global MagScope preferences.

_SIDEBAR_SECTIONS: tuple[tuple[str, str], Ellipsis] = (('tune', 'MagScope'), ('ads_click', 'Tracking'), ('palette', 'Appearance/Layout'))

manager

load_preferences_button

save_preferences_button

reset_all_preferences_button

preferences_file_status

settings_panel

settings_scroll

tracking_options_panel

tracking_scroll

appearance_layout_tab

appearance_scroll

stack

reset_section_button

sidebar

static _sidebar_selection_background(accent: str) → str

_apply_preferences_style(accent: str) → None

_refresh_sidebar_icons(accent: str | None = None) → None

_on_load_preferences_clicked() → None

_on_save_preferences_clicked() → None

_on_reset_all_preferences_clicked() → None

_set_preferences_file_status(message: str) → None

_create_appearance_layout_tab() → PyQt6.QtWidgets.QWidget

_choose_accent_color() → None

_update_accent_color_swatch(color: str) → None

_apply_accent_color_setting() → None

_apply_live_plot_progress_indicator_setting(checked: bool) → None

_scrollable_tab(widget: PyQt6.QtWidgets.QWidget) → PyQt6.QtWidgets.QScrollArea

static _make_material_symbol_icon(font: PyQt6.QtGui.QFont, text: str, color: str = '#888888', size: int = 16) → PyQt6.QtGui.QIcon

_on_sidebar_selection(index: int) → None

_on_reset_current_section() → None

_stack_index_for_scroll(scroll: PyQt6.QtWidgets.QScrollArea) → int

reveal_setting(setting_key: str) → None

reveal_magscope_setting(setting_key: str) → None

reveal_tracking_option(widget_attr: str) → None

reveal_widget(tab_name: str, widget_attr: str) → None

_reveal_widget(scroll: PyQt6.QtWidgets.QScrollArea, widget: PyQt6.QtWidgets.QWidget) → None

_on_reset_appearance_tab_clicked() → None

_reset_appearance_layout(*, reset_accent: bool) → None

class magscope.ui.ScriptPanel(manager: magscope.ui.ui.UIManager)

Bases: ControlPanelBase

NO_SCRIPT_SELECTED_TEXT = 'No script loaded'

status_prefix = 'Status'

status_label

step_position_label

step_description_label

button_layout

load_button

start_button

pause_button

filepath_textedit

update_status(status: magscope.scripting.ScriptStatus)

update_step(current_step: int | None, total_steps: int, description: str | None)

callback_load()

callback_start()

callback_pause()

class magscope.ui.StatusPanel(manager: magscope.ui.ui.UIManager)

Bases: ControlPanelBase

dot_count = 0

display_rate_status

video_processors_status

video_buffer_size_status

video_buffer_status

video_buffer_status_bar

video_buffer_purge_label

update_display_rate(text)

update_video_processors_status(status_text: str)

update_video_buffer_status(status_text: str)

_update_video_buffer_size_label() → None

update_video_buffer_purge(timestamp: float)

class magscope.ui.TrackingOptionsPanel(manager: magscope.ui.ui.UIManager, *, collapsible: bool = True)

Bases: ControlPanelBase

_current_options: dict[str, Any]

_updating_fields = False

background_combo

iterations

line_ratio

n_local

use_fft

fft_oversample

fft_rmin

fft_rmax

fft_gaus_factor

radial_oversample

lookup_n_local

static _build_preferences_group(title: str, parent: PyQt6.QtWidgets.QWidget) → tuple[PyQt6.QtWidgets.QWidget, PyQt6.QtWidgets.QVBoxLayout]

static _configure_lineedit_row(widget: magscope.ui.widgets.LabeledLineEditWithValue) → None

static _configure_checkbox_row(widget: magscope.ui.widgets.LabeledCheckbox) → None

static search_targets() → list[magscope.ui.search.SearchTarget]

_option_line_edits() → tuple[magscope.ui.widgets.LabeledLineEditWithValue, Ellipsis]

_update_value_labels() → None

_sync_fft_enabled_state() → None

_use_fft_changed(value: bool) → None

_set_options(options: dict[str, Any], message: str | None = None, *, populate_inputs: bool = False) → None

_populate_inputs_from_options() → None

_load_options_from_mapping(loaded: Any) → dict[str, Any]

_options_from_inputs() → dict[str, Any]

_apply_options_from_inputs() → None

reset_defaults() → None

class magscope.ui.MagScopeSettingsPanel(manager: magscope.ui.ui.UIManager, *, collapsible: bool = True, file_status_label: PyQt6.QtWidgets.QLabel | None = None)

Bases: PyQt6.QtWidgets.QWidget

Allow importing, exporting, and editing MagScope configuration values.

_SETTING_GROUPS: tuple[tuple[str, tuple[str, Ellipsis]], Ellipsis] = (('Imaging', ('ROI', 'magnification')), ('Data Buffers', ('tracks max datapoints', 'video buffer...

manager

_current_settings

_setting_inputs: dict[str, PyQt6.QtWidgets.QLineEdit]

_setting_value_labels: dict[str, PyQt6.QtWidgets.QLabel]

static search_targets() → list[magscope.ui.search.SearchTarget]

_show_error(message: str) → None

_push_settings(settings: magscope.settings.MagScopeSettings) → None

_refresh_fields() → None

_apply_setting_from_input(key: str) → None

reset_defaults() → None

_build_setting_group(title: str, keys: tuple[str, Ellipsis]) → PyQt6.QtWidgets.QWidget

_update_saved_label_for_input(key: str) → None

class magscope.ui.Controls(manager: UIManager)

Bases: PyQt6.QtWidgets.QWidget

Adaptive workflow controls with movable tabs and responsive columns.

LAYOUT_SETTINGS_GROUP = 'controls/layout'

WORKFLOW_COLUMNS_SETTINGS_KEY = 'controls/workflow_columns'

MIN_COLUMN_WIDTH = 360

MAX_COLUMNS = 4

WORKFLOW_ORDER = ['Run', 'Analysis', 'Locking', 'Motors']

WORKFLOW_TAB_ALIASES

DEFAULT_LAYOUTS

manager

panels: dict[str, magscope.ui.controls.ControlPanelBase | PyQt6.QtWidgets.QWidget]

_settings

_tab_widgets: list[WorkflowTabWidget] = []

_tab_pages: dict[str, PyQt6.QtWidgets.QScrollArea]

_tab_content_layouts: dict[str, PyQt6.QtWidgets.QVBoxLayout]

_panel_to_tab: dict[str, str]

_current_column_count = 0

_loading_layout = False

_columns_layout

property settings

_create_standard_panels() → None

_create_workflow_pages() → None

_populate_workflow_pages() → None

_desired_column_count() → int

_default_layout_for_count(count: int) → list[list[str]]

_load_saved_layout() → list[list[str]] | None

_save_workflow_layout() → None

_current_workflow_layout() → list[list[str]]

classmethod _canonical_workflow_tab_id(tab_id: Any) → str

_layout_for_column_count(count: int) → list[list[str]]

_expand_layout_to_count(columns: list[list[str]], count: int) → list[list[str]]

_fill_empty_columns(columns: list[list[str]], preferred_layout: list[list[str]]) → list[list[str]]

_tabs_for_empty_column(columns: list[list[str]], preferred_layout: list[list[str]], empty_index: int) → list[str]

_clear_tab_widgets() → None

_apply_workflow_layout(layout: list[list[str]], *, save: bool) → None

_sync_column_count_to_width() → None

move_workflow_tab(tab_id: str, target_column: int, target_index: int) → None

export_preferences() → dict[str, Any]

import_preferences(preferences: Mapping[str, Any]) → None

validate_preferences(preferences: Mapping[str, Any]) → None

_normalise_workflow_layout(raw_layout: Any) → list[list[str]]

reveal_panel(panel_id: str) → None

_reveal_legacy_panel(panel_id: str) → None

reset_to_defaults() → None

resizeEvent(event)

class magscope.ui.UIManager

Bases: magscope.processes.ManagerProcessBase

Abstract base class for processes in the MagScope

Subclass requirements: * Each subclass should have a unique name. * There should only be one instance of each subclass (singleton). * The class name is used for consistent inter-process identification.

_material_symbols_font_family: str | None = None

VIEWER_LAYOUT_STATE_VERSION = 1

VIEWER_GEOMETRY_SETTINGS_KEY = 'viewer/main_window_geometry'

VIEWER_DOCK_STATE_SETTINGS_KEY = 'viewer/dock_state'

_ZLUT_TRACKING_ACQUISITION_MODES

_active_bead_graphic: magscope.ui.widgets.BeadGraphic | None = None

_active_bead_id: int | None = None

_bead_rois: dict[int, tuple[int, int, int, int]]

_pending_bead_add_id: int | None = None

_pending_bead_add_roi: tuple[int, int, int, int] | None = None

_bead_next_id: int = 0

beads_in_view_on = False

beads_in_view_count = 1

beads_in_view_marker_size = 20

central_widgets: list[PyQt6.QtWidgets.QWidget] = []

central_layouts: list[PyQt6.QtWidgets.QLayout] = []

controls: Controls | None = None

controls_to_add = []

camera_dock: PyQt6.QtWidgets.QDockWidget | None = None

camera_dock_title_bar: PyQt6.QtWidgets.QWidget | None = None

camera_dock_header: PyQt6.QtWidgets.QWidget | None = None

bead_toolbar: PyQt6.QtWidgets.QWidget | None = None

bead_instructions_button: PyQt6.QtWidgets.QPushButton | None = None

bead_roi_size_label: PyQt6.QtWidgets.QLabel | None = None

bead_total_count_label: PyQt6.QtWidgets.QLabel | None = None

bead_next_id_label: PyQt6.QtWidgets.QLabel | None = None

bead_reassign_ids_button: PyQt6.QtWidgets.QPushButton | None = None

bead_remove_all_button: PyQt6.QtWidgets.QPushButton | None = None

_display_rate_counter: int = 0

_display_rate_last_time: float

_display_rate_last_rate: float = 0

plot_worker: magscope.ui.plots.PlotWorker

plot_thread: PyQt6.QtCore.QThread

plots_widget: PyQt6.QtWidgets.QLabel

plots_dock: PyQt6.QtWidgets.QDockWidget | None = None

plots_dock_title_bar: PyQt6.QtWidgets.QWidget | None = None

plots_dock_header: PyQt6.QtWidgets.QWidget | None = None

plots_to_add: list[magscope.ui.plots.TimeSeriesPlotBase] = []

plots_progress_indicator: LivePlotProgressIndicator | None = None

_plot_progress_timer: PyQt6.QtCore.QTimer | None = None

_plot_progress_started_at: float | None = None

_plot_progress_last_image_time: float | None = None

_plot_progress_interval_seconds = 1.0

_preferences_dialog: magscope.ui.controls.PreferencesDialog | None = None

qt_app: PyQt6.QtWidgets.QApplication | None = None

selected_bead = 0

reference_bead: int | None = None

_timer: PyQt6.QtCore.QTimer | None = None

_timer_video_view: PyQt6.QtCore.QTimer | None = None

_video_buffer_last_index: int = 0

_video_viewer_need_reset: bool = True

video_viewer: magscope.ui.video_viewer.VideoViewer | None = None

windows: list[PyQt6.QtWidgets.QMainWindow] = []

_suppress_bead_roi_updates: bool = False

_last_applied_roi: int | None = None

_settings_persistence_warning_shown = False

_bead_roi_capacity = 10000

_auto_bead_selection_dialog: magscope.ui.auto_bead_selection_dialog.AutoBeadSelectionDialog | None = None

_startup_ready_sent = False

_zlut_generation_dialog: magscope.ui.controls.ZLUTGenerationDialog | None = None

_zlut_generation_setup_dialog: magscope.ui.controls.ZLUTGenerationSetupDialog | None = None

_current_zlut_dialog: magscope.ui.controls.CurrentZLUTDialog | None = None

_current_zlut_filepath: str | None = None

_current_zlut_metadata: dict[str, float | int | None]

_zlut_generation_phase = 'idle'

_zlut_generation_z_axis_min_nm: float | None = None

_zlut_generation_z_axis_max_nm: float | None = None

_zlut_generation_z_axis_descending = False

_zlut_sweep_dataset: magscope.datatypes.ZLUTSweepDataset | None = None

_zlut_evaluation_bead_ids: list[int] = []

_zlut_evaluation_selected_bead_id: int | None = None

_zlut_preview_last_poll: float = 0.0

_shutdown_complete = False

_search_box: PyQt6.QtWidgets.QLineEdit | None = None

_search_container: PyQt6.QtWidgets.QWidget | None = None

_search_toggle_button: PyQt6.QtWidgets.QToolButton | None = None

_search_popup: PyQt6.QtWidgets.QWidget | None = None

_search_popup_box: PyQt6.QtWidgets.QLineEdit | None = None

_search_popup_escape_shortcut: PyQt6.QtGui.QShortcut | None = None

_search_status_label: PyQt6.QtWidgets.QLabel | None = None

_search_status_timer: PyQt6.QtCore.QTimer | None = None

_menu_row: PyQt6.QtWidgets.QWidget | None = None

_menu_bar: PyQt6.QtWidgets.QMenuBar | None = None

_top_bar_menu_controls: PyQt6.QtWidgets.QWidget | None = None

_top_bar_menu_buttons: dict[str, _TopBarActionButton]

_top_bar_action_buttons: dict[str, _TopBarActionButton]

_window_controls: PyQt6.QtWidgets.QWidget | None = None

_minimize_button: PyQt6.QtWidgets.QToolButton | None = None

_maximize_restore_button: PyQt6.QtWidgets.QToolButton | None = None

_close_button: PyQt6.QtWidgets.QToolButton | None = None

_caption_button_state_filter: _CaptionButtonStateFilter | None = None

_top_bar_compact_filter: _TopBarCompactModeFilter | None = None

_top_bar: _UnifiedTopBar | None = None

_help_menu_action: PyQt6.QtGui.QAction | None = None

_window_icon_label: PyQt6.QtWidgets.QLabel | None = None

_window_title_label: PyQt6.QtWidgets.QLabel | None = None

_title_bar_safe_area_spacer: PyQt6.QtWidgets.QWidget | None = None

_title_bar_safe_area_window_handle: Any = None

_layout_menu: PyQt6.QtWidgets.QMenu | None = None

_auto_bead_selection_action: PyQt6.QtGui.QAction | None = None

_zlut_menu: PyQt6.QtWidgets.QMenu | None = None

_new_zlut_action: PyQt6.QtGui.QAction | None = None

_load_zlut_action: PyQt6.QtGui.QAction | None = None

_unload_zlut_action: PyQt6.QtGui.QAction | None = None

_show_current_zlut_action: PyQt6.QtGui.QAction | None = None

_menus: dict[str, PyQt6.QtWidgets.QMenu]

_search_shortcuts: list[PyQt6.QtGui.QShortcut] = []

_search_registry

_search_highlighter

classmethod _material_symbols_font(point_size: int = 18) → PyQt6.QtGui.QFont

static _material_symbols_filled_stylesheet() → str

static _configure_unified_top_bar_window(window: PyQt6.QtWidgets.QMainWindow) → None

static _ensure_unified_top_menu_bar(window: PyQt6.QtWidgets.QMainWindow) → _UnifiedTopMenuBar

static _viewer_dock_separator_stylesheet() → str

_refresh_plot_progress_indicator() → None

_live_plot_progress_indicator_enabled() → bool

_apply_live_plot_progress_indicator_enabled() → None

static _install_viewer_dock_separator_hover_delay(window: PyQt6.QtWidgets.QMainWindow) → None

_apply_viewer_dock_separator_style(window: PyQt6.QtWidgets.QMainWindow) → None

static _zlut_requested_sweep_edges(z_axis_min_nm: float | None, z_axis_max_nm: float | None, n_steps: int) → tuple[float | None, float | None]

static _build_zlut_preview_payload(preview_snapshot: dict[str, object], *, z_axis_min_nm: float | None, z_axis_max_nm: float | None, z_axis_descending: bool) → dict[str, object]

setup()

_notify_startup_ready() → None

set_settings(settings: magscope.settings.MagScopeSettings)

Apply new settings and clear beads if the ROI size changed.

_current_accent_color() → str

_apply_accent_color(color: str) → None

_show_settings_persistence_warning_if_needed() → None

_show_settings_persistence_warning() → None

update_plot_figure_size(w, h)

_set_plot_image(img: PyQt6.QtGui.QImage) → None

_create_live_plot_progress_indicator() → LivePlotProgressIndicator

_ensure_plot_progress_timer() → None

_reset_plot_progress() → None

_update_plot_progress() → None

static _disconnect_signal(signal, callback) → None

static _stop_timer(timer: PyQt6.QtCore.QTimer | None) → None

static _close_widget(widget: PyQt6.QtWidgets.QWidget | None) → None

_shutdown_plot_worker() → None

quit()

Shutdown the process (and ask the other processes to quit too).

do_main_loop()

_handle_timer_exception(exc: BaseException) → None

Surface exceptions that occur inside Qt timer callbacks.

_run_safe(callback: Callable[[], None]) → None

_main_loop_tick() → None

_update_view_and_hist_tick() → None

set_selected_bead(bead: int)

set_live_profile_monitor_enabled(enabled: bool) → None

set_reference_bead(bead: int | None)

_sync_plot_settings_selected_bead(bead: int) → None

_sync_plot_settings_reference_bead(bead: int | None) → None

_normalize_bead_id(bead: int | None) → int | None

_get_bead_highlight_state(bead_id: int) → str

_refresh_bead_overlay() → None

_update_auto_bead_selection_action_state() → None

_can_start_auto_bead_selection() → bool

_snapshot_recent_image() → numpy.ndarray | None

_current_image_display_scale() → int

_current_scene_rect() → PyQt6.QtCore.QRectF

_current_visible_scene_rect() → PyQt6.QtCore.QRectF

_next_random_bead_roi(rng: numpy.random.Generator, visible_rect: PyQt6.QtCore.QRectF) → tuple[int, int, int, int] | None

_set_active_bead(bead_id: int | None) → None

on_active_bead_move_completed(bead_id: int, roi: tuple[int, int, int, int]) → None

add_random_beads(count: int, seed: int | None = None) → None

_add_new_bead_batch(rois: Iterable[tuple[int, int, int, int]]) → dict[int, tuple[int, int, int, int]]

_hit_test_bead(pos: PyQt6.QtCore.QPoint) → int | None

_update_bead_highlight(bead_id: int) → None

_update_bead_highlights(*, old_selected: int | None = None, old_reference: int | None = None)

_clear_live_profile_buffer() → None

property n_windows

property bead_roi_updates_suppressed: bool

property bead_next_id: int

_broadcast_bead_roi_update() → None

_write_bead_rois_to_buffer(bead_rois: dict[int, tuple[int, int, int, int]]) → None

create_central_widgets()

_create_viewer_docks(window: PyQt6.QtWidgets.QMainWindow) → None

_create_viewer_dock_title_bar(dock: PyQt6.QtWidgets.QDockWidget, title: str) → PyQt6.QtWidgets.QWidget

_create_viewer_dock_content(dock: PyQt6.QtWidgets.QDockWidget, viewer: PyQt6.QtWidgets.QWidget, toolbar: PyQt6.QtWidgets.QWidget | None = None, viewer_margins: tuple[int, int, int, int] | None = None, viewer_overlay: PyQt6.QtWidgets.QWidget | None = None) → tuple[PyQt6.QtWidgets.QWidget, PyQt6.QtWidgets.QWidget]

_create_live_bead_toolbar() → PyQt6.QtWidgets.QWidget

show_bead_selection_instructions() → None

_dock_viewer_pane(dock: PyQt6.QtWidgets.QDockWidget) → None

_set_viewer_dock_header_visible(dock: PyQt6.QtWidgets.QDockWidget, visible: bool) → None

_set_viewer_dock_title_bar_visible(dock: PyQt6.QtWidgets.QDockWidget, visible: bool) → None

_handle_viewer_dock_top_level_changed(dock: PyQt6.QtWidgets.QDockWidget, floating: bool) → None

_schedule_floating_dock_window_configuration(dock: PyQt6.QtWidgets.QDockWidget, floating: bool) → None

_configure_floating_dock_window(dock: PyQt6.QtWidgets.QDockWidget, floating: bool) → None

_create_view_menu(window: PyQt6.QtWidgets.QMainWindow) → None

_create_tools_menu(window: PyQt6.QtWidgets.QMainWindow) → None

_create_zlut_menu(window: PyQt6.QtWidgets.QMainWindow) → None

_update_zlut_menu_action_state() → None

_register_menu(name: str, menu: PyQt6.QtWidgets.QMenu) → None

_create_preferences_menu_action(window: PyQt6.QtWidgets.QMainWindow) → None

_create_help_menu_action(window: PyQt6.QtWidgets.QMainWindow) → None

static _title_bar_right_safe_area_width(window: PyQt6.QtWidgets.QMainWindow) → int

_update_title_bar_safe_area_spacing(window: PyQt6.QtWidgets.QMainWindow) → None

_install_title_bar_safe_area_updates(window: PyQt6.QtWidgets.QMainWindow) → None

static _apply_top_bar_style(menu_container: PyQt6.QtWidgets.QWidget, menu_bar_vertical_padding: int) → None

_create_top_bar_menu_controls(menu_bar: PyQt6.QtWidgets.QMenuBar, parent: PyQt6.QtWidgets.QWidget, target_height: int) → PyQt6.QtWidgets.QWidget

_create_caption_button(parent: PyQt6.QtWidgets.QWidget, object_name: str, icon_text: str, tooltip: str, callback: Callable[[], None], target_height: int, role: str) → PyQt6.QtWidgets.QToolButton

_create_main_window_controls(window: PyQt6.QtWidgets.QMainWindow, parent: PyQt6.QtWidgets.QWidget, target_height: int) → PyQt6.QtWidgets.QWidget

_toggle_main_window_maximized(window: PyQt6.QtWidgets.QMainWindow) → None

_create_search_menu_widget(window: PyQt6.QtWidgets.QMainWindow) → None

_connect_menu_search_box(search_box: PyQt6.QtWidgets.QLineEdit) → None

_create_search_popup(window: PyQt6.QtWidgets.QMainWindow, target_height: int) → tuple[PyQt6.QtWidgets.QWidget, PyQt6.QtWidgets.QLineEdit]

_handle_search_box_text_edited(search_box: PyQt6.QtWidgets.QLineEdit, model: PyQt6.QtCore.QStringListModel, completer: PyQt6.QtWidgets.QCompleter, text: str) → None

_guide_to_search_result_from_box(search_box: PyQt6.QtWidgets.QLineEdit) → None

_guide_to_search_result_from_text(text: str) → None

_sync_search_boxes(text: str, source: PyQt6.QtWidgets.QLineEdit | None = None) → None

_show_search_popup() → None

_hide_search_popup() → None

_clear_search_popup_box() → None

_focus_menu_search() → None

_search_container_horizontal_margins() → int

_search_inline_total_width(search_box_width: int) → int

_search_collapsed_total_width() → int

static _widget_width_hint(widget: PyQt6.QtWidgets.QWidget | None) → int

_set_menu_search_compact_state(collapsed: bool, search_box_width: int) → None

_set_top_bar_menu_icon_mode(icon_only: bool) → None

_update_top_bar_compact_mode() → None

_refresh_search_registry() → None

_ensure_search_registry() → None

_menu_search_targets() → list[magscope.ui.search.SearchTarget]

_generic_panel_search_targets() → list[magscope.ui.search.SearchTarget]

_core_control_search_targets() → list[magscope.ui.search.SearchTarget]

static _normalize_search_text(text: str) → str

_find_search_target(text: str) → magscope.ui.search.SearchTarget | None

_find_exact_search_target(text: str) → magscope.ui.search.SearchTarget | None

_search_completion_labels(text: str) → list[str]

_update_search_completion_model(model: PyQt6.QtCore.QStringListModel, completer: PyQt6.QtWidgets.QCompleter, text: str) → None

_guide_to_search_result(text: str) → bool

_guide_to_target(target: magscope.ui.search.SearchTarget) → None

_reveal_search_target(target: magscope.ui.search.SearchTarget) → None

_search_target_widget(target: magscope.ui.search.PanelControlTarget) → PyQt6.QtWidgets.QWidget | None

_reveal_preference_setting(target: magscope.ui.search.PreferencesSettingTarget) → None

_reveal_preference_widget(target: magscope.ui.search.PreferencesWidgetTarget) → None

_reveal_menu_action(target: magscope.ui.search.MenuActionTarget) → None

_highlight_search_widget(widget: PyQt6.QtWidgets.QWidget) → None

_clear_search_highlight(widget: PyQt6.QtWidgets.QWidget) → None

_install_search_shortcuts(window: PyQt6.QtWidgets.QMainWindow, search_box: PyQt6.QtWidgets.QLineEdit) → None

_focus_search_box(search_box: PyQt6.QtWidgets.QLineEdit) → None

_clear_search_box(search_box: PyQt6.QtWidgets.QLineEdit) → None

_set_search_status(text: str) → None

_clear_search_status_label_ref() → None

_show_preferences_dialog() → None

_dock_all_viewers() → None

_viewer_layout_settings() → PyQt6.QtCore.QSettings

_save_viewer_layout() → None

_restore_viewer_layout() → bool

_clear_viewer_layout() → None

static _encode_qbytearray(value: PyQt6.QtCore.QByteArray) → str

static _decode_qbytearray(value: str) → PyQt6.QtCore.QByteArray

export_appearance_layout_preferences() → dict[str, Any]

import_appearance_layout_preferences(preferences: Mapping[str, Any]) → None

validate_appearance_layout_preferences(preferences: Mapping[str, Any]) → None

reset_appearance_layout_preferences() → None

_sync_viewer_dock_headers() → None

_apply_default_viewer_layout() → None

_reset_viewer_layout() → None

update_view_coords()

_update_view_and_hist()

callback_view_clicked(pos: PyQt6.QtCore.QPoint, button=Qt.MouseButton.LeftButton)

refresh_bead_rois()

update_bead_rois()

_add_bead_roi(bead_id: int, roi: tuple[int, int, int, int]) → None

_update_bead_roi(bead_id: int, roi: tuple[int, int, int, int]) → None

_update_multiple_bead_rois(bead_rois: dict[int, tuple[int, int, int, int]]) → None

_remove_bead_roi(bead_id: int) → None

move_beads(moves: list[tuple[int, int, int]])

add_bead(pos: PyQt6.QtCore.QPoint)

start_auto_bead_selection() → None

_apply_auto_bead_selection(rois: list[tuple[int, int, int, int]]) → None

_show_auto_bead_selection_capacity_warning(skipped_count: int) → None

_on_auto_bead_selection_dialog_finished(_result: int) → None

remove_bead(id: int)

clear_beads()

reset_bead_ids()

_update_roi_labels(roi: int) → None

_update_next_bead_id_label() → None

_update_bead_roi_size_label(roi: int | None = None) → None

_update_bead_count_label() → None

_update_live_bead_toolbar_labels() → None

_clear_pending_bead_add() → None

_calculate_next_bead_id() → int

update_video_processors_status()

update_video_buffer_status()

_update_display_rate()

_update_beads_in_view()

update_camera_setting(name: str, value: str)

update_video_buffer_purge(t: float)

update_script_status(status: magscope.scripting.ScriptStatus)

update_script_step(current_step: int | None, total_steps: int, description: str | None)

print(text: str, details: str | None = None)

show_error(text: str, details: str | None = None)

show_warning(text: str, details: str | None = None)

set_acquisition_on(value: bool)

set_acquisition_dir(value: str | None)

set_acquisition_dir_on(value: bool)

set_acquisition_mode(mode: magscope.utils.AcquisitionMode)

update_xy_lock_enabled(value: bool)

update_xy_lock_interval(value: float)

update_xy_lock_max(value: float)

update_xy_lock_window(value: int)

update_z_lock_enabled(value: bool)

update_z_lock_bead(value: int)

update_z_lock_target(value: float)

update_z_lock_interval(value: float)

update_z_lock_max(value: float)

update_z_lock_window(value: int)

request_zlut_file(filepath: str) → None

clear_zlut() → None

unload_zlut() → None

load_zlut_file_dialog() → None

show_current_zlut_dialog() → None

_clear_current_zlut_dialog_ref() → None

show_new_zlut_dialog() → None

_zlut_generation_preflight_error() → str | None

_registered_focus_motor_names() → list[str]

_set_current_zlut(*, filepath: str | None, z_min: float | None = None, z_max: float | None = None, step_size: float | None = None, profile_length: int | None = None) → None

_update_current_zlut_dialog() → None

_clear_zlut_generation_preview(message: str = 'Waiting for Z-LUT sweep data...') → None

_read_zlut_preview_snapshot(dataset: magscope.datatypes.ZLUTSweepDataset) → dict[str, object]

show_zlut_generation_dialog() → None

start_zlut_generation(*, start_nm: float, step_nm: float, stop_nm: float, profiles_per_bead: int) → None

cancel_zlut_generation() → None

discard_generated_zlut_evaluation() → None

select_generated_zlut_bead(bead_id: int) → None

save_generated_zlut(bead_id: int, load_after_save: bool = True) → None

request_profile_length() → None

update_zlut_metadata(filepath: str | None = None, z_min: float | None = None, z_max: float | None = None, step_size: float | None = None, profile_length: int | None = None) → None

report_profile_length(profile_length: int | None = None) → None

update_zlut_generation_state(status: str, detail: str | None = None, running: bool = False, can_cancel: bool = False, phase: str = 'idle', z_axis_min_nm: float | None = None, z_axis_max_nm: float | None = None, z_axis_descending: bool = False) → None

update_zlut_generation_evaluation(active: bool, bead_ids: list[int], selected_bead_id: int | None = None) → None

update_zlut_generation_progress(current_step: int, total_steps: int, capture_count: int, capture_capacity: int, motor_z_value: float | None = None) → None

_handle_zlut_dialog_destroyed() → None

_detach_zlut_sweep_dataset() → None

_update_zlut_generation_dialog() → None

_refresh_zlut_preview_from_dataset() → None