XYStage

Bases: AbstractSystem

XYStage class defines the interface for 2D-positioning devices

This class extends AbstractSystem to provide control of dual-axis positioning stages, enabling positioning in a 2D coordinate space.

getXPosition()

Get the X-axis position

Retrieves the current position of the stage along the X-axis.

Returns:

Type	Description
float	The X position

setXPosition(x)

Set the X-axis position

Moves the stage to the specified position along the X-axis.

Parameters:

Name	Type	Description	Default
x	float	The X position to set	required

checkXPosition()

Wait until the X-axis position is set

Wait until the X-axis position is properly set, up to the tolerance level.

getXResolution()

Get the X-axis check function tolerance

Retrieves the tolerance level of the check function of the stage X position.

Returns:

Type	Description
float	The tolerance

setXResolution(resolution)

Set the X-axis check function tolerance

Sets the tolerance level of the check function of the stage X position.

Parameters:

Name	Type	Description	Default
resolution	float	The tolerance to set	required

getYPosition()

Get the Y-axis position

Retrieves the current position of the stage along the Y-axis.

Returns:

Type	Description
float	The Y position

setYPosition(y)

Set the Y-axis position

Moves the stage to the specified position along the Y-axis.

Parameters:

Name	Type	Description	Default
y	float	The Y position to set	required

checkYPosition()

Wait until the Y axis position is set

Wait until the Y axis position is properly set, up to the tolerance level.

getYResolution()

Get the axis check function tolerance

Retrieves the tolerance level of the check function of the stage Y position.

Returns:

Type	Description
float	The Y tolerance

setYResolution(resolution)

Set the axis check function tolerance

Sets the tolerance level of the check function of the stage Y position.

Parameters:

Name	Type	Description	Default
resolution	float	The Y tolerance to set	required

moveXYAxis()

Move both axes

Triggers the movement of the stage to the set X and Y positions.