SIDX 7
SIDXStage.h
Go to the documentation of this file.
1 
6 #include "SIDXConstants.h"
7 
8 #ifndef SIDXXOPStage_H
9 #define SIDXXOPStage_H
10 
19 SIDXStageAccelerateGetLimitXY(integer SIDXstage, double maximum, integer status);
28 SIDXStageAccelerateGetLimitZ(integer SIDXstage, double maximum, integer status);
38 SIDXStageAccelerateGetXY(integer SIDXstage, double acceleration, integer status);
47 SIDXStageAccelerateGetZ(integer SIDXstage, double acceleration, integer status);
55 SIDXStageAccelerateSetXY(integer SIDXstage, double acceleration, integer status);
63 SIDXStageAccelerateSetZ(integer SIDXstage, double acceleration, integer status);
64 
73 SIDXStageAxisEnableXY(integer SIDXstage, integer x_enable, integer y_enable, integer status);
81 SIDXStageAxisEnableZ(integer SIDXstage, integer z_enable, integer status);
90 SIDXStageAxisExistsXY(integer SIDXstage, integer motorized, integer status);
98 SIDXStageAxisExistsZ(integer SIDXstage, integer motorized, integer status);
99 
107 SIDXStageBacklashExists(integer SIDXstage, integer control, integer status);
116 SIDXStageBacklashGetXY(integer SIDXstage, double distance, integer status);
124 SIDXStageBacklashGetZ(integer SIDXstage, double distance, integer status);
132 SIDXStageBacklashSetXY(integer SIDXstage, double distance, integer status);
140 SIDXStageBacklashSetZ(integer SIDXstage, double distance, integer status);
141 
149 SIDXStageClose(integer SIDXstage, integer status);
150 
158 SIDXStageJoystickDisable(integer SIDXstage, integer status);
166 SIDXStageJoystickEnable(integer SIDXstage, integer status);
179 SIDXStageJoystickSetMovementXY
180  (integer SIDXstage, integer x_right, integer y_right, double fraction, integer status);
191 SIDXStageJoystickSetMovementZ
192  (integer SIDXstage, integer z_up, double fraction, integer status);
193 
203 SIDXStageLimitIsXMinus(integer SIDXstage, integer limit, integer status);
213 SIDXStageLimitIsXPlus(integer SIDXstage, integer limit, integer status);
223 SIDXStageLimitIsXY(integer SIDXstage, integer limit, integer status);
233 SIDXStageLimitIsXYZ(integer SIDXstage, integer limit, integer status);
243 SIDXStageLimitIsYMinus(integer SIDXstage, integer limit, integer status);
253 SIDXStageLimitIsYPlus(integer SIDXstage, integer limit, integer status);
263 SIDXStageLimitIsZ(integer SIDXstage, integer limit, integer status);
273 SIDXStageLimitIsZMinus(integer SIDXstage, integer limit, integer status);
283 SIDXStageLimitIsZPlus(integer SIDXstage, integer limit, integer status);
292 SIDXStageLimitQuery(integer SIDXstage, integer status);
293 
304 SIDXStageMotorAccelerateGet(integer SIDXstage, integer motor, double acceleration, integer status);
315 SIDXStageMotorAccelerateSet(integer SIDXstage, integer motor, double acceleration, integer status);
325 SIDXStageMotorBacklashExists(integer SIDXstage, integer motor, integer available, integer status);
334 SIDXStageMotorBacklashGet(integer SIDXstage, integer motor, double distance, integer status);
343 SIDXStageMotorBacklashSet(integer SIDXstage, integer motor, double distance, integer status);
352 SIDXStageMotorExists(integer SIDXstage, integer motor, integer installed, integer status);
361 SIDXStageMotorGetByName(integer SIDXstage, string name, integer motor, integer status);
369 SIDXStageMotorGetCount(integer SIDXstage, integer identifiers, integer status);
378 SIDXStageMotorGetName(integer SIDXstage, integer motor, string name, integer status);
388 SIDXStageMotorLimit(integer SIDXstage, integer motor, integer limit, integer status);
398 SIDXStageMotorLimitMinus(integer SIDXstage, integer motor, integer limit, integer status);
408 SIDXStageMotorLimitPlus(integer SIDXstage, integer motor, integer limit, integer status);
419 SIDXStageMotorMoveRelative(integer SIDXstage, integer motor, double offset, integer status);
430 SIDXStageMotorMoveSpeed(integer SIDXstage, integer motor, double velocity, integer status);
438 SIDXStageMotorMoveStop(integer SIDXstage, integer motor, integer status);
447 SIDXStageMotorMovingIs(integer SIDXstage, integer motor, integer moving, integer status);
457 SIDXStageMotorSpeedGet(integer SIDXstage, integer motor, double speed, integer status);
467 SIDXStageMotorSpeedSet(integer SIDXstage, integer motor, double speed, integer status);
468 
480 SIDXStageMovePositionXY
481  (integer SIDXstage, double x_position_m, double y_position_m, integer status);
495 SIDXStageMovePositionXYZ(
496  integer SIDXstage,
497  double x_position_m,
498  double y_position_m,
499  double z_position_m
500 , integer status);
510 SIDXStageMovePositionZ(integer SIDXstage, double z_position_m, integer status);
511 
523 SIDXStageMoveRelativeXY
524  (integer SIDXstage, double x_offset_m, double y_offset_m, integer status);
538 SIDXStageMoveRelativeXYZ
539  (integer SIDXstage, double x_offset_m, double y_offset_m, double z_offset_m, integer status);
548 SIDXStageMoveRelativeZ(integer SIDXstage, double z_offset_m, integer status);
549 
561 SIDXStageMoveSpeedXY
562  (integer SIDXstage, double x_velocity_mps, double y_velocity_mps, integer status);
576 SIDXStageMoveSpeedXYZ(
577  integer SIDXstage,
578  double x_velocity_mps,
579  double y_velocity_mps,
580  double z_velocity_mps
581 , integer status);
591 SIDXStageMoveSpeedZ(integer SIDXstage, double z_velocity_mps, integer status);
592 
600 SIDXStageMoveStopXYZ(integer SIDXstage, integer status);
609 SIDXStageMovingIsXY(integer SIDXstage, integer moving, integer status);
610 
619 SIDXStageMovingIsXYZ(integer SIDXstage, integer moving, integer status);
628 SIDXStageMovingIsZ(integer SIDXstage, integer moving, integer status);
637 SIDXStageMovingQuery(integer SIDXstage, integer status);
638 
647 SIDXStageOriginResetXYZ(integer SIDXstage, integer status);
648 
658 SIDXStagePositionGet
659  (integer SIDXstage, double position_x, double position_y, double position_z, integer status);
668 SIDXStagePositionGetX(integer SIDXstage, double coordinate, integer status);
677 SIDXStagePositionGetY(integer SIDXstage, double coordinate, integer status);
686 SIDXStagePositionGetZ(integer SIDXstage, double coordinate, integer status);
695 SIDXStagePositionQuery(integer SIDXstage, integer status);
696 
704 SIDXStageReset(integer SIDXstage, integer status);
705 
713 SIDXStageResolutionGetXY(integer SIDXstage, double resolution, integer status);
721 SIDXStageResolutionGetZ(integer SIDXstage, double resolution, integer status);
722 
730 SIDXStageRotateClear(integer SIDXstage, integer status);
741 SIDXStageRotateMirrorX(integer SIDXstage, integer status);
752 SIDXStageRotateMirrorY(integer SIDXstage, integer status);
764 SIDXStageRotateSet(integer SIDXstage, integer count, integer status);
765 
774 SIDXStageSpeedGetXY(integer SIDXstage, double speed, integer status);
783 SIDXStageSpeedGetZ(integer SIDXstage, double speed, integer status);
791 SIDXStageSpeedSetXY(integer SIDXstage, double speed_mps, integer status);
799 SIDXStageSpeedSetZ(integer SIDXstage, double speed_mps, integer status);
800 
806 SIDXStageGetLastError(integer SIDXstage, string message);
807 
808 #endif
SIDXStageLimitIsXYZ
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 su...
SIDXStageRotateClear
SIDXStageRotateClear(integer SIDXstage, integer status)
Clear the rotation and mirroring settings, so acquired images are not transformed.
SIDXStageBacklashGetZ
SIDXStageBacklashGetZ(integer SIDXstage, double distance, integer status)
Gets the backlash distance for the Z axis, measured in meters.
SIDXStageMoveStopXYZ
SIDXStageMoveStopXYZ(integer SIDXstage, integer status)
Commands the stage to stop all movement along the X, Y and Z axes.
SIDXStageLimitIsZMinus
SIDXStageLimitIsZMinus(integer SIDXstage, integer limit, integer status)
Gets whether the lower limit switch associated with the Z axis was set during the last successful lim...
SIDXStageMotorLimitPlus
SIDXStageMotorLimitPlus(integer SIDXstage, integer motor, integer limit, integer status)
Gets whether the upper limit switch associated with the specified motor is currently set...
SIDXStageMotorExists
SIDXStageMotorExists(integer SIDXstage, integer motor, integer installed, integer status)
Gets whether the specified motor is currently installed.
SIDXStageRotateSet
SIDXStageRotateSet(integer SIDXstage, integer count, integer status)
Set the image rotation as a count of 90 degree clockwise rotations.
SIDXStageMovingQuery
SIDXStageMovingQuery(integer SIDXstage, integer status)
Queries the stage about the current motion along the X, Y and Z axes.
SIDXStageJoystickDisable
SIDXStageJoystickDisable(integer SIDXstage, integer status)
Sets the stage's attached joystick to be disabled.
SIDXStageAccelerateGetXY
SIDXStageAccelerateGetXY(integer SIDXstage, double acceleration, integer status)
Gets the acceleration during stage movement for the X and Y axes as a fraction of maximum acceleratio...
SIDXStageMoveSpeedXYZ
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.
SIDXStageMovingIsXYZ
SIDXStageMovingIsXYZ(integer SIDXstage, integer moving, integer status)
Gets the motion status of the X, Y and Z axes during the last successful motion query.
SIDXStageLimitQuery
SIDXStageLimitQuery(integer SIDXstage, integer status)
Queries the current stage limit switch values.
SIDXStageMotorMovingIs
SIDXStageMotorMovingIs(integer SIDXstage, integer motor, integer moving, integer status)
Gets the motion status of the specified motor.
SIDXStageLimitIsXY
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 succe...
SIDXStageLimitIsZ
SIDXStageLimitIsZ(integer SIDXstage, integer limit, integer status)
Gets whether either of the limit switches associated with the Z axis were set during the last success...
SIDXStageSpeedGetZ
SIDXStageSpeedGetZ(integer SIDXstage, double speed, integer status)
Gets the speed for the Z axis in meters per second.
SIDXStagePositionQuery
SIDXStagePositionQuery(integer SIDXstage, integer status)
Queries the stage about the current position of the X, Y and Z axes.
SIDXStageMotorAccelerateGet
SIDXStageMotorAccelerateGet(integer SIDXstage, integer motor, double acceleration, integer status)
Gets the acceleration during stage movement for the specified motor as a fraction of maximum accelera...
SIDXConstants.h
File containing SIDX constants for reference.
SIDXStageAxisExistsXY
SIDXStageAxisExistsXY(integer SIDXstage, integer motorized, integer status)
Gets the motorized status of the X and Y axes.
SIDXStagePositionGetX
SIDXStagePositionGetX(integer SIDXstage, double coordinate, integer status)
Gets the current absolute position coordinate for the X axis, in meters.
SIDXStageMovePositionXY
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...
SIDXStageResolutionGetXY
SIDXStageResolutionGetXY(integer SIDXstage, double resolution, integer status)
Gets the resolution of the X and Y axes in units of meters.
SIDXStageLimitIsYMinus
SIDXStageLimitIsYMinus(integer SIDXstage, integer limit, integer status)
Gets whether the lower limit switch associated with the Y axis was set during the last successful lim...
SIDXStageMotorGetByName
SIDXStageMotorGetByName(integer SIDXstage, string name, integer motor, integer status)
Gets the handle to the specified motor.
SIDXStageMotorSpeedGet
SIDXStageMotorSpeedGet(integer SIDXstage, integer motor, double speed, integer status)
Gets the speed for the specified motor as a fraction of maximum speed.
SIDXStageLimitIsXMinus
SIDXStageLimitIsXMinus(integer SIDXstage, integer limit, integer status)
Gets whether the lower limit switch associated with the X axis was set during the last successful lim...
SIDXStageJoystickSetMovementXY
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.
SIDXStageJoystickEnable
SIDXStageJoystickEnable(integer SIDXstage, integer status)
Sets the stage's attached joystick to be enabled.
SIDXStageMotorBacklashSet
SIDXStageMotorBacklashSet(integer SIDXstage, integer motor, double distance, integer status)
Sets the backlash distance for the specified motor, in meters.
SIDXStageSpeedGetXY
SIDXStageSpeedGetXY(integer SIDXstage, double speed, integer status)
Gets the speed for the X and Y axes in meters per second.
SIDXStageLimitIsZPlus
SIDXStageLimitIsZPlus(integer SIDXstage, integer limit, integer status)
Gets whether the upper limit switch associated with the Z axis was set during the last successful lim...
SIDXStageMotorGetCount
SIDXStageMotorGetCount(integer SIDXstage, integer identifiers, integer status)
Gets the number of different motor identifiers.
SIDXStageBacklashExists
SIDXStageBacklashExists(integer SIDXstage, integer control, integer status)
Gets whether backlash control is available on this stage.
SIDXStageSpeedSetXY
SIDXStageSpeedSetXY(integer SIDXstage, double speed_mps, integer status)
Sets the speed for the X and Y axes in meters per second.
SIDXStageBacklashSetZ
SIDXStageBacklashSetZ(integer SIDXstage, double distance, integer status)
Sets the backlash distance for the Z axis, measured in meters.
SIDXStageAxisEnableZ
SIDXStageAxisEnableZ(integer SIDXstage, integer z_enable, integer status)
Enables and disables motorized control of the focus axis.
SIDXStageMoveRelativeZ
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...
SIDXStageMoveSpeedXY
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/...
SIDXStagePositionGetY
SIDXStagePositionGetY(integer SIDXstage, double coordinate, integer status)
Gets the current absolute position coordinate for the Y axis, in meters.
SIDXStageSpeedSetZ
SIDXStageSpeedSetZ(integer SIDXstage, double speed_mps, integer status)
Sets the speed for the Z axis in meters per second.
SIDXStageClose
SIDXStageClose(integer SIDXstage, integer status)
Close the stage controller.
SIDXStageAxisExistsZ
SIDXStageAxisExistsZ(integer SIDXstage, integer motorized, integer status)
Gets the motorized status of the Z axis.
SIDXStageAxisEnableXY
SIDXStageAxisEnableXY(integer SIDXstage, integer x_enable, integer y_enable, integer status)
Enables and disables motorized control of the stage axes.
SIDXStageLimitIsYPlus
SIDXStageLimitIsYPlus(integer SIDXstage, integer limit, integer status)
Gets whether the upper limit switch associated with the Y axis was set during the last successful lim...
SIDXStageMotorLimitMinus
SIDXStageMotorLimitMinus(integer SIDXstage, integer motor, integer limit, integer status)
Gets whether the lower limit switch associated with the specified motor is currently set...
SIDXStageMotorMoveStop
SIDXStageMotorMoveStop(integer SIDXstage, integer motor, integer status)
Commands the stage to stop the motor.
SIDXStageMotorBacklashGet
SIDXStageMotorBacklashGet(integer SIDXstage, integer motor, double distance, integer status)
Gets the backlash distance for the specified motor, in meters.
SIDXStageMovingIsXY
SIDXStageMovingIsXY(integer SIDXstage, integer moving, integer status)
Gets the motion status of the X and Y axes during the last successful motion query.
SIDXStageMoveSpeedZ
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...
SIDXStageMotorSpeedSet
SIDXStageMotorSpeedSet(integer SIDXstage, integer motor, double speed, integer status)
Sets the speed for the specified motor as a fraction of maximum speed.
SIDXStageRotateMirrorX
SIDXStageRotateMirrorX(integer SIDXstage, integer status)
Mirror the image in x.
SIDXStageBacklashSetXY
SIDXStageBacklashSetXY(integer SIDXstage, double distance, integer status)
Sets the backlash distance for the X and Y axes, measured in meters.
SIDXStageMotorGetName
SIDXStageMotorGetName(integer SIDXstage, integer motor, string name, integer status)
Gets the name corresponding to the specified motor number.
SIDXStageMotorBacklashExists
SIDXStageMotorBacklashExists(integer SIDXstage, integer motor, integer available, integer status)
Gets whether backlash control is available on the specified motor.
SIDXStageOriginResetXYZ
SIDXStageOriginResetXYZ(integer SIDXstage, integer status)
Sets the current position to zero on the X, Y and Z axes.
SIDXStageAccelerateGetZ
SIDXStageAccelerateGetZ(integer SIDXstage, double acceleration, integer status)
Gets the acceleration during stage movement for the Z axis as a fraction of maximum acceleration...
SIDXStageMoveRelativeXYZ
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.
SIDXStagePositionGetZ
SIDXStagePositionGetZ(integer SIDXstage, double coordinate, integer status)
Gets the current absolute position coordinate for the Z axis, in meters.
SIDXStageRotateMirrorY
SIDXStageRotateMirrorY(integer SIDXstage, integer status)
Mirror the image in y.
SIDXStageAccelerateGetLimitZ
SIDXStageAccelerateGetLimitZ(integer SIDXstage, double maximum, integer status)
Gets the maximum acceleration during stage movement for the Z axis in meters/second^2.
SIDXStageMoveRelativeXY
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...
SIDXStageResolutionGetZ
SIDXStageResolutionGetZ(integer SIDXstage, double resolution, integer status)
Gets the resolution of the Z axis in units of meters.
SIDXStageAccelerateGetLimitXY
SIDXStageAccelerateGetLimitXY(integer SIDXstage, double maximum, integer status)
Gets the maximum acceleration during stage movement for the X and Y axes in meters/second^2.
SIDXStageAccelerateSetZ
SIDXStageAccelerateSetZ(integer SIDXstage, double acceleration, integer status)
Sets the acceleration during stage movement for the Z axis as a fraction of maximum acceleration...
SIDXStageMotorLimit
SIDXStageMotorLimit(integer SIDXstage, integer motor, integer limit, integer status)
Gets whether either of the limit switches associated with the specified motor is currently set...
SIDXStageGetLastError
SIDXStageGetLastError(integer SIDXstage, string message)
The function translates the error code into a text string.
SIDXStageMovingIsZ
SIDXStageMovingIsZ(integer SIDXstage, integer moving, integer status)
Gets the motion status of the Z axis during the last successful motion query.
SIDXStageReset
SIDXStageReset(integer SIDXstage, integer status)
Commands the stage to stop all motion and reboot.
SIDXStageMovePositionZ
SIDXStageMovePositionZ(integer SIDXstage, double z_position_m, integer status)
Commands the stage to begin moving to the absolute position specified along the Z axis...
SIDXStageMotorMoveRelative
SIDXStageMotorMoveRelative(integer SIDXstage, integer motor, double offset, integer status)
Commands the stage to begin moving the specified motor the specified offset, measured in meters...
SIDXStageMotorMoveSpeed
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 maxim...
SIDXStageAccelerateSetXY
SIDXStageAccelerateSetXY(integer SIDXstage, double acceleration, integer status)
Sets the acceleration during stage movement for the X and Y axes as a fraction of maximum acceleratio...
SIDXStageBacklashGetXY
SIDXStageBacklashGetXY(integer SIDXstage, double distance, integer status)
Gets the backlash distance for the X and Y axes, measured in meters.
SIDXStageMovePositionXYZ
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.
SIDXStageMotorAccelerateSet
SIDXStageMotorAccelerateSet(integer SIDXstage, integer motor, double acceleration, integer status)
Sets the acceleration during stage movement for the specified motor as a fraction of maximum accelera...
SIDXStageJoystickSetMovementZ
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. ...
SIDXStagePositionGet
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.
SIDXStageLimitIsXPlus
SIDXStageLimitIsXPlus(integer SIDXstage, integer limit, integer status)
Gets whether the upper limit switch associated with the X axis was set during the last successful lim...
Generated on Mon Jul 20 2015 10:29:14 for SIDX 7 by   doxygen 1.8.9