h5info

有关 HDF5 文件的信息

全页折叠

语法

info = h5info(filename)

info = h5info(filename,loc)

info = h5info(filename,loc,'TextEncoding','UTF-8')

说明

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

示例

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

示例

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

示例

全部折叠

有关整个 HDF5 文件的信息

打开实时脚本

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

info = h5info('example.h5')

info = struct with fields:
      Filename: '/mathworks/devel/bat/filer/batfs1904-0/Bdoc24a.2589924/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/filer/batfs1904-0/Bdoc24a.2589924/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/filer/batfs1904-0/Bdoc24a.2589924/build/matlab/toolbox/matlab/demos/example.h5'
          Name: 'time'
      Datatype: [1x1 struct]
     Dataspace: [1x1 struct]
     ChunkSize: 10
     FillValue: 0
       Filters: []
    Attributes: [2x1 struct]

输入参数

全部折叠

`filename` — 文件名
字符串标量 | 字符向量

现有 HDF5 文件的文件名，指定为字符串标量或字符向量。

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

位置

形式

当前文件夹

指定 filename 中文件的名称。

示例："myFile.h5"

其他文件夹

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

示例："C:\myFolder\myFile.h5"

示例："myFolder\myFile.h5"

远程位置

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

scheme_name://path_to_file/filename

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

远程位置	`scheme_name`
Amazon S3™	`s3`
Windows Azure^® Blob 存储	`wasb`, `wasbs`
HDFS™	`hdfs`

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

示例："s3://myBucket/myFolder/myFile.h5"

如果您的文件包含多个使用 Family 驱动的物理文件，请使用格式设定符指定 filename。例如，要将 Family 驱动用于两个文件 family0.h5 和 family1.h5，请将 filename 指定为 "family%d.h5"。
如果您的文件包含多个使用 Multi 驱动或 Split 驱动的物理文件，请指定 filename 作为物理文件名的前缀。例如，要将 Multi 驱动用于六个文件 multi-b.h5、multi-g.h5、multi-l.h5、multi-o.h5、multi-r.h5 和 multi-s.h5，请将 filename 指定为 "multi"。

`loc` — 文件中的位置
字符向量 | 字符串标量

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

输出参量

全部折叠

`info` — 文件信息
结构体

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

文件和组

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

数据集

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

给定数据类型

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