Widgets Module

The widgets module contains PyQt6-based GUI components for the VISTA application.

Overview

The widgets module provides the graphical user interface components for VISTA, including:

• Core application widgets (viewers, panels, controls)

• Algorithm configuration dialogs

• Data management interfaces

• Visualization tools

This module follows PyQt6 conventions and extends Qt widgets with VISTA-specific functionality.

Module Structure

The widgets module is organized into several submodules:

• core - Core application widgets

• algorithms - Algorithm configuration dialogs

• utils - Widget utilities and helpers

Core Widgets

Core widgets provide the main application interface:

• Data Manager: Central widget for managing imagery, detections, and tracks

• Imagery Panel: Display and control imagery data

• Playback Controls: Frame navigation and playback

• Settings Dialog: Application configuration

Algorithm Widgets

Algorithm widgets provide user interfaces for configuring and running algorithms:

• Detector Widgets: Configuration for detection algorithms

• Tracker Widgets: Configuration for tracking algorithms

• Treatment Widgets: Configuration for image treatments

• Background Removal Widgets: Configuration for background subtraction

Module Reference

Core Widgets

Data manager panel - coordinating panel for managing imagery, tracks, detections, and AOIs

class vista.widgets.core.data.data_manager.DataManagerPanel(*args, **kwargs)

Bases: QWidget

Main panel for managing all data types

__init__(viewer)

Initialize the data manager panel.

Parameters:

viewer (ImageryViewer) – ImageryViewer instance

init_ui()

Initialize the user interface

on_sensor_selected(sensor)

Handle sensor selection change

on_sensor_data_changed()

Handle sensor data changes (e.g., sensor deletion)

refresh()

Refresh all panels

on_track_selected_in_viewer(track)

Handle track selection from viewer click. Forwards to tracks panel or detections panel depending on state.

Parameters:

track (Track) – Track object that was clicked

on_detections_selected_in_viewer(detections)

Handle detection selection from viewer click. Forwards to detections panel.

Parameters:

detections (list of tuple) – List of tuples [(detector, frame, index), …]

refresh_aois_table()

Refresh AOIs table - wrapper for compatibility

Imagery panel for data manager

class vista.widgets.core.data.imagery_panel.ImageryPanel(*args, **kwargs)

Bases: QWidget

Panel for managing imagery

__init__(viewer)

init_ui()

Initialize the user interface

refresh_imagery_table()

Refresh the imagery table, filtering by selected sensor

on_imagery_selection_changed()

Handle imagery selection changes from table

on_imagery_cell_changed(row, column)

Handle imagery cell changes

delete_selected_imagery()

Delete imagery that is selected in the table

PlaybackControls widget for controlling imagery playback

class vista.widgets.core.playback_controls.PlaybackControls(*args, **kwargs)

Bases: QWidget

Widget for playback controls

__init__(parent=None)

init_ui()

set_frame_range(min_frame, max_frame)

Set the range of frame numbers without changing current frame

set_frame(frame_number)

Set current frame by frame number

update_label()

Update frame label and time display

on_slider_changed(value)

Handle slider value change

on_fps_dial_changed(value)

Handle FPS dial change

on_fps_spinbox_changed(value)

Handle FPS spinbox change

toggle_play()

Toggle playback

toggle_reverse()

Toggle reverse playback

play()

Start playback

pause()

Pause playback

on_timer_tick()

Called by timer frequently - checks if enough time has passed to advance frame

advance_frame()

Advance frame based on playback direction and bounce mode

next_frame()

Go to next frame

prev_frame()

Go to previous frame

prev_frame_reverse()

Go to previous frame (for reverse playback with looping)

update_actual_fps()

Calculate and update the actual achieved FPS display

on_bounce_toggled(state)

Handle bounce mode toggle

on_bounce_range_changed()

Handle bounce range change

frame_changed(frame_index)

Override this method to handle frame changes

Algorithm Dialogs

Detector Dialogs

Base classes for detector widgets to reduce code duplication

class vista.widgets.algorithms.detectors.base_detector_widget.BaseDetectorProcessingThread(*args, **kwargs)

Bases: QThread

Base worker thread for running detector algorithms in background

progress_updated

alias of int

processing_complete

alias of object

error_occurred

alias of str

__init__(imagery, algorithm_class, algorithm_params, aoi=None, start_frame=0, end_frame=None, detector_name=None, default_color='r', default_marker='o', default_marker_size=12)

Initialize the processing thread.

Parameters:

• imagery (Imagery) – Imagery object to process

• algorithm_class (type) – Detector algorithm class to instantiate (e.g., SimpleThreshold)

• algorithm_params (dict) – Dictionary of parameters to pass to algorithm constructor

• aoi (AOI, optional) – AOI object to process subset of imagery, by default None

• start_frame (int, optional) – Starting frame index, by default 0

• end_frame (int, optional) – Ending frame index exclusive, by default None for all frames

• detector_name (str, optional) – Name for the detector, by default None (auto-generated)

• default_color (str, optional) – Default color for detections, by default ‘r’

• default_marker (str, optional) – Default marker for detections, by default ‘o’

• default_marker_size (int, optional) – Default marker size, by default 12

cancel()

Request cancellation of the processing operation

run()

Execute the detector algorithm in background thread

class vista.widgets.algorithms.detectors.base_detector_widget.BaseDetectorWidget(*args, **kwargs)

Bases: QDialog

Base configuration widget for detector algorithms

detector_processed

alias of object

__init__(parent=None, imagery=None, aois=None, algorithm_class=None, settings_name='BaseDetector', window_title='Detector', description='', default_color='r', default_marker='o', default_marker_size=12)

Initialize the base detector configuration widget.

Parameters:

• parent (QWidget, optional) – Parent widget, by default None

• imagery (Imagery, optional) – Imagery object to process, by default None

• aois (list of AOI, optional) – List of AOI objects to choose from, by default None

• algorithm_class (type, optional) – Detector algorithm class (e.g., SimpleThreshold), by default None

• settings_name (str, optional) – Name for QSettings storage, by default “BaseDetector”

• window_title (str, optional) – Window title, by default “Detector”

• description (str, optional) – HTML description text for the detector, by default “”

• default_color (str, optional) – Default color for detections, by default ‘r’

• default_marker (str, optional) – Default marker for detections, by default ‘o’

• default_marker_size (int, optional) – Default marker size, by default 12

init_ui()

Initialize the user interface

add_algorithm_parameters(layout)

Add algorithm-specific parameters to the layout. Override this method in subclasses to add custom parameters.

Parameters:

layout (QVBoxLayout) – QVBoxLayout to add parameters to

load_settings()

Load previously saved settings. Override this method in subclasses to load custom parameters.

save_settings()

Save current settings for next time. Override this method in subclasses to save custom parameters.

build_algorithm_params()

Build parameter dictionary for the algorithm. Override this method in subclasses to add custom parameters.

Returns:

Dictionary of algorithm parameters

Return type:

dict

validate_parameters()

Validate algorithm parameters before running. Override this method in subclasses for custom validation.

Returns:

Tuple containing (is_valid, error_message)

Return type:

tuple of (bool, str)

run_algorithm()

Start processing the imagery with the configured parameters

set_parameters_enabled(enabled)

Enable or disable parameter widgets. Override to handle custom parameter widgets.

Parameters:

enabled (bool) – True to enable, False to disable

cancel_processing()

Cancel the ongoing processing

on_progress_updated(current, total)

Handle progress updates from the processing thread.

Parameters:

• current (int) – Current frame number being processed

• total (int) – Total number of frames to process

on_processing_complete(detector)

Handle successful completion of processing.

Parameters:

detector (Detector) – The resulting Detector object containing all detections

on_error_occurred(error_message)

Handle errors from the processing thread.

Parameters:

error_message (str) – Error message string, potentially including traceback information

on_thread_finished()

Handle thread completion (cleanup)

reset_ui()

Reset UI to initial state

closeEvent(event)

Handle dialog close event.

Parameters:

event (QCloseEvent) – Close event to accept or ignore

Tracker Dialogs

Base classes for tracker dialogs to reduce code duplication

class vista.widgets.algorithms.trackers.base_tracker_dialog.BaseTrackingWorker(*args, **kwargs)

Bases: QThread

Base worker thread for running trackers in background

progress_updated

alias of str

tracking_complete

alias of object

error_occurred

alias of str

__init__(detectors, tracker_config, algorithm_function)

Initialize the tracking worker.

Parameters:

• detectors (list of Detector) – List of Detector objects to use for tracking

• tracker_config (dict) – Dictionary of tracker configuration parameters

• algorithm_function (callable) – Function to call for tracking (e.g., run_simple_tracker)

cancel()

Request cancellation

run()

Execute tracking in background

class vista.widgets.algorithms.trackers.base_tracker_dialog.BaseTrackingDialog(*args, **kwargs)

Bases: QDialog

Base dialog for configuring tracker parameters

__init__(viewer, parent=None, algorithm_function=None, settings_name='BaseTracker', window_title='Tracker', description='', default_track_color='b', default_track_marker='s', default_track_line_width=2, default_track_marker_size=10)

Initialize the base tracking dialog.

Parameters:

• viewer (object) – VISTA viewer object

• parent (QWidget, optional) – Parent widget, by default None

• algorithm_function (callable, optional) – Function to call for tracking (e.g., run_simple_tracker), by default None

• settings_name (str, optional) – Name for QSettings storage, by default “BaseTracker”

• window_title (str, optional) – Window title, by default “Tracker”

• description (str, optional) – HTML description text for the tracker, by default “”

• default_track_color (str, optional) – Default color for created tracks, by default ‘b’

• default_track_marker (str, optional) – Default marker for created tracks, by default ‘s’

• default_track_line_width (int, optional) – Default line width for created tracks, by default 2

• default_track_marker_size (int, optional) – Default marker size for created tracks, by default 10

setup_ui()

Setup the dialog UI - can be overridden by subclasses

add_algorithm_parameters(main_layout)

Add algorithm-specific parameters to the form layout. Override this method in subclasses to add custom parameters.

Parameters:

main_layout (QVBoxLayout) – The main QVBoxLayout - use this if you need to add custom group boxes. For simple parameters, add to self.params_layout (QFormLayout).

load_settings()

Load previously saved settings. Override this method in subclasses to load custom parameters.

save_settings()

Save current settings for next time. Override this method in subclasses to save custom parameters.

build_config()

Build configuration dictionary for the tracker. Override this method in subclasses to add custom parameters.

Returns:

Dictionary of tracker configuration parameters

Return type:

dict

run_tracker()

Start the tracking process

on_progress(message)

Update progress dialog

on_complete(track_data_list, tracker_name)

Handle tracking completion

on_error(error_msg)

Handle tracking error

cancel_tracking()

Cancel the tracking process

Treatment Dialogs

Base classes for treatment widgets to reduce code duplication

class vista.widgets.algorithms.treatments.base_treatment_widget.BaseTreatmentThread(*args, **kwargs)

Bases: QThread

Base worker thread for running treatment algorithms

progress_updated

alias of int

processing_complete

alias of object

error_occurred

alias of str

__init__(imagery, aoi=None)

Initialize the processing thread.

Parameters:

• imagery (Imagery) – Imagery object to process

• aoi (AOI, optional) – AOI object to process subset of imagery, by default None

cancel()

Request cancellation of the processing operation

process_frame(frame_data, frame_index, frame_number)

Process a single frame. Override this method in subclasses.

Parameters:

• frame_data (ndarray) – The image data for this frame

• frame_index (int) – Index in the temp_imagery arrays

• frame_number (int) – Actual frame number from original imagery

Returns:

Processed frame data

Return type:

ndarray

get_processed_name_suffix()

Get the suffix to add to the processed imagery name. Override in subclasses (e.g., “BR”, “NUC”).

Returns:

String suffix for processed imagery name

Return type:

str

run()

Execute the treatment in background thread

class vista.widgets.algorithms.treatments.base_treatment_widget.BaseTreatmentWidget(*args, **kwargs)

Bases: QDialog

Base configuration widget for treatment algorithms

imagery_processed

alias of object

__init__(parent=None, imagery=None, aois=None, window_title='Treatment', description='')

Initialize the base treatment configuration widget.

Parameters:

• parent (QWidget, optional) – Parent widget, by default None

• imagery (Imagery, optional) – Imagery object to process, by default None

• aois (list of AOI, optional) – List of AOI objects to choose from, by default None

• window_title (str, optional) – Window title, by default “Treatment”

• description (str, optional) – Description text for the treatment, by default “”

init_ui()

Initialize the user interface

add_treatment_ui(layout)

Add treatment-specific UI elements. Override this method in subclasses if needed.

Parameters:

layout (QVBoxLayout) – QVBoxLayout to add elements to

create_processing_thread(imagery, aoi)

Create the processing thread for this treatment. Must be implemented by subclasses.

Parameters:

• imagery (Imagery) – Imagery object to process

• aoi (AOI, optional) – AOI object

Returns:

BaseTreatmentThread instance

Return type:

BaseTreatmentThread

validate_sensor_requirements()

Validate that the sensor has required data for this treatment. Override in subclasses to check for specific sensor properties.

Returns:

Tuple containing (is_valid, error_message)

Return type:

tuple of (bool, str)

run_treatment()

Start processing the imagery

set_treatment_ui_enabled(enabled)

Enable or disable treatment-specific UI elements. Override in subclasses if there are custom UI elements.

Parameters:

enabled (bool) – True to enable, False to disable

cancel_processing()

Cancel the ongoing processing

on_progress_updated(current, total, label=None)

Handle progress updates from the processing thread

on_processing_complete(processed_imagery)

Handle successful completion of processing

on_error_occurred(error_message)

Handle errors from the processing thread

on_thread_finished()

Handle thread completion (cleanup)

reset_ui()

Reset UI to initial state

closeEvent(event)

Handle dialog close event

Extending Widgets

To create custom algorithm widgets, inherit from the appropriate base class:

from vista.widgets.algorithms.detectors.base_detector_widget import BaseDetectorWidget

class MyDetectorWidget(BaseDetectorWidget):
    def __init__(self, parent=None):
        super().__init__(parent)
        self.setup_ui()

    def setup_ui(self):
        # Add custom UI elements
        pass

    def get_parameters(self):
        # Return algorithm parameters
        return {
            'threshold': self.threshold_spinbox.value(),
            'min_area': self.area_spinbox.value()
        }

See Extending VISTA for more details on extending VISTA widgets.