LabVIEW Sound and Vibration API Reference

SV TDMS Write VI

  • Updated2024-06-18
  • 29 minute(s) read

SV TDMS Write VI

Owning Palette: TDMS VIs

Requires: Sound and Vibration Toolkit

Writes data to the specified .tdms file in a format specific to the polymorphic instance. Wire data to the scaled signal [EU] input to determine the polymorphic instance to use or manually select the instance.

Use the SVPO TDMS Write VI to write data to the specified .tdms file on embedded targets that have limited computational resources.

SV TDMS Write Time Waveform (1 Ch)

write channel properties (T) specifies whether to write the channel properties when the VI runs. You can set this input to TRUE the first time the VI runs, and thereafter set it to FALSE to speed up the VI. The default is TRUE.
tdms file specifies a reference number to the .tdms file on which to perform the operation. Use the TDMS Open function to open the refnum.
group name in specifies the channel group on which to perform the operation.
channel name in specifies the channel to perform the operation on.
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 specifies the start time of the waveform.
dt specifies the time interval in seconds between data points in the waveform.
Y specifies the data values of the waveform.
error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
tdms file out returns a TDMS file reference to the .tdms file on which you performed the operation.
group name out returns the name of the channel group on which you performed the operation.
channel name out returns the name of the channel on which you performed the operation.
error out contains error information. This output provides standard error out functionality.

SV TDMS Write Time Waveform (N Ch)

write channel properties (T) specifies whether to write the channel properties when the VI runs. You can set this input to TRUE the first time the VI runs, and thereafter set it to FALSE to speed up the VI. The default is TRUE.
tdms file specifies a reference number to the .tdms file on which to perform the operation. Use the TDMS Open function to open the refnum.
group name in specifies the channel group on which to perform the operation.
channel names in specifies the channels to perform the operation on.
scaled signals 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 a virtual channel in National Instruments Measurement & Automation Explorer (MAX).
t0 specifies the start time of the waveform.
dt specifies the time interval in seconds between data points in the waveform.
Y specifies the data values of the waveform.
error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
tdms file out returns a TDMS file reference to the .tdms file on which you performed the operation.
group name out returns the name of the channel group on which you performed the operation.
channel names out returns the names of the channels you performed the operation on.
error out contains error information. This output provides standard error out functionality.

SV TDMS Write Octave (1 Ch)

tdms file specifies a reference number to the .tdms file on which to perform the operation. Use the TDMS Open function to open the refnum.
group name in specifies the channel group on which to perform the operation.
channel name in specifies the channel to perform the operation on.
octave spectrum specifies the octave spectrum to perform the operation on, in band power versus nominal frequencies.
nominal frequencies [Hz] specifies the nominal, or preferred, frequencies as opposed to the exact frequencies associated with each 1/n octave band.
band power specifies the band power in decibels associated with each 1/n octave band.
error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
octave info specifies information about the octave spectrum that you can pass from another VI.
Note  You must wire octave info when performing extended measurements. Do not modify the octave info values. If you want to view the information, you can right-click the octave info wire and select Custom Probe»Octave Info from the shortcut menu.
tdms file out returns a TDMS file reference to the .tdms file on which you performed the operation.
group name out returns the name of the channel group on which you performed the operation.
channel name out returns the name of the channel on which you performed the operation.
error out contains error information. This output provides standard error out functionality.

SV TDMS Write Octave (N Ch)

tdms file specifies a reference number to the .tdms file on which to perform the operation. Use the TDMS Open function to open the refnum.
group name in specifies the channel group on which to perform the operation.
channel names in specifies the channels to perform the operation on.
octave spectra specifies the octave spectra to perform the operation on, in band power versus nominal frequencies.
nominal frequencies [Hz] specifies the nominal, or preferred, frequencies as opposed to the exact frequencies associated with each 1/n octave band.
band power specifies the band power in decibels associated with each 1/n octave band.
error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
octave info contains information about the octave spectra that you can pass from another VI.
Note  You must wire octave info when performing extended measurements. Do not modify the octave info values. If you want to view the information, you can create a custom probe.
tdms file out returns a TDMS file reference to the .tdms file on which you performed the operation.
group name out returns the name of the channel group on which you performed the operation.
channel names out returns the names of the channels you performed the operation on.
error out contains error information. This output provides standard error out functionality.

SV TDMS Write Spectrum (1 Ch)

write mode specifies how LabVIEW writes data to an existing file.
append—Appends the streaming, continuous data to the existing group and channel(s).
new group—Creates a new group of data in the existing block-based data file.
overwrite—Overwriting existing channels of data is not supported by LabVIEW. To edit the data of an existing channel, you can read the data and then write modified data to a new file, group, or channel.
tdms file specifies a reference number to the .tdms file on which to perform the operation. Use the TDMS Open function to open the refnum.
group name in specifies the channel group on which to perform the operation.
channel name in specifies the channel to perform the operation on.
spectrum specifies the frequency-domain data for the spectrum.
x0 specifies the start frequency, in hertz, for the spectrum.
dx specifies the frequency resolution, in hertz, for the spectrum.
array specifies the data values for the spectrum.
error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
component specifies the spectrum component. The valid values are Magnitude, Phase, Real, Imaginary, Coherence, and Unknown.
spectrum info contains information about the spectrum that you can pass from another VI.
Note  You must wire spectrum info when performing extended measurements. Do not modify the spectrum info values. If you want to view the information, you can right-click the spectrum info wire and select Custom Probe»Spectrum Info from the shortcut menu.
tdms file out returns a TDMS file reference to the .tdms file on which you performed the operation.
group name out returns the name of the channel group on which you performed the operation.
channel name out returns the name of the channel on which you performed the operation.
error out contains error information. This output provides standard error out functionality.

SV TDMS Write Spectrum (N Ch)

tdms file specifies a reference number to the .tdms file on which to perform the operation. Use the TDMS Open function to open the refnum.
group name in specifies the channel group on which to perform the operation.
channel names in specifies the channels to perform the operation on.
spectra specifies the frequency-domain data for each spectrum.
x0 specifies the start frequency, in hertz, for each spectrum.
dx specifies the frequency resolution, in hertz, for each spectrum.
array specifies the data values for each spectrum.
error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
component specifies the spectrum component. The valid values are Magnitude^2, Magnitude, Phase, Real, Imaginary, Complex, Coherence, and Unknown.
spectra info contains information about the spectra that you can pass from another VI.
Note  You must wire spectra info when performing extended measurements. Do not modify the spectra info values. If you want to view the information, you can create a custom probe.
tdms file out returns a TDMS file reference to the .tdms file on which you performed the operation.
group name out returns the name of the channel group on which you performed the operation.
channel names out returns the names of the channels you performed the operation on.
error out contains error information. This output provides standard error out functionality.

SV TDMS Write Spectrum (Colormap)

tdms file specifies a reference number to the .tdms file on which to perform the operation. Use the TDMS Open function to open the refnum.
group name in specifies the channel group on which to perform the operation.
colormap specifies the spectral results of a transient analysis on an intensity graph with a rainbow color scale.
spectral map specifies the 2D array of magnitude data for the spectra.
X scale specifies the scaling information associated with the first index of the 2D spectral map. offset and multiplier specify scaling values such that the final value equals (deltaX)*X + Xo.
offset specifies the offset, or initial value, for scaling data using (deltaX)*X + Xo. If you change the offset, the scale no longer uses 0 as the origin of the plot.
multiplier specifies the multiplier, or interval, for scaling data using (deltaX)*X + Xo.
Y scale specifies the scaling information associated with the first index of the 2D spectral map. offset and multiplier specify scaling values such that the final value equals (deltaY)*Y + Yo.
offset specifies the offset, or initial value, for scaling data using (deltaY)*Y + Yo. If you change the offset, the scale no longer uses 0 as the origin of the plot.
multiplier specifies the multiplier, or interval, for scaling data using (deltaY)*Y + Yo.
attribute specifies additional information about the spectra. LabVIEW uses this information to display the data properly and to perform extended measurements.
error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
spectrum info contains information about the spectrum that you can pass from another VI.
Note  You must wire spectrum info when performing extended measurements. Do not modify the spectrum info values. If you want to view the information, you can right-click the spectrum info wire and select Custom Probe»Spectrum Info from the shortcut menu.
tdms file out returns a TDMS file reference to the .tdms file on which you performed the operation.
group name out returns the name of the channel group on which you performed the operation.
error out contains error information. This output provides standard error out functionality.

SV TDMS Write Spectrum (Waterfall)

tdms file specifies a reference number to the .tdms file on which to perform the operation. Use the TDMS Open function to open the refnum.
group name in specifies the channel group on which to perform the operation.
channel names in specifies the channels to perform the operation on.
waterfall graph data specifies an array of 2D waveform signals in three dimensions.
z0 specifies the initial value of the first plot on the z-axis.
dz specifies the interval between plots on the z-axis.
plots specifies the data on the waterfall graph.
x0 specifies the initial value on the x-axis.
dx specifies the interval between points on the waterfall graph.
Y specifies the values of the points on the waterfall graph.
error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
Z info specifies z-axis label information about the waterfall graph.
Z-axis label specifies the label of the z-axis.
Z-unit string specifies the units of the z-axis.
spectrum info contains information about the spectrum that you can pass from another VI.
Note  You must wire spectrum info when performing extended measurements. Do not modify the spectrum info values. If you want to view the information, you can right-click the spectrum info wire and select Custom Probe»Spectrum Info from the shortcut menu.
tdms file out returns a TDMS file reference to the .tdms file on which you performed the operation.
group name out returns the name of the channel group on which you performed the operation.
channel names out returns the names of the channels you performed the operation on.
error out contains error information. This output provides standard error out functionality.

SV TDMS Write Speed Profile (1 Ch)

tdms file specifies a reference number to the .tdms file on which to perform the operation. Use the TDMS Open function to open the refnum.
group name in specifies the channel group on which to perform the operation.
channel name in specifies the channel to perform the operation on.
speed profile specifies the tachometer-pulse arrival time and the rotational speed at each pulse.
time [s] specifies the time instant of pulses in seconds.
speed [RPM] specifies the rotational speed at each pulse time instant in revolutions per minute.
error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
speed position info specifies the position information of the speed [rpm] subparameter for each tachometer signal.
positions [s] specifies the locations of the samples, in seconds.
samples/rev specifies the number of samples per revolution.
tdms file out returns a TDMS file reference to the .tdms file on which you performed the operation.
group name out returns the name of the channel group on which you performed the operation.
channel name out returns the name of the channel on which you performed the operation.
error out contains error information. This output provides standard error out functionality.

SV TDMS Write Even-Angle Signal (1 Ch)

write channel properties (T) specifies whether to write the channel properties when the VI runs. You can set this input to TRUE the first time the VI runs, and thereafter set it to FALSE to speed up the VI. The default is TRUE.
tdms file specifies a reference number to the .tdms file on which to perform the operation. Use the TDMS Open function to open the refnum.
group name in specifies the channel group on which to perform the operation.
channel name in specifies the channel to perform the operation on.
even-angle signal specifies the data resampled at even-angle intervals. even-angle signal is synchronous to the rotational speed with a constant number of samples per revolution.
r0 specifies the start of the revolution index.
dr specifies the revolution interval between two sequential samples.
Y specifies the values of even-angle spaced samples in a scaled engineering unit.
error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
even-angle channel info contains information that you can pass from another VI about the measurement configuration for even-angle signal.
Note  You must wire even-angle channel info when performing extended measurements. Do not modify the even-angle channel info values. If you want to view the information, you can create a custom probe.
even-angle position info specifies the position information of even-angle signal.
positions [s] specifies the locations of the samples, in seconds.
samples/rev specifies the number of samples per revolution.
tdms file out returns a TDMS file reference to the .tdms file on which you performed the operation.
group name out returns the name of the channel group on which you performed the operation.
channel name out returns the name of the channel on which you performed the operation.
error out contains error information. This output provides standard error out functionality.

SV TDMS Write Even-Angle Signal (N Ch)

write channel properties (T) specifies whether to write the channel properties when the VI runs. You can set this input to TRUE the first time the VI runs, and thereafter set it to FALSE to speed up the VI. The default is TRUE.
tdms file specifies a reference number to the .tdms file on which to perform the operation. Use the TDMS Open function to open the refnum.
group name in specifies the channel group on which to perform the operation.
channel names in specifies the channels to perform the operation on.
even-angle signals specifies an array of data resampled at even-angle intervals. even-angle signals are synchronous to the rotational speed with a constant number of samples per revolution.
r0 specifies the start of the revolution index.
dr specifies the revolution interval between two sequential samples.
Y specifies the values of even-angle spaced samples in a scaled engineering unit.
error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
even-angle channel info contains information that you can pass from another VI about the measurement configuration for even-angle signals.
Note  You must wire even-angle channel info when performing extended measurements. Do not modify the even-angle channel info values. If you want to view the information, you can create a custom probe.
even-angle position info specifies the position information of even-angle signals.
positions [s] specifies the locations of the samples, in seconds.
samples/rev specifies the number of samples per revolution.
tdms file out returns a TDMS file reference to the .tdms file on which you performed the operation.
group name out returns the name of the channel group on which you performed the operation.
channel names out returns the names of the channels you performed the operation on.
error out contains error information. This output provides standard error out functionality.

SV TDMS Write Order Track (1 Ch)

write mode specifies how LabVIEW writes data to an existing file.
append—Appends the streaming, continuous data to the existing group and channel(s).
new group—Creates a new group of data in the existing block-based data file.
overwrite—Overwriting existing channels of data is not supported by LabVIEW. To edit the data of an existing channel, you can read the data and then write modified data to a new file, group, or channel.
tdms file specifies a reference number to the .tdms file on which to perform the operation. Use the TDMS Open function to open the refnum.
group name in specifies the channel group on which to perform the operation.
channel name in specifies the channel to perform the operation on.
order component specifies the order component.
X specifies the speed, time, or revolutions of the order components.
Y specifies the data values of the order components.
error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
component specifies the spectrum component. The valid values are Magnitude, Phase, Real, Imaginary, Coherence, and Unknown.
spectrum info contains information about the spectrum that you can pass from another VI.
Note  You must wire spectrum info when performing extended measurements. Do not modify the spectrum info values. If you want to view the information, you can right-click the spectrum info wire and select Custom Probe»Spectrum Info from the shortcut menu.
tdms file out returns a TDMS file reference to the .tdms file on which you performed the operation.
group name out returns the name of the channel group on which you performed the operation.
channel names out returns the names of the channels you performed the operation on.
error out contains error information. This output provides standard error out functionality.

SV TDMS Write Order Track (N Ch)

write mode specifies how LabVIEW writes data to an existing file.
append—Appends the streaming, continuous data to the existing group and channel(s).
new group—Creates a new group of data in the existing block-based data file.
overwrite—Overwriting existing channels of data is not supported by LabVIEW. To edit the data of an existing channel, you can read the data and then write modified data to a new file, group, or channel.
tdms file specifies a reference number to the .tdms file on which to perform the operation. Use the TDMS Open function to open the refnum.
group name in specifies the channel group on which to perform the operation.
channel names in specifies the channels to perform the operation on.
order components specifies the order components.
X specifies the speed, time, or revolutions of the order components.
Y specifies the data values of the order components.
error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
component specifies the spectrum component. The valid values are Magnitude, Phase, Real, Imaginary, Coherence, and Unknown.
spectra info contains information about the spectra that you can pass from another VI.
Note  You must wire spectra info when performing extended measurements. Do not modify the spectra info values. If you want to view the information, you can create a custom probe.
tdms file out returns a TDMS file reference to the .tdms file on which you performed the operation.
group name out returns the name of the channel group on which you performed the operation.
channel names out returns the names of the channels you performed the operation on.
error out contains error information. This output provides standard error out functionality.

SV TDMS Write Scalar (1 Ch)

write channel properties (T) specifies whether to write the channel properties when the VI runs. You can set this input to TRUE the first time the VI runs, and thereafter set it to FALSE to speed up the VI. The default is TRUE.
tdms file specifies a reference number to the .tdms file on which to perform the operation. Use the TDMS Open function to open the refnum.
group name in specifies the channel group on which to perform the operation.
channel name in specifies the channel to perform the operation on.
value specifies the double-precision scalar value to write to the .tdms file.
error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
scalar info in specifies the measurement-analysis context of value.
Y-unit label (" ") specifies the engineering unit for value.
tdms file out returns a TDMS file reference to the .tdms file on which you performed the operation.
group name out returns the name of the channel group on which you performed the operation.
channel name out returns the name of the channel on which you performed the operation.
error out contains error information. This output provides standard error out functionality.

SV TDMS Write Scalar (N Ch)

write channel properties (T) specifies whether to write the channel properties when the VI runs. You can set this input to TRUE the first time the VI runs, and thereafter set it to FALSE to speed up the VI. The default is TRUE.
tdms file specifies a reference number to the .tdms file on which to perform the operation. Use the TDMS Open function to open the refnum.
group name in specifies the channel group on which to perform the operation.
channel names in specifies the channels to perform the operation on.
values in specifies the double-precision scalar values to write to the .tdms file.
error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
scalar function info in specifies the measurement-analysis context of values.
Y-unit label (" ") specifies the engineering unit for values.
tdms file out returns a TDMS file reference to the .tdms file on which you performed the operation.
group name out returns the name of the channel group on which you performed the operation.
channel names out returns the names of the channels you performed the operation on.
error out contains error information. This output provides standard error out functionality.

Log in to get a better experience