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: object

FilterWheelBase - Parent class for controlling filter wheels.

__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

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.

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