Newport XPS-D - Positionercompensationphasecorrectionfilterget

XPS Unified Programmer’s Manual
7.2.1.183 PositionerCompensationPhaseCorrectionFilterGet
Name
PositionerCompensationPhaseCorrectionFilterGet – Gets the phase correction filter
parameters.
Input tests
- Refer to section 7.1: “Input Tests Common to all XPS Functions”.
- Checks the object type of this command is valid: (-8)
- Checks phase correction number: (-17)
- Checks the positioner name: (-18)
Description
This function returns the system compensation parameters defined for selected phase
correction filter.
Phase correction filter parameters:
- PhaseCorrectionFn.
- PhaseCorrectionFd.
- PhaseCorrectionGain.
Prototype
int PositionerCompensationPhaseCorrectionFilterGet(
int SocketID,
char * PositionerName,
int PhaseCorrectionFilterNumber,
double * PhaseCorrectionFn,
double * PhaseCorrectionFd,
double * PhaseCorrectionGain
)
Input parameters
SocketID int Socket identifier gets by the
“TCP_ConnectToServer” function.
PositionerName char * Positioner name.
PhaseCorrectionFilterNumber int Number of the selected Notch Frequency
filter.
Output parameters
PhaseCorrectionFn double * Frequency (Hertz) for notch filter.
PhaseCorrectionFd double * Band width (Hertz) for notch filter.
PhaseCorrectionGain double * Gain for notch filter.
281 EDH0373En1023 — 01/18