navigate.model.devices.laser.synthetic.SyntheticLaser
- class navigate.model.devices.laser.synthetic.SyntheticLaser(microscope_name: str, device_connection: Any, configuration: dict[str, Any], device_id: int)
Bases:
LaserBaseSyntheticLaser Class
- __init__(microscope_name: str, device_connection: Any, configuration: dict[str, Any], device_id: int) → None
Initialize the SyntheticLaser class.
- Parameters:
microscope_name (str) – The microscope name.
device_connection (Any) – The device connection object.
configuration (Dict[str, Any]) – The device configuration.
device_id (int) – The laser ID.
Methods
__init__(microscope_name, device_connection, ...)Initialize the SyntheticLaser class.
close()Close the port before exit.
set_power(laser_intensity)Set the laser power.
turn_off()Turn off the laser
turn_on()Turn on the laser
Attributes
- close() → None
Close the port before exit.
- set_power(laser_intensity: int) → None
Set the laser power.
- Parameters:
laser_intensity (int) – The laser intensity to set.
- turn_off() → None
Turn off the laser
- turn_on() → None
Turn on the laser
- configuration
Configuration dictionary
- Type:
dict
- configuration_schema = {'onoff/hardware/max': SettingSpec(value_type=<class 'float'>, default=5.0, label='On/Off Maximum', help_text='Highest signal value used for laser on/off control.', choices=None, choice_values=None, minimum=None, exclusive_minimum=None, maximum=None, step=None, required=False, dynamic_source=None, depends_on=None), 'onoff/hardware/min': SettingSpec(value_type=<class 'float'>, default=0.0, label='On/Off Minimum', help_text='Lowest signal value used for laser on/off control.', choices=None, choice_values=None, minimum=None, exclusive_minimum=None, maximum=None, step=None, required=False, dynamic_source=None, depends_on=None), 'onoff/hardware/type': SettingSpec(value_type=<class 'str'>, default='Synthetic', label='On/Off Type', help_text='Hardware used to switch the laser on and off.', choices=('NI', 'ASI', 'Synthetic'), choice_values=None, minimum=None, exclusive_minimum=None, maximum=None, step=None, required=True, dynamic_source=None, depends_on=None), 'power/hardware/max': SettingSpec(value_type=<class 'float'>, default=5.0, label='Power Maximum', help_text='Highest voltage used for analog laser-power control.', choices=None, choice_values=None, minimum=None, exclusive_minimum=None, maximum=None, step=None, required=False, dynamic_source=None, depends_on=None), 'power/hardware/min': SettingSpec(value_type=<class 'float'>, default=0.0, label='Power Minimum', help_text='Lowest voltage used for analog laser-power control.', choices=None, choice_values=None, minimum=None, exclusive_minimum=None, maximum=None, step=None, required=False, dynamic_source=None, depends_on=None), 'power/hardware/type': SettingSpec(value_type=<class 'str'>, default='Synthetic', label='Power Type', help_text='Hardware used to control laser power.', choices=('NI', 'ASI', 'Synthetic'), choice_values=None, minimum=None, exclusive_minimum=None, maximum=None, step=None, required=True, dynamic_source=None, depends_on=None), 'wavelength': SettingSpec(value_type=<class 'int'>, default=488, label='Wavelength (nm)', help_text='Laser emission wavelength in nanometres.', choices=None, choice_values=None, minimum=None, exclusive_minimum=None, maximum=None, step=None, required=True, dynamic_source=None, depends_on=None)}
- device_config
Laser ID
- Type:
int
- device_connection
Communication instance with the device
- Type:
Any
- microscope_name
Name of the microscope
- Type:
str