Main Content

mdfChannelGroupInfo

Get channel group metadata from MDF file

Since R2023a

collapse all in page

    Syntax

    infoTable = mdfChannelGroupInfo(mdfFileName)
    infoTable = mdfChannelGroupInfo(mdfFileName,GroupNumber=grpNum)

    Description

    infoTable = mdfChannelGroupInfo(mdfFileName) returns a table of information about all channel groups in the specified MDF file.

    infoTable = mdfChannelGroupInfo(mdfFileName,GroupNumber=grpNum) returns information about only the groups specified by grpNum. The channel group number, grpNum, is specified as a numeric scalar for one group, or numeric vector for multiple groups.

    example

    Examples

    collapse all

    Get information on all groups.

    gi = mdfChannelGroupInfo("VehicleData.mf4")
    gi =

  2×13 table

    GroupNumber    AcquisitionName                                      Comment                                      NumSamples    DataSize    Sorted    SourceName     SourcePath     SourceComment    SourceType     SourceBusType    SourceBusChannelNumber    SourceSimulated
    ___________    _______________    ___________________________________________________________________________    __________    ________    ______    ___________    ___________    _____________    ___________    _____________    ______________________    _______________

         1           <undefined>      Simulation of an automatic transmission controller during passing maneuver.        751         43558     true      <undefined>    <undefined>     <undefined>     Unspecified     Unspecified               0                    false     
         2           <undefined>      Simulation of engine gas dynamics.                                               92033       2208792     true      <undefined>    <undefined>     <undefined>     Unspecified     Unspecified               0                    false

    Get information of a specific group.

    gi = mdfChannelGroupInfo("VehicleData.mf4",GroupNumber=2)
    gi =

  1×13 table

    GroupNumber    AcquisitionName                 Comment                  NumSamples    DataSize    Sorted    SourceName     SourcePath     SourceComment    SourceType     SourceBusType    SourceBusChannelNumber    SourceSimulated
    ___________    _______________    __________________________________    __________    ________    ______    ___________    ___________    _____________    ___________    _____________    ______________________    _______________

         2           <undefined>      Simulation of engine gas dynamics.      92033       2208792     true      <undefined>    <undefined>     <undefined>     Unspecified     Unspecified               0                    false

    Input Arguments

    collapse all

    MDF file name, specified as a string or character vector, including the necessary full or relative path. You can use a URL to specify a file on a remote server.

    Depending on the location you are accessing, mdfFileName can take one of these forms.

    Location

    Form

    Current folder or MATLAB® path

    To access a file in the current folder or MATLAB path, specify the name of the file in filename, including the file extension.

    Example: "myMdfFile.mf4"

    Other folders

    To access a file in a folder other than the current folder, specify the full or relative path name in filename.

    Example: "C:\myFolder\myMdfFile.mf4"

    Example: "\dataDir\myMdfFile.mf4"

    Remote locations

    To access a file in a remote location, filename must contain the full path of the file specified as a uniform resource locator (URL) of the form:

    scheme://path_to_file/myMdfFile.mf4

    Based on the remote location, scheme can be one of the values in this table.

    Remote Locationscheme
    Amazon S3™s3
    Windows Azure® Blob Storagewasb, wasbs
    HDFS™hdfs

    For more information, see Work with Remote Data.

    Example: "s3://bucketname/path_to_file/myMdfFile.mf4"

    Data Types: string | char

    Output Arguments

    collapse all

    Channel group information returned in a table of groups.

    Version History

    Introduced in R2023a

    expand all