Constructors:
AvAPI_Actuator(fdva, mag, phase)
Swept sine Constructor
Returns: Object pointer
Parameters:
char fdva - type of actuator [‘F’, ‘D’, ‘V’, ‘A’]
F = Force
D = Displacement
V = Velocity
A = Acceleration
double mag - magnitude of sine
double phase - phase of sine
AvAPI_Actuator(isForce, isLeading, mass, offset, dnormal)
Rotating mass Constructor
Returns: Object pointer
Parameters:
bool isForce - true for force; false for moment
bool isLeading- true for leading; false for lagging
double mass - mass of rotation
double offset - radial distance to the imbalance
double dnormal - perpendicular distance to the plane (moment only)
AvAPI_Actuator(fdva, ufunc, data)
User function Constructor
Returns: Object pointer
Parameters:
char fdva - type of actuator [‘F’, ’D’, ‘V’, ‘A’]
F = Force
D = Displacement
V = Velocity
A = Acceleration
string ufunc - name of the user function must be in the global dictionary
complex ufunc(data , w)
Returns: complex f(w) actuator value at w
Parameters:
list data - user data given when actuator was constructed
double w - frequency of evaluation
list data - user data to be returned when ufunc is called
AvAPI_Actuator(fdva, ufunc, data, crossList)
PSD Constructor
Returns: Object pointer
Parameters:
char fdva - type of actuator [‘F’, ‘D’, ‘V’, ‘A’]
F = Force
D = Displacement
V = Velocity
A = Acceleration
string ufunc - name of the user function must be in the global dictionary
complex ufunc(data , w)
Returns: complex f(w) actuator value at w
Parameters:
list data - user data given when actuator was constructed
double w - frequency of evaluation
list data - user data to be returned when ufunc is called
list crossList - list of cross correlation actuators
Public Methods:
AvAPI_Matrix Evaluate(Omega)
Actuator evaluation multiple frequencies
Returns:AvAPI_Matrix - vector of complex values
Parameters:
AvAPI_MatrixOmega - Vector of frequencies to evaluate at
AvAPI_Complex Evaluate(Omega)
Actuator evaluation single frequency
Returns:AvAPI_Complex - complex value
Parameters:
doubleOmega - Frequency of evaluation
char DVAType(void)
Type of actuator
Returns: char [‘F’, ‘D’, ‘V’, ‘A’]
F = Force
D = Displacement
V = Velocity
A = Acceleration
Parameters: None
boolPSD(void)
PSD type actuator
Returns: bool True if PSD actuator False otherwise
Parameters: None
AvAPI_Actuator CrossActuator(iIC)
Get the cross correlation actuator for given input channel
Returns: AvAPI_Actuator cross correlation actuator
Parameters: int iic input channel index
bool HasCrossActuator(int iic)
Determine if cross correlation actuator exists
Returns: bool True if the given input channel has a cross correlation actuator False otherwise
Parameters:
int iic input channel index.
If iic is less than zero the function returns True if any input channel has a cross correlation actuator.