navigate.model.devices.filter_wheel.base.FilterWheelBase

class navigate.model.devices.filter_wheel.base.FilterWheelBase(microscope_name: str, device_connection: Any, configuration: dict[str, Any], device_id: int = 0)

Bases: ABC

Abstract base class for filter wheels.

This class defines the interface for filter wheel devices used in the Navigate software. Implementations should handle the specifics of communication with particular hardware.

__init__(microscope_name: str, device_connection: Any, configuration: dict[str, Any], device_id: int = 0) → None

Initialize the FilterWheelBase 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 FilterWheelBase class.
check_if_filter_in_filter_dictionary(filter_name)	Checks if the filter designation (string) given exists in the filter dictionary
set_filter(position[, wait_until_done])	Set the filter wheel to the specified position.

Attributes

device_connection	Device connection object.
filter_dictionary	Dictionary of filters available on the filter wheel.
wheel_position	Filter wheel position.
filter_wheel_number	index of filter wheel

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.

abstract set_filter(position: Any, wait_until_done: bool = True) → None

Set the filter wheel to the specified position.

Parameters:

• position (Any) – The desired filter position.

• wait_until_done (bool) – Whether to wait until the filter wheel has completed the move. Default is True.

device_connection

Device connection object.

Type:

Any

filter_dictionary

Dictionary of filters available on the filter wheel.

Type:

dict

filter_wheel_number

index of filter wheel

Type:

int

wheel_position

Filter wheel position.

Type:

int