navigate.controller.sub_controllers.acquire_bar.AcquireBarController

class navigate.controller.sub_controllers.acquire_bar.AcquireBarController(view: AcquireBar, parent_controller: Any)

Bases: GUIController

Acquire Bar Controller.

__init__(view: AcquireBar, parent_controller: Any) → None

Initialize the Acquire Bar Controller.

Parameters:

• view (AcquireBar) – Instance of the View.

• parent_controller (Any) – Instance of the Main Controller.

Methods

__init__(view, parent_controller)	Initialize the Acquire Bar Controller.
add_mode(mode)	Add a new mode to the mode dictionary.
execute(command, *args)	This function is called when a command is passed from a child process.
exit_program()	Exit Button to close the program.
get_mode()	Get the current imaging mode.
initialize()	This function is called when the controller is initialized
is_valid_string(string)	Check if the string is valid.
launch_acquisition(popup_window)	Launch the Acquisition.
launch_popup_window()	Launch the Save Dialog Popup Window
populate_experiment_values()	Populate the experiment values from the config file.
progress_bar(images_received, ...[, stop])	Update progress bars.
register_event_listener(event_name, ...)	Register event listener in the parent_controller
set_bdv_settings()	Set the BDV Settings from the configuration file.
set_experiment_values()	Sets values of widgets based on experiment setting
set_mode(mode)	Set imaging mode.
set_save_option(is_save)	Set whether the image will be saved.
show_verbose_info(*info)	Prints verbose information to the console
stop_acquire()	Stop the acquisition.
stop_progress_bar()	Stop moving the continuous progress bar.
toggle_bdv_widgets(main_widget, ...)	Toggles the state of the dependent widgets.
update_bdv_settings()	Update the BDV settings.
update_experiment_values(popup_window)	Gets the entries from the popup save dialog and overwrites the saving_settings dictionary.
update_file_type(file_type)	Updates the file type when the drop-down in save dialog is changed.
update_microscope_mode(*args)	Gets the state of the pull-down menu and tells the central controller
update_progress_label(seconds_left)	Update the progress label in the Acquire Bar.

Attributes

custom_events	Custom events for the controller
acquire_pop	Instance of the popup window.
saving_settings	Saving settings.
mode	Acquisition image mode.
is_save	Whether the image will be saved.
is_acquiring	Whether the microscope is acquiring.
mode_dict	Dictionary of different operating modes.
bdv_configuration	The ProxyDict for the BDV configuration.
bdv_widgets	BDV Widgets.

add_mode(mode: str) → None

Add a new mode to the mode dictionary.

Parameters:

mode (str) – Mode to add to the dictionary.

execute(command, *args)

This function is called when a command is passed from a child process.

Parameters:

• command (str) – command name

• args (tuple) – command arguments

exit_program() → None

Exit Button to close the program.

get_mode() → str

Get the current imaging mode.

Returns:

mode – Current imaging mode.

Return type:

str

initialize()

This function is called when the controller is initialized

This function initializes GUI based on configuration setting parameter: configuration_controller set range value for entry or spinbox widgets; add values to combobox get other necessary information for configuration.yml

static is_valid_string(string: str) → bool

Check if the string is valid.

Parameters:

string (str) – String to check.

Returns:

True if the string is valid.

Return type:

bool

launch_acquisition(popup_window: AcquirePopUp) → None

Launch the Acquisition.

Once the popup window has been filled out, we first create the save path using the create_save_path function. This automatically removes spaces and replaces them with underscores. Then it makes the directory.

Parameters:

popup_window (AcquirePopUp) – Instance of the popup save dialog.

launch_popup_window() → None

Launch the Save Dialog Popup Window

The popup window should only be launched if the microscope is set to save the data, except the continuous acquisition mode. The popup window provides the user with the opportunity to fill in fields that describe the experiment and also dictate the save path of the data in a standardized format.

populate_experiment_values() → None

Populate the experiment values from the config file.

progress_bar(images_received: int, microscope_state: Dict[str, Any], mode: str, stop=False)

Update progress bars.

Parameters:

• microscope_state (dict) – State of the microscope. Positions, channels, z-steps, etc.

• mode (str) – Imaging mode. ‘live’, ‘z-stack’, …

• images_received (int) – Number of images received in the controller.

• stop (bool) – Stop flag to set back to 0.

register_event_listener(event_name, event_handler)

Register event listener in the parent_controller

Parameters:

• event_name (str) – event name

• event_handler (function) – event handler

set_bdv_settings() → None

Set the BDV Settings from the configuration file.

If the settings are not in the configuration file, they will be added.

set_experiment_values()

Sets values of widgets based on experiment setting

setting_dict is a dictionary

set_mode(mode: str) → None

Set imaging mode.

Parameters:

mode (str) – Mode could be: ‘live’, ‘z-stack’, ‘single’, ‘projection’,

set_save_option(is_save: bool) → None

Set whether the image will be saved.

Parameters:

is_save (bool) – True if we will save the data. False if we will not.

show_verbose_info(*info)

Prints verbose information to the console

Parameters:

info (tuple) – information to be printed

stop_acquire() → None

Stop the acquisition.

Stop the progress bar, set the acquire button back to “Acquire”, place pull down menu in non-disabled format.

stop_progress_bar() → None

Stop moving the continuous progress bar.

toggle_bdv_widgets(main_widget: str, dependent_widgets: list) → None

Toggles the state of the dependent widgets.

Parameters:

• main_widget (str) – The main widget that is being toggled.

• dependent_widgets (list) – A list of dependent widgets that will be toggled.

update_bdv_settings() → None

Update the BDV settings.

update_experiment_values(popup_window: AcquirePopUp) → None

Gets the entries from the popup save dialog and overwrites the saving_settings dictionary.

Parameters:

popup_window (AcquirePopUp) – Instance of the popup save dialog.

update_file_type(file_type: StringVar) → None

Updates the file type when the drop-down in save dialog is changed.

Parameters:

file_type (tk.StringVar) – File type.

update_microscope_mode(*args: Iterable) → None

Gets the state of the pull-down menu and tells the central controller

Will additionally call functions to disable and enable widgets based on mode

Parameters:

args (str) – Imaging Mode.

update_progress_label(seconds_left: int) → None

Update the progress label in the Acquire Bar.

Formatted time is in HH:MM:SS.

Parameters:

seconds_left (int) – Seconds left in the acquisition.

acquire_pop

Instance of the popup window.

Type:

AcquirePopUp

bdv_configuration

The ProxyDict for the BDV configuration.

Type:

dict

bdv_widgets

BDV Widgets. Keys are primary widgets, values are lists.

Type:

dict

property custom_events

Custom events for the controller

is_acquiring

Whether the microscope is acquiring.

Type:

bool

is_save

Whether the image will be saved.

Type:

bool

mode

Acquisition image mode.

Type:

str

mode_dict

Dictionary of different operating modes.

Type:

dict

parent_controller

parent controller

Type:

Controller

saving_settings

Saving settings.

Type:

dict

view

GUI view

Type:

tkinter.Tk