 |
reset filter specifies if the octave filters have to be reset. The default is FALSE.
The filters are automatically reset the first time this VI is called.
|
|
restart averaging specifies if the selected averaging process has to be restarted. The default is FALSE. When you call this VI for the first time, the averaging process restarts automatically.
|
 |
scaled signal [EU] specifies the scaled signal expressed in the selected engineering units. To obtain a properly scaled signal, you can use the SVL Scale Voltage to EU VI or define a virtual channel in National Instruments Measurement & Automation Explorer (MAX).
 |
t0 is the start time of the waveform.
|
 |
dt is the time interval in seconds between data points in the waveform.
|
 |
Y contains the data values of the waveform.
|
|
 |
frequency range specifies the low and high frequencies of the octave analysis.
 |
low band specifies the center frequency of the lowest octave band. The values for low band range from 16 Hz to 16000 Hz.
|
|
high band specifies the center frequency of the highest octave band. The values for high band range from 16 Hz to 16000 Hz.
|
|
|
dB On specifies if results are expressed in decibels. The default is TRUE. The dB reference is specified when the scaling from voltage to engineering units is applied.
|
 |
error in describes error conditions that occur before this VI or function runs.
The default is no error. If an error occurred before this VI or function runs, the VI or function passes the error in value to error out. This VI or function runs normally only if no error occurred before this VI or function runs. If an error occurs while this VI or function runs, it runs normally and sets its own error status in error out. Use the Simple Error Handler or General Error Handler VIs to display the description of the error code. Use exception control to treat what is normally an error as no error or to treat a warning as an error. Use error in and error out to check errors and to specify execution order by wiring error out from one node to error in of the next node.
|
status is TRUE (X) if an error occurred before this VI or function ran or FALSE (checkmark) to indicate a warning or that no error occurred before this VI or function ran. The default is FALSE.
|
 |
code is the error or warning code. The default is 0.
If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code.
|
 |
source specifies the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning. The default is an empty string.
|
|
|
averaging type specifies the type of averaging that is applied to the result of the 1/n octave filtering.
Exponential uses specific parameters defined in exp avg settings. Equal confidence uses specific parameters defined in equal confidence level [dB].
| 0 | Linear (default) | | 1 | Exponential | | 2 | Equal confidence | | 3 | Peak |
|
|
exp avg settings specifies how the exponential averaging is performed.
|
mode specifies the exponential averaging mode.
The Custom mode allows you to specify any time constant [ms].
| 0 | Slow t= 1 s | | 1 | Fast (default) t= 125 ms | | 2 | Impulse t= 35 ms rising and 1.5 s falling | | 3 | Custom |
|
|
time constant specifies the time constant in milliseconds used for exponential averaging if exponential mode is set to Custom. In all other cases, this parameter is ignored.
|
|
|
equal confidence level [dB] specifies the confidence value in decibels used if averaging type is set to Equal confidence.
|
 |
filter settled returns TRUE when all octave filters are settled.
|
 |
octave spectrum returns the octave spectrum in band power versus nominal frequencies.
You can display the results in an Octave Graph or a Multiplot Octave Graph indicator.
 |
nominal frequencies [Hz] returns the nominal, or preferred, frequencies as opposed to the exact frequencies associated with each 1/n octave band.
|
|
band power returns, in decibels, the band power associated with each 1/n octave band, if dB On is TRUE.
|
|
 |
unit label returns the selected engineering units.
|
 |
total band power returns the sum of the power, in decibels, contained in all the octave bands.
|
|
octave info contains octave information needed by the Octave Extended Measurements VIs and the waterfall display for octave VIs.
|
 |
error out contains error information. If error in indicates that an error occurred before this VI or function ran, error out contains the same error information. Otherwise, it describes the error status that this VI or function produces.
Right-click the error out front panel indicator and select Explain Error from the shortcut menu for more information about the error.
|
status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred.
|
 |
code is the error or warning code.
If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code.
|
|
source describes the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning.
|
|
|
reset filter specifies if the octave filters have to be reset. The default is FALSE.
The filters are automatically reset the first time this VI is called.
|
|
restart averaging specifies if the selected averaging process has to be restarted. The default is FALSE. When you call this VI for the first time, the averaging process restarts automatically.
|
 |
scaled signals [EU] specifies the scaled signals expressed in the selected engineering units. To obtain a properly scaled signal, you can use the SVL Scale Voltage to EU VI or define virtual channels in National Instruments Measurement & Automation Explorer (MAX).
|
|
frequency range specifies the low and high frequencies of the octave analysis.
|
low band specifies the center frequency of the lowest octave band. The values for low band range from 16 Hz to 16000 Hz.
|
|
high band specifies the center frequency of the highest octave band. The values for high band range from 16 Hz to 16000 Hz.
|
|
|
dB On specifies if results are expressed in decibels. The default is TRUE. The dB reference is specified when the scaling from voltage to engineering units is applied.
|
|
error in describes error conditions that occur before this VI or function runs.
The default is no error. If an error occurred before this VI or function runs, the VI or function passes the error in value to error out. This VI or function runs normally only if no error occurred before this VI or function runs. If an error occurs while this VI or function runs, it runs normally and sets its own error status in error out. Use the Simple Error Handler or General Error Handler VIs to display the description of the error code. Use exception control to treat what is normally an error as no error or to treat a warning as an error. Use error in and error out to check errors and to specify execution order by wiring error out from one node to error in of the next node.
|
status is TRUE (X) if an error occurred before this VI or function ran or FALSE (checkmark) to indicate a warning or that no error occurred before this VI or function ran. The default is FALSE.
|
|
code is the error or warning code. The default is 0.
If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code.
|
|
source specifies the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning. The default is an empty string.
|
|
|
averaging type specifies the type of averaging that is applied to the result of the 1/n octave filtering.
Exponential uses specific parameters defined in exp avg settings. Equal confidence uses specific parameters defined in equal confidence level [dB].
| 0 | Linear (default) | | 1 | Exponential | | 2 | Equal confidence | | 3 | Peak |
|
|
exp avg settings specifies how the exponential averaging is performed.
|
mode specifies the exponential averaging mode.
The Custom mode allows you to specify any time constant [ms].
| 0 | Slow t= 1 s | | 1 | Fast (default) t= 125 ms | | 2 | Impulse t= 35 ms rising and 1.5 s falling | | 3 | Custom |
|
|
time constant specifies the time constant in milliseconds used for exponential averaging if exponential mode is set to Custom. In all other cases, this parameter is ignored.
|
|
|
equal confidence level [dB] specifies the confidence value in decibels used if averaging type is set to Equal confidence.
|
|
filter settled returns TRUE when all octave filters are settled.
|
 |
octave spectra returns the octave spectra in band power versus nominal frequencies.
You can display the results in an Octave Graph or a Multiplot Octave Graph indicator.
|
nominal frequencies [Hz] returns the nominal, or preferred, frequencies as opposed to the exact frequencies associated with each 1/n octave band.
|
|
band power returns the band power in decibels associated with each 1/n octave band.
|
|
 |
unit labels returns the unit label for each channel.
|
|
total band powers returns the total band power in decibels for each channel.
|
|
octave info contains octave information needed by the Octave Extended Measurements VIs and the waterfall display for octave VIs.
|
|
error out contains error information. If error in indicates that an error occurred before this VI or function ran, error out contains the same error information. Otherwise, it describes the error status that this VI or function produces.
Right-click the error out front panel indicator and select Explain Error from the shortcut menu for more information about the error.
|
status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred.
|
|
code is the error or warning code.
If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code.
|
|
source describes the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning.
|
|
The octave filters are designed in accordance with ANSI S1.11-1986, Order 3, Type 1-D, optional range. To meet this standard, the sampling frequency must be at least three times the highest exact midband frequency.
