Scope#
The scope object allows you to control the microscope of the connected probe station. Please be aware that not all probe stations support scope operations.
method auto_focus()#
Triggers the automatic focus search.
Example#
probe_station = measmatic.GetDevice('device-probe-station')
probe_station.scope.auto_focus()
method get_scope_home_position()#
Gets the scope's home position.
Returns#
| Type | Description |
|---|---|
| float | The home position on the x axis in micrometers. |
| float | The home position on the y axis in micrometers. |
Example#
probe_station = measmatic.GetDevice('device-probe-station')
xhome, yhome = probe_station.scope.get_scope_home_position()
method get_scope_xy()#
Gets the current scope position on the x and y axis.
Returns#
| Type | Description |
|---|---|
| float | The absolute position on the x axis in micrometers. |
| float | The absolute position on the y axis in micrometers. |
Example#
probe_station = measmatic.GetDevice('device-probe-station')
xpos, ypos = probe_station.scope.get_scope_xy()
method get_scope_z()#
Gets the current scope position on the z axis.
Returns#
| Type | Description |
|---|---|
| float | The absolute position on the z axis in micrometers. |
Example#
probe_station = measmatic.GetDevice('device-probe-station')
zpos = probe_station.scope.get_scope_z()
method go_to_focus()#
Moves the scope to the last known focus height.
Example#
probe_station = measmatic.GetDevice('device-probe-station')
probe_station.scope.go_to_focus()
method move_scope_lift(is_lifted: bool, z_offset_in_micrometers: float)#
Moves the scope z axis to the lift or unlift position. This command needs motorized scope z hardware support.
Parameters#
| Name | Description |
|---|---|
| is_lifted | True to move the scope to the lift position or False to move it |
| z_offset_in_micrometers | An optional additional offset on the z axis in micrometers. |
Example#
probe_station = measmatic.GetDevice('device-probe-station')
probe_station.scope.move_scope_lift(True)
method move_scope_xy(x_in_micrometers: float, y_in_micrometers: float, reference_point: int)#
Moves the scope to the defined position on the x and y axis.
Parameters#
| Name | Description |
|---|---|
| x_in_micrometers | The position on the x axis in micrometers. |
| y_in_micrometers | The position on the y axis in micrometers. |
| reference_point | An integer value representing the reference point for the movement. |
Example#
probe_station = measmatic.GetDevice('device-probe-station')
probe_station.scope.move_scope_xy(1000, 2000)
method move_scope_z(z_in_micrometers: float, reference_point: int)#
Moves the scope to the defined position on the z axis.
Parameters#
| Name | Description |
|---|---|
| z_in_micrometers | The position on the z axis in micrometers. |
| reference_point | An integer value representing the reference point for the movement. |
Example#
probe_station = measmatic.GetDevice('device-probe-station')
probe_station.scope.move_scope_z(5000)
method set_scope_follow_mode(is_scope_follow_mode_active: bool)#
Sets the scope follow mode. If the follow mode is active the scope follows the chuck movement. This command needs hardware support by the probe station.
Parameters#
| Name | Description |
|---|---|
| is_scope_follow_mode_active | True to activate the scope follow mode or False to deactivate it. |
Example#
probe_station = measmatic.GetDevice('device-probe-station')
probe_station.scope.set_scope_follow_mode(True)
method set_scope_home_position(x_in_micrometers: float, y_in_micrometers: float)#
Sets the scope's home position.
Parameters#
| Name | Description |
|---|---|
| x_in_micrometers | The home position on the x axis in micrometers. |
| y_in_micrometers | The home position on the y axis in micrometers. |
Example#
probe_station = measmatic.GetDevice('device-probe-station')
probe_station.scope.set_scope_home_position(1000, 2000)
method set_scope_home_position_to_current()#
Sets the current scope position as the scope's home position.
Example#
probe_station = measmatic.GetDevice('device-probe-station')
probe_station.scope.set_scope_home_position_to_current()