Isomet Modular Synthesiser (iMS) API
v1.4.2
iMS API
|
Sets the parameters required to control the operation of the Encoder Input / Velocity Compensation function. More...
#include <SignalPath.h>
Public Member Functions | |
void | SetVelGain (const IMSSystem &ims, SignalPath::ENCODER_CHANNEL chan, kHz EncoderFreq, MHz DesiredFreqDeviation, bool Reverse=false) |
Sets the amount of frequency deviation gain applied to velocity measurement. More... | |
Public Attributes | |
SignalPath::ENCODER_MODE | EncoderMode { SignalPath::ENCODER_MODE::QUADRATURE } |
Sets the type of encoder signal connected to the Synthesiser inputs. | |
SignalPath::VELOCITY_MODE | VelocityMode { SignalPath::VELOCITY_MODE::FAST } |
Sets the velocity calculation method used in the tracking filter for frequency compensation. | |
std::uint16_t | TrackingLoopProportionCoeff { 4000 } |
The Proportion Coefficient (0 - 65535) used in the Tracking Loop Filter. | |
std::uint16_t | TrackingLoopIntegrationCoeff { 10000 } |
The Integration Coefficient (0 - 65535) used in the Tracking Loop Filter. | |
std::array< std::int16_t, 2 > | VelocityGain |
Controls the extent to which a given value of velocity causes a deviation in synthesiser frequency. Do not set manually, use SetVelGain. | |
Sets the parameters required to control the operation of the Encoder Input / Velocity Compensation function.
Holds parameters for the Encoder type (Quadrature or Clk/Dir), Velocity Estimation method, tracking loop filter parameters and overall output gain - being the amount of deviation applied to the RF frequency generation for a given encoder velocity. Also contains a method for calculating the value of the gain parameter for a desired frequency deviation at a given encoder velocity.
void iMS::VelocityConfiguration::SetVelGain | ( | const IMSSystem & | ims, |
SignalPath::ENCODER_CHANNEL | chan, | ||
kHz | EncoderFreq, | ||
MHz | DesiredFreqDeviation, | ||
bool | Reverse = false |
||
) |
Sets the amount of frequency deviation gain applied to velocity measurement.
Use this function to set the encoder channel gain according to the amount of desired frequency offset (deviation) at a chosen spot encoder angular frequency.
[in] | ims | a const reference to the IMSSystem in use |
[in] | chan | Which channel (X or Y) to set the encoder gain for |
[in] | EncoderFreq | The encoder tick frequency for which we shall define the gain |
[in] | DesiredFreqDeviation | The amount of change to the RF Frequency that shall be offset when the encoder is operating at the specified velocity |
[in] | Reverse | Causes the RF frequency deviation to effect in the opposite direction |