navigate.model.devices.stage.base.StageBase

class navigate.model.devices.stage.base.StageBase(microscope_name: str, device_connection: Any, configuration: Dict[str, Any], device_id: int = 0)

Bases: object

Stage Parent Class

__init__(microscope_name: str, device_connection: Any, configuration: Dict[str, Any], device_id: int = 0) → None

Initialize the stage.

Parameters:

• microscope_name (str) – Name of microscope in configuration

• device_connection (Any) – Hardware device to connect to

• configuration (Dict[str, Any]) – Global configuration of the microscope

• device_id (int) – Device ID. Default is 0.

Methods

__init__(microscope_name, device_connection, ...)	Initialize the stage.
close()	Close the stage.
get_abs_position(axis, axis_abs)	Ensure the requested position is within axis bounds and return it.
get_position_dict()	Return a dictionary with the saved stage positions.
stop()	Stop all stage movement abruptly.
verify_abs_position(move_dictionary[, is_strict])	Ensure the requested moving positions are within axes bounds

Attributes

device_connection	Device connection object.
axes	List of stage axes available.
stage_feedback	Feedback alignment value for the stage.
axes_mapping	Initial setting for all positions self.x_pos, self.y_pos etc are the true axis positions, no matter whether the stages are zeroed or not.
stage_limits	Whether the stage has limits enabled or not.

close()

Close the stage.

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

get_position_dict()

Return a dictionary with the saved stage positions.

Returns:

Dictionary of stage positions.

Return type:

dict

stop()

Stop all stage movement abruptly.

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

Initial setting for all positions self.x_pos, self.y_pos etc are the true axis positions, no matter whether the stages are zeroed or not. All units are in microns.

device_connection

Device connection object.

Type:

Any

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