Positionercompensatedpcoprepare - Newport XPS Programmer's Manual

XPS Unified
EDH0373En1023 — 01/18
7.2.1.163

PositionerCompensatedPCOPrepare

Name
PositionerCompensatedPCOPrepare – Prepares data for CIE08 compensated PCO
pulses generation.
Input tests
- Refer to section 7.1: "Input Tests Common to all XPS Functions".
- Checks the positioner name: (-18)
- Checks the positioner type: (-8)
- Checks the position encoder ("AquadB" or "AnalogInterpolated"): (-24)
- Checks the CIE board supports this function: (-115)
- Checks CIE08CompensatedPCOMode = Enabled (system.ini):
ERR_NOT_ALLOWED_MODE_DISABLED (-121)
- Checks data have been set, loaded or read from file to buffer (DataNumber must > 0
and < CIE08CompensatedPCOMaximumDataNumber (system.ini)):
ERR_CHECK_DATA_INCORRECT (-122)
- Checks scanning zone exceed stage travel limits: (-35)
- Checks input parameter values (ScanDirection value must equal to 1 (positive
direction) or -1 (negative direction)): (-17)
Description
This function calculates the firing for absolute positions, in user's coordinate system
and converts them to firing absolute raw PCO positions, in encoder's coordinate
system.
When mappings are enabled, the correction between user's coordinate system position
and raw encoder position will be different at each location. For this reason, the prepare
function must know the location (positions of all positioners in the scanning group)
where the scan will be done.
This function must be called before the use of PositionerCompensatedPCOEnable()
function.
Parameters :
• ScanDirection: Scan direction,(value: 1 (positive) or -1 (negative)).
• StartPosition1: Group 1
• StartPosition2: Group 2
• StartPosition3: Group 3
• ...... etc ......
The function works only when the CIE08 compensated PCO mode configuration is
enabled (system.ini: CIE08CompensatedPCOMode = Enabled)..
This function can be used only with a position encoder ("AquadB" or
"AnalogInterpolated"), otherwise (-24) error is returned.
st positioner start position.
nd positioner start position
rd positioner start position
NOTE
248
Programmer's Manual