navigate.model.devices.laser.ni.NILaser
- class navigate.model.devices.laser.ni.NILaser(microscope_name: str, device_connection: Any, configuration: dict[str, Any], device_id: int)
-
- __init__(microscope_name: str, device_connection: Any, configuration: dict[str, Any], device_id: int) → None
Initialize the LaserNI 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 LaserNI class.
close()Close the NI Task before exit.
Initialize the analog modulation of the laser.
Initialize the digital modulation of the laser.
set_power(laser_intensity)Sets the analog laser power.
turn_off()Turns off the laser.
turn_on()Turns on the laser.
Attributes
- close() → None
Close the NI Task before exit.
- initialize_analog_modulation() → None
Initialize the analog modulation of the laser.
- initialize_digital_modulation() → None
Initialize the digital modulation of the laser.
- set_power(laser_intensity: float) → None
Sets the analog laser power.
- Parameters:
laser_intensity (float) – The laser intensity.
- turn_off() → None
Turns off the laser.
- turn_on() → None
Turns on the laser.
- configuration
Configuration dictionary
- Type:
dict
- configuration_schema = {'onoff/hardware/channel': SettingSpec(value_type=<class 'str'>, default='', label='On/Off Channel', help_text='NI digital or analog channel used to switch the laser.', choices=None, choice_values=None, minimum=None, exclusive_minimum=None, maximum=None, step=None, required=False, dynamic_source=None, depends_on=None), 'power/hardware/channel': SettingSpec(value_type=<class 'str'>, default='', label='Power Channel', help_text='NI analog-output channel used for 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)}
LaserNI Class
This class is used to control a laser connected to a National Instruments DAQ.
- device_config
Laser ID
- Type:
int
- device_connection
Communication instance with the device
- Type:
Any
- digital_port_type
Modulation type of the laser - Analog or Digital.
- Type:
str
- laser_ao_task
The laser analog modulation task.
- Type:
nidaqmx.Task
- laser_do_task
The laser digital modulation task.
- Type:
nidaqmx.Task
- laser_max_ao
The maximum analog modulation voltage.
- Type:
float
- laser_max_do
The maximum digital modulation voltage.
- Type:
float
- laser_min_ao
The minimum analog modulation voltage.
- Type:
float
- laser_min_do
The minimum digital modulation voltage.
- Type:
float
- microscope_name
Name of the microscope
- Type:
str
- modulation_type
The modulation type of the laser - Analog, Digital, or Mixed.
- Type:
str