_StgCalibrateXY4Points, _StgCalibrateXYAutomatic, _StgConfigXY, FindPointInPairedDocument, PI_GcsCommand, StgCalibrateXYAutomatic, StgEnableJoystickXY, StgGeneratePointsForXYOverview, StgGetInitValuesXY, StgGetPosXY, StgGetRelativeMovements, StgInitiateXY, StgMoveXY, StgMoveXYScan, StgMoveXYToRoi, StgSetRelativeMovements, StgSetTrigger, StgToggleJoystickXY, StgXY_DrawCircleAsync_Start, StgXY_DrawCircleAsync_Stop, StgXY_DrawCircleAsync_WaitAngle, StgXY_GetBlockAxis, StgXY_GetBlockAxisSupported, StgXY_GetJoystickSpeed, StgXY_GetJoystickSpeedSteps, StgXY_GetLimits, StgXY_GetMotorSpeed, StgXY_GetMotorSpeedSteps, StgXY_GetPrecision, StgXY_GetSettleTime, StgXY_GetSpeedRamp, StgXY_GetSpeedRampSteps, StgXY_GetSpeedVector, StgXY_GetStepJoystickSpeed, StgXY_GetStepMotorSpeed, StgXY_IsJoystickSpeedControllable, StgXY_IsMotorSpeedControllable, StgXY_IsPrecisionControllable, StgXY_IsPresent, StgXY_IsSettleTimeControllable, StgXY_IsSpeedRampControllable, StgXY_IsSpeedVectorControllable, StgXY_IsVirtualJoystickSupported, StgXY_MoveVirtualJoystickAtSpeed, StgXY_SetBlockAxis, StgXY_SetJoystickSpeed, StgXY_SetLimits, StgXY_SetMotorSpeed, StgXY_SetPrecision, StgXY_SetSettleTime, StgXY_SetSpeedRamp, StgXY_SetSpeedVector

PI_GcsCommand

Description 

 PI_GcsCommand(
   wchar *GCSCommand,
   char *GCSAnswer,
   int  GCSAnswerSize
);

This function enables the user to use any SDK command of the C-867 PILine Motion Controller.

Parameters

wchar *GCSCommand

SDK command.

char *GCSAnswer

Stage answer.

int GCSAnswerSize

Buffer size of the stage answer.

StgGeneratePointsForXYOverview

Description 

 StgGeneratePointsForXYOverview();

Function generates points into the XY Overview Control and overwrites the ND Multipoint experiment. Points are generated according to settings given by the Scan setup... dialog.

See Also 
StgMoveXYScan, StgMoveXYZScan

FindPointInPairedDocument

Description 

 FindPointInPairedDocument(
   double  StgX,
   double  StgY,
   int  PairDeleteAfter
);

If two images have matching XY coordinates, this function can be used to locate the position in one image inside the other one.

Parameters

double StgX

The X coordinate of the center of the circle.

double StgY

The Y coordinate of the center of the circle.

int PairDeleteAfter

The cross indication can be deleted after indicating the pair point.

0	Indication cross remains.
1	Indication cross is deleted.

StgCalibrateXYAutomatic

Description 

 StgCalibrateXYAutomatic(
   double *LpCalibrationX,
   double *Aspect,
   double *Angle
);

This function finds calibration, aspect ratio and camera angle. Calibration is fully automatic and non-interactive.

Parameters

double *LpCalibrationX

Calibration to be filled.

double *Aspect

Aspect ratio to be filled.

double *Angle

Camera angle to be filled.

Return Values

0 (LX_OK)	calibration successful
-9 (LX_ERR_FAIL)	any error during calibration (e.g. camera angle is out of range)

See Also 
_StgCalibrateXYAutomatic

StgEnableJoystickXY

Description 

 StgEnableJoystickXY(
   int  EnableJoystickXY
);

Sets XY device joystick status (enable/disable).

Parameters

int EnableJoystickXY

Joystick status (enable/disable).

TRUE	Enable joystick.
FALSE	Disable joystick.

Return Values

DR_OK (1)	Joystick status was set
DR_NOTAVAILABLE (-4)	XY device is not connected
DR_NOTAUTOMATIC (-5)	XY device is not in automatic mode
DR_NOTSUPPORTED (-3)	Joystick status is not changeable
DR_UNKNOWNERROR (-1)	Set joystick status failed

See Also 
StgXY_IsJoystickSpeedControllable

StgGetInitValuesXY

Description 

 StgGetInitValuesXY(
   int *LpInitMethodXY,
   double *LpRangeWidth,
   double *LpRangeHeight
);

Retrieves the last initialization parameters.

Parameters

int *LpInitMethodXY

Method of initialization to be filled.

double *LpRangeWidth

Stage working width [mm] to be filled.

double *LpRangeHeight

Stage working height [mm] to be filled.

Return Values

DR_OK (1)	Initialization parameters was retrieved
DR_NOTAVAILABLE (-4)	XY device is not present
DR_NOTINITIALIZED (-7)	XY device was never initialized

See Also 
StgInitiateXY

StgGetPosXY

Description 

 StgGetPosXY(
   double *LpStgX,
   double *LpStgY
);

Retrieves the current position [microns] of the XY device.

Parameters

double *LpStgX

x coordinate [µm] to be filled

double *LpStgY

y coordinate [µm] to be filled

Return Values

DR_OK (1)	Retrieved coordinates are valid
DR_NOTAVAILABLE (-4)	XY device is not connected
DR_NOTINITIALIZED (-7)	XY device is not initialized
DR_UNKNOWNERROR (-1)	Retrieving current position failed

StgGetRelativeMovements

Description 

 StgGetRelativeMovements(
   int *pXDir,
   int *pYDir,
   int *pZDir
);

This function returns relative coordinates of certain point with respect to orientation of the stage.

Parameters

int *pXDir

X coordinate of the point.

int *pYDir

Y coordinate of the point.

int *pZDir

Z coordinate of the point.

StgInitiateXY

Description 

 StgInitiateXY(
   int  InitMethodXY,
   double  RangeWidth,
   double  RangeHeight,
   int  ReturnBack,
   int  QuietMode
);

Initiate XY device.

Parameters

int InitMethodXY

Method of initialization.

0	Maximal Travel Range
1	Zero Position & Range
2	Current Position & Range

double RangeWidth

Stage travel width [microns]. Value is ignored if method is 0.

double RangeHeight

Stage travel height [microns]. Value is ignored if method is 0.

int ReturnBack

After the initialization is done, move the stage back to starting position?

0	stay at the last position
1	move to starting position

int QuietMode

Turns on/off the stage quiet mode.

0	Off.
1	On.

Return Values

DR_OK (1)	XY device was initialized
DR_BADPARAMETER (-2)	Some parameter has invalid value
DR_NOTAVAILABLE (-4)	XY device is not present
DR_NOTAUTOMATIC (-5)	XY device is not in automatic mode
DR_UNKNOWNERROR (-1)	XY device initialization failed

See Also 
StgInitiate

StgMoveXY

This function runs the Move this Point to Center command.

Description 

 StgMoveXY(
   double  x,
   double  y,
   int  relative
);

Moves XY device to specified position [microns].

Parameters

double x

x destination coordinate [microns]

double y

y destination coordinate [microns]

int relative

Movement type (absolute/relative).

0, MOVE_ABSOLUTE	Absolute movement
1, MOVE_RELATIVE	Relative movement

Return Values

DR_OK (1)	XY device moved to specified position
DR_NOTAVAILABLE (-4)	XY device is not connected
DR_NOTINITIALIZED (-7)	XY device is not initialized
DR_NOTAUTOMATIC (-5)	XY device is not in automatic mode
DR_UNKNOWNERROR (-1)	XY device move failed

See Also 
StgXY_IsMotorSpeedControllable, StgXY_IsSpeedRampControllable

StgMoveXYScan

Description 

 StgMoveXYScan(
   int  Index,
   int  relative
);

This function moves the XY stage to a position of the point set generated by the StgGeneratePointsForXYOverview function. The difference between StgMoveXY and StgMoveXYScan is that StgMoveXYScan updates the XY Overview control window - already visited points will be highlighted. Index parameter is the index of a point in a point set generated by the StgGeneratePointsForXYOverview function.

Parameters

int Index

Index number (zero-based).

int relative

Movement type (absolute/relative).

0, MOVE_ABSOLUTE	Absolute movement
1, MOVE_RELATIVE	Relative movement

See Also 
StgMoveXYZScan, StgGeneratePointsForXYOverview

StgMoveXYToRoi

Description 

 StgMoveXYToRoi(
   int  DstRoiId
);

Moves the XY stage to the center of the defined ROI.

Parameters

int DstRoiId

Destination ROI ID.

StgSetRelativeMovements

Description 

 StgSetRelativeMovements(
   int  XDir,
   int  YDir,
   int  ZDir
);

This function reverses the relative movements of XYZ stage invoked by the following functions: StgMove StgMoveXY StgMoveZ.

Parameters

int XDir

X direction.

1	Keeps the direction as if the function was not used.
-1	Reverses the direction of stage movement

int YDir

Y direction.

1	Keeps the direction as if the function was not used.
-1	Reverses the direction of stage movement

int ZDir

Z direction.

1	Keeps the direction as if the function was not used.
-1	Reverses the direction of stage movement

StgSetTrigger

Description 

 StgSetTrigger(
   int  Enabled,
   int  Axis,
   double  Position,
   double  Increment
);

This function is used to send trigger signals based on defined stage position(s) of the Physik Instrumente C867 device.

Parameters

int Enabled

0	Disabled.
1	Enabled.

int Axis

Specifies which axis is used for triggering.

0	X axis
1	Y axis

double Position

Axis position [µm] on which the device sends the first trigger signal.

double Increment

Repetitive interval [µm] measured from the first trigger position, after which the signal is triggered.

StgToggleJoystickXY

Description 

 StgToggleJoystickXY();

Switches XY device joystick status (enable->disable or disable->enable).

Return Values

DR_OK (1)	Joystick status was switched
DR_NOTAVAILABLE (-4)	XY device is not connected
DR_NOTAUTOMATIC (-5)	XY device is not in automatic mode
DR_NOTSUPPORTED (-3)	Joystick status is not changeable
DR_UNKNOWNERROR (-1)	Switch joystick status failed

See Also 
StgEnableJoystickXY

StgXY_DrawCircleAsync_Start

Description 

 StgXY_DrawCircleAsync_Start(
   double  StgX,
   double  StgY,
   double  StgRadius,
   double  StgDuration,
   double  StgTimeout
);

This function can be used in laser-cutting applications. The principle is in moving the XY stage in circles at steady pace and turning the Laser ON and OFF at a precise position so that a perfect circle is cut.

Parameters

double StgX

The X coordinate of the center of the circle.

double StgY

The Y coordinate of the center of the circle.

double StgRadius

The circle radius in micrometers.

double StgDuration

Duration of one cycle [s].

double StgTimeout

The time after which the movement is stopped [s].

StgXY_DrawCircleAsync_Stop

Description 

 StgXY_DrawCircleAsync_Stop();

This function stops the movement of the XY stage started by the StgXY_DrawCircleAsync_Start function.

StgXY_DrawCircleAsync_WaitAngle

Description 

 StgXY_DrawCircleAsync_WaitAngle(
   double  StgAngle
);

This function breaks the macro execution until the defined angle is reached by the XY stage (see StgXY_DrawCircleAsync_Start). This function shall be used in laser-cutting applications where you start and stop the cutting precisely at the same angle of the circle made by the XY stage.

Parameters

double StgAngle

The angle of rotation.

StgXY_GetBlockAxis

Description 

 StgXY_GetBlockAxis(
   int *LpBlockX,
   int *LpBlockY
);

Returns information whether the axes are blocked.

Parameters

int *LpBlockX

Pointer to information about the X axis blocking.

int *LpBlockY

Pointer to information about the Y axis blocking.

StgXY_GetBlockAxisSupported

Description 

 StgXY_GetBlockAxisSupported(
   int *LpBlockX,
   int *LpBlockY
);

Returns information whether the device supports axis blocking.

Parameters

int *LpBlockX

Pointer to information about the X axis blocking.

int *LpBlockY

Pointer to information about the Y axis blocking.

StgXY_GetJoystickSpeed

Description 

 StgXY_GetJoystickSpeed();

Returns current XY device joystick speed [microns/s]. This command should only be called if StgXY_IsJoystickSpeedControllable returns TRUE.

Return Values

Value > 0.0	Current joystick speed [microns/s]
DR_NOTAVAILABLE (-4)	XY device is not connected
DR_NOTSUPPORTED (-3)	Joystick speed is not controllable
DR_UNKNOWNERROR (-1)	Retrieving the current joystick speed failed

See Also 
StgXY_IsJoystickSpeedControllable, StgXY_GetJoystickSpeedSteps, StgXY_GetStepJoystickSpeed, StgXY_SetJoystickSpeed

StgXY_GetJoystickSpeedSteps

Description 

 StgXY_GetJoystickSpeedSteps();

Returns the number of available XY device joystick speed steps. This command should only be called if StgXY_IsJoystickSpeedControllable returns TRUE.

Return Values

Value > 0	The number of joystick speed steps
DR_NOTAVAILABLE (-4)	XY device is not connected
DR_NOTSUPPORTED (-3)	Joystick speed is not controllable
DR_UNKNOWNERROR (-1)	Retrieving the number of joystick speed steps failed

See Also 
StgXY_IsJoystickSpeedControllable, StgXY_GetStepJoystickSpeed, StgXY_SetJoystickSpeed, StgXY_GetJoystickSpeed

StgXY_GetLimits

Description 

 StgXY_GetLimits(
   double *LpMinX,
   double *LpMinY,
   double *LpMaxX,
   double *LpMaxY
);

This function retrieves the actual software limits of the XY stage.

Parameters

double *LpMinX

Minimum X (micrometers)

double *LpMinY

Minimum Y (micrometers)

double *LpMaxX

Maximum X (micrometers).

double *LpMaxY

Maximum Y (micrometers).

StgXY_GetMotorSpeed

Description 

 StgXY_GetMotorSpeed();

Returns the current XY device motor speed [microns/s]. This command should only be called if StgXY_IsMotorSpeedControllable returns TRUE.

Return Values

Value > 0.0	Current motor speed [microns/s]
DR_NOTAVAILABLE (-4)	XY device is not connected
DR_NOTSUPPORTED (-3)	Motor speed is not controllable
DR_UNKNOWNERROR (-1)	Retrieving the current motor speed failed

See Also 
StgXY_IsMotorSpeedControllable, StgXY_GetMotorSpeedSteps, StgXY_GetStepMotorSpeed, StgXY_SetMotorSpeed

StgXY_GetMotorSpeedSteps

Description 

 StgXY_GetMotorSpeedSteps();

Returns the number of available XY device motor speed steps. This command should only be called if StgXY_IsMotorSpeedControllable returns TRUE.

Return Values

Value > 0	The number of motor speed steps
DR_NOTAVAILABLE (-4)	XY device is not connected
DR_NOTSUPPORTED (-3)	Motor speed is not controllable
DR_UNKNOWNERROR (-1)	Retrieving the number of motor speed steps failed

See Also 
StgXY_IsMotorSpeedControllable, StgXY_GetStepMotorSpeed, StgXY_SetMotorSpeed, StgXY_GetMotorSpeed

StgXY_GetPrecision

Description 

 StgXY_GetPrecision();

Returns the stage precision value.

StgXY_GetSettleTime

Description 

 StgXY_GetSettleTime();

Returns the stage settle time value.

StgXY_GetSpeedRamp

Description 

 StgXY_GetSpeedRamp();

Returns current XY device speed ramp [step]. This command should only be called if StgXY_IsSpeedRampControllable returns TRUE.

Return Values

Value >= 0	Current speed ramp [step]
DR_NOTAVAILABLE (-4)	XY device is not connected
DR_NOTSUPPORTED (-3)	Speed ramp is not controllable
DR_UNKNOWNERROR (-1)	Retrieving the current speed ramp failed

See Also 
StgXY_IsSpeedRampControllable, StgXY_GetSpeedRampSteps, StgXY_SetSpeedRamp

StgXY_GetSpeedRampSteps

Description 

 StgXY_GetSpeedRampSteps();

Returns the number of available XY device speed ramp steps. This command should only be called if StgXY_IsSpeedRampControllable returns TRUE.

Return Values

Value > 0	The number of speed ramp steps
DR_NOTAVAILABLE (-4)	XY device is not connected
DR_NOTSUPPORTED (-3)	Speed ramp is not controllable
DR_UNKNOWNERROR (-1)	Retrieving the number of speed ramp steps failed

See Also 
StgXY_IsSpeedRampControllable, StgXY_SetSpeedRamp, StgXY_GetSpeedRamp

StgXY_GetSpeedVector

Description 

 StgXY_GetSpeedVector(
   double *pdSpeedX,
   double *pdSpeedY
);

Retrieves the current vector speed [µm/s] of the XY device. This command should only be called if StgXY_IsSpeedVectorControllable returns TRUE (1).

Parameters

double *pdSpeedX

double *pdSpeedY

Return Values

1, DR_OK	Retrieved values are valid
-4, DR_NOTAVAILABLE	The device is not connected
-1, DR_UNKNOWNERROR	Retrieving current speed vector failed

StgXY_GetStepJoystickSpeed

Description 

 StgXY_GetStepJoystickSpeed(
   int  step
);

Returns the XY device joystick speed [microns/s] for a given step. This command should only be called if StgXY_IsJoystickSpeedControllable returns TRUE.

Parameters

int step

The joystick speed step is number between 0 and steps-1, where steps is the number of joystick speed steps returned by

Return Values

Value > 0.0	The joystick speed [microns/s] for a given step
DR_NOTAVAILABLE (-4)	XY device is not connected
DR_NOTSUPPORTED (-3)	Joystick speed is not controllable
DR_UNKNOWNERROR (-1)	Retrieving the step joystick speed failed

See Also 
StgXY_IsJoystickSpeedControllable, StgXY_GetJoystickSpeedSteps, StgXY_SetJoystickSpeed, StgXY_GetJoystickSpeed

StgXY_GetStepMotorSpeed

Description 

 StgXY_GetStepMotorSpeed(
   int  step
);

Returns the XY device motor speed [microns/s] for a given step. This command should only be called if StgXY_IsMotorSpeedControllable returns TRUE.

Parameters

int step

The motor speed step is number between 0 and steps-1, where steps is the number of motor speed steps returned by

Return Values

Value > 0.0	The motor speed [microns/s] for a given step
DR_NOTAVAILABLE (-4)	XY device is not connected
DR_NOTSUPPORTED (-3)	Joystick speed is not controllable
DR_UNKNOWNERROR (-1)	Retrieving the step motor speed failed

See Also 
StgXY_IsMotorSpeedControllable, StgXY_GetMotorSpeedSteps, StgXY_SetMotorSpeed, StgXY_GetMotorSpeed

StgXY_IsJoystickSpeedControllable

Description 

 StgXY_IsJoystickSpeedControllable();

Detects if the joystick speed of XY device can be controlled.

Return Values

TRUE (1)	Joystick speed is controllable
FALSE (0)	Joystick speed is not controllable
DR_NOTAVAILABLE (-4)	XY device is not connected

See Also 
StgXY_GetJoystickSpeedSteps, StgXY_GetStepJoystickSpeed, StgXY_SetJoystickSpeed, StgXY_GetJoystickSpeed

StgXY_IsMotorSpeedControllable

Description 

 StgXY_IsMotorSpeedControllable();

Detects if the motor speed of XY device can be controlled.

Return Values

TRUE (1)	Motor speed is controllable
FALSE (0)	Motor speed is not controllable
DR_NOTAVAILABLE (-4)	XY device is not connected

See Also 
StgXY_GetMotorSpeedSteps, StgXY_GetStepMotorSpeed, StgXY_SetMotorSpeed, StgXY_GetMotorSpeed

StgXY_IsPrecisionControllable

Description 

 StgXY_IsPrecisionControllable();

Returns whether the precision of the stage is controllable.

StgXY_IsPresent

Description 

 StgXY_IsPresent();

Checks if a logical device of “XY” type exists and is currently connected.

Return Values

TRUE if present, FALSE if not.

StgXY_IsSettleTimeControllable

Description 

 StgXY_IsSettleTimeControllable();

Returns whether the settle time of the stage is controllable.

StgXY_IsSpeedRampControllable

Description 

 StgXY_IsSpeedRampControllable();

Detects if the speed ramp of the XY device can be controlled.

Return Values

TRUE (1)	Speed ramp is controllable
FALSE (0)	Speed ramp is not controllable
DR_NOTAVAILABLE (-4)	XY device is not connected

See Also 
StgXY_GetSpeedRampSteps, StgXY_SetSpeedRamp, StgXY_GetSpeedRamp

StgXY_IsSpeedVectorControllable

Description 

 StgXY_IsSpeedVectorControllable();

This function tests whether the speed vector control functionality is supported by the current XY stage.

Return Values

The functions returns TRUE (1) if speed vector control currently supported, otherwise FALSE (0).

StgXY_IsVirtualJoystickSupported

Description 

 StgXY_IsVirtualJoystickSupported();

This function tests whether the virtual joystick functionality is supported by the current XY stage.

StgXY_MoveVirtualJoystickAtSpeed

Description 

 StgXY_MoveVirtualJoystickAtSpeed(
   double  MotorSpeedX,
   double  MotorSpeedY
);

This function moves the active XY stage according to the defined vector.

Parameters

double MotorSpeedX

Speed in the X axis direction [micron/s]

double MotorSpeedY

Speed in the Y axis direction [micron/s]

Note

This function moves the stage continuously. The direction and the speed can be changed by calling it again with modified parameters. The movement can be stopped by giving the function a zero vector - StgXY_MoveVirtualJoystickAtSpeed(0.000,0.000);.

StgXY_SetBlockAxis

Description 

 StgXY_SetBlockAxis(
   int  BlockX,
   int  BlockY
);

Sets which stage axes will be blocked.

Parameters

int BlockX

0	X axis will not be blocked
1	X axis will be blocked

int BlockY

0	Y axis will not be blocked
1	Y axis will be blocked

StgXY_SetJoystickSpeed

Description 

int StgXY_SetJoystickSpeed(
   double  speed
);

Sets the XY device joystick speed [µm/s]. If the speed is not valid, the closest valid speed will be chosen. This command should only be called if StgXY_IsJoystickSpeedControllable returns TRUE (1).

Parameters

double speed

The joystick speed [µm/s] should be number returned by StgXY_GetStepJoystickSpeed.

Return Values

int

1, DR_OK	Joystick speed was successfully set
-4, DR_NOTAVAILABLE	XY device is not connected
-3, DR_NOTSUPPORTED	Joystick speed is not controllable
-1, DR_UNKNOWNERROR	Setting the joystick speed failed

See Also 
StgXY_IsJoystickSpeedControllable, StgXY_GetJoystickSpeedSteps, StgXY_GetStepJoystickSpeed, StgXY_GetJoystickSpeed

StgXY_SetLimits

Description 

 StgXY_SetLimits(
   double  MinX,
   double  MinY,
   double  MaxX,
   double  MaxY
);

This function sets up the Software limits of the XY stage. It works with Ni and Ti microscopes. If the function succeeds, it returns a boolean type.

Parameters

double MinX

Minimum X (micrometers)

double MinY

Minimum Y (micrometers)

double MaxX

Maximum X (micrometers)

double MaxY

Maximum Y (micrometers)

StgXY_SetMotorSpeed

Description 

 StgXY_SetMotorSpeed(
   double  speed
);

Sets the XY device motor speed [microns/s]. If the speed is not valid, the closest valid speed will be chosen. This command should only be called if StgXY_IsMotorSpeedControllable returns TRUE.

Parameters

double speed

The motor speed [microns/s] should be number returned by

Return Values

DR_OK (1)	Motor speed was successfully set
DR_NOTAVAILABLE (-4)	XY device is not connected
DR_NOTSUPPORTED (-3)	Motor speed is not controllable
DR_UNKNOWNERROR (-1)	Setting the motor speed failed

See Also 
StgXY_IsMotorSpeedControllable, StgXY_GetMotorSpeedSteps, StgXY_GetStepMotorSpeed, StgXY_GetMotorSpeed

StgXY_SetPrecision

Description 

 StgXY_SetPrecision(
   double  PrecisionXY
);

Precision of the stage.

Parameters

double PrecisionXY

Stage precision [µm].

StgXY_SetSettleTime

Description 

 StgXY_SetSettleTime(
   double  SettleTimeXY
);

Settle time after the finished stage movement.

Parameters

double SettleTimeXY

Stage settle time [ms].

StgXY_SetSpeedRamp

Description 

 StgXY_SetSpeedRamp(
   int  step
);

Sets the XY device speed ramp [step]. This command should only be called if StgXY_IsSpeedRampControllable returns TRUE.

Parameters

int step

The speed ramp [step] is number between 0 and steps-1, where steps is the number of speed ramp steps returned by

Return Values

DR_OK (1)	Speed ramp was successfully set
DR_NOTAVAILABLE (-4)	XY device is not connected
DR_NOTSUPPORTED (-3)	Speed ramp is not controllable
DR_UNKNOWNERROR (-1)	Setting the speed ramp failed

See Also 
StgXY_IsSpeedRampControllable, StgXY_GetSpeedRampSteps, StgXY_GetSpeedRamp

StgXY_SetSpeedVector

Description 

 StgXY_SetSpeedVector(
   double  MotorSpeedX,
   double  MotorSpeedY
);

This function sets vector speed [µm/s] for the XY device. This command should only be called if StgXY_IsSpeedVectorControllable returns TRUE (1).

Parameters

double MotorSpeedX

Speed in the X axis direction [micron/s]

double MotorSpeedY

Speed in the Y axis direction [micron/s]

Return Values

1, DR_OK	Retrieved values are valid
-4, DR_NOTAVAILABLE	The device is not connected
-1, DR_UNKNOWNERROR	Retrieving current speed vector failed

_StgCalibrateXY4Points

Description 

 _StgCalibrateXY4Points(
   double *LpCalibrationX,
   double *LpAspect,
   double *Angle
);

This function finds calibration, aspect ratio and camera angle. Calibration requires user interaction.

Parameters

double *LpCalibrationX

Calibration to be filled.

double *LpAspect

Aspect ratio of the image.

double *Angle

Camera angle to be filled.

See Also 
_StgCalibrateXYAutomatic

_StgCalibrateXYAutomatic

Description 

 _StgCalibrateXYAutomatic(
   double *LpCalibrationX,
   double *LpAspect,
   double *Angle
);

This function finds calibration, aspect ratio and camera angle. Calibration is fully automatic.

Parameters

double *LpCalibrationX

Calibration to be filled.

double *LpAspect

Aspect ratio of the image.

double *Angle

Camera angle to be filled.

See Also 
StgCalibrateXYAutomatic, _StgCalibrateXY4Points

_StgConfigXY

Description 

 _StgConfigXY();

Displays a dialog box allowing the user to configure XY device parameters.

Return Values

DR_OK (1)	Dialog was shown and XY device was configured
DR_NOTAVAILABLE (-4)	XY device is not present
DR_NOTSUPPORTED (-3)	XY device is not configurable
DR_UNKNOWNERROR (-1)	XY device configuration failed