navigate.model.devices.filter_wheel.base.FilterWheelBase

class navigate.model.devices.filter_wheel.base.FilterWheelBase(device_connection: Any, device_config: Dict[str, Any])

Bases: object

FilterWheelBase - Parent class for controlling filter wheels.

__init__(device_connection: Any, device_config: Dict[str, Any]) → None

Initialize the FilterWheelBase class.

Parameters:

• device_connection (Any) – The communication instance with the device.

• device_config (Dict[str, Any]) – Dictionary of device configuration parameters.

Methods

__init__(device_connection, device_config)	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.
device_config	Dictionary of device configuration parameters.
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_config

Dictionary of device configuration parameters.

Type:

Dict[str, Any]

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