Positionercompensationencodernotchfilterget - Newport XPS Programmer's Manual

XPS Unified
EDH0373En1023 — 01/18
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.
Raw
Encoder Position
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
PositionerName
NotchFrequencyNumber
Output parameters
NotchFrequency
NotchBandwith
NotchGain
Corrected
Encoder
Mapping
Encoder Position
int Socket identifier gets by the
TCP_ConnectToServer" function.
char * Positioner name.
int Number of the selected Notch Frequency filter (1
to 5).
double * Frequency (Hertz) for Encoder Notch filter.
double * Band width (Hertz) for Encoder Notch filter.
double * Gain for Encoder Notch filter.
264
Programmer's Manual
Filtered Corrected
F4
Encoder Position