Main Content

h5readatt

Read attribute from HDF5 file

Description

example

attval = h5readatt(filename,loc,attr) retrieves the value of the specified attribute from the specified location in an HDF5 file.

Examples

collapse all

Read the attribute attr2 from the root group of the HDF5 file example.h5.

val = h5readatt('example.h5','/','attr2')
val = 2x2 int32 matrix

   0   2
   1   3

Read the attribute units from the dataset lon in the HDF5 file example.h5.

val = h5readatt('example.h5','/g4/lon','units')
val = 
'degrees_east'

Input Arguments

collapse all

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 Locationscheme_name
Amazon S3™s3
Windows Azure® Blob Storagewasb, wasbs
HDFS™hdfs

For more information, see Work with Remote Data.

Example: 's3://bucketname/path_to_file/myFile.h5'

Location in the file, specified as a character vector or string scalar containing the full path of an existing group or dataset to which the attribute belongs. To read an attribute from the root group of the file, specify '/' as the location.

Attribute name, specified as a character vector or string scalar containing the name of an attribute belonging to a group or dataset.

Introduced in R2011a