File containing SIDX stage usage for reference. More...

#include "SIDXCConstants.h"

Functions
int	SIDXStageAccelerateGetLimitXY (void *SIDXstage, double &maximum)
	Gets the maximum acceleration during stage movement for the X and Y axes in meters/second^2. More...

int	SIDXStageAccelerateGetLimitZ (void *SIDXstage, double &maximum)
	Gets the maximum acceleration during stage movement for the Z axis in meters/second^2. More...

int	SIDXStageAccelerateGetXY (void *SIDXstage, double &acceleration)
	Gets the acceleration during stage movement for the X and Y axes as a fraction of maximum acceleration. More...

int	SIDXStageAccelerateGetZ (void *SIDXstage, double &acceleration)
	Gets the acceleration during stage movement for the Z axis as a fraction of maximum acceleration. More...

int	SIDXStageAccelerateSetXY (void *SIDXstage, double acceleration)
	Sets the acceleration during stage movement for the X and Y axes as a fraction of maximum acceleration. More...

int	SIDXStageAccelerateSetZ (void *SIDXstage, double acceleration)
	Sets the acceleration during stage movement for the Z axis as a fraction of maximum acceleration. More...

int	SIDXStageAxisEnableXY (void *SIDXstage, bool x_enable, bool y_enable)
	Enables and disables motorized control of the stage axes. More...

int	SIDXStageAxisEnableZ (void *SIDXstage, bool z_enable)
	Enables and disables motorized control of the focus axis. More...

int	SIDXStageAxisExistsXY (void *SIDXstage, bool &motorized)
	Gets the motorized status of the X and Y axes. More...

int	SIDXStageAxisExistsZ (void *SIDXstage, bool &motorized)
	Gets the motorized status of the Z axis. More...

int	SIDXStageBacklashExists (void *SIDXstage, bool &control)
	Gets whether backlash control is available on this stage. More...

int	SIDXStageBacklashGetXY (void *SIDXstage, double &distance)
	Gets the backlash distance for the X and Y axes, measured in meters. More...

int	SIDXStageBacklashGetZ (void *SIDXstage, double &distance)
	Gets the backlash distance for the Z axis, measured in meters. More...

int	SIDXStageBacklashSetXY (void *SIDXstage, double distance)
	Sets the backlash distance for the X and Y axes, measured in meters. More...

int	SIDXStageBacklashSetZ (void *SIDXstage, double distance)
	Sets the backlash distance for the Z axis, measured in meters. More...

int	SIDXStageClose (void *SIDXstage)
	Close the stage controller. More...

int	SIDXStageJoystickDisable (void *SIDXstage)
	Sets the stage's attached joystick to be disabled. More...

int	SIDXStageJoystickEnable (void *SIDXstage)
	Sets the stage's attached joystick to be enabled. More...

int	SIDXStageJoystickSetMovementXY (void *SIDXstage, bool x_right, bool y_right, double fraction)
	Sets the direction and speed of the X and Y axis controls for stage's attached joystick. More...

int	SIDXStageJoystickSetMovementZ (void *SIDXstage, bool z_up, double fraction)
	Sets the direction and speed of the Z axis control for stage's attached joystick. More...

int	SIDXStageLimitIsXMinus (void *SIDXstage, bool &limit)
	Gets whether the lower limit switch associated with the X axis was set during the last successful limit query. More...

int	SIDXStageLimitIsXPlus (void *SIDXstage, bool &limit)
	Gets whether the upper limit switch associated with the X axis was set during the last successful limit query. More...

int	SIDXStageLimitIsXY (void *SIDXstage, bool &limit)
	Gets whether any of the limit switches associated with the X or Y axes were set during the last successful limit query. More...

int	SIDXStageLimitIsXYZ (void *SIDXstage, bool &limit)
	Gets whether any of the limit switches associated with the X, Y or Z axes were set during the last successful limit query. More...

int	SIDXStageLimitIsYMinus (void *SIDXstage, bool &limit)
	Gets whether the lower limit switch associated with the Y axis was set during the last successful limit query. More...

int	SIDXStageLimitIsYPlus (void *SIDXstage, bool &limit)
	Gets whether the upper limit switch associated with the Y axis was set during the last successful limit query. More...

int	SIDXStageLimitIsZ (void *SIDXstage, bool &limit)
	Gets whether either of the limit switches associated with the Z axis were set during the last successful limit query. More...

int	SIDXStageLimitIsZMinus (void *SIDXstage, bool &limit)
	Gets whether the lower limit switch associated with the Z axis was set during the last successful limit query. More...

int	SIDXStageLimitIsZPlus (void *SIDXstage, bool &limit)
	Gets whether the upper limit switch associated with the Z axis was set during the last successful limit query. More...

int	SIDXStageLimitQuery (void *SIDXstage)
	Queries the current stage limit switch values. More...

int	SIDXStageMotorAccelerateGet (void *SIDXstage, int motor, double &acceleration)
	Gets the acceleration during stage movement for the specified motor as a fraction of maximum acceleration. More...

int	SIDXStageMotorAccelerateSet (void *SIDXstage, int motor, double acceleration)
	Sets the acceleration during stage movement for the specified motor as a fraction of maximum acceleration. More...

int	SIDXStageMotorBacklashExists (void *SIDXstage, int motor, bool &available)
	Gets whether backlash control is available on the specified motor. More...

int	SIDXStageMotorBacklashGet (void *SIDXstage, int motor, double &distance)
	Gets the backlash distance for the specified motor, in meters. More...

int	SIDXStageMotorBacklashSet (void *SIDXstage, int motor, double distance)
	Sets the backlash distance for the specified motor, in meters. More...

int	SIDXStageMotorExists (void *SIDXstage, int motor, bool &installed)
	Gets whether the specified motor is currently installed. More...

int	SIDXStageMotorGetByName (void SIDXstage, const wchar_t name, int &motor)
	Gets the handle to the specified motor. More...

int	SIDXStageMotorGetCount (void *SIDXstage, int &identifiers)
	Gets the number of different motor identifiers. More...

int	SIDXStageMotorGetName (void SIDXstage, int motor, wchar_t name, size_t length)
	Gets the name corresponding to the specified motor number. More...

int	SIDXStageMotorLimit (void *SIDXstage, int motor, bool &limit)
	Gets whether either of the limit switches associated with the specified motor is currently set. More...

int	SIDXStageMotorLimitMinus (void *SIDXstage, int motor, bool &limit)
	Gets whether the lower limit switch associated with the specified motor is currently set. More...

int	SIDXStageMotorLimitPlus (void *SIDXstage, int motor, bool &limit)
	Gets whether the upper limit switch associated with the specified motor is currently set. More...

int	SIDXStageMotorMoveRelative (void *SIDXstage, int motor, double offset)
	Commands the stage to begin moving the specified motor the specified offset, measured in meters. More...

int	SIDXStageMotorMoveSpeed (void *SIDXstage, int motor, double velocity)
	Commands the stage to begin moving the specified motor at the specified speed, as a fraction of maximum speed. More...

int	SIDXStageMotorMoveStop (void *SIDXstage, int motor)
	Commands the stage to stop the motor. More...

int	SIDXStageMotorMovingIs (void *SIDXstage, int motor, bool &moving)
	Gets the motion status of the specified motor. More...

int	SIDXStageMotorSpeedGet (void *SIDXstage, int motor, double &speed)
	Gets the speed for the specified motor as a fraction of maximum speed. More...

int	SIDXStageMotorSpeedSet (void *SIDXstage, int motor, double speed)
	Sets the speed for the specified motor as a fraction of maximum speed. More...

int	SIDXStageMovePositionXY (void *SIDXstage, double x_position_m, double y_position_m)
	Commands the stage to begin moving to the absolute position specified along the X and Y axes, measured in meters. More...

int	SIDXStageMovePositionXYZ (void *SIDXstage, double x_position_m, double y_position_m, double z_position_m)
	Commands the stage to begin moving to the absolute position specified along the X, Y and Z axes, measured in meters. More...

int	SIDXStageMovePositionZ (void *SIDXstage, double z_position_m)
	Commands the stage to begin moving to the absolute position specified along the Z axis, measured in meters. More...

int	SIDXStageMoveRelativeXY (void *SIDXstage, double x_offset_m, double y_offset_m)
	Commands the stage to begin moving the specified offsets along the X and Y axes, measured in meters. More...

int	SIDXStageMoveRelativeXYZ (void *SIDXstage, double x_offset_m, double y_offset_m, double z_offset_m)
	Commands the stage to begin moving the specified offsets along the X, Y and Z axes, measured in meters. More...

int	SIDXStageMoveRelativeZ (void *SIDXstage, double z_offset_m)
	Commands the stage to begin moving the specified offset along the Z axis, measured in meters. More...

int	SIDXStageMoveSpeedXY (void *SIDXstage, double x_velocity_mps, double y_velocity_mps)
	Commands the stage to begin moving at the specified speed along the X and Y axes, measured in meters/second. More...

int	SIDXStageMoveSpeedXYZ (void *SIDXstage, double x_velocity_mps, double y_velocity_mps, double z_velocity_mps)
	Commands the stage to begin moving at the specified speed along the X, Y and Z axes, measured in meters/second. More...

int	SIDXStageMoveSpeedZ (void *SIDXstage, double z_velocity_mps)
	Commands the stage to begin moving at the specified speed along the Z axis, measured in meters/second. More...

int	SIDXStageMoveStopXYZ (void *SIDXstage)
	Commands the stage to stop all movement along the X, Y and Z axes. More...

int	SIDXStageMovingIsXY (void *SIDXstage, bool &moving)
	Gets the motion status of the X and Y axes during the last successful motion query. More...

int	SIDXStageMovingIsXYZ (void *SIDXstage, bool &moving)
	Gets the motion status of the X, Y and Z axes during the last successful motion query. More...

int	SIDXStageMovingIsZ (void *SIDXstage, bool &moving)
	Gets the motion status of the Z axis during the last successful motion query. More...

int	SIDXStageMovingQuery (void *SIDXstage)
	Queries the stage about the current motion along the X, Y and Z axes. More...

int	SIDXStageOriginResetXYZ (void *SIDXstage)
	Sets the current position to zero on the X, Y and Z axes. More...

int	SIDXStagePositionGet (void *SIDXstage, double &position_x, double &position_y, double &position_z)
	Gets the current absolute position coordinates for all three axes, in meters. More...

int	SIDXStagePositionGetX (void *SIDXstage, double &coordinate)
	Gets the current absolute position coordinate for the X axis, in meters. More...

int	SIDXStagePositionGetY (void *SIDXstage, double &coordinate)
	Gets the current absolute position coordinate for the Y axis, in meters. More...

int	SIDXStagePositionGetZ (void *SIDXstage, double &coordinate)
	Gets the current absolute position coordinate for the Z axis, in meters. More...

int	SIDXStagePositionQuery (void *SIDXstage)
	Queries the stage about the current position of the X, Y and Z axes. More...

int	SIDXStageReset (void *SIDXstage)
	Commands the stage to stop all motion and reboot. More...

int	SIDXStageResolutionGetXY (void *SIDXstage, double &resolution)
	Gets the resolution of the X and Y axes in units of meters. More...

int	SIDXStageResolutionGetZ (void *SIDXstage, double &resolution)
	Gets the resolution of the Z axis in units of meters. More...

int	SIDXStageRotateClear (void *SIDXstage)
	Clear the rotation and mirroring settings, so acquired images are not transformed. More...

int	SIDXStageRotateMirrorX (void *SIDXstage)
	Mirror the image in x. More...

int	SIDXStageRotateMirrorY (void *SIDXstage)
	Mirror the image in y. More...

int	SIDXStageRotateSet (void *SIDXstage, int count)
	Set the image rotation as a count of 90 degree clockwise rotations. More...

int	SIDXStageSpeedGetXY (void *SIDXstage, double &speed)
	Gets the speed for the X and Y axes in meters per second. More...

int	SIDXStageSpeedGetZ (void *SIDXstage, double &speed)
	Gets the speed for the Z axis in meters per second. More...

int	SIDXStageSpeedSetXY (void *SIDXstage, double speed_mps)
	Sets the speed for the X and Y axes in meters per second. More...

int	SIDXStageSpeedSetZ (void *SIDXstage, double speed_mps)
	Sets the speed for the Z axis in meters per second. More...

void	SIDXStageGetLastError (void SIDXstage, wchar_t message, size_t length)
	The function translates the error code into a text string. More...

Detailed Description

File containing SIDX stage usage for reference.

Function Documentation

int SIDXStageAccelerateGetLimitXY	(	void *	SIDXstage,
		double &	maximum
	)

Gets the maximum acceleration during stage movement for the X and Y axes in meters/second^2.

Parameters

SIDXstage	A handle value that references the open stage context.
maximum	A variable to receive a real (floating-point) value representing the acceleration. If -1 is returned, the maximum acceleration is unknown.

Returns: Non-zero if the function failed, zero if it succeeded.

int SIDXStageAccelerateGetLimitZ	(	void *	SIDXstage,
		double &	maximum
	)

Gets the maximum acceleration during stage movement for the Z axis in meters/second^2.

Parameters

SIDXstage	A handle value that references the open stage context.
maximum	A variable to receive a real (floating-point) value representing the acceleration. If -1 is returned, the maximum acceleration is unknown.

Returns: Non-zero if the function failed, zero if it succeeded.

int SIDXStageAccelerateGetXY	(	void *	SIDXstage,
		double &	acceleration
	)

Gets the acceleration during stage movement for the X and Y axes as a fraction of maximum acceleration.

Parameters

SIDXstage	A handle value that references the open stage context.
acceleration	A variable to receive a real (floating-point) value representing the acceleration fraction, a value in the range [0, 1.0].

Returns: Non-zero if the function failed, zero if it succeeded.

int SIDXStageAccelerateGetZ	(	void *	SIDXstage,
		double &	acceleration
	)

Gets the acceleration during stage movement for the Z axis as a fraction of maximum acceleration.

Parameters

SIDXstage	A handle value that references the open stage context.
acceleration	A variable to receive a real (floating-point) value representing the acceleration fraction, a value in the range [0, 1.0].

Returns: Non-zero if the function failed, zero if it succeeded.

int SIDXStageAccelerateSetXY	(	void *	SIDXstage,
		double	acceleration
	)

Sets the acceleration during stage movement for the X and Y axes as a fraction of maximum acceleration.

Parameters

SIDXstage	A handle value that references the open stage context.
acceleration	The desired acceleration fraction, a value in the range [0, 1.0].

Returns: Non-zero if the function failed, zero if it succeeded.

int SIDXStageAccelerateSetZ	(	void *	SIDXstage,
		double	acceleration
	)

Sets the acceleration during stage movement for the Z axis as a fraction of maximum acceleration.

Parameters

SIDXstage	A handle value that references the open stage context.
acceleration	The desired acceleration fraction,a value in the range [0, 1.0].

Returns: Non-zero if the function failed, zero if it succeeded.

int SIDXStageAxisEnableXY	(	void *	SIDXstage,
		bool	x_enable,
		bool	y_enable
	)

Enables and disables motorized control of the stage axes.

Parameters

SIDXstage	A handle value that references the open stage context.
x_enable	True to enable the axis motor, false to disable.
y_enable	True to enable the axis motor, false to disable.

Returns: Non-zero if the function failed, zero if it succeeded.

int SIDXStageAxisEnableZ	(	void *	SIDXstage,
		bool	z_enable
	)

Enables and disables motorized control of the focus axis.

Parameters

SIDXstage	A handle value that references the open stage context.
z_enable	True to enable the axis motor, false to disable.

Returns: Non-zero if the function failed, zero if it succeeded.

int SIDXStageAxisExistsXY	(	void *	SIDXstage,
		bool &	motorized
	)

Gets the motorized status of the X and Y axes.

Parameters

SIDXstage	A handle value that references the open stage context.
motorized	A variable to receive a boolean value, true if X and Y are motorized axes, false otherwise.

Returns: Non-zero if the function failed, zero if it succeeded.

int SIDXStageAxisExistsZ	(	void *	SIDXstage,
		bool &	motorized
	)

Gets the motorized status of the Z axis.

Parameters

SIDXstage	A handle value that references the open stage context.
motorized	A variable to receive a boolean value, true if Z is motorized, false otherwise.

Returns: Non-zero if the function failed, zero if it succeeded.

int SIDXStageBacklashExists	(	void *	SIDXstage,
		bool &	control
	)

Gets whether backlash control is available on this stage.

Parameters

SIDXstage	A handle value that references the open stage context.
control	A variable to receive a boolean value specifying the availability of backlash control.

Returns: Non-zero if the function failed, zero if it succeeded.

int SIDXStageBacklashGetXY	(	void *	SIDXstage,
		double &	distance
	)

Gets the backlash distance for the X and Y axes, measured in meters.

Parameters

SIDXstage	A handle value that references the open stage context.
distance	A variable to receive a real (floating-point) value representing the backlash distance in meters.

Returns: Non-zero if the function failed, zero if it succeeded.

int SIDXStageBacklashGetZ	(	void *	SIDXstage,
		double &	distance
	)

Gets the backlash distance for the Z axis, measured in meters.

Parameters

SIDXstage	A handle value that references the open stage context.
distance	A variable to receive a real (floating-point) value representing the backlash distance.

Returns: Non-zero if the function failed, zero if it succeeded.

int SIDXStageBacklashSetXY	(	void *	SIDXstage,
		double	distance
	)

Sets the backlash distance for the X and Y axes, measured in meters.

Parameters

SIDXstage	A handle value that references the open stage context.
distance	The backlash distance.

Returns: Non-zero if the function failed, zero if it succeeded.

int SIDXStageBacklashSetZ	(	void *	SIDXstage,
		double	distance
	)

Sets the backlash distance for the Z axis, measured in meters.

Parameters

SIDXstage	A handle value that references the open stage context.
distance	The backlash distance.

Returns: Non-zero if the function failed, zero if it succeeded.

int SIDXStageClose ( void * SIDXstage )

Close the stage controller.

Parameters

SIDXstage A handle value that references the open stage context.

Returns: Non-zero if the function failed, zero if it succeeded.

void SIDXStageGetLastError	(	void *	SIDXstage,
		wchar_t *	message,
		size_t	length
	)

The function translates the error code into a text string.

Parameters

SIDXstage	A handle value that references the open stage context.
message	A text string to receive the text associated with the last error occurred.
length	The length of the array to receive the text string, measured in characters. The array should include space for a null character at the end of the string.

int SIDXStageJoystickDisable ( void * SIDXstage )

Sets the stage's attached joystick to be disabled.

Parameters

SIDXstage A handle value that references the open stage context.

Returns: Non-zero if the function failed, zero if it succeeded.

int SIDXStageJoystickEnable ( void * SIDXstage )

Sets the stage's attached joystick to be enabled.

Parameters

SIDXstage A handle value that references the open stage context.

Returns: Non-zero if the function failed, zero if it succeeded.

int SIDXStageJoystickSetMovementXY	(	void *	SIDXstage,
		bool	x_right,
		bool	y_right,
		double	fraction
	)

Sets the direction and speed of the X and Y axis controls for stage's attached joystick.

Parameters

SIDXstage	A handle value that references the open stage context.
x_right	True if, as the x axis coordinate increases, the stage moves the right. False if it moves left.
y_right	True if, as the y axis coordinate increases, the stage moves the forward. False if it moves backward.
fraction	The stage motion speed to use, as a as a fraction of full speed. This is a numeric value in the range [0,1.0].

Returns: Non-zero if the function failed, zero if it succeeded.

int SIDXStageJoystickSetMovementZ	(	void *	SIDXstage,
		bool	z_up,
		double	fraction
	)

Sets the direction and speed of the Z axis control for stage's attached joystick.

Parameters

SIDXstage	A handle value that references the open stage context.
z_up	True if, as the z axis coordinate increases, the stage moves the up. False if it moves down.
fraction	The stage motion speed to use, as a as a fraction of full speed. This is a numeric value in the range [0,1.0].

Returns: Non-zero if the function failed, zero if it succeeded.

int SIDXStageLimitIsXMinus	(	void *	SIDXstage,
		bool &	limit
	)

Gets whether the lower limit switch associated with the X axis was set during the last successful limit query.

Parameters

SIDXstage	A handle value that references the open stage context.
limit	A variable to receive a boolean value, true if the lower X axis limit switch was set, false otherwise.

Returns: Non-zero if the function failed, zero if it succeeded.

int SIDXStageLimitIsXPlus	(	void *	SIDXstage,
		bool &	limit
	)

Gets whether the upper limit switch associated with the X axis was set during the last successful limit query.

Parameters

SIDXstage	A handle value that references the open stage context.
limit	A variable to receive a boolean value, true if the upper X axis limit switch was set, false otherwise.

Returns: Non-zero if the function failed, zero if it succeeded.

int SIDXStageLimitIsXY	(	void *	SIDXstage,
		bool &	limit
	)

Gets whether any of the limit switches associated with the X or Y axes were set during the last successful limit query.

Parameters

SIDXstage	A handle value that references the open stage context.
limit	A variable to receive a boolean value, true if one of the X or Y axes' limit switches was set, false otherwise.

Returns: Non-zero if the function failed, zero if it succeeded.

int SIDXStageLimitIsXYZ	(	void *	SIDXstage,
		bool &	limit
	)

Gets whether any of the limit switches associated with the X, Y or Z axes were set during the last successful limit query.

Parameters

SIDXstage	A handle value that references the open stage context.
limit	A variable to receive a boolean value, true if one of the X, Y or Z axes' limit switches was set, false otherwise.

Returns: Non-zero if the function failed, zero if it succeeded.

int SIDXStageLimitIsYMinus	(	void *	SIDXstage,
		bool &	limit
	)

Gets whether the lower limit switch associated with the Y axis was set during the last successful limit query.

Parameters

SIDXstage	A handle value that references the open stage context.
limit	A variable to receive a boolean value, true if the lower Y axis limit switch was set, false otherwise.

Returns: Non-zero if the function failed, zero if it succeeded.

int SIDXStageLimitIsYPlus	(	void *	SIDXstage,
		bool &	limit
	)

Gets whether the upper limit switch associated with the Y axis was set during the last successful limit query.

Parameters

SIDXstage	A handle value that references the open stage context.
limit	A variable to receive a boolean value, true if the upper Y axis limit switch was set, false otherwise.

Returns: Non-zero if the function failed, zero if it succeeded.

int SIDXStageLimitIsZ	(	void *	SIDXstage,
		bool &	limit
	)

Gets whether either of the limit switches associated with the Z axis were set during the last successful limit query.

Parameters

SIDXstage	A handle value that references the open stage context.
limit	A variable to receive a boolean value, true if one of the Z axis limit switches was set, false otherwise.

Returns: Non-zero if the function failed, zero if it succeeded.

int SIDXStageLimitIsZMinus	(	void *	SIDXstage,
		bool &	limit
	)

Gets whether the lower limit switch associated with the Z axis was set during the last successful limit query.

Parameters

SIDXstage	A handle value that references the open stage context.
limit	A variable to receive a boolean value, true if the lower Z axis limit switch was set, false otherwise.

Returns: Non-zero if the function failed, zero if it succeeded.

int SIDXStageLimitIsZPlus	(	void *	SIDXstage,
		bool &	limit
	)

Gets whether the upper limit switch associated with the Z axis was set during the last successful limit query.

Parameters

SIDXstage	A handle value that references the open stage context.
limit	A variable to receive a boolean value, true if the upper Z axis limit switch was set, false otherwise.

Returns: Non-zero if the function failed, zero if it succeeded.

int SIDXStageLimitQuery ( void * SIDXstage )

Queries the current stage limit switch values.

Each axis has two limit switches, the values of all limit switches are captured synchronously.

Parameters

SIDXstage A handle value that references the open stage context.

Returns: Non-zero if the function failed, zero if it succeeded.

int SIDXStageMotorAccelerateGet	(	void *	SIDXstage,
		int	motor,
		double &	acceleration
	)

Gets the acceleration during stage movement for the specified motor as a fraction of maximum acceleration.

Parameters

SIDXstage	A handle value that references the open stage context.
motor	An integer value representing the handle to the motor.
acceleration	A variable to receive a real (floating-point) value representing the acceleration fraction, a value in the range [0, 1.0].

Returns: Non-zero if the function failed, zero if it succeeded.

int SIDXStageMotorAccelerateSet	(	void *	SIDXstage,
		int	motor,
		double	acceleration
	)

Sets the acceleration during stage movement for the specified motor as a fraction of maximum acceleration.

Parameters

SIDXstage	A handle value that references the open stage context.
motor	An integer value representing the handle to the motor.
acceleration	An integer value representing the desired acceleration fraction, a value in the range [0, 1.0].

Returns: Non-zero if the function failed, zero if it succeeded.

int SIDXStageMotorBacklashExists	(	void *	SIDXstage,
		int	motor,
		bool &	available
	)

Gets whether backlash control is available on the specified motor.

Parameters

SIDXstage	A handle value that references the open stage context.
motor	An integer value representing the handle to the motor.
available	A variable to receive a boolean value, true if backlash control is available, otherwise false.

Returns: Non-zero if the function failed, zero if it succeeded.

int SIDXStageMotorBacklashGet	(	void *	SIDXstage,
		int	motor,
		double &	distance
	)

Gets the backlash distance for the specified motor, in meters.

Parameters

SIDXstage	A handle value that references the open stage context.
motor	An integer value representing the handle to the motor.
distance	A variable to receive a real (floating-point) value representing the backlash distance.

Returns: Non-zero if the function failed, zero if it succeeded.

int SIDXStageMotorBacklashSet	(	void *	SIDXstage,
		int	motor,
		double	distance
	)

Sets the backlash distance for the specified motor, in meters.

Parameters

SIDXstage	A handle value that references the open stage context.
motor	An integer value representing the handle to the motor.
distance	A real (floating-point) value representing the backlash distance.

Returns: Non-zero if the function failed, zero if it succeeded.

int SIDXStageMotorExists	(	void *	SIDXstage,
		int	motor,
		bool &	installed
	)

Gets whether the specified motor is currently installed.

Parameters

SIDXstage	A handle value that references the open stage context.
motor	An integer value representing the handle to the motor.
installed	A variable to receive a boolean value, true if the motor is installed, otherwise false.

Returns: Non-zero if the function failed, zero if it succeeded.

int SIDXStageMotorGetByName	(	void *	SIDXstage,
		const wchar_t *	name,
		int &	motor
	)

Gets the handle to the specified motor.

Parameters

SIDXstage	A handle value that references the open stage context.
name	An integer value representing the name of the motor.
motor	A variable to receive an integer handle to the motor.

Returns: Non-zero if the function failed, zero if it succeeded.

int SIDXStageMotorGetCount	(	void *	SIDXstage,
		int &	identifiers
	)

Gets the number of different motor identifiers.

Parameters

SIDXstage	A handle value that references the open stage context.
identifiers	A variable to receive an integer value representing the number of identifiers.

Returns: Non-zero if the function failed, zero if it succeeded.

int SIDXStageMotorGetName	(	void *	SIDXstage,
		int	motor,
		wchar_t *	name,
		size_t	length
	)

Gets the name corresponding to the specified motor number.

Parameters

SIDXstage	A handle value that references the open stage context.
motor	An integer value representing the handle to the motor.
name	A variable to receive a n integer value representing the name of the motor.
length	The length of the array to receive the text string, measured in characters. The array should include space for a null character at the end of the string.

Returns: Non-zero if the function failed, zero if it succeeded.

int SIDXStageMotorLimit	(	void *	SIDXstage,
		int	motor,
		bool &	limit
	)

Gets whether either of the limit switches associated with the specified motor is currently set.

Parameters

SIDXstage	A handle value that references the open stage context.
motor	An integer value representing the handle to the motor.
limit	A variable to receive a boolean value, true if one of the stepper motor's limit switches is set, false otherwise.

Returns: Non-zero if the function failed, zero if it succeeded.

int SIDXStageMotorLimitMinus	(	void *	SIDXstage,
		int	motor,
		bool &	limit
	)

Gets whether the lower limit switch associated with the specified motor is currently set.

Parameters

SIDXstage	A handle value that references the open stage context.
motor	An integer value representing the handle to the motor.
limit	A variable to receive a boolean value, true if the lower motor limit switch is set, false otherwise.

Returns: Non-zero if the function failed, zero if it succeeded.

int SIDXStageMotorLimitPlus	(	void *	SIDXstage,
		int	motor,
		bool &	limit
	)

Gets whether the upper limit switch associated with the specified motor is currently set.

Parameters

SIDXstage	A handle value that references the open stage context.
motor	An integer value representing the handle to the motor.
limit	A variable to receive a boolean value, true if the upper motor limit switch is set, false otherwise.

Returns: Non-zero if the function failed, zero if it succeeded.

int SIDXStageMotorMoveRelative	(	void *	SIDXstage,
		int	motor,
		double	offset
	)

Commands the stage to begin moving the specified motor the specified offset, measured in meters.

Parameters

SIDXstage	A handle value that references the open stage context.
motor	An integer value representing the handle to the motor.
offset	A real (floating-point) value representing the offset to move (in the units expected by the stage). This can be a positive or negative value.

Returns: Non-zero if the function failed, zero if it succeeded.

int SIDXStageMotorMoveSpeed	(	void *	SIDXstage,
		int	motor,
		double	velocity
	)

Commands the stage to begin moving the specified motor at the specified speed, as a fraction of maximum speed.

Parameters

SIDXstage	A handle value that references the open stage context.
motor	An integer value representing the handle to the motor.
velocity	A real (floating-point) value representing the speed. This can be a positive or negative value.

Returns: Non-zero if the function failed, zero if it succeeded.

int SIDXStageMotorMoveStop	(	void *	SIDXstage,
		int	motor
	)

Commands the stage to stop the motor.

Parameters

SIDXstage	A handle value that references the open stage context.
motor	An integer value representing the handle to the motor.

Returns: Non-zero if the function failed, zero if it succeeded.

int SIDXStageMotorMovingIs	(	void *	SIDXstage,
		int	motor,
		bool &	moving
	)

Gets the motion status of the specified motor.

Parameters

SIDXstage	A handle value that references the open stage context.
motor	An integer value representing the handle to the motor.
moving	A variable to receive a boolean value, true if the motor is moving, false otherwise.

Returns: Non-zero if the function failed, zero if it succeeded.

int SIDXStageMotorSpeedGet	(	void *	SIDXstage,
		int	motor,
		double &	speed
	)

Gets the speed for the specified motor as a fraction of maximum speed.

Parameters

SIDXstage	A handle value that references the open stage context.
motor	An integer value representing the handle to the motor.
speed	A variable to receive a real (floating-point) value representing the speed fraction, a value in the range [0, 1.0].

Returns: Non-zero if the function failed, zero if it succeeded.

int SIDXStageMotorSpeedSet	(	void *	SIDXstage,
		int	motor,
		double	speed
	)

Sets the speed for the specified motor as a fraction of maximum speed.

Parameters

SIDXstage	A handle value that references the open stage context.
motor	An integer value representing the handle to the motor.
speed	An real (floating-point) value representing the speed fraction, a value in the range [0, 1.0].

Returns: Non-zero if the function failed, zero if it succeeded.

int SIDXStageMovePositionXY	(	void *	SIDXstage,
		double	x_position_m,
		double	y_position_m
	)

Commands the stage to begin moving to the absolute position specified along the X and Y axes, measured in meters.

Parameters

SIDXstage	A handle value that references the open stage context.
x_position_m	A real (floating-point) value representing the coordinate on the X axis to move to, in meters.
y_position_m	A real (floating-point) value representing the coordinate on the Y axis to move to, in meters.

Returns: Non-zero if the function failed, zero if it succeeded.

int SIDXStageMovePositionXYZ	(	void *	SIDXstage,
		double	x_position_m,
		double	y_position_m,
		double	z_position_m
	)

Commands the stage to begin moving to the absolute position specified along the X, Y and Z axes, measured in meters.

Parameters

SIDXstage	A handle value that references the open stage context.
x_position_m	A real (floating-point) value representing the coordinate on the X axis to move to, in meters.
y_position_m	A real (floating-point) value representing the coordinate on the Y axis to move to, in meters.
z_position_m	A real (floating-point) value representing the coordinate on the Z axis to move to, in meters.

Returns: Non-zero if the function failed, zero if it succeeded.

int SIDXStageMovePositionZ	(	void *	SIDXstage,
		double	z_position_m
	)

Commands the stage to begin moving to the absolute position specified along the Z axis, measured in meters.

Parameters

SIDXstage	A handle value that references the open stage context.
z_position_m	A real (floating-point) value representing the coordinate on the Z axis to move to, in meters.

Returns: Non-zero if the function failed, zero if it succeeded.

int SIDXStageMoveRelativeXY	(	void *	SIDXstage,
		double	x_offset_m,
		double	y_offset_m
	)

Commands the stage to begin moving the specified offsets along the X and Y axes, measured in meters.

Parameters

SIDXstage	A handle value that references the open stage context.
x_offset_m	A real (floating-point) value representing the X axis offset to move in meters. This can be a positive or negative value.
y_offset_m	A real (floating-point) value representing the Y axis offset to move in meters. This can be a positive or negative value.

Returns: Non-zero if the function failed, zero if it succeeded.

int SIDXStageMoveRelativeXYZ	(	void *	SIDXstage,
		double	x_offset_m,
		double	y_offset_m,
		double	z_offset_m
	)

Commands the stage to begin moving the specified offsets along the X, Y and Z axes, measured in meters.

Parameters

SIDXstage	A handle value that references the open stage context.
x_offset_m	A real (floating-point) value representing the X axis offset to move in meters. This can be a positive or negative value.
y_offset_m	A real (floating-point) value representing the Y axis offset to move in meters. This can be a positive or negative value.
z_offset_m	A real (floating-point) value representing the Z axis offset to move in meters. This can be a positive or negative value.

Returns: Non-zero if the function failed, zero if it succeeded.

int SIDXStageMoveRelativeZ	(	void *	SIDXstage,
		double	z_offset_m
	)

Commands the stage to begin moving the specified offset along the Z axis, measured in meters.

Parameters

SIDXstage	A handle value that references the open stage context.
z_offset_m	A real (floating-point) value representing the offset to move in meters. This can be a positive or negative value.

Returns: Non-zero if the function failed, zero if it succeeded.

int SIDXStageMoveSpeedXY	(	void *	SIDXstage,
		double	x_velocity_mps,
		double	y_velocity_mps
	)

Commands the stage to begin moving at the specified speed along the X and Y axes, measured in meters/second.

Parameters

SIDXstage	A handle value that references the open stage context.
x_velocity_mps	A real (floating-point) value representing the X axis speed. This can be a positive or negative value.
y_velocity_mps	A real (floating-point) value representing the Y axis speed. This can be a positive or negative value.

Returns: Non-zero if the function failed, zero if it succeeded.

int SIDXStageMoveSpeedXYZ	(	void *	SIDXstage,
		double	x_velocity_mps,
		double	y_velocity_mps,
		double	z_velocity_mps
	)

Commands the stage to begin moving at the specified speed along the X, Y and Z axes, measured in meters/second.

Parameters

SIDXstage	A handle value that references the open stage context.
x_velocity_mps	A real (floating-point) value representing the X axis speed. This can be a positive or negative value.
y_velocity_mps	A real (floating-point) value representing the Y axis speed. This can be a positive or negative value.
z_velocity_mps	A real (floating-point) value representing the Z axis speed. This can be a positive or negative value.

Returns: Non-zero if the function failed, zero if it succeeded.

int SIDXStageMoveSpeedZ	(	void *	SIDXstage,
		double	z_velocity_mps
	)

Commands the stage to begin moving at the specified speed along the Z axis, measured in meters/second.

Parameters

SIDXstage	A handle value that references the open stage context.
z_velocity_mps	A real (floating-point) value representing the Z axis speed. This can be a positive or negative value.

Returns: Non-zero if the function failed, zero if it succeeded.

int SIDXStageMoveStopXYZ ( void * SIDXstage )

Commands the stage to stop all movement along the X, Y and Z axes.

Parameters

SIDXstage A handle value that references the open stage context.

Returns: Non-zero if the function failed, zero if it succeeded.

int SIDXStageMovingIsXY	(	void *	SIDXstage,
		bool &	moving
	)

Gets the motion status of the X and Y axes during the last successful motion query.

Parameters

SIDXstage	A handle value that references the open stage context.
moving	A variable to receive a boolean value, true if the stage is moving along the X or Y axes, false if X and Y are not moving.

Returns: Non-zero if the function failed, zero if it succeeded.

int SIDXStageMovingIsXYZ	(	void *	SIDXstage,
		bool &	moving
	)

Gets the motion status of the X, Y and Z axes during the last successful motion query.

Parameters

SIDXstage	A handle value that references the open stage context.
moving	A variable to receive a boolean value, true if the stage is moving along the X or Y axes, false if X and Y are not moving.

Returns: Non-zero if the function failed, zero if it succeeded.

int SIDXStageMovingIsZ	(	void *	SIDXstage,
		bool &	moving
	)

Gets the motion status of the Z axis during the last successful motion query.

Parameters

SIDXstage	A handle value that references the open stage context.
moving	A variable to receive a boolean value, true if the stage is moving along the X, Y or Z axes, false if X, Y and Z are not moving.

Returns: Non-zero if the function failed, zero if it succeeded.

int SIDXStageMovingQuery ( void * SIDXstage )

Queries the stage about the current motion along the X, Y and Z axes.

The results of query are accessed through any of the MovingIs... methods.

Parameters

SIDXstage A handle value that references the open stage context.

Returns: Non-zero if the function failed, zero if it succeeded.

int SIDXStageOriginResetXYZ ( void * SIDXstage )

Sets the current position to zero on the X, Y and Z axes.

Future absolute positions are referenced to this new origin.

Parameters

SIDXstage A handle value that references the open stage context.

Returns: Non-zero if the function failed, zero if it succeeded.

int SIDXStagePositionGet	(	void *	SIDXstage,
		double &	position_x,
		double &	position_y,
		double &	position_z
	)

Gets the current absolute position coordinates for all three axes, in meters.

Parameters

SIDXstage	A handle value that references the open stage context.
position_x	A variable to receive a real (floating-point) value representing the x position.
position_y	A variable to receive a real (floating-point) value representing the y position.
position_z	A variable to receive a real (floating-point) value representing the z position.

Returns: Non-zero if the function failed, zero if it succeeded.

int SIDXStagePositionGetX	(	void *	SIDXstage,
		double &	coordinate
	)

Gets the current absolute position coordinate for the X axis, in meters.

Parameters

SIDXstage	A handle value that references the open stage context.
coordinate	A variable to receive a real (floating-point) value representing the X axis coordinate in meters.

Returns: Non-zero if the function failed, zero if it succeeded.

int SIDXStagePositionGetY	(	void *	SIDXstage,
		double &	coordinate
	)

Gets the current absolute position coordinate for the Y axis, in meters.

Parameters

SIDXstage	A handle value that references the open stage context.
coordinate	A variable to receive a real (floating-point) value representing the Y axis coordinate in meters.

Returns: Non-zero if the function failed, zero if it succeeded.

int SIDXStagePositionGetZ	(	void *	SIDXstage,
		double &	coordinate
	)

Gets the current absolute position coordinate for the Z axis, in meters.

Parameters

SIDXstage	A handle value that references the open stage context.
coordinate	A variable to receive a real (floating-point) value representing the Z axis coordinate in meters.

Returns: Non-zero if the function failed, zero if it succeeded.

int SIDXStagePositionQuery ( void * SIDXstage )

Queries the stage about the current position of the X, Y and Z axes.

The results of query are accessed through any of the PositionGet... methods.

Parameters

SIDXstage A handle value that references the open stage context.

Returns: Non-zero if the function failed, zero if it succeeded.

int SIDXStageReset ( void * SIDXstage )

Commands the stage to stop all motion and reboot.

Parameters

SIDXstage A handle value that references the open stage context.

Returns: Non-zero if the function failed, zero if it succeeded.

int SIDXStageResolutionGetXY	(	void *	SIDXstage,
		double &	resolution
	)

Gets the resolution of the X and Y axes in units of meters.

Parameters

SIDXstage	A handle value that references the open stage context.
resolution	A variable to receive a real (floating-point) value representing the resolution.

Returns: Non-zero if the function failed, zero if it succeeded.

int SIDXStageResolutionGetZ	(	void *	SIDXstage,
		double &	resolution
	)

Gets the resolution of the Z axis in units of meters.

Parameters

SIDXstage	A handle value that references the open stage context.
resolution	A variable to receive a real (floating-point) value representing the resolution.

Returns: Non-zero if the function failed, zero if it succeeded.

int SIDXStageRotateClear ( void * SIDXstage )

Clear the rotation and mirroring settings, so acquired images are not transformed.

Parameters

SIDXstage A handle value that references the open stage context.

Returns: Non-zero if the function failed, zero if it succeeded.

int SIDXStageRotateMirrorX ( void * SIDXstage )

Mirror the image in x.

Calls to this method are cumulative, so two successive calls result in no mirroring. The mirroring and rotation calls operate in sequence. Calling RotateSet followed RotateMirrorX rotates the image, then mirrors the image. Calling RotateMirrorX then RotateSet mirrors the image, then rotates the image.

Parameters

SIDXstage A handle value that references the open stage context.

Returns: Non-zero if the function failed, zero if it succeeded.

int SIDXStageRotateMirrorY ( void * SIDXstage )

Mirror the image in y.

Calls to this method are cumulative, so two successive calls result in no mirroring. The mirroring and rotation calls operate in sequence. Calling RotateSet followed RotateMirrorY rotates the image, then mirrors the image. Calling RotateMirrorY then RotateSet mirrors the image, then rotates the image.

Parameters

SIDXstage A handle value that references the open stage context.

Returns: Non-zero if the function failed, zero if it succeeded.

int SIDXStageRotateSet	(	void *	SIDXstage,
		int	count
	)

Set the image rotation as a count of 90 degree clockwise rotations.

For example, a 90 degree clockwise rotation is 1, a 90 degree counterclockwise rotation is -1, and a 360 degree rotation is 4. Rotations are cumulative, so successive calls add. For example, four calls each with a rotation count of 1 produce a rotation count of 4.

Parameters

SIDXstage	A handle value that references the open stage context.
count	An integer value specifying the image rotation as a signed count of 90 degree clockwise rotations.

Returns: Non-zero if the function failed, zero if it succeeded.

int SIDXStageSpeedGetXY	(	void *	SIDXstage,
		double &	speed
	)

Gets the speed for the X and Y axes in meters per second.

Parameters

SIDXstage	A handle value that references the open stage context.
speed	A variable to receive a real (floating-point) value representing the speed in meters per second.

Returns: Non-zero if the function failed, zero if it succeeded.

int SIDXStageSpeedGetZ	(	void *	SIDXstage,
		double &	speed
	)

Gets the speed for the Z axis in meters per second.

Parameters

SIDXstage	A handle value that references the open stage context.
speed	A variable to receive a real (floating-point) value representing the speed in meters per second.

Returns: Non-zero if the function failed, zero if it succeeded.

int SIDXStageSpeedSetXY	(	void *	SIDXstage,
		double	speed_mps
	)

Sets the speed for the X and Y axes in meters per second.

Parameters

SIDXstage	A handle value that references the open stage context.
speed_mps	An integer value representing the speed in meters per second.

Returns: Non-zero if the function failed, zero if it succeeded.

int SIDXStageSpeedSetZ	(	void *	SIDXstage,
		double	speed_mps
	)

Sets the speed for the Z axis in meters per second.

Parameters

SIDXstage	A handle value that references the open stage context.
speed_mps	An integer value representing the speed in meters per second.

Returns: Non-zero if the function failed, zero if it succeeded.

Functions

Detailed Description

Function Documentation