|
SIDX 7
|
File containing SIDX stage usage for reference. More...
#include "SIDXConstants.h"Go to the source code of this file.
Functions | |
| SIDXStageAccelerateGetLimitXY (integer SIDXstage, double maximum, integer status) | |
| Gets the maximum acceleration during stage movement for the X and Y axes in meters/second^2. More... | |
| SIDXStageAccelerateGetLimitZ (integer SIDXstage, double maximum, integer status) | |
| Gets the maximum acceleration during stage movement for the Z axis in meters/second^2. More... | |
| SIDXStageAccelerateGetXY (integer SIDXstage, double acceleration, integer status) | |
| Gets the acceleration during stage movement for the X and Y axes as a fraction of maximum acceleration. More... | |
| SIDXStageAccelerateGetZ (integer SIDXstage, double acceleration, integer status) | |
| Gets the acceleration during stage movement for the Z axis as a fraction of maximum acceleration. More... | |
| SIDXStageAccelerateSetXY (integer SIDXstage, double acceleration, integer status) | |
| Sets the acceleration during stage movement for the X and Y axes as a fraction of maximum acceleration. More... | |
| SIDXStageAccelerateSetZ (integer SIDXstage, double acceleration, integer status) | |
| Sets the acceleration during stage movement for the Z axis as a fraction of maximum acceleration. More... | |
| SIDXStageAxisEnableXY (integer SIDXstage, integer x_enable, integer y_enable, integer status) | |
| Enables and disables motorized control of the stage axes. More... | |
| SIDXStageAxisEnableZ (integer SIDXstage, integer z_enable, integer status) | |
| Enables and disables motorized control of the focus axis. More... | |
| SIDXStageAxisExistsXY (integer SIDXstage, integer motorized, integer status) | |
| Gets the motorized status of the X and Y axes. More... | |
| SIDXStageAxisExistsZ (integer SIDXstage, integer motorized, integer status) | |
| Gets the motorized status of the Z axis. More... | |
| SIDXStageBacklashExists (integer SIDXstage, integer control, integer status) | |
| Gets whether backlash control is available on this stage. More... | |
| SIDXStageBacklashGetXY (integer SIDXstage, double distance, integer status) | |
| Gets the backlash distance for the X and Y axes, measured in meters. More... | |
| SIDXStageBacklashGetZ (integer SIDXstage, double distance, integer status) | |
| Gets the backlash distance for the Z axis, measured in meters. More... | |
| SIDXStageBacklashSetXY (integer SIDXstage, double distance, integer status) | |
| Sets the backlash distance for the X and Y axes, measured in meters. More... | |
| SIDXStageBacklashSetZ (integer SIDXstage, double distance, integer status) | |
| Sets the backlash distance for the Z axis, measured in meters. More... | |
| SIDXStageClose (integer SIDXstage, integer status) | |
| Close the stage controller. More... | |
| SIDXStageJoystickDisable (integer SIDXstage, integer status) | |
| Sets the stage's attached joystick to be disabled. More... | |
| SIDXStageJoystickEnable (integer SIDXstage, integer status) | |
| Sets the stage's attached joystick to be enabled. More... | |
| SIDXStageJoystickSetMovementXY (integer SIDXstage, integer x_right, integer y_right, double fraction, integer status) | |
| Sets the direction and speed of the X and Y axis controls for stage's attached joystick. More... | |
| SIDXStageJoystickSetMovementZ (integer SIDXstage, integer z_up, double fraction, integer status) | |
| Sets the direction and speed of the Z axis control for stage's attached joystick. More... | |
| SIDXStageLimitIsXMinus (integer SIDXstage, integer limit, integer status) | |
| Gets whether the lower limit switch associated with the X axis was set during the last successful limit query. More... | |
| SIDXStageLimitIsXPlus (integer SIDXstage, integer limit, integer status) | |
| Gets whether the upper limit switch associated with the X axis was set during the last successful limit query. More... | |
| SIDXStageLimitIsXY (integer SIDXstage, integer limit, integer status) | |
| Gets whether any of the limit switches associated with the X or Y axes were set during the last successful limit query. More... | |
| SIDXStageLimitIsXYZ (integer SIDXstage, integer limit, integer status) | |
| Gets whether any of the limit switches associated with the X, Y or Z axes were set during the last successful limit query. More... | |
| SIDXStageLimitIsYMinus (integer SIDXstage, integer limit, integer status) | |
| Gets whether the lower limit switch associated with the Y axis was set during the last successful limit query. More... | |
| SIDXStageLimitIsYPlus (integer SIDXstage, integer limit, integer status) | |
| Gets whether the upper limit switch associated with the Y axis was set during the last successful limit query. More... | |
| SIDXStageLimitIsZ (integer SIDXstage, integer limit, integer status) | |
| Gets whether either of the limit switches associated with the Z axis were set during the last successful limit query. More... | |
| SIDXStageLimitIsZMinus (integer SIDXstage, integer limit, integer status) | |
| Gets whether the lower limit switch associated with the Z axis was set during the last successful limit query. More... | |
| SIDXStageLimitIsZPlus (integer SIDXstage, integer limit, integer status) | |
| Gets whether the upper limit switch associated with the Z axis was set during the last successful limit query. More... | |
| SIDXStageLimitQuery (integer SIDXstage, integer status) | |
| Queries the current stage limit switch values. More... | |
| SIDXStageMotorAccelerateGet (integer SIDXstage, integer motor, double acceleration, integer status) | |
| Gets the acceleration during stage movement for the specified motor as a fraction of maximum acceleration. More... | |
| SIDXStageMotorAccelerateSet (integer SIDXstage, integer motor, double acceleration, integer status) | |
| Sets the acceleration during stage movement for the specified motor as a fraction of maximum acceleration. More... | |
| SIDXStageMotorBacklashExists (integer SIDXstage, integer motor, integer available, integer status) | |
| Gets whether backlash control is available on the specified motor. More... | |
| SIDXStageMotorBacklashGet (integer SIDXstage, integer motor, double distance, integer status) | |
| Gets the backlash distance for the specified motor, in meters. More... | |
| SIDXStageMotorBacklashSet (integer SIDXstage, integer motor, double distance, integer status) | |
| Sets the backlash distance for the specified motor, in meters. More... | |
| SIDXStageMotorExists (integer SIDXstage, integer motor, integer installed, integer status) | |
| Gets whether the specified motor is currently installed. More... | |
| SIDXStageMotorGetByName (integer SIDXstage, string name, integer motor, integer status) | |
| Gets the handle to the specified motor. More... | |
| SIDXStageMotorGetCount (integer SIDXstage, integer identifiers, integer status) | |
| Gets the number of different motor identifiers. More... | |
| SIDXStageMotorGetName (integer SIDXstage, integer motor, string name, integer status) | |
| Gets the name corresponding to the specified motor number. More... | |
| SIDXStageMotorLimit (integer SIDXstage, integer motor, integer limit, integer status) | |
| Gets whether either of the limit switches associated with the specified motor is currently set. More... | |
| SIDXStageMotorLimitMinus (integer SIDXstage, integer motor, integer limit, integer status) | |
| Gets whether the lower limit switch associated with the specified motor is currently set. More... | |
| SIDXStageMotorLimitPlus (integer SIDXstage, integer motor, integer limit, integer status) | |
| Gets whether the upper limit switch associated with the specified motor is currently set. More... | |
| SIDXStageMotorMoveRelative (integer SIDXstage, integer motor, double offset, integer status) | |
| Commands the stage to begin moving the specified motor the specified offset, measured in meters. More... | |
| SIDXStageMotorMoveSpeed (integer SIDXstage, integer motor, double velocity, integer status) | |
| Commands the stage to begin moving the specified motor at the specified speed, as a fraction of maximum speed. More... | |
| SIDXStageMotorMoveStop (integer SIDXstage, integer motor, integer status) | |
| Commands the stage to stop the motor. More... | |
| SIDXStageMotorMovingIs (integer SIDXstage, integer motor, integer moving, integer status) | |
| Gets the motion status of the specified motor. More... | |
| SIDXStageMotorSpeedGet (integer SIDXstage, integer motor, double speed, integer status) | |
| Gets the speed for the specified motor as a fraction of maximum speed. More... | |
| SIDXStageMotorSpeedSet (integer SIDXstage, integer motor, double speed, integer status) | |
| Sets the speed for the specified motor as a fraction of maximum speed. More... | |
| SIDXStageMovePositionXY (integer SIDXstage, double x_position_m, double y_position_m, integer status) | |
| Commands the stage to begin moving to the absolute position specified along the X and Y axes, measured in meters. More... | |
| SIDXStageMovePositionXYZ (integer SIDXstage, double x_position_m, double y_position_m, double z_position_m, integer status) | |
| Commands the stage to begin moving to the absolute position specified along the X, Y and Z axes, measured in meters. More... | |
| SIDXStageMovePositionZ (integer SIDXstage, double z_position_m, integer status) | |
| Commands the stage to begin moving to the absolute position specified along the Z axis, measured in meters. More... | |
| SIDXStageMoveRelativeXY (integer SIDXstage, double x_offset_m, double y_offset_m, integer status) | |
| Commands the stage to begin moving the specified offsets along the X and Y axes, measured in meters. More... | |
| SIDXStageMoveRelativeXYZ (integer SIDXstage, double x_offset_m, double y_offset_m, double z_offset_m, integer status) | |
| Commands the stage to begin moving the specified offsets along the X, Y and Z axes, measured in meters. More... | |
| SIDXStageMoveRelativeZ (integer SIDXstage, double z_offset_m, integer status) | |
| Commands the stage to begin moving the specified offset along the Z axis, measured in meters. More... | |
| SIDXStageMoveSpeedXY (integer SIDXstage, double x_velocity_mps, double y_velocity_mps, integer status) | |
| Commands the stage to begin moving at the specified speed along the X and Y axes, measured in meters/second. More... | |
| SIDXStageMoveSpeedXYZ (integer SIDXstage, double x_velocity_mps, double y_velocity_mps, double z_velocity_mps, integer status) | |
| Commands the stage to begin moving at the specified speed along the X, Y and Z axes, measured in meters/second. More... | |
| SIDXStageMoveSpeedZ (integer SIDXstage, double z_velocity_mps, integer status) | |
| Commands the stage to begin moving at the specified speed along the Z axis, measured in meters/second. More... | |
| SIDXStageMoveStopXYZ (integer SIDXstage, integer status) | |
| Commands the stage to stop all movement along the X, Y and Z axes. More... | |
| SIDXStageMovingIsXY (integer SIDXstage, integer moving, integer status) | |
| Gets the motion status of the X and Y axes during the last successful motion query. More... | |
| SIDXStageMovingIsXYZ (integer SIDXstage, integer moving, integer status) | |
| Gets the motion status of the X, Y and Z axes during the last successful motion query. More... | |
| SIDXStageMovingIsZ (integer SIDXstage, integer moving, integer status) | |
| Gets the motion status of the Z axis during the last successful motion query. More... | |
| SIDXStageMovingQuery (integer SIDXstage, integer status) | |
| Queries the stage about the current motion along the X, Y and Z axes. More... | |
| SIDXStageOriginResetXYZ (integer SIDXstage, integer status) | |
| Sets the current position to zero on the X, Y and Z axes. More... | |
| SIDXStagePositionGet (integer SIDXstage, double position_x, double position_y, double position_z, integer status) | |
| Gets the current absolute position coordinates for all three axes, in meters. More... | |
| SIDXStagePositionGetX (integer SIDXstage, double coordinate, integer status) | |
| Gets the current absolute position coordinate for the X axis, in meters. More... | |
| SIDXStagePositionGetY (integer SIDXstage, double coordinate, integer status) | |
| Gets the current absolute position coordinate for the Y axis, in meters. More... | |
| SIDXStagePositionGetZ (integer SIDXstage, double coordinate, integer status) | |
| Gets the current absolute position coordinate for the Z axis, in meters. More... | |
| SIDXStagePositionQuery (integer SIDXstage, integer status) | |
| Queries the stage about the current position of the X, Y and Z axes. More... | |
| SIDXStageReset (integer SIDXstage, integer status) | |
| Commands the stage to stop all motion and reboot. More... | |
| SIDXStageResolutionGetXY (integer SIDXstage, double resolution, integer status) | |
| Gets the resolution of the X and Y axes in units of meters. More... | |
| SIDXStageResolutionGetZ (integer SIDXstage, double resolution, integer status) | |
| Gets the resolution of the Z axis in units of meters. More... | |
| SIDXStageRotateClear (integer SIDXstage, integer status) | |
| Clear the rotation and mirroring settings, so acquired images are not transformed. More... | |
| SIDXStageRotateMirrorX (integer SIDXstage, integer status) | |
| Mirror the image in x. More... | |
| SIDXStageRotateMirrorY (integer SIDXstage, integer status) | |
| Mirror the image in y. More... | |
| SIDXStageRotateSet (integer SIDXstage, integer count, integer status) | |
| Set the image rotation as a count of 90 degree clockwise rotations. More... | |
| SIDXStageSpeedGetXY (integer SIDXstage, double speed, integer status) | |
| Gets the speed for the X and Y axes in meters per second. More... | |
| SIDXStageSpeedGetZ (integer SIDXstage, double speed, integer status) | |
| Gets the speed for the Z axis in meters per second. More... | |
| SIDXStageSpeedSetXY (integer SIDXstage, double speed_mps, integer status) | |
| Sets the speed for the X and Y axes in meters per second. More... | |
| SIDXStageSpeedSetZ (integer SIDXstage, double speed_mps, integer status) | |
| Sets the speed for the Z axis in meters per second. More... | |
| SIDXStageGetLastError (integer SIDXstage, string message) | |
| The function translates the error code into a text string. More... | |
File containing SIDX stage usage for reference.
| SIDXStageAccelerateGetLimitXY | ( | integer | SIDXstage, |
| double | maximum, | ||
| integer | status | ||
| ) |
Gets the maximum acceleration during stage movement for the X and Y axes in meters/second^2.
| 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. |
| status | Non-zero if the function failed, zero if it succeeded. |
| SIDXStageAccelerateGetLimitZ | ( | integer | SIDXstage, |
| double | maximum, | ||
| integer | status | ||
| ) |
Gets the maximum acceleration during stage movement for the Z axis in meters/second^2.
| 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. |
| status | Non-zero if the function failed, zero if it succeeded. |
| SIDXStageAccelerateGetXY | ( | integer | SIDXstage, |
| double | acceleration, | ||
| integer | status | ||
| ) |
Gets the acceleration during stage movement for the X and Y axes as a fraction of maximum acceleration.
| 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]. |
| status | Non-zero if the function failed, zero if it succeeded. |
| SIDXStageAccelerateGetZ | ( | integer | SIDXstage, |
| double | acceleration, | ||
| integer | status | ||
| ) |
Gets the acceleration during stage movement for the Z axis as a fraction of maximum acceleration.
| 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]. |
| status | Non-zero if the function failed, zero if it succeeded. |
| SIDXStageAccelerateSetXY | ( | integer | SIDXstage, |
| double | acceleration, | ||
| integer | status | ||
| ) |
Sets the acceleration during stage movement for the X and Y axes as a fraction of maximum acceleration.
| SIDXstage | A handle value that references the open stage context. |
| acceleration | The desired acceleration fraction, a value in the range [0, 1.0]. |
| status | Non-zero if the function failed, zero if it succeeded. |
| SIDXStageAccelerateSetZ | ( | integer | SIDXstage, |
| double | acceleration, | ||
| integer | status | ||
| ) |
Sets the acceleration during stage movement for the Z axis as a fraction of maximum acceleration.
| SIDXstage | A handle value that references the open stage context. |
| acceleration | The desired acceleration fraction,a value in the range [0, 1.0]. |
| status | Non-zero if the function failed, zero if it succeeded. |
| SIDXStageAxisEnableXY | ( | integer | SIDXstage, |
| integer | x_enable, | ||
| integer | y_enable, | ||
| integer | status | ||
| ) |
Enables and disables motorized control of the stage axes.
| 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. |
| status | Non-zero if the function failed, zero if it succeeded. |
| SIDXStageAxisEnableZ | ( | integer | SIDXstage, |
| integer | z_enable, | ||
| integer | status | ||
| ) |
Enables and disables motorized control of the focus axis.
| SIDXstage | A handle value that references the open stage context. |
| z_enable | True to enable the axis motor, false to disable. |
| status | Non-zero if the function failed, zero if it succeeded. |
| SIDXStageAxisExistsXY | ( | integer | SIDXstage, |
| integer | motorized, | ||
| integer | status | ||
| ) |
Gets the motorized status of the X and Y axes.
| 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. |
| status | Non-zero if the function failed, zero if it succeeded. |
| SIDXStageAxisExistsZ | ( | integer | SIDXstage, |
| integer | motorized, | ||
| integer | status | ||
| ) |
Gets the motorized status of the Z axis.
| 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. |
| status | Non-zero if the function failed, zero if it succeeded. |
| SIDXStageBacklashExists | ( | integer | SIDXstage, |
| integer | control, | ||
| integer | status | ||
| ) |
Gets whether backlash control is available on this stage.
| SIDXstage | A handle value that references the open stage context. |
| control | A variable to receive a boolean value specifying the availability of backlash control. |
| status | Non-zero if the function failed, zero if it succeeded. |
| SIDXStageBacklashGetXY | ( | integer | SIDXstage, |
| double | distance, | ||
| integer | status | ||
| ) |
Gets the backlash distance for the X and Y axes, measured in meters.
| 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. |
| status | Non-zero if the function failed, zero if it succeeded. |
| SIDXStageBacklashGetZ | ( | integer | SIDXstage, |
| double | distance, | ||
| integer | status | ||
| ) |
Gets the backlash distance for the Z axis, measured in meters.
| SIDXstage | A handle value that references the open stage context. |
| distance | A variable to receive a real (floating-point) value representing the backlash distance. |
| status | Non-zero if the function failed, zero if it succeeded. |
| SIDXStageBacklashSetXY | ( | integer | SIDXstage, |
| double | distance, | ||
| integer | status | ||
| ) |
Sets the backlash distance for the X and Y axes, measured in meters.
| SIDXstage | A handle value that references the open stage context. |
| distance | The backlash distance. |
| status | Non-zero if the function failed, zero if it succeeded. |
| SIDXStageBacklashSetZ | ( | integer | SIDXstage, |
| double | distance, | ||
| integer | status | ||
| ) |
Sets the backlash distance for the Z axis, measured in meters.
| SIDXstage | A handle value that references the open stage context. |
| distance | The backlash distance. |
| status | Non-zero if the function failed, zero if it succeeded. |
| SIDXStageClose | ( | integer | SIDXstage, |
| integer | status | ||
| ) |
Close the stage controller.
| SIDXstage | A handle value that references the open stage context. |
| status | Non-zero if the function failed, zero if it succeeded. |
| SIDXStageGetLastError | ( | integer | SIDXstage, |
| string | message | ||
| ) |
The function translates the error code into a text string.
| SIDXstage | A handle value that references the open stage context. |
| message | A text string to receive the text associated with the last error occurred. |
| SIDXStageJoystickDisable | ( | integer | SIDXstage, |
| integer | status | ||
| ) |
Sets the stage's attached joystick to be disabled.
| SIDXstage | A handle value that references the open stage context. |
| status | Non-zero if the function failed, zero if it succeeded. |
| SIDXStageJoystickEnable | ( | integer | SIDXstage, |
| integer | status | ||
| ) |
Sets the stage's attached joystick to be enabled.
| SIDXstage | A handle value that references the open stage context. |
| status | Non-zero if the function failed, zero if it succeeded. |
| SIDXStageJoystickSetMovementXY | ( | integer | SIDXstage, |
| integer | x_right, | ||
| integer | y_right, | ||
| double | fraction, | ||
| integer | status | ||
| ) |
Sets the direction and speed of the X and Y axis controls for stage's attached joystick.
| 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]. |
| status | Non-zero if the function failed, zero if it succeeded. |
| SIDXStageJoystickSetMovementZ | ( | integer | SIDXstage, |
| integer | z_up, | ||
| double | fraction, | ||
| integer | status | ||
| ) |
Sets the direction and speed of the Z axis control for stage's attached joystick.
| 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]. |
| status | Non-zero if the function failed, zero if it succeeded. |
| SIDXStageLimitIsXMinus | ( | integer | SIDXstage, |
| integer | limit, | ||
| integer | status | ||
| ) |
Gets whether the lower limit switch associated with the X axis was set during the last successful limit query.
| 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. |
| status | Non-zero if the function failed, zero if it succeeded. |
| SIDXStageLimitIsXPlus | ( | integer | SIDXstage, |
| integer | limit, | ||
| integer | status | ||
| ) |
Gets whether the upper limit switch associated with the X axis was set during the last successful limit query.
| 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. |
| status | Non-zero if the function failed, zero if it succeeded. |
| SIDXStageLimitIsXY | ( | integer | SIDXstage, |
| integer | limit, | ||
| integer | status | ||
| ) |
Gets whether any of the limit switches associated with the X or Y axes were set during the last successful limit query.
| 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. |
| status | Non-zero if the function failed, zero if it succeeded. |
| SIDXStageLimitIsXYZ | ( | integer | SIDXstage, |
| integer | limit, | ||
| integer | status | ||
| ) |
Gets whether any of the limit switches associated with the X, Y or Z axes were set during the last successful limit query.
| 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. |
| status | Non-zero if the function failed, zero if it succeeded. |
| SIDXStageLimitIsYMinus | ( | integer | SIDXstage, |
| integer | limit, | ||
| integer | status | ||
| ) |
Gets whether the lower limit switch associated with the Y axis was set during the last successful limit query.
| 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. |
| status | Non-zero if the function failed, zero if it succeeded. |
| SIDXStageLimitIsYPlus | ( | integer | SIDXstage, |
| integer | limit, | ||
| integer | status | ||
| ) |
Gets whether the upper limit switch associated with the Y axis was set during the last successful limit query.
| 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. |
| status | Non-zero if the function failed, zero if it succeeded. |
| SIDXStageLimitIsZ | ( | integer | SIDXstage, |
| integer | limit, | ||
| integer | status | ||
| ) |
Gets whether either of the limit switches associated with the Z axis were set during the last successful limit query.
| 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. |
| status | Non-zero if the function failed, zero if it succeeded. |
| SIDXStageLimitIsZMinus | ( | integer | SIDXstage, |
| integer | limit, | ||
| integer | status | ||
| ) |
Gets whether the lower limit switch associated with the Z axis was set during the last successful limit query.
| 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. |
| status | Non-zero if the function failed, zero if it succeeded. |
| SIDXStageLimitIsZPlus | ( | integer | SIDXstage, |
| integer | limit, | ||
| integer | status | ||
| ) |
Gets whether the upper limit switch associated with the Z axis was set during the last successful limit query.
| 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. |
| status | Non-zero if the function failed, zero if it succeeded. |
| SIDXStageLimitQuery | ( | integer | SIDXstage, |
| integer | status | ||
| ) |
Queries the current stage limit switch values.
Each axis has two limit switches, the values of all limit switches are captured synchronously.
| SIDXstage | A handle value that references the open stage context. |
| status | Non-zero if the function failed, zero if it succeeded. |
| SIDXStageMotorAccelerateGet | ( | integer | SIDXstage, |
| integer | motor, | ||
| double | acceleration, | ||
| integer | status | ||
| ) |
Gets the acceleration during stage movement for the specified motor as a fraction of maximum acceleration.
| 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]. |
| status | Non-zero if the function failed, zero if it succeeded. |
| SIDXStageMotorAccelerateSet | ( | integer | SIDXstage, |
| integer | motor, | ||
| double | acceleration, | ||
| integer | status | ||
| ) |
Sets the acceleration during stage movement for the specified motor as a fraction of maximum acceleration.
| 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]. |
| status | Non-zero if the function failed, zero if it succeeded. |
| SIDXStageMotorBacklashExists | ( | integer | SIDXstage, |
| integer | motor, | ||
| integer | available, | ||
| integer | status | ||
| ) |
Gets whether backlash control is available on the specified motor.
| 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. |
| status | Non-zero if the function failed, zero if it succeeded. |
| SIDXStageMotorBacklashGet | ( | integer | SIDXstage, |
| integer | motor, | ||
| double | distance, | ||
| integer | status | ||
| ) |
Gets the backlash distance for the specified motor, in meters.
| 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. |
| status | Non-zero if the function failed, zero if it succeeded. |
| SIDXStageMotorBacklashSet | ( | integer | SIDXstage, |
| integer | motor, | ||
| double | distance, | ||
| integer | status | ||
| ) |
Sets the backlash distance for the specified motor, in meters.
| 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. |
| status | Non-zero if the function failed, zero if it succeeded. |
| SIDXStageMotorExists | ( | integer | SIDXstage, |
| integer | motor, | ||
| integer | installed, | ||
| integer | status | ||
| ) |
Gets whether the specified motor is currently installed.
| 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. |
| status | Non-zero if the function failed, zero if it succeeded. |
| SIDXStageMotorGetByName | ( | integer | SIDXstage, |
| string | name, | ||
| integer | motor, | ||
| integer | status | ||
| ) |
Gets the handle to the specified motor.
| 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. |
| status | Non-zero if the function failed, zero if it succeeded. |
| SIDXStageMotorGetCount | ( | integer | SIDXstage, |
| integer | identifiers, | ||
| integer | status | ||
| ) |
Gets the number of different motor identifiers.
| SIDXstage | A handle value that references the open stage context. |
| identifiers | A variable to receive an integer value representing the number of identifiers. |
| status | Non-zero if the function failed, zero if it succeeded. |
| SIDXStageMotorGetName | ( | integer | SIDXstage, |
| integer | motor, | ||
| string | name, | ||
| integer | status | ||
| ) |
Gets the name corresponding to the specified motor number.
| 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. |
| status | Non-zero if the function failed, zero if it succeeded. |
| SIDXStageMotorLimit | ( | integer | SIDXstage, |
| integer | motor, | ||
| integer | limit, | ||
| integer | status | ||
| ) |
Gets whether either of the limit switches associated with the specified motor is currently set.
| 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. |
| status | Non-zero if the function failed, zero if it succeeded. |
| SIDXStageMotorLimitMinus | ( | integer | SIDXstage, |
| integer | motor, | ||
| integer | limit, | ||
| integer | status | ||
| ) |
Gets whether the lower limit switch associated with the specified motor is currently set.
| 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. |
| status | Non-zero if the function failed, zero if it succeeded. |
| SIDXStageMotorLimitPlus | ( | integer | SIDXstage, |
| integer | motor, | ||
| integer | limit, | ||
| integer | status | ||
| ) |
Gets whether the upper limit switch associated with the specified motor is currently set.
| 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. |
| status | Non-zero if the function failed, zero if it succeeded. |
| SIDXStageMotorMoveRelative | ( | integer | SIDXstage, |
| integer | motor, | ||
| double | offset, | ||
| integer | status | ||
| ) |
Commands the stage to begin moving the specified motor the specified offset, measured in meters.
| 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. |
| status | Non-zero if the function failed, zero if it succeeded. |
| SIDXStageMotorMoveSpeed | ( | integer | SIDXstage, |
| integer | motor, | ||
| double | velocity, | ||
| integer | status | ||
| ) |
Commands the stage to begin moving the specified motor at the specified speed, as a fraction of maximum speed.
| 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. |
| status | Non-zero if the function failed, zero if it succeeded. |
| SIDXStageMotorMoveStop | ( | integer | SIDXstage, |
| integer | motor, | ||
| integer | status | ||
| ) |
Commands the stage to stop the motor.
| SIDXstage | A handle value that references the open stage context. |
| motor | An integer value representing the handle to the motor. |
| status | Non-zero if the function failed, zero if it succeeded. |
| SIDXStageMotorMovingIs | ( | integer | SIDXstage, |
| integer | motor, | ||
| integer | moving, | ||
| integer | status | ||
| ) |
Gets the motion status of the specified motor.
| 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. |
| status | Non-zero if the function failed, zero if it succeeded. |
| SIDXStageMotorSpeedGet | ( | integer | SIDXstage, |
| integer | motor, | ||
| double | speed, | ||
| integer | status | ||
| ) |
Gets the speed for the specified motor as a fraction of maximum speed.
| 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]. |
| status | Non-zero if the function failed, zero if it succeeded. |
| SIDXStageMotorSpeedSet | ( | integer | SIDXstage, |
| integer | motor, | ||
| double | speed, | ||
| integer | status | ||
| ) |
Sets the speed for the specified motor as a fraction of maximum speed.
| 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]. |
| status | Non-zero if the function failed, zero if it succeeded. |
| SIDXStageMovePositionXY | ( | integer | SIDXstage, |
| double | x_position_m, | ||
| double | y_position_m, | ||
| integer | status | ||
| ) |
Commands the stage to begin moving to the absolute position specified along the X and Y axes, measured in meters.
| 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. |
| status | Non-zero if the function failed, zero if it succeeded. |
| SIDXStageMovePositionXYZ | ( | integer | SIDXstage, |
| double | x_position_m, | ||
| double | y_position_m, | ||
| double | z_position_m, | ||
| integer | status | ||
| ) |
Commands the stage to begin moving to the absolute position specified along the X, Y and Z axes, measured in meters.
| 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. |
| status | Non-zero if the function failed, zero if it succeeded. |
| SIDXStageMovePositionZ | ( | integer | SIDXstage, |
| double | z_position_m, | ||
| integer | status | ||
| ) |
Commands the stage to begin moving to the absolute position specified along the Z axis, measured in meters.
| 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. |
| status | Non-zero if the function failed, zero if it succeeded. |
| SIDXStageMoveRelativeXY | ( | integer | SIDXstage, |
| double | x_offset_m, | ||
| double | y_offset_m, | ||
| integer | status | ||
| ) |
Commands the stage to begin moving the specified offsets along the X and Y axes, measured in meters.
| 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. |
| status | Non-zero if the function failed, zero if it succeeded. |
| SIDXStageMoveRelativeXYZ | ( | integer | SIDXstage, |
| double | x_offset_m, | ||
| double | y_offset_m, | ||
| double | z_offset_m, | ||
| integer | status | ||
| ) |
Commands the stage to begin moving the specified offsets along the X, Y and Z axes, measured in meters.
| 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. |
| status | Non-zero if the function failed, zero if it succeeded. |
| SIDXStageMoveRelativeZ | ( | integer | SIDXstage, |
| double | z_offset_m, | ||
| integer | status | ||
| ) |
Commands the stage to begin moving the specified offset along the Z axis, measured in meters.
| 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. |
| status | Non-zero if the function failed, zero if it succeeded. |
| SIDXStageMoveSpeedXY | ( | integer | SIDXstage, |
| double | x_velocity_mps, | ||
| double | y_velocity_mps, | ||
| integer | status | ||
| ) |
Commands the stage to begin moving at the specified speed along the X and Y axes, measured in meters/second.
| 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. |
| status | Non-zero if the function failed, zero if it succeeded. |
| SIDXStageMoveSpeedXYZ | ( | integer | SIDXstage, |
| double | x_velocity_mps, | ||
| double | y_velocity_mps, | ||
| double | z_velocity_mps, | ||
| integer | status | ||
| ) |
Commands the stage to begin moving at the specified speed along the X, Y and Z axes, measured in meters/second.
| 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. |
| status | Non-zero if the function failed, zero if it succeeded. |
| SIDXStageMoveSpeedZ | ( | integer | SIDXstage, |
| double | z_velocity_mps, | ||
| integer | status | ||
| ) |
Commands the stage to begin moving at the specified speed along the Z axis, measured in meters/second.
| 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. |
| status | Non-zero if the function failed, zero if it succeeded. |
| SIDXStageMoveStopXYZ | ( | integer | SIDXstage, |
| integer | status | ||
| ) |
Commands the stage to stop all movement along the X, Y and Z axes.
| SIDXstage | A handle value that references the open stage context. |
| status | Non-zero if the function failed, zero if it succeeded. |
| SIDXStageMovingIsXY | ( | integer | SIDXstage, |
| integer | moving, | ||
| integer | status | ||
| ) |
Gets the motion status of the X and Y axes during the last successful motion query.
| 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. |
| status | Non-zero if the function failed, zero if it succeeded. |
| SIDXStageMovingIsXYZ | ( | integer | SIDXstage, |
| integer | moving, | ||
| integer | status | ||
| ) |
Gets the motion status of the X, Y and Z axes during the last successful motion query.
| 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. |
| status | Non-zero if the function failed, zero if it succeeded. |
| SIDXStageMovingIsZ | ( | integer | SIDXstage, |
| integer | moving, | ||
| integer | status | ||
| ) |
Gets the motion status of the Z axis during the last successful motion query.
| 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. |
| status | Non-zero if the function failed, zero if it succeeded. |
| SIDXStageMovingQuery | ( | integer | SIDXstage, |
| integer | status | ||
| ) |
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.
| SIDXstage | A handle value that references the open stage context. |
| status | Non-zero if the function failed, zero if it succeeded. |
| SIDXStageOriginResetXYZ | ( | integer | SIDXstage, |
| integer | status | ||
| ) |
Sets the current position to zero on the X, Y and Z axes.
Future absolute positions are referenced to this new origin.
| SIDXstage | A handle value that references the open stage context. |
| status | Non-zero if the function failed, zero if it succeeded. |
| SIDXStagePositionGet | ( | integer | SIDXstage, |
| double | position_x, | ||
| double | position_y, | ||
| double | position_z, | ||
| integer | status | ||
| ) |
Gets the current absolute position coordinates for all three axes, in meters.
| 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. |
| status | Non-zero if the function failed, zero if it succeeded. |
| SIDXStagePositionGetX | ( | integer | SIDXstage, |
| double | coordinate, | ||
| integer | status | ||
| ) |
Gets the current absolute position coordinate for the X axis, in meters.
| 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. |
| status | Non-zero if the function failed, zero if it succeeded. |
| SIDXStagePositionGetY | ( | integer | SIDXstage, |
| double | coordinate, | ||
| integer | status | ||
| ) |
Gets the current absolute position coordinate for the Y axis, in meters.
| 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. |
| status | Non-zero if the function failed, zero if it succeeded. |
| SIDXStagePositionGetZ | ( | integer | SIDXstage, |
| double | coordinate, | ||
| integer | status | ||
| ) |
Gets the current absolute position coordinate for the Z axis, in meters.
| 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. |
| status | Non-zero if the function failed, zero if it succeeded. |
| SIDXStagePositionQuery | ( | integer | SIDXstage, |
| integer | status | ||
| ) |
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.
| SIDXstage | A handle value that references the open stage context. |
| status | Non-zero if the function failed, zero if it succeeded. |
| SIDXStageReset | ( | integer | SIDXstage, |
| integer | status | ||
| ) |
Commands the stage to stop all motion and reboot.
| SIDXstage | A handle value that references the open stage context. |
| status | Non-zero if the function failed, zero if it succeeded. |
| SIDXStageResolutionGetXY | ( | integer | SIDXstage, |
| double | resolution, | ||
| integer | status | ||
| ) |
Gets the resolution of the X and Y axes in units of meters.
| SIDXstage | A handle value that references the open stage context. |
| resolution | A variable to receive a real (floating-point) value representing the resolution. |
| status | Non-zero if the function failed, zero if it succeeded. |
| SIDXStageResolutionGetZ | ( | integer | SIDXstage, |
| double | resolution, | ||
| integer | status | ||
| ) |
Gets the resolution of the Z axis in units of meters.
| SIDXstage | A handle value that references the open stage context. |
| resolution | A variable to receive a real (floating-point) value representing the resolution. |
| status | Non-zero if the function failed, zero if it succeeded. |
| SIDXStageRotateClear | ( | integer | SIDXstage, |
| integer | status | ||
| ) |
Clear the rotation and mirroring settings, so acquired images are not transformed.
| SIDXstage | A handle value that references the open stage context. |
| status | Non-zero if the function failed, zero if it succeeded. |
| SIDXStageRotateMirrorX | ( | integer | SIDXstage, |
| integer | status | ||
| ) |
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.
| SIDXstage | A handle value that references the open stage context. |
| status | Non-zero if the function failed, zero if it succeeded. |
| SIDXStageRotateMirrorY | ( | integer | SIDXstage, |
| integer | status | ||
| ) |
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.
| SIDXstage | A handle value that references the open stage context. |
| status | Non-zero if the function failed, zero if it succeeded. |
| SIDXStageRotateSet | ( | integer | SIDXstage, |
| integer | count, | ||
| integer | status | ||
| ) |
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.
| 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. |
| status | Non-zero if the function failed, zero if it succeeded. |
| SIDXStageSpeedGetXY | ( | integer | SIDXstage, |
| double | speed, | ||
| integer | status | ||
| ) |
Gets the speed for the X and Y axes in meters per second.
| 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. |
| status | Non-zero if the function failed, zero if it succeeded. |
| SIDXStageSpeedGetZ | ( | integer | SIDXstage, |
| double | speed, | ||
| integer | status | ||
| ) |
Gets the speed for the Z axis in meters per second.
| 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. |
| status | Non-zero if the function failed, zero if it succeeded. |
| SIDXStageSpeedSetXY | ( | integer | SIDXstage, |
| double | speed_mps, | ||
| integer | status | ||
| ) |
Sets the speed for the X and Y axes in meters per second.
| SIDXstage | A handle value that references the open stage context. |
| speed_mps | An integer value representing the speed in meters per second. |
| status | Non-zero if the function failed, zero if it succeeded. |
| SIDXStageSpeedSetZ | ( | integer | SIDXstage, |
| double | speed_mps, | ||
| integer | status | ||
| ) |
Sets the speed for the Z axis in meters per second.
| SIDXstage | A handle value that references the open stage context. |
| speed_mps | An integer value representing the speed in meters per second. |
| status | Non-zero if the function failed, zero if it succeeded. |
1.8.9