SV TDMS Read VI

SV TDMS Read VI

Owning Palette: TDMS VIs

Requires: Sound and Vibration Toolkit

Reads the specified .tdms file and returns data in a format specific to the polymorphic instance selected.

Use this VI with the TDMS List Contents function to read different types of channels from a .tdms file. Use the TDMS File Viewer VI to view the data in .tdms files.

Details  

SV TDMS Read Time Waveform (1 Ch)

	count specifies the maximum number of data elements to read from the .tdms file for each channel. The default is –1, all available elements.
	offset specifies the number of data elements into the .tdms file at which the function begins reading the .tdms file. The default is 0.
	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.
	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.
	waveform returns the waveform read from the .tdms file. t0 returns the trigger time of the waveform. dt returns the time interval in seconds between data points in the waveform. Y returns the data values of the waveform.
	error out contains error information. This output provides standard error out functionality.
	eof indicates if the end of the file has been reached.

SV TDMS Read 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.
	error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
	scale labels returns the x-scale and y-scale labels. X-scale label returns the label of the x-scale. Y-scale label returns the label of 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.
	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 power associated with each 1/n octave band expressed in decibels rms.
	error out contains error information. This output provides standard error out functionality.
	octave info returns information about the octave spectra that you can pass to 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.

SV TDMS Read 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.
	error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
	scale labels returns the x-scale and y-scale labels. X-scale label returns the label of the x-scale. Y-scale label returns the label of 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 name out returns the name of the channel on which you performed the operation.
	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 the band power in decibels associated with each 1/n octave band.
	error out contains error information. This output provides standard error out functionality.
	octave info returns information about the octave spectrum that you can pass to 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.

SV TDMS Read Spectrum (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.
	error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
	scale labels returns the x-scale and y-scale labels. X-scale label returns the label of the x-scale. Y-scale label returns the label of 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 name out returns the name of the channel on which you performed the operation.
	spectrum returns a single spectrum read from the .tdms file. x0 returns the start frequency, in hertz, of the spectrum. dx returns the frequency resolution, in hertz, of the spectrum. array returns the data values of the spectrum.
	error out contains error information. This output provides standard error out functionality.
	spectrum info returns information about the spectrum that you can pass to 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.

SV TDMS Read 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.
	error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
	scale labels returns the x-scale and y-scale labels. X-scale label returns the label of the x-scale. Y-scale label returns the label of 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.
	spectra returns the spectra read from the .tdms file. x0 returns the start frequency, in hertz, of each spectrum. dx returns the frequency resolution, in hertz, of each spectrum. array returns the data values of each spectrum.
	error out contains error information. This output provides standard error out functionality.
	spectra info returns information about the spectra that you can pass to 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.

SV TDMS Read 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.
	error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
	scale labels returns the axis label for the x, y, and z axes. X-scale label returns the label of the x-scale. Y-scale label returns the label of values. Z-scale label returns the label of the z-scale.
	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.
	colormap returns the spectral results of a transient analysis. spectral map returns the 2D array of magnitude data for the spectra. X scale returns the scaling information associated with the first index of the 2D spectral map. offset returns the x value associated with elements (0, n) of spectral map. multiplier returns the x-axis spacing between consecutive elements in a column. Y scale returns the scaling information associated with the second index of the 2D spectral map. offset returns the y value associated with elements (n, 0) of spectral map. multiplier returns the y-axis spacing between consecutive elements in a row. attribute returns additional information about the spectra. LabVIEW uses this information to display the data properly and to perform extended measurements.
	error out contains error information. This output provides standard error out functionality.
	spectrum info returns information about the spectrum that you can pass to 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.

SV TDMS Read 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.
	error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
	scale labels returns the x-scale, y-scale, and z-scale labels. X-scale label returns the label of the x-scale. Y-scale label returns the label of values. Z-scale label returns the label of the z-scale.
	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.
	waterfall graph data returns an array of 2D waveform signals in three dimensions. You can display the results in a Waterfall Graph indicator. z0 returns the initial value of the first plot on the z-axis. dz returns the interval between plots on the z-axis. plots returns the data on the waterfall graph. x0 returns the initial value on the x-axis. dx returns the interval between points on the waterfall graph. Y returns the values of the points on the waterfall graph.
	error out contains error information. This output provides standard error out functionality.
	spectrum info returns information about the spectrum that you can pass to 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.

SV TDMS Read 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.
	error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
	scale labels returns the x-scale and y-scale labels. X-scale label returns the label of the x-scale. Y-scale label returns the label of 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 name out returns the name of the channel on which you performed the operation.
	speed profile returns information about the tachometer pulse arrival time and the rotational speed at each pulse. time [s] returns the time instant of pulses in seconds. speed [RPM] returns the rotational speed at each pulse time instant in revolutions per minute.
	error out contains error information. This output provides standard error out functionality.
	speed position info returns the position information of the speed [RPM] subparameter. positions [s] returns the locations of the samples in seconds. samples/rev returns the number of samples per revolution.

SV TDMS Read Even-Angle Signal (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.
	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.
	even-angle signal returns 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 returns the start of the revolution index. dr returns the revolution interval between two sequential samples. Y returns the values of even-angle spaced samples in a scaled engineering unit.
	error out contains error information. This output provides standard error out functionality.
	even-angle channel info returns information that you can pass to 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 returns the position information of even-angle signal. positions [s] returns the locations of the samples in seconds. samples/rev returns the number of samples per revolution.

SV TDMS Read Even-Angle Signal (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.
	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.
	even-angle signals returns the data resampled at even-angle intervals for each channel. even-angle signals are synchronous to the rotational speed with a constant number of samples per revolution. r0 returns the start of the revolution index. dr returns the revolution interval between two sequential samples. Y returns the values of even-angle spaced samples in a scaled engineering unit.
	error out contains error information. This output provides standard error out functionality.
	even-angle channel info returns information that you can pass to 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 returns the position information of even-angle signals. positions [s] returns the locations of the samples in seconds. samples/rev returns the number of samples per revolution.

SV TDMS Read Order Track (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 names in specifies the channels to perform the operation on.
	error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
	scale labels returns the x-scale and y-scale labels. X-scale label returns the label of the x-scale. Y-scale label returns the label of 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.
	order components returns the order components read from the .tdms file. X returns the speed, time, or revolutions of the order components. Y returns the data values of the order components.
	error out contains error information. This output provides standard error out functionality.
	spectrum info returns information about the spectrum that you can pass to 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.

SV TDMS Read Order Track (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.
	error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
	scale labels returns the x-scale and y-scale labels. X-scale label returns the label of the x-scale. Y-scale label returns the label of 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.
	order components returns the order components read from the .tdms file. X returns the speed, time, or revolutions of the order components. Y returns the data values of the order components.
	error out contains error information. This output provides standard error out functionality.
	spectra info returns information about the spectra that you can pass to 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.

SV TDMS Read Scalar (1 Ch)

	count specifies the maximum number of data elements to read from the .tdms file for each channel. The default is –1, all available elements.
	offset specifies the number of data elements into the .tdms file at which the function begins reading the .tdms file. The default is 0.
	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.
	error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
	scale labels returns the x-scale and y-scale labels. X-scale label returns the label of the x-scale. Y-scale label returns the label of 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 name out returns the name of the channel on which you performed the operation.
	values returns the double-precision values read from the .tdms file
	error out contains error information. This output provides standard error out functionality.
	end of file returns TRUE when the VI reaches the end of the file.
	scalar function info returns the measurement-analysis context of values out.

SV TDMS Read Scalar (N Ch)

	count specifies the maximum number of data elements to read from the .tdms file for each channel. The default is –1, all available elements.
	offset specifies the number of data elements into the .tdms file at which the function begins reading the .tdms file. The default is 0.
	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.
	error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
	scale labels returns the x-scale and y-scale labels. X-scale label returns the label of the x-scale. Y-scale label returns the label of 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.
	values returns the double-precision values read from the .tdms file
	error out contains error information. This output provides standard error out functionality.
	end of file returns TRUE when the VI reaches the end of the file.
	scalar function info returns the measurement-analysis context of values out.

SV TDMS Read Details

Use this VI with the TDMS List Contents VI to create a generic TDMS read VI that can read different types of channels from a TDMS file. Use the TDMS File Viewer to visually inspect TDMS files.