navigate.model.devices.stage.thorlabs.KIM001Stage

class navigate.model.devices.stage.thorlabs.KIM001Stage(microscope_name, device_connection, configuration, device_id=0)

Bases: StageBase, IntegratedDevice

Thorlabs KIM Stage

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

Initialize the stage.

Parameters:

• microscope_name (str) – Name of the microscope.

• device_connection (str) – Connection string for the device.

• configuration (dict) – Configuration dictionary for the device.

• device_id (int) – Device ID for the device.

Methods

__init__(microscope_name, device_connection, ...)	Initialize the stage.
close()	Close the stage.
connect(serial_number)	Connect to the Thorlabs KIM Stage
get_abs_position(axis, axis_abs)	Ensure the requested position is within axis bounds and return it.
get_connect_params()	Register the parameters required to connect to the stage.
get_position_dict()	Return a dictionary with the saved stage positions.
move_absolute(move_dictionary[, wait_until_done])	Move stage along a single axis.
move_axis_absolute(axis, abs_pos[, ...])	Implement movement logic along a single axis.
report_position()	Report the position of the stage.
stop()	Stop all stage channels move
verify_abs_position(move_dictionary[, is_strict])	Ensure the requested moving positions are within axes bounds

Attributes

axes_mapping	Dictionary mapping software axes to hardware axes.
kim_axes	List of KIM axes available.
kim_controller	Thorlabs KIM Stage
serial_number	Serial number of the stage.

close()

Close the stage.

classmethod connect(serial_number: str)

Connect to the Thorlabs KIM Stage

Parameters:

serial_number (str) – Serial number of the stage.

Returns:

Thorlabs KIM Stage controller

Return type:

kim_controller

get_abs_position(axis, axis_abs)

Ensure the requested position is within axis bounds and return it.

Parameters:

• axis (str) – An axis: x, y, z, f, theta

• axis_abs (float) – Absolute position value

Returns:

Position to move the stage to for this axis.

Return type:

float

classmethod get_connect_params()

Register the parameters required to connect to the stage.

Returns:

List of parameters required to connect to the stage.

Return type:

list

get_position_dict()

Return a dictionary with the saved stage positions.

Returns:

Dictionary of stage positions.

Return type:

dict

move_absolute(move_dictionary, wait_until_done=False)

Move stage along a single axis.

Parameters:

• move_dictionary (dict) – A dictionary of values required for movement. Includes ‘x_abs’, etc. for one or more axes. Expects values in micrometers, except for theta, which is in degrees.

• wait_until_done (bool) – Block until stage has moved to its new spot.

Returns:

success – Was the move successful?

Return type:

bool

move_axis_absolute(axis, abs_pos, wait_until_done=False)

Implement movement logic along a single axis.

Parameters:

• axis (str) – An axis. For example, ‘x’, ‘y’, ‘z’, ‘f’, ‘theta’.

• abs_pos (float) – Absolute position value

• wait_until_done (bool) – Block until stage has moved to its new spot.

Returns:

Was the move successful?

Return type:

bool

report_position()

Report the position of the stage.

Reports the position of the stage for all axes, and creates the hardware position dictionary.

Returns:

position_dict – Dictionary containing the current position of the stage.

Return type:

dict

stop()

Stop all stage channels move

verify_abs_position(move_dictionary, is_strict=False)

Ensure the requested moving positions are within axes bounds

Parameters:

• move_dictionary (dict) – A dictionary of values required for movement. Includes ‘x_abs’, ‘y_abs’, etc. for one or more axes. Expect values in micrometers, except for theta, which is in degrees.

• is_strict (bool, optional) – If True, return an empty dict if any axis is out of bounds.

Returns:

a verified moving dict {axis: abs_position}

Return type:

dict

axes

List of stage axes available.

Type:

list

axes_mapping

Dictionary mapping software axes to hardware axes.

Type:

dict

device_connection

Device connection object.

Type:

Any

kim_axes

List of KIM axes available.

Type:

list

kim_controller

Thorlabs KIM Stage

Type:

navigate.model.devices.APIs.thorlabs.kcube_inertial

serial_number

Serial number of the stage.

Type:

str

stage_feedback

Feedback alignment value for the stage. Default is None.

Type:

int

stage_limits

Whether the stage has limits enabled or not. Default is True.

Type:

bool