navigate.model.devices.filter_wheel.synthetic.SyntheticFilterWheel

class navigate.model.devices.filter_wheel.synthetic.SyntheticFilterWheel(microscope_name, device_connection, configuration, device_id)

Bases: FilterWheelBase

SyntheticFilterWheel Class

__init__(microscope_name, device_connection, configuration, device_id)

Initialize the SyntheticFilterWheel.

Parameters:

• microscope_name (str) – Name of the microscope.

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

• configuration (Dict[str, Any]) – Global configuration dictionary.

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

Methods

__init__(microscope_name, device_connection, ...)	Initialize the SyntheticFilterWheel.
check_if_filter_in_filter_dictionary(filter_name)	Checks if the filter designation (string) given exists in the filter dictionary
close()	Close the SyntheticFilterWheel.
filter_change_delay(filter_name)	Calculate duration of time necessary to change filter wheel positions
read(num_bytes)	Reads the specified number of bytes from the serial port.
set_filter(filter_name[, wait_until_done])	Change the filter wheel to the filter designated by the filter position argument.

Attributes

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 SyntheticFilterWheel.

Sets the filter wheel to the Empty-Alignment position and then closes the port.

filter_change_delay(filter_name)

Calculate duration of time necessary to change filter wheel positions

Parameters:

filter_name (str) – Name of the filter that we want to move to

read(num_bytes)

Reads the specified number of bytes from the serial port.

Parameters:

num_bytes (int) – Number of bytes to read from the serial port.

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

wheel_position

Filter wheel position.

Type:

int