XPS Unified Programmer’s Manual
7.2.1.198 PositionerCompensationPreFeedForwardFrequencyNotchFilterSet
Name
PositionerCompensationPreFeedForwardFrequencyNotchFilterSet – 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)
• NotchFrequency with CorrectorPeriod = 0.0001 s (10 kHz) = >
• NotchBandwidth with CorrectorPeriod = 0.0001 s (10 kHz) = >
• NotchGain
- Checks the positioner name: (-18)
- Checks compensation preFeed forward mode is enabled: (-24)
- Checks the motion status (Motion status must be disable): (-134)
Description
This function configures the parameters defined for selected notch filter. If the
“NotchFrequency” value is NULL or the “NotchGain” value is NULL then the notch
filter is not activated.
Notch filters parameters:
• UserNotchFrequency.
• UserNotchBandwidth.
• UserNotchGain.
Prototype
int PositionerCompensationPreFeedForwardFrequencyNotchFilterSet(
int SocketID,
char * PositionerName,
int NotchFrequencyNumber,
double NotchFrequency,
double NotchBandwith,
double NotchGain
)
Input parameters
SocketID int Socket identifier gets by the
“TCP_ConnectToServer” function.
PositionerName char * Positioner name.
NotchFrequencyNumber int Number of the selected Notch Frequency filter.
NotchFrequency double Frequency (Hertz) for notch filter.
NotchBandwith double Band width (Hertz) for notch filter.
NotchGain double Gain for notch filter.