navigate.model.features.update_setting.SetCameraParameters
- class navigate.model.features.update_setting.SetCameraParameters(model, microscope_name=None, sensor_mode='Normal', readout_direction=None, rolling_shutter_width=None)
Bases:
FeatureBaseSetCameraParameters class for modifying the parameters of a camera.
This class provides functionality to update the parameters of a camera.
Notes
This class can set sensor_mode, readout_direction and rolling_shutter_with.
If the value of a parameter is None it doesn’t update the parameter value.
- __init__(model, microscope_name=None, sensor_mode='Normal', readout_direction=None, rolling_shutter_width=None)
Initialize the ChangeResolution class.
- Parameters:
model (MicroscopeModel) – The microscope model object used for resolution mode changes.
sensor_mode (str, optional) – The desired sensor mode to set for the camera. “Normal” or “Light-Sheet”
readout_direction (str, optional) – The readout direction to set for the camera. “Top-to-Bottom”, “Bottom-to-Top”, “Bidirectional” or “Rev. Bidirectional”
rolling_shutter_width (int, optional) – The number of pixels for the rolling shutter.
Methods
__init__(model[, microscope_name, ...])Initialize the ChangeResolution class.
cleanup()Perform actions to change the resolution mode and update the active
Attributes
- cleanup()
- 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:
A boolean value indicating the success of the resolution change process.
- Return type:
bool
- config_table
A dictionary defining the configuration for the resolution change
- Type:
dict
- microscope_name
Microscope name
- Type:
str
- model
The microscope model associated with the resolution change.
- Type:
MicroscopeModel
- parameter_schema = {'microscope_name': SettingSpec(value_type=<class 'str'>, default=None, label='Microscope', help_text='Microscope name to update. Leave empty for the active microscope.', choices=None, choice_values=None, minimum=None, exclusive_minimum=None, maximum=None, step=None, required=False, dynamic_source='microscopes', depends_on=None), 'readout_direction': SettingSpec(value_type=<class 'str'>, default=None, label='Readout Direction', help_text='Readout direction for light-sheet sensor mode.', choices=('Top-to-Bottom', 'Bottom-to-Top', 'Bidirectional', 'Rev. Bidirectional'), choice_values=None, minimum=None, exclusive_minimum=None, maximum=None, step=None, required=False, dynamic_source=None, depends_on=None), 'rolling_shutter_width': SettingSpec(value_type=<class 'int'>, default=None, label='Rolling Shutter Width', help_text='Number of pixels used for rolling-shutter acquisition.', choices=None, choice_values=None, minimum=1, exclusive_minimum=None, maximum=None, step=1, required=False, dynamic_source=None, depends_on=None), 'sensor_mode': SettingSpec(value_type=<class 'str'>, default='Normal', label='Sensor Mode', help_text='Camera sensor mode.', choices=('Normal', 'Light-Sheet'), choice_values=None, minimum=None, exclusive_minimum=None, maximum=None, step=None, required=True, dynamic_source=None, depends_on=None)}
- readout_direction
The reading direction to set for the microscope.
- Type:
str
- sensor_mode
The desired sensor mode to set for the camera.
- Type:
str