Company Events Academic NI Developer Zone Support Solutions Products & Services Contact NI MyNI

SVT UFF58 Write VI

Owning Palette: UFF58 File I/O VIs

Installed With: Sound and Vibration Measurement Suite

Writes data to the UFF58 (universal file format) file specified by the file refnum input. This VI also writes the fields in records 1, 2, and 3, ID lines (1-3). You can write a single time domain waveform, multiple time domain waveforms, a single real frequency spectrum, multiple real frequency spectra, a single complex frequency spectrum, multiple complex frequency spectra, or generic data to a UFF file. If a frequency spectrum is in decibels, this VI converts the spectrum to linear before writing to the UFF58 file. The default instance, SVT UFF58 Write Time Waveform (1 Ch), writes a single time domain waveform to the file specified by the file refnum input.

Details  

Use the pull-down menu to select an instance of this VI.

SVT UFF58 Write Time Waveform (1Ch)

data precision (double-precision:1) specifies the numeric precision of the data to be written to the file.
0double-precision
1single-precision
ID lines (1-3) specifies the data in records 1, 2, and 3. ID line 1 typically is used for the function description. ID line 3 typically is used to identify when the function was created. The date is in the format DD-MM-YY, and the time is in the format HH:MM:SS.
ID line 1 (description) specifies the contents of ID line 1.
ID line 2 specifies the contents of ID line 2.
ID line 3 (date & time) specifies the contents of ID line 3.
file refnum specifies the UFF58 file refnum associated with the file you want to use.
waveform specifies a single time domain signal to write to the file.
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.
dup file refnum returns the same value as the input file refnum. You can wire this output to the file refnum input of another UFF58 File I/O or UFF58 Advanced VI. You also can use this refnum to close the UFF file.
function refnum returns the reference to a function in the UFF58 file.
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.

SVT UFF58 Write Time Waveform (N Ch)

data precision (double-precision:1) specifies the numeric precision of the data to be written to the file.
0double-precision
1single-precision
ID lines (1-3) specifies the data in the fields in records 1, 2, and 3. ID line 1 typically is used for the function description. ID line 3 typically is used to identify when the function was created. The date is in the format DD-MM-YY, and the time is in the format HH:MM:SS.
ID line 1 (description) specifies the contents of ID line 1.
ID line 2 specifies the contents of ID line 2.
ID line 3 (date & time) specifies the contents of ID line 3.
file refnum specifies the UFF58 file refnum associated with the file you want to use.
waveforms specifies the time domain signals to write to the file.
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.
dup file refnum returns the same value as the input file refnum. You can wire this output to the file refnum input of another UFF58 File I/O or UFF58 Advanced VI. You also can use this refnum to close the UFF file.
function refnums returns the references to all the functions in the UFF58 file.
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.

SVT UFF58 Write Spectrum (Real) (1 Ch)

data precision (double-precision:1) specifies the numeric precision of the data to be written to the file.

0double-precision
1single-precision
ID lines (1-3) specifies the data in records 1, 2, and 3. ID line 1 typically is used for the function description. ID line 3 typically is used to identify when the function was created. The date is in the format DD-MM-YY, and the time is in the format HH:MM:SS.
ID line 1 (description) specifies the contents of ID line 1.
ID line 2 specifies the contents of ID line 2.
ID line 3 (date & time) specifies the contents of ID line 3.
file refnum specifies the UFF58 file refnum associated with the file you want to use.
spectrum specifies a single spectrum to write to the file.
x0 specifies the start frequency or order of the spectrum.
dx specifies the frequency or order resolution of the spectrum.
Y specifies the magnitude of the power or amplitude spectrum.
spectrum info is a cluster that contains properties of the computed spectrum. The properties contained in spectrum info include channel name, spectrum type, spectrum scale as linear or dB, applied window, window size, FFT size, units, x-axis units, dB reference, applied weighting, peak units, and spectral density.
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.
dup file refnum returns the same value as the input file refnum. You can wire this output to the file refnum input of another UFF58 File I/O or UFF58 Advanced VI. You also can use this refnum to close the UFF file.
function refnum returns the reference to a function in the UFF58 file.
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.

SVT UFF58 Write Spectrum (Real) (N Ch)

data precision (double-precision:1) specifies the numeric precision of the data to be written to the file.

0double-precision
1single-precision
ID lines (1-3) specifies the data in the fields in records 1, 2, and 3. ID line 1 typically is used for the function description. ID line 3 typically is used to identify when the function was created. The date is in the format DD-MM-YY, and the time is in the format HH:MM:SS.
ID line 1 (description) specifies the contents of ID line 1.
ID line 2 specifies the contents of ID line 2.
ID line 3 (date & time) specifies the contents of ID line 3.
file refnum specifies the UFF58 file refnum associated with the file you want to use.
spectra specifies multiple spectra to write to the file.
spectrum specifies a single spectrum to write to the file.
x0 specifies the start frequency or order of the spectrum.
dx specifies the frequency or order resolution of the spectrum.
Y specifies the magnitude of the power or amplitude spectrum.
spectrum info is a cluster that contain properties of the computed spectrum. The properties contained in spectrum info include channel name, spectrum type, spectrum scale as linear or dB, applied window, window size, FFT size, units, x-axis units, dB reference, applied weighting, peak units, and spectral density.
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.
dup file refnum returns the same value as the input file refnum. You can wire this output to the file refnum input of another UFF58 File I/O or UFF58 Advanced VI. You also can use this refnum to close the UFF file.
function refnums returns the references to all the functions in the UFF58 file.
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.

SVT UFF58 Write Spectrum (Complex) (1 Ch)

data precision (double-precision:1) specifies the numeric precision of the data to be written to the file.

0double-precision
1single-precision
ID lines (1-3) specifies the data in records 1, 2, and 3. ID line 1 typically is used for the function description. ID line 3 typically is used to identify when the function was created. The date is in the format DD-MM-YY, and the time is in the format HH:MM:SS.
ID line 1 (description) specifies the contents of ID line 1.
ID line 2 specifies the contents of ID line 2.
ID line 3 (date & time) specifies the contents of ID line 3.
file refnum specifies the UFF58 file refnum associated with the file you want to use.
real part specifies the real part of the spectrum.
x0 specifies the start frequency or order of the spectrum.
dx specifies the frequency or order resolution of the spectrum.
Y Real specifies the real part of the complex spectrum.
imaginary part specifies the imaginary part of the spectrum.
x0 specifies the start frequency or order of the spectrum.
dx specifies the frequency or order resolution of the spectrum.
Y Im specifies the imaginary part of the complex spectrum.
spectrum info is a cluster that contains properties of the computed spectrum. The properties contained in spectrum info include channel name, spectrum type, spectrum scale as linear or dB, applied window, window size, FFT size, units, x-axis units, dB reference, applied weighting, peak units, and spectral density.
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.
dup file refnum returns the same value as the input file refnum. You can wire this output to the file refnum input of another UFF58 File I/O or UFF58 Advanced VI. You also can use this refnum to close the UFF file.
function refnum returns the reference to a function in the UFF58 file.
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.

SVT UFF58 Write Spectrum (Complex) (N Ch)

data precision (double-precision:1) specifies the numeric precision of the data to be written to the file.

0double-precision
1single-precision
ID lines (1-3) specifies the data in the fields in records 1, 2, and 3. ID line 1 typically is used for the function description. ID line 3 typically is used to identify when the function was created. The date is in the format DD-MM-YY, and the time is in the format HH:MM:SS.
ID line 1 (description) specifies the contents of ID line 1.
ID line 2 specifies the contents of ID line 2.
ID line 3 (date & time) specifies the contents of ID line 3.
file refnum specifies the UFF58 file refnum associated with the file you want to use.
real part specifies the real part of the spectra.
real part specifies the real part of the spectrum.
x0 specifies the start frequency or order of the spectrum.
dx specifies the frequency or order resolution of the spectrum.
Y Real specifies the real part of the complex spectrum.
spectrum info specifies properties of the computed spectrum. The properties contained in spectrum info include channel name, spectrum type, spectrum scale as linear or dB, applied window, window size, FFT size, units, x-axis units, dB reference, applied weighting, peak units, and spectral density.
Note  spectrum info must be wired when performing extended measurements. Do not modify the spectrum info values.
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.
dup file refnum returns the same value as the input file refnum. You can wire this output to the file refnum input of another UFF58 File I/O or UFF58 Advanced VI. You also can use this refnum to close the UFF file.
function refnums returns the references to all the functions in the UFF58 file.
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.

SVT UFF58 Write Generic

function type specifies the function type.

0general or unknown (default)
1time response
2auto spectrum
3cross spectrum
4frequency response function
5transmissibility
6coherence
7auto correlation
8cross correlation
9power spectral density (PSD)
10energy spectral density (ESD)
11probability density function
12spectrum
13cumulative frequency distribution
14peaks valley
15stress/cycles
16strain/cycles
17orbit
18mode indicator function
19force pattern
20partial power
21partial Coherence
22eigenvalue
23eigenvector
24shock response spectrum
25finite impulse response (FIR) filter
26multiple coherence
27order function
data precision (double-precision:1) specifies the numeric precision of the data to be written to the file.

0double-precision
1single-precision
ID lines (1-3) specifies the data in records 1, 2, and 3. ID line 1 typically is used for the function description. ID line 3 typically is used to identify when the function was created. The date is in the format DD-MM-YY, and the time is in the format HH:MM:SS.
ID line 1 (description) specifies the contents of ID line 1.
ID line 2 specifies the contents of ID line 2.
ID line 3 (date & time) specifies the contents of ID line 3.
file refnum specifies the UFF58 file refnum associated with the file you want to use.
ordinate values (Y Real) contains the real part of the spectrum.
ordinate values (Y Im) contains the imaginary part of the spectrum.
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.
abscissa minimum (x0) specifies the initial value of coordinates on the horizontal axis.
abscissa increment (dx) specifies the interval between data points in the signal.
dup file refnum returns the same value as the input file refnum. You can wire this output to the file refnum input of another UFF58 File I/O or UFF58 Advanced VI. You also can use this refnum to close the UFF file.
function refnum returns the reference to a function in the UFF58 file.
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.

SVT UFF58 Write Details

Use the SVT UFF58 Write Spectrum (Real) (1 Ch) and SVT UFF58 Write Spectrum (Real) (N Ch) instances to write measurements such as power spectrum and power spectral density. Use the SVT UFF58 Write Frequency Spectrum (Complex) (1 Ch) and SVT UFF58 Write Frequency Spectrum (Complex) (N Ch) instances to write real and imaginary components of frequency response data. Use the SVT UFF58 Write Generic instance to write measurements such as coherence. If you use the SVT UFF58 Write Spectrum (Real) (1 Ch) or SVT UFF58 Write Spectrum (Real) (N Ch) instance, this VI converts any spectrum that is in decibels to linear before writing to the UFF58 file.

You cannot edit a UFF58 file with the UFF58 File I/O or UFF58 Advanced VIs after you write and close the file. If you need to edit the contents of an existing UFF58 file after you write and close the file, you can read the information then write modified information to a new UFF58 file.

Note  If you write to the same UFF58 file multiple times without using the SVT UFF58 Close File VI each time, you create new functions in the file every time you write to the UFF58 file. This VI does not append data within a single function.

Resources


 

Your Feedback! poor Poor  |  Excellent excellent   Yes No
 Document Quality? 
 Answered Your Question? 
Add Comments 1 2 3 4 5 submit