navigate.model.devices.remote_focus.asi.ASIRemoteFocus

class navigate.model.devices.remote_focus.asi.ASIRemoteFocus(microscope_name: str, device_connection: Any, configuration: Dict[str, Any], *args, **kwargs)

Bases: RemoteFocusBase, SerialDevice

ASIRemoteFocus Class - Analog control of the remote focus device.

__init__(microscope_name: str, device_connection: Any, configuration: Dict[str, Any], *args, **kwargs) → None

Initialize the ASIRemoteFocus class.

Parameters:

• microscope_name (str) – The microscope name.

• device_connection (Any) – The device connection object.

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

Methods

__init__(microscope_name, device_connection, ...)	Initialize the ASIRemoteFocus class.
adjust(exposure_times, sweep_times[, offset])	Adjust the waveform.
close()	Close the ASI remote_focus serial port.
connect(port[, baudrate, timeout])	Build ASILaser Serial Port connection
disconnect()	Disconnect from serial device.
move(exposure_times, sweep_times[, offset])	Move the remote focus.
ramp([exposure_time, amplitude, offset])	Sends the tiger controller commands to initiate the ramp wave.
triangle([sweep_time, amplitude, offset])	Sends the tiger controller commands to initiate the triangle wave.
turn_off()	Stops the remote focus waveform

Attributes

remote_focus	Device connection object.
axis	Output axis on Tiger Controller

adjust(exposure_times, sweep_times, offset=None)

Adjust the waveform.

This method adjusts the waveform parameters. Based on the sensor mode and readout direction, either the triangle or ramp function will be called.

Parameters:

• exposure_times (dict) – Dictionary of exposure times for each selected channel

• sweep_times (dict) – Dictionary of sweep times for each selected channel

• offset (float, optional) – Offset value for the remote focus waveform, by default None

close()

Close the ASI remote_focus serial port.

Stops the remote focus waveform and then closes the port.

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

Build ASILaser 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.

move(exposure_times, sweep_times, offset=None)

Move the remote focus.

This method moves the remote focus.

Parameters:

• exposure_times (dict) – Dictionary of exposure times for each selected channel

• sweep_times (dict) – Dictionary of sweep times for each selected channel

• offset (float) – The offset of the signal in volts.

ramp(exposure_time=0.2, amplitude=1, offset=0.5)

Sends the tiger controller commands to initiate the ramp wave.

The waveform starts at offset and immediately rises linearly to 2x amplitude (amplitude here refers to 1/2 peak-to-peak) and then immediately drops back down to the offset voltage during the fall period.

There is a delay period after each cycle that comes from the PLC, which is not included in this function.

Parameters:

• exposure_time (Float) – Unit - Seconds

• sweep_time (Float) – Unit - Seconds

• remote_focus_delay (Float) – Unit - seconds

• camera_delay (Float) – Unit - seconds

• fall (Float) – Unit - seconds

• amplitude (Float) – Unit - Volts

• offset (Float) – Unit - Volts

triangle(sweep_time=0.24, amplitude=1, offset=0)

Sends the tiger controller commands to initiate the triangle wave.

The waveform starts at the offset and immediately rises linearly to 2x amplitude (amplitude here refers to 1/2 peak-to-peak) and immediately falls linearly back to the offset. The waveform is a periodic waveform with no delay periods between cycles.

Parameters:

• sweep_time (Float) – Unit - Seconds

• amplitude (Float) – Unit - Volts

• offset (Float) – Unit - Volts

turn_off()

Stops the remote focus waveform

axis

Output axis on Tiger Controller

Type:

str

camera_delay

Camera delay percent.

Type:

float

configuration

Configuration dictionary.

Type:

dict

device_config

Remote focus device parameters.

Type:

dict

device_connection

Device connection object.

Type:

Any

microscope_name

Name of the microscope.

Type:

str

remote_focus

Device connection object.

Type:

Any

remote_focus_max_voltage

Remote focus max voltage.

Type:

float

remote_focus_min_voltage

Remote focus min voltage.

Type:

float

sample_rate

Sample rate of the DAQ.

Type:

int

sweep_time

Sweep time of the DAQ.

Type:

float

waveform_dict

Waveform dictionary.

Type:

dict