navigate.model.devices.filter_wheel.filter_wheel_base.FilterWheelBase
- class navigate.model.devices.filter_wheel.filter_wheel_base.FilterWheelBase(device_connection, device_config)
Bases:
object
FilterWheelBase - Parent class for controlling filter wheels.
- __init__(device_connection, device_config)
Initialize the FilterWheelBase class.
- Parameters:
device_connection (dict) – Dictionary of device connections.
device_config (dict) – 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
Dictionary of filters available on the filter wheel.
Filter wheel position.
index of filter wheel
- check_if_filter_in_filter_dictionary(filter_name)
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.
- 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