Owning Palette: TDMS File I/O VIs
Installed With: Sound and Vibration Measurement Suite
Reads the specified .tdms file and returns data in a format specific to the polymorphic instance. You must manually select the polymorphic instance you want to use.
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.
Use the pull-down menu to select an instance of this VI.
.gif)
![]() |
count is the maximum number of data elements to read from the .tdms file for each channel. The default is -1. | ||||||
![]() |
offset determines the number of data elements into the .tdms file at which the function begins analyzing the .tdms file. The default is 0. | ||||||
![]() |
tdms file is a refnum to the .tdms file to perform the operation on. Use the TDMS Open function to open the refnum. | ||||||
![]() |
group name in specifies the channel group to perform the operation on. | ||||||
![]() |
channel name in specifies the channel to perform the operation on. | ||||||
![]() |
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.
| ||||||
![]() |
tdms file out generates a tdms file reference to the .tdms file you performed the operation on. | ||||||
![]() |
group name out returns the name of the channel group you performed the operation on. | ||||||
![]() |
channel name out returns the name of the channel you performed the operation on. | ||||||
![]() |
waveform returns the waveform read from the .tdms 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.
| ||||||
![]() |
eof indicates if the end of the file has been reached. |
.gif)
![]() |
count is the maximum number of data elements to read from the .tdms file for each channel. The default is -1. | ||||||
![]() |
offset determines the number of data elements into the .tdms file at which the function begins analyzing the .tdms file. The default is 0. | ||||||
![]() |
tdms file is a refnum to the .tdms file to perform the operation on. Use the TDMS Open function to open the refnum. | ||||||
![]() |
group name in specifies the channel group to perform the operation on. | ||||||
![]() |
channel names in specifies the channels to perform the operation on. | ||||||
![]() |
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.
| ||||||
![]() |
tdms file out generates a tdms file reference to the .tdms file you performed the operation on. | ||||||
![]() |
group name out returns the name of the channel group you performed the operation on. | ||||||
![]() |
channel names out returns the names of the channels you performed the operation on. | ||||||
![]() |
waveforms returns the waveforms read from the .tdms 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.
| ||||||
![]() |
eof indicates if the end of the file has been reached. |
.gif)
![]() |
tdms file is a refnum to the .tdms file to perform the operation on. Use the TDMS Open function to open the refnum. | ||||||
![]() |
group name in specifies the channel group to perform the operation on. | ||||||
![]() |
channel name in specifies the channel to perform the operation on. | ||||||
![]() |
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.
| ||||||
![]() |
scale labels returns the x-scale and y-scale labels.
| ||||||
![]() |
tdms file out generates a tdms file reference to the .tdms file you performed the operation on. | ||||||
![]() |
group name out returns the name of the channel group you performed the operation on. | ||||||
![]() |
channel name out returns the name of the channel you performed the operation on. | ||||||
![]() |
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.
| ||||||
![]() |
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.
| ||||||
![]() |
octave info returns information about the octave spectrum that you can pass to another VI. 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. |
.gif)
![]() |
tdms file is a refnum to the .tdms file to perform the operation on. Use the TDMS Open function to open the refnum. | ||||||
![]() |
group name in specifies the channel group to perform the operation on. | ||||||
![]() |
channel names in specifies the channels to perform the operation on. | ||||||
![]() |
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.
| ||||||
![]() |
scale labels returns the x-scale and y-scale labels.
| ||||||
![]() |
tdms file out generates a tdms file reference to the .tdms file you performed the operation on. | ||||||
![]() |
group name out returns the name of the channel group you performed the operation on. | ||||||
![]() |
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.
| ||||||
![]() |
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.
| ||||||
![]() |
octave info returns information about the octave spectra that you can pass to another VI. If you want to view the information, you can create a custom probe. |
.gif)
![]() |
tdms file is a refnum to the .tdms file to perform the operation on. Use the TDMS Open function to open the refnum. | ||||||
![]() |
group name in specifies the channel group to perform the operation on. | ||||||
![]() |
channel name in specifies the channel to perform the operation on. | ||||||
![]() |
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.
| ||||||
![]() |
scale labels returns the x-scale and y-scale labels.
| ||||||
![]() |
tdms file out generates a tdms file reference to the .tdms file you performed the operation on. | ||||||
![]() |
group name out returns the name of the channel group you performed the operation on. | ||||||
![]() |
channel name out returns the name of the channel you performed the operation on. | ||||||
![]() |
spectrum returns a single spectrum read from the .tdms 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.
| ||||||
![]() |
spectrum info returns information about the spectrum that you can pass to another VI. If you want to view the information, you can right-click the spectrum info wire and select Custom Probe»Spectrum Info or Custom Probe»Power Spectrum Info from the shortcut menu. |
.gif)
![]() |
tdms file is a refnum to the .tdms file to perform the operation on. Use the TDMS Open function to open the refnum. | ||||||
![]() |
group name in specifies the channel group to perform the operation on. | ||||||
![]() |
channel names in specifies the channels to perform the operation on. | ||||||
![]() |
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.
| ||||||
![]() |
scale labels returns the x-scale and y-scale labels.
| ||||||
![]() |
tdms file out generates a tdms file reference to the .tdms file you performed the operation on. | ||||||
![]() |
group name out returns the name of the channel group you performed the operation on. | ||||||
![]() |
channel names out returns the names of the channels you performed the operation on. | ||||||
![]() |
spectra returns the spectra read from the .tdms 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.
| ||||||
![]() |
spectra info returns information about the spectra that you can pass to another VI. If you want to view the information, you can create a custom probe. |
.gif)
![]() |
tdms file is a refnum to the .tdms file to perform the operation on. Use the TDMS Open function to open the refnum. | ||||||||||||||||
![]() |
group name in specifies the channel group to perform the operation on. | ||||||||||||||||
![]() |
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.
| ||||||||||||||||
![]() |
tdms file out generates a tdms file reference to the .tdms file you performed the operation on. | ||||||||||||||||
![]() |
group name out returns the name of the channel group you performed the operation on. | ||||||||||||||||
![]() |
colormap returns the spectral results of a transient analysis.
| ||||||||||||||||
![]() |
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.
| ||||||||||||||||
![]() |
spectrum info returns information about the spectrum that you can pass to another VI. If you want to view the information, you can right-click the spectrum info wire and select Custom Probe»Spectrum Info or Custom Probe»Power Spectrum Info from the shortcut menu. |
.gif)
![]() |
tdms file is a refnum to the .tdms file to perform the operation on. Use the TDMS Open function to open the refnum. | ||||||||||||
![]() |
group name in specifies the channel group to perform the operation on. | ||||||||||||
![]() |
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.
| ||||||||||||
![]() |
scale labels returns the x-scale, y-scale, and z-scale labels.
| ||||||||||||
![]() |
tdms file out generates a tdms file reference to the .tdms file you performed the operation on. | ||||||||||||
![]() |
group name out returns the name of the channel group you performed the operation on. | ||||||||||||
![]() |
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.
| ||||||||||||
![]() |
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.
| ||||||||||||
![]() |
spectrum info returns information about the spectrum that you can pass to another VI. If you want to view the information, you can right-click the spectrum info wire and select Custom Probe»Spectrum Info or Custom Probe»Power Spectrum Info from the shortcut menu. |
.gif)
![]() |
tdms file is a refnum to the .tdms file to perform the operation on. Use the TDMS Open function to open the refnum. | ||||||
![]() |
group name in specifies the channel group to perform the operation on. | ||||||
![]() |
channel name in specifies the channel to perform the operation on. | ||||||
![]() |
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.
| ||||||
![]() |
scale labels returns the x-scale and y-scale labels.
| ||||||
![]() |
tdms file out generates a tdms file reference to the .tdms file you performed the operation on. | ||||||
![]() |
group name out returns the name of the channel group you performed the operation on. | ||||||
![]() |
channel name out returns the name of the channel you performed the operation on. | ||||||
![]() |
speed profile returns information about the tachometer pulse arrival time and the rotational speed at each pulse.
| ||||||
![]() |
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.
| ||||||
![]() |
speed position info returns the position information of the speed [rpm] subparameter.
|
.gif)
![]() |
tdms file is a refnum to the .tdms file to perform the operation on. Use the TDMS Open function to open the refnum. | ||||||
![]() |
group name in specifies the channel group to perform the operation on. | ||||||
![]() |
channel name in specifies the channel to perform the operation on. | ||||||
![]() |
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.
| ||||||
![]() |
tdms file out generates a tdms file reference to the .tdms file you performed the operation on. | ||||||
![]() |
group name out returns the name of the channel group you performed the operation on. | ||||||
![]() |
channel name out returns the name of the channel you performed the operation on. | ||||||
![]() |
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.
| ||||||
![]() |
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.
| ||||||
![]() |
even-angle channel info returns information that you can pass to another VI about the measurement configuration for even-angle signal. 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.
|
.gif)
![]() |
tdms file is a refnum to the .tdms file to perform the operation on. Use the TDMS Open function to open the refnum. | ||||||
![]() |
group name in specifies the channel group to perform the operation on. | ||||||
![]() |
channel names in specifies the channels to perform the operation on. | ||||||
![]() |
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.
| ||||||
![]() |
tdms file out generates a tdms file reference to the .tdms file you performed the operation on. | ||||||
![]() |
group name out returns the name of the channel group you performed the operation on. | ||||||
![]() |
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.
| ||||||
![]() |
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.
| ||||||
![]() |
even-angle channel info returns information that you can pass to another VI about the measurement configuration for even-angle signals. 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.
|
.gif)
![]() |
tdms file is a refnum to the .tdms file to perform the operation on. Use the TDMS Open function to open the refnum. | ||||||
![]() |
group name in specifies the channel group to perform the operation on. | ||||||
![]() |
channel names in specifies the channels to perform the operation on. | ||||||
![]() |
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.
| ||||||
![]() |
scale labels returns the x-scale and y-scale labels.
| ||||||
![]() |
tdms file out generates a tdms file reference to the .tdms file you performed the operation on. | ||||||
![]() |
group name out returns the name of the channel group you performed the operation on. | ||||||
![]() |
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.
| ||||||
![]() |
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.
| ||||||
![]() |
spectrum info returns information about the spectrum that you can pass to another VI. If you want to view the information, you can right-click the spectrum info wire and select Custom Probe»Spectrum Info or Custom Probe»Power Spectrum Info from the shortcut menu. |
.gif)
![]() |
tdms file is a refnum to the .tdms file to perform the operation on. Use the TDMS Open function to open the refnum. | ||||||
![]() |
group name in specifies the channel group to perform the operation on. | ||||||
![]() |
channel names in specifies the channels to perform the operation on. | ||||||
![]() |
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.
| ||||||
![]() |
scale labels returns the x-scale and y-scale labels.
| ||||||
![]() |
tdms file out generates a tdms file reference to the .tdms file you performed the operation on. | ||||||
![]() |
group name out returns the name of the channel group you performed the operation on. | ||||||
![]() |
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.
| ||||||
![]() |
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.
| ||||||
![]() |
spectra info returns information about the spectra that you can pass to another VI. If you want to view the information, you can create a custom probe. |