h5info

Information about HDF5 file

Syntax

info = h5info(filename)

info = h5info(filename,loc)

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

Description

info = h5info(filename) returns information about an entire HDF5 file, including information about the groups, datasets, and named datatypes contained within it.

info = h5info(filename,loc) returns information about the specified location in the HDF5 file.

info = h5info(filename,loc,'TextEncoding','UTF-8') forces object and attribute names to be treated as UTF-8-encoded text. This usage is unnecessary if the HDF5 file accurately specifies the use of UTF-8 encoding.

Examples

Information About Entire HDF5 File

Return information about the entire file 'example.h5'.

info = h5info('example.h5')

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

Information About Group

Return information about the group g4.

info = h5info('example.h5','/g4')

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

Information About Specific Dataset

Return information about the dataset time in the group g4.

info = h5info('example.h5','/g4/time')

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

Input Arguments

filename — File name

character vector | string scalar

File name, specified as a character vector or string scalar containing the name of an existing HDF5 file.

Depending on the location of your file, filename can take on one of these forms.

Location	Form
Current folder	Specify the name of the file in filename. Example: 'myFile.h5'
Other folders	If the file is not in the current folder or in a folder on the MATLAB® path, then specify the full or relative path name in filename. Example: 'C:\myFolder\myFile.h5' Example: 'myFolder\myFile.h5'
Remote Location	If the file is stored at a remote location, then filename must contain the full path of the file specified as a uniform resource locator (URL) of the form: scheme_name://path_to_file/my_file.ext Based on your remote location, scheme_name can be one of the values in this table. Remote Location scheme_name Amazon S3™ s3 Windows Azure® Blob Storage wasb, wasbs HDFS™ hdfs For more information, see Work with Remote Data. Example: 's3://bucketname/path_to_file/myFile.h5'

loc — Location in file

character vector | string scalar

Location in the file, specified as a character vector or string scalar containing the file path of a group, dataset, or named datatype in the file. To return information about the entire file, specify '/' as the location.

Output Arguments

info — File information

structure

File information returned as a structure. The structure has different fields depending on the loc argument points to a file or group, dataset, or named datatype. The following tables list the fields that are present for each location type.

Files and Groups

Field	Description
Name	Character vector specifying name of the group or dataset. If you specify only the HDF5 file name, the function will return information about the root group.
Groups	Array of structures describing subgroups.
Datasets	Array of structures describing datasets.
Datatypes	Array of structures describing named datatypes.
Links	Array of structures describing soft, external, user-defined, and certain hard links.
Attributes	Array of structures describing group attributes.

Datasets

Field	Description
Name	Character vector specifying the name of the dataset.
Datatype	Structure describing the datatype.
Dataspace	Structure describing the size of the dataset.
ChunkSize	Dimensions of the dataset chunk size, if defined.
FillValue	Fill value for missing data, if defined.
Filter	Array of structures describing any defined filters, such as compression.
Attributes	Array of structures describing dataset attributes.

Named Datatypes

Field	Description
Name	Character vector specifying the name of the datatype object.
Class	HDF5 class of the named datatype.
Type	Character vector or struct further describing the datatype.
Size	Size of the named datatype in bytes.