Newport XPS-D - Positionercompensationencodernotchfilterget

XPS Unified Programmer’s Manual
7.2.1.173 PositionerCompensationEncoderNotchFilterGet
Name
PositionerCompensationEncoderNotchFilterGet – Gets Encoder compensation notch
filter parameters.
Input tests
- Refer to section 7.1: “Input Tests Common to all XPS Functions”.
- Checks parameter values: (-17)
- Notch Frequency number
Description
This function returns parameters defined for the [Dual]EncoderFilter frequency notch
filter from the encoder compensation (F4 compensation block) configured in encoder.
Encoder Notch filters parameters:
• NotchFrequency (Hertz).
• NotchBandwidth (Hertz).
• NotchGain.
Prototype
int PositionerCompensationEncoderNotchFilterGet(
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 (1
to 5).
Output parameters
NotchFrequency double * Frequency (Hertz) for Encoder Notch filter.
NotchBandwith double * Band width (Hertz) for Encoder Notch filter.
NotchGain double * Gain for Encoder Notch filter.
Encoder
Mapping
F4
Raw
Encoder Position
Corrected
Encoder Position
Filtered Corrected
Encoder Position
EDH0373En1023 — 01/18 264