Описание
Используйте MATLAB® HDF5 приписывают интерфейс, H5A
, чтобы создать, читайте, и набор данных записи и атрибуты группы и информация о доступе о них.
Атрибут HDF5 является маленьким объектом метаданных, который описывает природу и/или предназначенное использование объекта первичных данных, который может быть набором данных, группой или названным типом данных.
Функции
H5A.close
Закройте заданный атрибут
H5A.close(attrID)
отключает доступ к атрибуту, заданному attrID
, выпуск идентификатора.
H5A.create
Создайте атрибут
attrID = H5A.create(locID,attname,typeID,spaceID,acplID)
создает атрибут с именем attname
это присоединено к объекту, заданному locID
. Этот синтаксис соответствует H5Acreate
в версии 1.6 библиотеки HDF5 C.
attrID = H5A.create(locID,attname,typeID,spaceID,acplID,aaplID)
создает атрибут с дополнительным идентификатором списка свойств доступа к атрибуту aaplID
. Этот синтаксис соответствует H5Acreate
в версии 1.8 библиотеки HDF5 C.
Детали
Входные параметры
locID
— Группа, набор данных или названный идентификатор типа данных.
attname
— Название атрибута.
typeID
— Припишите идентификатор типа данных, созданное использование H5T
интерфейс.
spaceID
— Припишите идентификатор пространства данных, созданное использование H5S
интерфейс.
acplID
— Припишите идентификатор списка свойств. Этот аргумент в настоящее время не использован и должен быть установлен в 'H5P_DEFAULT'
.
aaplID
— Дополнительный идентификатор списка свойств доступа к атрибуту. Это значение должно в настоящее время быть установлено к 'H5P_DEFAULT'
.
H5A.delete
Удалите атрибут
H5A.delete(locID,attname)
удаляет атрибут, заданный attname
от набора данных группа или названный тип данных задана locID
.
H5A.get_info
Информация об атрибуте
info = H5A.get_info(attrID)
возвращает информацию об атрибуте, заданном attrID
.
H5A.get_name
Название атрибута
attname = H5A.get_name(attrID)
возвращает имя атрибута, заданного attrID
.
attname = H5A.get_name(attrID,'TextEncoding',encoding)
задает текстовое кодирование, чтобы использовать, чтобы интерпретировать название атрибута.
Детали
H5A.get_space
Копия пространства данных атрибута
dspaceID = H5A.get_space(attrID)
возвращает копию пространства данных для атрибута, заданного attrID
.
H5A.get_type
Копия типа данных атрибута
typeID = H5A.get_type(attrID)
возвращает копию типа данных для атрибута, заданного attrID
.
H5A.iterate
Выполните функцию для атрибутов, присоединенных к объекту
H5A.iterate(locID,idx,fnc)
выполняет заданную функцию для каждого атрибута группы, набора данных или названного типа данных, заданного locID
. Этот интерфейс соответствует H5Aiterate1
функция в библиотеке HDF5 C.
Детали
Входные параметры
locID
— Группа, набор данных или названный идентификатор типа данных.
idx
— Индексируйте, в котором начинается итерация.
fnc
— Указатель функции обратного вызова с этой подписью: status = fnc(locID,attname)
.
attname
— Текущий атрибут.
Выходные аргументы
Выходной аргумент fnc
функция:
[status,idxStop,cdataOut] = H5A.iterate(objID,idxType,order,idxStart,fnc,cdataIn)
выполняет заданный функциональный fnc
для каждого атрибута, соединенного с объектом. Этот интерфейс соответствует H5Aiterate2
функция в библиотеке HDF5 C.
Детали
Входные параметры
objID
— Объект, к которому присоединяются атрибуты.
idxType
— Тип индекса в виде одного из этих значений:
order
— Индексируйте пересекающийся порядок в виде одного из этих значений:
'H5_ITER_INC'
— Итерация с начала до конца.
'H5_ITER_DEC'
— Итерация от конца до начала.
'H5_ITER_NATIVE'
— Итерация в самом быстром доступном порядке.
idxStart
— Начальная точка итерации.
fnc
— Функция обратного вызова с этой подписью: [status,cdataOut] = fnc(locID,attname,info,cdataIn)
.
attname
— Текущий атрибут.
info
— Информационная структура атрибута.
cdataIn
— Пользовательское значение или структура и передаются первому шагу итерации в fnc
cdataIn
параметр.
Выходные аргументы
status
— Значение возвращено функцией обратного вызова fnc
и интерпретированный как одно из этих значений:
zero
— Продолжает итерацию или возвращает нулевое значение состояния вызывающей стороне, если все члены были обработаны.
positive
— Останавливает итерацию и возвращает положительное значение состояния вызывающей стороне.
negative
— Останавливает итерацию и выдает ошибку при указании на отказ.
idxStop
— Остановка точки итерации. H5A.iterate
функция возвращает значение idxStop
, который может использоваться, чтобы возобновить прерванную итерацию.
cdataOut
— Значение, которое формирует cdataIn
для следующего шага итерации. Затем итоговый cdataOut
в конце итерации возвращен в вызывающую сторону как cdataOut
.
H5A.open
Открытый атрибут
attrID = H5A.open(objID,attname)
открывает атрибут для объекта, заданного идентификатором родительского объекта objID
и название атрибута attname
.
attrID = H5A.open(objID,attname,aaplID)
открывает атрибут с идентификатором списка свойств доступа к атрибуту aaplID
.
Детали
Входные параметры
objID
— Идентификатор родительского объекта.
attname
— Название атрибута.
aaplID
— Припишите идентификатор списка свойств доступа. Единственное в настоящее время допустимое значение для aaplID
'H5P_DEFAULT'
.
H5A.open_by_idx
Открытый атрибут задан индексом
attrID = H5A.open_by_idx(locID,objname,idxType,order,n)
открывает существующий атрибут в индексе n
присоединенный к объекту, заданному его местоположением, locID
, и имя, objname
.
attrID = H5A.open_by_idx(locID,objname,idxType,order,n,aaplID,laplID)
открывает атрибут с идентификатором списка свойств доступа к атрибуту aaplID
и соедините идентификатор списка свойств доступа laplID
.
Детали
Входные параметры
locID
— Группа, набор данных или названный идентификатор типа данных.
objname
— Имя группы, набора данных или названного типа данных.
idxType
— Тип индекса в виде одного из этих значений:
order
— Индексируйте пересекающийся порядок в виде одного из этих значений:
'H5_ITER_INC'
— Итерация с начала до конца.
'H5_ITER_DEC'
— Итерация от конца до начала.
'H5_ITER_NATIVE'
— Итерация в самом быстром доступном порядке.
n
— Индексируйте, в котором можно открыть существующий атрибут.
aaplID
— Припишите идентификатор списка свойств доступа. aaplID
аргумент должен в настоящее время быть задан как 'H5P_DEFAULT'
.
laplID
— Соедините идентификатор списка свойств доступа. laplID
может быть задан как 'H5P_DEFAULT'
.
H5A.open_by_name
Открытый атрибут задан по наименованию
attrID = H5A.open_by_name(locID,objname,attname)
открывает существующий атрибут, присоединенный к объекту, заданному его местоположением locID
и назовите objname
.
attrID = H5A.open_by_name(locID,objname,attname,aaplID,laplID)
открывает существующий атрибут с идентификатором списка свойств доступа к атрибуту aaplID
и соедините идентификатор списка свойств доступа laplID
.
Детали
Входные параметры
locID
— Группа, набор данных или названный идентификатор типа данных.
objname
— Имя группы, набора данных или названного типа данных.
attname
— Существующее название атрибута.
aaplID
— Припишите идентификатор списка свойств доступа. aaplID
аргумент должен быть задан как 'H5P_DEFAULT'
.
laplID
— Соедините идентификатор списка свойств доступа. laplID
аргумент может быть задан как 'H5P_DEFAULT'
.
H5A.read
Считайте атрибут
attr = H5A.read(attrID)
читает атрибут, заданный attrID
. MATLAB определит соответствующий тип данных памяти.
attr = H5A.read(attrID,memtypeID)
читает атрибут, заданный attrID
.
Детали
Входные параметры
attrID
— Припишите идентификатор.
memtypeID
— Тип данных памяти атрибута, и должен обычно даваться как 'H5ML_DEFAULT'
, который указывает, что MATLAB определит соответствующий тип данных памяти.
Примечание
Библиотека HDF5 использует упорядоченное расположение C-стиля для многомерных массивов, в то время как MATLAB использует упорядоченное расположение FORTRAN-style. Например, если библиотека HDF5 сообщает о размере атрибута как 3 4 5, то соответствующий размер MATLAB массивов 5 4 3. Для получения дополнительной информации смотрите, Размерности Набора данных Отчета.
H5A.write
Запишите атрибут
H5A.write(attrID,typeID,buf)
написали данные в буферном buf
в атрибут, заданный attrID
использование типа данных памяти typeID
.
Детали
Входные параметры
attrID
— Припишите идентификатор.
typeID
— Тип данных памяти атрибута. Типом данных памяти должен быть 'H5ML_DEFAULT'
, который указывает, что MATLAB должен определить соответствующий тип данных памяти.
buf
— Буфер данных.
Примечание
Библиотека HDF5 использует упорядоченное расположение C-стиля для многомерных массивов, в то время как MATLAB использует упорядоченное расположение FORTRAN-style. Например, если размер MATLAB массивов 5 4 3, то библиотека HDF5 должна сообщать о размере атрибута как 3 4 5. Для получения дополнительной информации смотрите, Размерности Набора данных Отчета.