Main Content

h5info

有关 HDF5 文件的信息

说明

示例

info = h5info(filename) 返回整个 HDF5 文件的有关信息,包括其中包含的组、数据集和命名数据类型的有关信息。

示例

info = h5info(filename,loc) 返回 HDF5 文件中指定位置的有关信息。

info = h5info(filename,loc,'TextEncoding','UTF-8') 强制将对象和属性名称视为 UTF-8 编码文本。如果 HDF5 文件准确地指定使用 UTF-8 编码,则这种用法是不必要的。

示例

全部折叠

返回 example.h5 整个文件的有关信息。

info = h5info('example.h5')
info = struct with fields:
      Filename: '/mathworks/devel/bat/Bdoc22b/build/matlab/toolbox/matlab/demos/example.h5'
          Name: '/'
        Groups: [4x1 struct]
      Datasets: []
     Datatypes: []
         Links: []
    Attributes: [2x1 struct]

返回 g4 组的有关信息。

info = h5info('example.h5','/g4')
info = struct with fields:
      Filename: '/mathworks/devel/bat/Bdoc22b/build/matlab/toolbox/matlab/demos/example.h5'
          Name: '/g4'
        Groups: []
      Datasets: [4x1 struct]
     Datatypes: []
         Links: []
    Attributes: []

返回 g4 组中数据集 time 的有关信息。

info = h5info('example.h5','/g4/time')
info = struct with fields:
      Filename: '/mathworks/devel/bat/Bdoc22b/build/matlab/toolbox/matlab/demos/example.h5'
          Name: 'time'
      Datatype: [1x1 struct]
     Dataspace: [1x1 struct]
     ChunkSize: 10
     FillValue: 0
       Filters: []
    Attributes: [2x1 struct]

输入参数

全部折叠

文件名,指定为包含现有 HDF5 文件名称的字符向量或字符串标量。

根据文件的位置,filename 可以采用下列形式之一。

位置

形式

当前文件夹

指定 filename 中文件的名称。

示例:'myFile.h5'

其他文件夹

如果该文件不在当前文件夹或 MATLAB® 路径下的文件夹中,则在 filename 中指定完整或相对路径名。

示例:'C:\myFolder\myFile.h5'

示例:'myFolder\myFile.h5'

远程位置

如果文件存储在远程位置,则 filename 必须包含指定为统一资源定位器 (URL) 形式的文件的完整路径:

scheme_name://path_to_file/my_file.ext

根据您的远程位置,scheme_name 可以是下表中的值之一。

远程位置scheme_name
Amazon S3™s3
Windows Azure® Blob Storagewasb, wasbs
HDFS™hdfs

有关详细信息,请参阅处理远程数据

示例:'s3://bucketname/path_to_file/myFile.h5'

文件中的位置,指定为字符向量或字符串标量,其中包含文件中的组、数据集或命名数据类型的文件路径。要返回整个文件的有关信息,请指定 '/' 作为位置。

输出参数

全部折叠

文件信息,以结构体形式返回。根据 loc 参数指向文件或组、数据集或命名数据类型,该结构体具有不同字段。下表列出了针对每个位置类型提供的字段。

文件和组

字段描述
Name用来指定组或数据集名称的字符向量。如果您只指定 HDF5 文件名,该函数将返回根组的有关信息。
Groups描述子组的结构体数组。
Datasets描述数据集的结构体数组。
Datatypes描述给定数据类型的结构体数组。
Links描述用户定义的外部软链接和某些硬链接的结构体数组。
Attributes 描述组属性的结构体数组。

数据集

字段描述
Name指定数据集名称的字符向量。
Datatype描述数据类型的结构体。
Dataspace描述数据集大小的结构体。
ChunkSize数据集分块大小的维度(如果已定义)。
FillValue缺失数据的填充值(如果已定义)。
Filter描述任何定义的过滤器(例如压缩)的结构体数组。
Attributes描述数据集属性的结构体数组。

给定数据类型

字段描述
Name用来指定数据类型对象名称的字符向量。
Class 给定数据类型的 HDF5 类。
Type用来进一步描述数据类型的字符向量或结构体。
Size给定数据类型的大小(以字节为单位)。

版本历史记录

在 R2011a 中推出