Isomet Modular Synthesiser (iMS) API  v1.4.2
iMS API
Public Member Functions | Public Attributes | List of all members
iMS::VelocityConfiguration Struct Reference

Sets the parameters required to control the operation of the Encoder Input / Velocity Compensation function. More...

#include <SignalPath.h>

Collaboration diagram for iMS::VelocityConfiguration:
Collaboration graph
[legend]

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.
 

Detailed Description

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.

Since
1.4

Member Function Documentation

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.

Parameters
[in]imsa const reference to the IMSSystem in use
[in]chanWhich channel (X or Y) to set the encoder gain for
[in]EncoderFreqThe encoder tick frequency for which we shall define the gain
[in]DesiredFreqDeviationThe amount of change to the RF Frequency that shall be offset when the encoder is operating at the specified velocity
[in]ReverseCauses the RF frequency deviation to effect in the opposite direction

The documentation for this struct was generated from the following file: