Positionercompensationdualloopnotchfilterset - Newport XPS Programmer's Manual

XPS Unified
EDH0373En1023 — 01/18
7.2.1.170

PositionerCompensationDualLoopNotchFilterSet

Name
PositionerCompensationDualLoopNotchFilterSet – 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)
• NotchFrequency
(10 kHz) = >
• NotchBandwidth with CorrectorPeriod = 0.0001 s (10 kHz) = >
• NotchGain
- Checks the positioner name: (-18)
Description
This function configures the parameters defined for selected notch filter in dual loop. If
the "NotchFrequency" value is NULL or the "NotchGain" value is NULL then the
notch filter is not activated.
Notch filters parameters:
- NotchFrequency.
- NotchBandwidth.
- NotchGain.
Prototype
int PositionerCompensationDualLoopNotchFilterSet(
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.
258
Programmer's Manual
with CorrectorPeriod = 0.0001 s