navigate.model.devices.filter_wheel.asi.ASICubeSliderFilterWheel

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

Bases: FilterWheelBase, SerialDevice

ASICubeSlider - Class for controlling the C60 Cube Slider from ASI.

Note

Additional information on the ASI Filter Wheel can be found at: www.asiimaging.com/docs/filter_and_turret_changer?s%5B%5D=filter&s%5B%5D=slider

Maximum number of positions is 4.

Typical switch time between adjacent positions is < 250 ms.

__init__(microscope_name, device_connection, configuration, device_id=0)

Initialize the ASICubeSlider 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 ASICubeSlider 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 dichroic
set_filter(filter_name[, wait_until_done])	Change the dichroic position.

Attributes

dichroic	ASI Tiger Controller object.
wait_until_done_delay	Delay for filter wheel to change positions.
dichroic_id	The ID of the dichroic in the Tiger Controller.
dichroic_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 dichroic

Assumes that it is <250 ms per adjacent position.

Parameters:

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

set_filter(filter_name, wait_until_done=True)

Change the dichroic position.

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

dichroic

ASI Tiger Controller object.

Type:

obj

dichroic_id

The ID of the dichroic in the Tiger Controller. e.g., “T”

Type:

str

dichroic_position

Filter wheel position.

Type:

int

filter_dictionary

Dictionary of filters available on the filter wheel.

Type:

dict

filter_wheel_number

index of filter wheel

Type:

int

wait_until_done_delay

Delay for filter wheel to change positions.

Type:

float

wheel_position

Filter wheel position.

Type:

int