FilterCoeffGet() [1/2]

double FilterCoeffGet ( RSIFilterGainPIDCoeff  coeff, int32  gainTable  )

pure virtual

Get value for a filter coefficient (ex: Kp, Ki, Kd, etc).

Description:

FilterCoeffGet returns a filter coefficient such as Kp, Ki, Kd etc.

Parameters

coeff	Use a value in RSIFilterGainPIDCoeff or RSIFilterGainPIVCoeff.
gainTable	An index, 0-4.

Returns

(double) Value of the coefficient.

Sample Code:

int32 coeff = (int32) RSIFilterGainPIDCoeff.RSIFilterGainPIDCoeffOUTPUT_OFFSET;
int32 gainTable = 0;

Console.WriteLine("Output Offset coefficient %lf in Gain Table %ld\n" +  
                   axis.FilterCoeffGet(coeff, gainTable));  

RapidSetup:

Go to axis screen->Tuning Parameters. Available filter coefficents are shown in image below.

See also

FilterCoeffSet, RSIFilterGainPIDCoeff, RSIFilterGainPIVCoeff

Examples

UserLimitGainChangeBasedOnPosition.cpp.