XPS Unified Programmer’s Manual
7.2.1.184 PositionerCompensationPhaseCorrectionFilterSet
Name
PositionerCompensationPhaseCorrectionFilterSet – Sets the notch 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
• PhaseCorrectionFd
• PhaseCorrectionGain ≥0
- Checks the positioner name: (-18)
- Checks the motion status (Motion status must be disable): (-134)
Description
This function configures the parameters defined for the selected phase correction filter.
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 PositionerCompensationPhaseCorrectionFilterSet(
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.
PhaseCorrectionFn double Frequency (Hertz) for notch filter.
PhaseCorrectionFd double Band width (Hertz) for notch filter.
PhaseCorrectionGain double Gain for notch filter.