Positionercompensationprefeedforwardfrequencynotchfilterset - Newport XPS Programmer's Manual

XPS Unified
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
PositionerName
NotchFrequencyNumber
NotchFrequency
NotchBandwith
NotchGain
int Socket identifier gets by the
"TCP_ConnectToServer" function.
char * Positioner name.
int Number of the selected Notch Frequency filter.
double Frequency (Hertz) for notch filter.
double Band width (Hertz) for notch filter.
double Gain for notch filter.
305
Programmer's Manual
[ ]
0 : 5000
[ ]
0 : 5000
EDH0373En1023 — 01/18