The IScanCtrl interface is an interactive scanner control interface. It can be used to
manually position and iteratively advance the scanner head. The function is also usable on scanners
with attached camera to position it to a choosen angle before taking a picture.
The GetPosition function as opposed to the others is strictly synchronous, so you need to take
extra care not to lock up your interface thread. This function has a uTimeout parameter
that will set the time you expect the command to finish. The function will return with an error
when the timeout has expired.
Before you can use this interface you will need to call the Open function
of the generic interface as usual.
Move [IScanCtrl]
- SYNOPSIS
- Move( double dSpeedTheta, double dSpeedPhi);
- MESSAGES
-
- SCFN_MOVE signals the success of the operation.
- PARAMETERS
- dSpeedTheta
- Desired speed for the vertical movement. [deg/s]
-
- dSpeedPhi
- Desired speed for horizontal movement. [deg/sec]
-
- REMARKS
- This function can be used to manually position the scanner head. You supply the speed of desired motion.
The sign chooses the direction and the value 0 is used to stop the motion. Arrange to be able to visually
control the acual movement of the scanner head.
Not all scanner models are able to move in vertical direction. Setting a speed is silently ignored for
such instruments.
-
- SEE ALSO
- none
Align [IScanCtrl]
- SYNOPSIS
- Align( double dTheta, double dPhi);
- MESSAGES
-
- SCFN_ALIGN signals the success of the operation.
- PARAMETERS
- dTheta
- Desired vertical position. [deg]
-
- dPhi
- Desired horizontal position. [deg]
-
- REMARKS
- Use this function to position the scanner. Note that this has nothing to do with normal scan behaviour.
You might use this function to prepare the scanner for taking photographs with an attached camera,
or move it to a parking position.
Not all scanner models are able to align in vertical direction. Setting a value is silently ignored for
such instruments.
-
- SEE ALSO
- none
- SYNOPSIS
- GetPosition( double* pdTheta, double* pdPhi);
- PARAMETERS
- pdTheta
- A pointer to a double that will receive the current vertical position.
-
- pdPhi
- A pointer to a double that will receive the current horizontal position.
-
- REMARKS
- Use this function to read the current position of the scanner head. This is also recommended in case you
have used the Align function to prepare for a photograph. Since the readout is more accurate than the
positioning, you will increase precision by using the information from this function.
Please bear in mind, that this function is a synchronous function and will either return on succes or
timeout. You have to be prepared to handle an error situation in the latter case.
-
- SEE ALSO
- none
Park [IScanCtrl2]
- SYNOPSIS
- Park();
- MESSAGES
-
- SCFN_PARK signals the success of the operation.
- PARAMETERS
- n.a.
- REMARKS
- Use this function to park the scanner.
Not all scanner models are able to perform this operation. You will receive an error for
such instruments.
-
- SEE ALSO
- none