Positionercompensatedfastpcoprepare - Newport XPS Programmer's Manual

XPS Unified
EDH0373En1023 — 01/18
7.2.1.153

PositionerCompensatedFastPCOPrepare

Name
PositionerCompensatedFastPCOPrepare – Prepares data for CIEFast compensated
PCO pulses generation.
Input tests
- Refer to section 7.1: "Input Tests Common to all XPS Functions".
- Checks direction value: (-17)
- Checks the positioner name: (-18)
- Checks if first and last PCO positions are within positions limits: (-35)
- Checks if CIEFAST compensated PCO pulses generation is enabled: (-121)
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. It will use the supplied start positions and the offset positions set with
PositionerCompensatedFastPCOSet() or PositionerCompensatedFastPCOFromFile()
or PositionerCompensatedFastPCOLoadToMemory() function.
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
PositionerCompensatedFastPCOEnable() function.
Parameters:
• ScanDirection: Scan direction,(value: 1 (positive) or -1 (negative)).
• StartPosition1: Group 1
• StartPosition2: Group 2
• StartPosition3: Group 3
• ...... etc ......
Prototype
int PositionerCompensatedFastPCOPrepare(
int SocketID,
char * PositionerName
int ScanDirection,
double StartPosition1,
double StartPosition2,
double StartPosition3,
...
)
positioner start position
st
positioner start position
nd
positioner start position
rd
232
Programmer's Manual