tdmsinfo

Information about TDMS file

Since R2022a

Syntax

info = tdmsinfo(tdmsfile)

Description

info = tdmsinfo(tdmsfile) returns a TdmsInfo object with properties containing general information about the TDMS file, such as file name, location, description, author, version, and list of channels.

Examples

Get Information on a TDMSFile

Get information on a TDMS file and its channels.

info = tdmsinfo("Turbine_003.tdms")

info = 

  TdmsInfo with properties:

           Path: "C:\data\tdms\Turbine_003.tdms"
           Name: "Turbine_003"
    Description: "Test the Acceleration, Force and Torque of Turbine"
          Title: "Turbine Tests"
         Author: "xyz"
        Version: "2.0"
    ChannelList: [6×8 table]

View the channel information in the file.

>> info.ChannelList

ans =

  6×8 table

    ChannelGroupNumber    ChannelGroupName    ChannelGroupDescription      ChannelName      ChannelDescription     Unit      DataType    NumSamples
    __________________    ________________    _______________________    _______________    __________________    _______    ________    __________

            1              "Acceleration"        "CGAcceleration"        "Acceleration1"     "from Clipboard"     "m/s^2"    "Double"       3312   
            1              "Acceleration"        "CGAcceleration"        "Acceleration2"     "from Clipboard"     "m/s^2"    "Double"       3312   
            2              "Force"               "CGForce"               "Force1"            "from Clipboard"     "N"        "Double"       3312   
            2              "Force"               "CGForce"               "Force2"            "from Clipboard"     "N"        "Double"       3312   
            3              "Torque"              "CGTorque"              "Torque1"           "from Clipboard"     "Nm"       "Double"       3312   
            3              "Torque"              "CGTorque"              "Torque2"           "from Clipboard"     "Nm"       "Double"       3312

Input Arguments

tdmsfile — TDMS file name

string

TDMS file name, specified as a string.

For local files, use a full or relative path that contains a file name and extension. You also can specify a file on the MATLAB^® path.

For Internet files, specify the URL. For example, to read a remote file from the Amazon S3™ cloud:

data = tdmsread("s3://bucketname/path_to_file/data.tdms");

Example: "airlinesmall.tdms"

Data Types: char | string

Output Arguments

info — TDMS file information

TdmsInfo object

TDMS file information, returned as a TdmsInfo object with the following properties:

Property	Type	Description
Path	string	Full path to file
Name	string	TDMS file name attribute
Description	string	TDMS file description attribute
Title	string	TDMS file title attribute
Author	string	TDMS file author attribute
Version	string	TDMS file version attribute
ChannelList	table	TDMS channel and channel group attributes

The ChannelList property value is a table with the following variables:

Table Variable	Type	Notes
ChannelGroupNumber	double	Internally created representational index of channel group
ChannelGroupName	string
ChannelGroupDescription	string
ChannelName	string
ChannelDescription	string
Unit	string	Unit of channel data
DataType	string	TDMS datatype in file
NumSamples	uint64	Number of samples in channel

Limitations

• TDMS functions are supported on Windows^® platforms only.

Version History

Introduced in R2022a