navigate.model.devices.filter_wheel.asi.ASIFilterWheel

class navigate.model.devices.filter_wheel.asi.ASIFilterWheel(microscope_name, device_connection, configuration, device_id=0)

Bases: FilterWheelBase, SerialDevice

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__(microscope_name, device_connection, configuration, device_id=0)

Initialize the ASIFilterWheel class.

Parameters:

• microscope_name (str) – Name of the microscope.

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

• configuration (dict) – Global configuration of the microscope.

• device_id (int) – The ID of the device. Default is 0.

Methods

__init__(microscope_name, device_connection, ...)	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.
connect(port[, baudrate, timeout])	Build ASIFilterWheel Serial Port connection
disconnect()	Disconnect from serial device.
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

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.

classmethod connect(port, baudrate=115200, timeout=0.25)

Build ASIFilterWheel Serial Port connection

Parameters:

• port (str) – Port for communicating with the filter wheel, e.g., COM1.

• baudrate (int) – Baud rate for communicating with the filter wheel, default is 115200.

• timeout (float) – Timeout for communicating with the filter wheel, default is 0.25.

Returns:

tiger_controller – ASI Tiger Controller object.

Return type:

TigerController

disconnect()

Disconnect from serial device.

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_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

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