CIFER®-MATLAB Interfaces: Development and ... - Cal Poly

Appendix E: Online Help for Analysis Utilities
This Appendix contains the information that is displayed when the ‘help functionname’ command
is used in MATLAB.
Function: cifrms
Description: This mex file allows the user to use the RMS
utility of CIFER. Function returns mean square value
and root mean squared value as well as information about
the frequency response if desired.
[msv,rms,npts,lowfreq,highfreq,rmsfrq] = cifrms(in, varargin)
Inputs:
in
- input structure, fields defined below.
Information on the details of the structure can
be found with an empty call:
>> cifrms
options - name-value pairs to set individual data
fields (optional) e.g.: ...,'io','I',...
Outputs:
rms
- optional output allows user to set up a template
structure using this call with no inputs:
>> out = cifrms
*** OR ***
rms - root mean squared value
msv - Mean square value (or full range RMS if
percentage of range is specified)
npts - number of points in response
lowfreq - smallest value in response
highfreq - highest value in response
rmsfrq - frequency where RMS is desired fraction of
full RMS value
NOTES:
This function can run with no outputs specified; the results
will be displayed in the Matlab command window.
---------------------------------------------------------------
DESCRIPTION OF FIELDS IN INPUT STRUCTURE
in.name
in.source
in.io
in.spower
in.minfreq
in.maxfreq
- Name of Frequency Response (string)
ex: name = 'XVLATSWP_FRE_A0000_AIL_P'
- Source: 'F' for file, 'D' for database
- 'I' to integrate input-auto, 'O' for output-auto
- value for power of s correction, positive or
negative integer (0 for none)
- start frequency for calculations (0 for default)
- end frequency for calculations (0 for default)
NOTE: set minfreq equal to maxfreq for a fraction of the
full range RMS.
in.toscrn
- turn printed screen output 'ON' or 'OFF'
90