Positionercompensationdualloopphasecorrectionfilterset - Newport XPS Programmer's Manual

XPS Unified
EDH0373En1023 — 01/18
7.2.1.172

PositionerCompensationDualLoopPhaseCorrectionFilterSet

Name
PositionerCompensationDualLoopPhaseCorrectionFilterSet – Sets the notch mode
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 input parameters value: (-17)
• PhaseCorrectionFn with CorrectorPeriod = 0.0001 s (10 kHz) = >
• PhaseCorrectionFd with CorrectorPeriod = 0.0001 s (10 kHz) = >
• PhaseCorrectionGain ≥0
- Checks the positioner name: (-18)
Description
This function configures the parameters defined for the selected phase correction filter
in dual loop. If the "PhaseCorrectionFn" value = 0 or the "PhaseCorrectionFd"
value = 0 then the phase correction filter is not activated.
Phase correction filter parameters:
- PhaseCorrectionFn.
- PhaseCorrectionFd.
- PhaseCorrectionGain.
Prototype
int PositionerCompensationDualLoopNotchFilterSet(
int SocketID,
char * PositionerName,
int PhaseCorrectionFilterNumber,
double PhaseCorrectionFn,
double PhaseCorrectionFd,
double PhaseCorrectionGain
)
Input parameters
SocketID
PositionerName
PhaseCorrectionFilterNumber
PhaseCorrectionFn
PhaseCorrectionFd
PhaseCorrectionGain
int Socket identifier gets by the
"TCP_ConnectToServer" function.
char * Positioner name.
int Number of the selected selected phase
correction filter.
double Numerator frequency (Hertz) for phase
correction filter.
double Denominator frequency (Hertz) for phase
correction filter.
double Gain for phase correction filter.
262
Programmer's Manual
[ ]
0 : 5000
[ ]
0 : 5000