navigate.model.features.common_features.ChangeResolution

class navigate.model.features.common_features.ChangeResolution(model, resolution_mode='high', zoom_value='N/A')

Bases: object

ChangeResolution class for modifying the resolution mode of a microscope.

This class provides functionality to change the resolution mode of a microscope by reconfiguring the microscope settings and updating the active microscope.

Notes:

• This class is used to change the resolution mode of a microscope by updating the

microscope settings and configuring the active microscope accordingly.

• The resolution_mode parameter specifies the desired resolution mode, and the

zoom_value parameter specifies the zoom value to be set. These parameters can be adjusted to modify the microscope’s configuration.

• The ChangeResolution class is typically used to adapt the microscope’s settings

for different imaging requirements during microscopy experiments.

• The resolution change process involves reconfiguring the microscope, updating the

active microscope instance, and resuming data acquisition.

• The config_table attribute is used to define the configuration for the

resolution change process, including signal acquisition and cleanup steps.

__init__(model, resolution_mode='high', zoom_value='N/A')

Initialize the ChangeResolution class.

Parameters:

modelMicroscopeModel

The microscope model object used for resolution mode changes.

resolution_modestr, optional

The desired resolution mode to set for the microscope. Default is “high”.

zoom_valuestr, optional

The zoom value to set for the microscope. Default is “N/A”.

Methods

__init__(model[, resolution_mode, zoom_value])	Initialize the ChangeResolution class.
cleanup()	Perform cleanup actions if needed.
signal_func()	Perform actions to change the resolution mode and update the active

Attributes

model	The microscope model associated with the resolution change.
config_table	A dictionary defining the configuration for the resolution change
resolution_mode	The desired resolution mode to set for the microscope.
zoom_value	The zoom value to set for the microscope.

cleanup()

Perform cleanup actions if needed.

This method is responsible for performing cleanup actions if required after the resolution change process.

signal_func()

Perform actions to change the resolution mode and update the active

microscope.

This method carries out actions to change the resolution mode of the microscope

by reconfiguring the microscope settings, updating the active microscope, and resuming data acquisition.

Returns:

bool

A boolean value indicating the success of the resolution change process.

config_table

A dictionary defining the configuration for the resolution change

Type:

dict

model

The microscope model associated with the resolution change.

Type:

MicroscopeModel

resolution_mode

The desired resolution mode to set for the microscope.

Type:

str

zoom_value

The zoom value to set for the microscope.

Type:

str