navigate.model.features.common_features.SetCameraParameters
- class navigate.model.features.common_features.SetCameraParameters(model, microscope_name=None, sensor_mode='Normal', readout_direction=None, rolling_shutter_width=None)
Bases:
object
SetCameraParameters 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:
- modelMicroscopeModel
The microscope model object used for resolution mode changes.
- sensor_modestr, optional
The desired sensor mode to set for the camera. “Normal” or “Light-Sheet”
- readout_directionstr, optional
The readout direction to set for the camera. “Top-to-Bottom”, “Bottom-to-Top”, “Bidirectional” or “Rev. Bidirectional”
- rolling_shutter_widthint, 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
The microscope model associated with the resolution change.
A dictionary defining the configuration for the resolution change
Microscope name
The desired sensor mode to set for the camera.
The reading direction to set for the microscope.
- 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
- microscope_name
Microscope name
- Type:
str
- model
The microscope model associated with the resolution change.
- Type:
MicroscopeModel
- 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