navigate.model.devices.filter_wheel.ludl.LUDLFilterWheel
- class navigate.model.devices.filter_wheel.ludl.LUDLFilterWheel(microscope_name: str, device_connection: Any, configuration: dict[str, Any], device_id: int = 0)
Bases:
FilterWheelBase,SerialDeviceLUDLFilterWheel - Class for controlling LUDL Electronic Products Filter Wheels
Testing using MAC6000 controller over RS-232. USB or Ethernet not tested. Single filter wheel only, but MAC6000 can handle max 2. Would need to modify code.
Note
Code for class adapted from Dr. Fabian Voigt’s mesoSPIM code: https://github.com/ffvoigt/mesoSPIM-control/blob/master/mesoSPIM/src/mesoSPIM_FilterWheel.py
- __init__(microscope_name: str, device_connection: Any, configuration: dict[str, Any], device_id: int = 0) → None
Initialize the LUDLFilterWheel class.
- Parameters:
microscope_name (str) – Name of the microscope.
device_connection (Any) – The communication instance with the device.
configuration (Dict[str, Any]) – Global configuration dictionary.
device_id (int) – The ID of the device. Default is 0.
Methods
__init__(microscope_name, device_connection, ...)Initialize the LUDLFilterWheel class.
check_if_filter_in_filter_dictionary(filter_name)Checks if the filter designation (string) given exists in the filter dictionary
close()Close the LUDLFilterWheel serial port.
connect(comport[, baudrate, timeout])Build LUDLFilterWheel Serial Port connection
Disconnect from serial device.
set_filter(filter_name[, wait_until_done])Set the filter wheel to a specific filter position.
Attributes
- check_if_filter_in_filter_dictionary(filter_name: str) → bool
Checks if the filter designation (string) given exists in the filter dictionary
- Parameters:
filter_name (str) – Name of filter.
- Returns:
filter_exists – Flag if filter exists in the filter dictionary.
- Return type:
bool
- Raises:
ValueError – If filter name is not in the filter dictionary.
- close() → None
Close the LUDLFilterWheel serial port.
Sets the filter wheel to the Empty-Alignment position and then closes the port.
- classmethod connect(comport: str, baudrate: int = 9600, timeout: float = 0.25) → Serial
Build LUDLFilterWheel Serial Port connection
- comport
Comport for communicating with the filter wheel, e.g., COM1.
- Type:
str
- baudrate
Baud rate for communicating with the filter wheel, e.g., 9600.
- Type:
int
- timeout
Timeout for communicating with the filter wheel, e.g., 0.25.
- Type:
float
- Returns:
Serial port connection to the filter wheel.
- Return type:
serial.Serial
- Raises:
UserWarning – Could not communicate with LUDL MAC6000 via COMPORT.
- disconnect() → None
Disconnect from serial device.
- set_filter(filter_name: str, wait_until_done: bool = True) → None
Set the filter wheel to a specific filter position.
- Parameters:
filter_name (str) – Name of the filter position.
wait_until_done (bool) – Wait until the filter wheel has changed positions.
- configuration_schema = {'available_filters': CollectionSpec(item_schema={'name': SettingSpec(value_type=<class 'str'>, default=None, label='Filter Name', help_text='Display name for this filter position.', choices=None, choice_values=None, minimum=None, exclusive_minimum=None, maximum=None, step=None, required=True, dynamic_source=None, depends_on=None), 'position': SettingSpec(value_type=<class 'int'>, default=None, label='Position', help_text='Numeric position used by the filter-wheel controller.', choices=None, choice_values=None, minimum=0, exclusive_minimum=None, maximum=99, step=1, required=True, dynamic_source=None, depends_on=None)}, storage='mapping', key_field='name', value_field='position', storage_fields=None, label='Available Filters', help_text='Filter names and their corresponding wheel positions.', dynamic_source=None, minimum_items=1, none_option_label=None), 'filter_wheel_delay': SettingSpec(value_type=<class 'float'>, default=0.03, label='Filter Wheel Delay (s)', help_text='Estimated delay in seconds while the filter wheel changes position.', choices=None, choice_values=None, minimum=0, exclusive_minimum=None, maximum=60, step=0.001, required=True, dynamic_source=None, depends_on=None), 'hardware/wheel_number': SettingSpec(value_type=<class 'int'>, default=0, label='Wheel Number', help_text='Filter wheel identifier used by its controller. Some controllers use zero-based wheel numbers.', choices=None, choice_values=None, minimum=0, exclusive_minimum=None, maximum=16, step=1, required=True, dynamic_source=None, depends_on=None), 'name': SettingSpec(value_type=<class 'str'>, default='', label='Name', help_text='Display name for this filter wheel in the main application.', choices=None, choice_values=None, minimum=None, exclusive_minimum=None, maximum=None, step=None, required=False, dynamic_source=None, depends_on=None)}
- device_connection
Device connection object.
- Type:
Any
- device_name
Name of the device, used as a unique identifier.
- Type:
str
- filter_dictionary
Dictionary of filters available on the filter wheel.
- Type:
dict
- filter_wheel_number
index of filter wheel
- Type:
int
- serial
Device connection object.
- Type:
Any
- sio
Text I/O wrapper for the serial port.
- Type:
io.TextIOWrapper
- unique_id
Unique identifier for the device,
serial_followed by the port.- Type:
str
- wait_until_done_delay
Delay for filter wheel to change positions.
- Type:
float
- wheel_position
Filter wheel position.
- Type:
int