navigate.model.devices.filter_wheel.asi.ASIFilterWheel

class navigate.model.devices.filter_wheel.asi.ASIFilterWheel(device_connection, device_config)

Bases: FilterWheelBase

ASIFilterWheel - Class for controlling ASI Filter Wheels

Note

Additional information on the ASI Filter Wheel can be found at: https://asiimaging.com/docs/fw_1000#fw-1000_ascii_command_set

__init__(device_connection, device_config)

Initialize the ASIFilterWheel class.

Parameters:

• device_connection (TigerController) – Communication object for the ASI Filter Wheel.

• device_config (dict) – Dictionary of device configuration parameters.

Methods

__init__(device_connection, device_config)	Initialize the ASIFilterWheel class.
check_if_filter_in_filter_dictionary(filter_name)	Checks if the filter designation (string) given exists in the filter dictionary
close()	Close the ASI Filter Wheel serial port.
filter_change_delay(filter_name)	Estimate duration of time necessary to move the filter wheel
set_filter(filter_name[, wait_until_done])	Change the filter wheel to the filter designated by the filter position argument.

Attributes

filter_wheel	ASI Tiger Controller object.
device_config	Configuration dictionary.
wait_until_done_delay	Delay for filter wheel to change positions.
filter_wheel_position	Filter wheel position.

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()

Close the ASI Filter Wheel serial port.

Sets the filter wheel to the home position and then closes the port.

filter_change_delay(filter_name)

Estimate duration of time necessary to move the filter wheel

Assumes that it is ~40ms per adjacent position. Depends on filter wheel parameters and load.

Parameters:

filter_name (str) – Name of filter to move to.

set_filter(filter_name, wait_until_done=True)

Change the filter wheel to the filter designated by the filter position argument.

Parameters:

• filter_name (str) – Name of filter to move to.

• wait_until_done (bool) – Waits duration of time necessary for filter wheel to change positions.

device_config

Configuration dictionary.

Type:

dict

device_connection

Device connection object.

Type:

Any

filter_dictionary

Dictionary of filters available on the filter wheel.

Type:

dict

filter_wheel

ASI Tiger Controller object.

Type:

TigerController

filter_wheel_number

index of filter wheel

Type:

int

filter_wheel_position

Filter wheel position.

Type:

int

wait_until_done_delay

Delay for filter wheel to change positions.

Type:

float

wheel_position

Filter wheel position.

Type:

int