functions in hdf5.i -
|
_H5Aclose
|
_H5Aclose | |
| SEE | _H5Acreate | |
|
_H5Adelete
|
_H5Adelete | |
| SEE | _H5Acreate | |
|
_H5Aget_name
|
_H5Aget_name | |
| SEE | _H5Acreate | |
|
_H5Aget_num_attrs
|
_H5Aget_num_attrs | |
| SEE | _H5Acreate | |
|
_H5Aget_space
|
_H5Aget_space | |
| SEE | _H5Acreate | |
|
_H5Aget_type
|
_H5Aget_type | |
| SEE | _H5Acreate | |
|
_H5Aopen_idx
|
_H5Aopen_idx | |
| SEE | _H5Acreate | |
|
_H5Aopen_name
|
_H5Aopen_name | |
| SEE | _H5Acreate | |
|
_H5Aread
|
_H5Aread | |
| SEE | _H5Acreate | |
|
_H5Awrite
|
_H5Awrite | |
| SEE | _H5Acreate | |
|
_H5close
|
_H5close | |
| SEE | _H5Eon | |
|
_H5Dcreate
|
_H5Dcreate | |
| SEE | _H5Dclose | |
|
_H5Dget_space
|
_H5Dget_space | |
| SEE | _H5Dclose | |
|
_H5Dget_type
|
_H5Dget_type | |
| SEE | _H5Dclose | |
|
_H5Dopen
|
_H5Dopen | |
| SEE | _H5Dclose | |
|
_H5Dread
|
_H5Dread | |
| SEE | _H5Dclose | |
|
_H5Dreads
|
_H5Dreads | |
| SEE | _H5Areads | |
|
_H5Dwrite
|
_H5Dwrite | |
| SEE | _H5Dclose | |
|
_H5Eoff
|
_H5Eoff | |
| SEE | _H5Eon | |
|
_H5Fclose
|
_H5Fclose | |
| SEE | _H5Fcreate | |
|
_H5Fopen
|
_H5Fopen | |
| SEE | _H5Fcreate | |
|
_H5Gclose
|
_H5Gclose | |
| SEE | _H5Gget_linkval | |
|
_H5Gcreate
|
_H5Gcreate | |
| SEE | _H5Gget_linkval | |
|
_H5Gget_num_objs
|
_H5Gget_num_objs | |
| SEE | _H5Gget_linkval | |
|
_H5Gget_objname_by_idx
|
_H5Gget_objname_by_idx | |
| SEE | _H5Gget_linkval | |
|
_H5Gget_objtype_by_idx
|
_H5Gget_objtype_by_idx | |
| SEE | _H5Gget_linkval | |
|
_H5Gget_objtype_by_name
|
_H5Gget_objtype_by_name | |
| SEE | _H5Gget_linkval | |
|
_H5Glink2
|
_H5Glink2 | |
| SEE | _H5Gget_linkval | |
|
_H5Gopen
|
_H5Gopen | |
| SEE | _H5Gget_linkval | |
|
_H5Gunlink
|
_H5Gunlink | |
| SEE | _H5Gget_linkval | |
|
_H5open
|
_H5open | |
| SEE | _H5Eon | |
|
_H5P_DATASET_CREATE
|
_H5P_DATASET_CREATE | |
| SEE | _H5T_C_S1 | |
|
_H5Pset_chunk
|
_H5Pset_chunk | |
| SEE | _H5Pcreate | |
|
_H5Pset_deflate
|
_H5Pset_deflate | |
| SEE | _H5Pcreate | |
|
_H5Screate
|
_H5Screate | |
| SEE | _H5Sclose | |
|
_H5Screate_simple
|
_H5Screate_simple | |
| SEE | _H5Sclose | |
|
_H5Sget_simple_extent_dims
|
_H5Sget_simple_extent_dims | |
| SEE | _H5Sclose | |
|
_H5Sget_simple_extent_ndims
|
_H5Sget_simple_extent_ndims | |
| SEE | _H5Sclose | |
|
_H5Sget_simple_extent_type
|
_H5Sget_simple_extent_type | |
| SEE | _H5Sclose | |
|
_H5T_IEEE_F32BE
|
_H5T_IEEE_F32BE | |
| SEE | _H5T_C_S1 | |
|
_H5T_IEEE_F32LE
|
_H5T_IEEE_F32LE | |
| SEE | _H5T_C_S1 | |
|
_H5T_IEEE_F64BE
|
_H5T_IEEE_F64BE | |
| SEE | _H5T_C_S1 | |
|
_H5T_IEEE_F64LE
|
_H5T_IEEE_F64LE | |
| SEE | _H5T_C_S1 | |
|
_H5T_NATIVE_CHAR
|
_H5T_NATIVE_CHAR | |
| SEE | _H5T_C_S1 | |
|
_H5T_NATIVE_DOUBLE
|
_H5T_NATIVE_DOUBLE | |
| SEE | _H5T_C_S1 | |
|
_H5T_NATIVE_FLOAT
|
_H5T_NATIVE_FLOAT | |
| SEE | _H5T_C_S1 | |
|
_H5T_NATIVE_INT
|
_H5T_NATIVE_INT | |
| SEE | _H5T_C_S1 | |
|
_H5T_NATIVE_LONG
|
_H5T_NATIVE_LONG | |
| SEE | _H5T_C_S1 | |
|
_H5T_NATIVE_SHORT
|
_H5T_NATIVE_SHORT | |
| SEE | _H5T_C_S1 | |
|
_H5T_STD_B16BE
|
_H5T_STD_B16BE | |
| SEE | _H5T_C_S1 | |
|
_H5T_STD_B16LE
|
_H5T_STD_B16LE | |
| SEE | _H5T_C_S1 | |
|
_H5T_STD_B32BE
|
_H5T_STD_B32BE | |
| SEE | _H5T_C_S1 | |
|
_H5T_STD_B32LE
|
_H5T_STD_B32LE | |
| SEE | _H5T_C_S1 | |
|
_H5T_STD_B64BE
|
_H5T_STD_B64BE | |
| SEE | _H5T_C_S1 | |
|
_H5T_STD_B64LE
|
_H5T_STD_B64LE | |
| SEE | _H5T_C_S1 | |
|
_H5T_STD_B8BE
|
_H5T_STD_B8BE | |
| SEE | _H5T_C_S1 | |
|
_H5T_STD_B8LE
|
_H5T_STD_B8LE | |
| SEE | _H5T_C_S1 | |
|
_H5T_STD_I16BE
|
_H5T_STD_I16BE | |
| SEE | _H5T_C_S1 | |
|
_H5T_STD_I16LE
|
_H5T_STD_I16LE | |
| SEE | _H5T_C_S1 | |
|
_H5T_STD_I32BE
|
_H5T_STD_I32BE | |
| SEE | _H5T_C_S1 | |
|
_H5T_STD_I32LE
|
_H5T_STD_I32LE | |
| SEE | _H5T_C_S1 | |
|
_H5T_STD_I64BE
|
_H5T_STD_I64BE | |
| SEE | _H5T_C_S1 | |
|
_H5T_STD_I64LE
|
_H5T_STD_I64LE | |
| SEE | _H5T_C_S1 | |
|
_H5T_STD_I8BE
|
_H5T_STD_I8BE | |
| SEE | _H5T_C_S1 | |
|
_H5T_STD_I8LE
|
_H5T_STD_I8LE | |
| SEE | _H5T_C_S1 | |
|
_H5T_STD_REF_OBJ
|
_H5T_STD_REF_OBJ | |
| SEE | _H5T_C_S1 | |
|
_H5T_STD_U16BE
|
_H5T_STD_U16BE | |
| SEE | _H5T_C_S1 | |
|
_H5T_STD_U16LE
|
_H5T_STD_U16LE | |
| SEE | _H5T_C_S1 | |
|
_H5T_STD_U32BE
|
_H5T_STD_U32BE | |
| SEE | _H5T_C_S1 | |
|
_H5T_STD_U32LE
|
_H5T_STD_U32LE | |
| SEE | _H5T_C_S1 | |
|
_H5T_STD_U64BE
|
_H5T_STD_U64BE | |
| SEE | _H5T_C_S1 | |
|
_H5T_STD_U64LE
|
_H5T_STD_U64LE | |
| SEE | _H5T_C_S1 | |
|
_H5T_STD_U8BE
|
_H5T_STD_U8BE | |
| SEE | _H5T_C_S1 | |
|
_H5T_STD_U8LE
|
_H5T_STD_U8LE | |
| SEE | _H5T_C_S1 | |
|
_H5T_UNIX_D32BE
|
_H5T_UNIX_D32BE | |
| SEE | _H5T_C_S1 | |
|
_H5T_UNIX_D32LE
|
_H5T_UNIX_D32LE | |
| SEE | _H5T_C_S1 | |
|
_H5T_UNIX_D64BE
|
_H5T_UNIX_D64BE | |
| SEE | _H5T_C_S1 | |
|
_H5T_UNIX_D64LE
|
_H5T_UNIX_D64LE | |
| SEE | _H5T_C_S1 | |
|
_H5Tget_class
|
_H5Tget_class | |
| SEE | _H5Tcopy | |
|
_H5Tget_size
|
_H5Tget_size | |
| SEE | _H5Tcopy | |
|
_H5Tset_cset
|
_H5Tset_cset | |
| SEE | _H5Tcopy | |
|
_H5Tset_size
|
_H5Tset_size | |
| SEE | _H5Tcopy | |
|
_H5Tset_strpad
|
_H5Tset_strpad | |
| SEE | _H5Tcopy | |
|
_H5version
|
_H5version | |
| SEE | _H5Eon | |
|
_hdf5file_struct
|
_hdf5file_struct
struct _hdf5file_struct { string fname; long fd; long nref; string curmode; };
| |
|
_hdf5info
|
_hdf5info
struct _hdf5info { string name, objectType; pointer aname; };
| |
|
h5adelete
|
h5adelete,file,object,aname
Delete attribute "aname" in object "object" in HDF5 file "file"
| |
| SEE ALSO: | h5aread, h5awrite | |
|
h5aread
|
attrib = h5aread(file,object,aname)
Read the value of an object attribute in a HDF5 file
file: file name (string) or file handle (from h5open)
object: object name (type GROUP or DATASET) (string)
aname: attribute name (string) or id (int).
If aname=[], then all attributes of the given object are read out
and returned.
| |
| SEE ALSO: | h5awrite, h5adelete | |
|
h5awrite
|
h5awrite,file,object,aname,attdata
Write an object attribute in a HDF5 file, attached to
a group or a dataset.
file: file name (string) or file handle (from h5open)
object: object name (type GROUP or DATASET) (string)
aname: attribute name (string)
attdata: attribute value (data). Any yorick type. Can be scalar
or an array. HDF5 limits length to about 1000 elements.
| |
| SEE ALSO: | h5aread, h5adelete | |
|
h5close
|
func h5close(files)
Close h5 access to file(s) (after a h5open)
files: scalar or vector of file descriptor or file names
Called without argument, this function closes all opened h5 files.
| |
|
h5delete
|
h5delete,file,object
Unlink or delete an object in a HDF5 file.
file: file name (string) or file handle (from h5open)
object: object name (string)
| |
| SEE ALSO: | h5write, h5read, h5link, h5info | |
|
h5info
|
h5info,filename,target_group,att=
Prints out the content of a HDF5 file (groups, datasets and links)
filename: file name (string) or file descriptor (long)
target_group: the root group at which to start scanning (default "/")
att=1: print out objects attributes (to group and datasets only)
| |
| SEE ALSO: | h5read, h5write, h5link, h5delete | |
|
h5link
|
h5link,file,group,group2link2,linktype
Create a SOFT or HARD link to a group in a HDF5 file
file: file name (string) or file handle (from h5open)
group: group to create that link to group2link2
Must not already exist.
group2link2: group to link to. Must exist. Has to be a group,
Can NOT be a dataset (error).
linktype: link type. valid are:
H5G_LINK_HARD or H5G_LINK_SOFT
| |
| SEE ALSO: | h5read, h5write, h5info, h5delete | |
|
h5list_open
|
func h5list_open(void)
Print (or return) a lit of open h5 files.
| |
| SEE ALSO: | h5open, h5close | |
|
h5off
|
h5ooff
Flushes all data to disk, closes file identifiers, and cleans up memory.
| |
| SEE ALSO: | ||
|
h5open
|
func h5open(fname,mode)
Open file for write, append or read access.
filename: file name
mode: access mode ("r"=read-only; "w"=write; "a"=append)
Returns a file handle that can be used in further calls to HDF5
functions (e.g. h5read, h5write).
If HDF5_SAFE=1, try to open in mode "w" an existing file will
produce an error ( to prevent accidentaly overwritting the data).
Delete the file prior to the h5open call if this is the case.
| |
| SEE ALSO: | h5close, h5list_open | |
|
h5read
|
data=h5read(file,target)
Read content of one dataset in a HDF5 file and return the data
file: h5 file name (string) or h5 file id (output from h5open)
target: dataset name (string)
This will read all data type but datatype will be casted to one
of the yorick datatype (char,short,int,long,float,double,string).
| |
| SEE ALSO: | H5write, h5info, h5link, h5delete | |
|
h5write
|
h5write,file,fullpath,data,zip=,mode=
Write data in a HDF5 file.
fname: file name or file handle (from h5open)
fullpath: full path to the dataset (string), including
hierarchy (ex: "/g1/data"). If parent group(s)
do not exist, they will be created. This function
will refuse to overwrite an existing dataset.
To do so, use delete the dataset with h5delete
prior to the h5write.
data: data. Any yorick valid data. Scalar or arrays.
Any yorick type is accepted (from char to double,
and strings). Strings are stored in H5T_VARIABLE,
which is a variable length type in the HDF5
specification.
zip=N will use compression (N=0-9). Larger N will
compress more (but take longer).
mode= "w"=write-only (erase previous content) or "a"=append
Warning: If file is a string, then mode="w" is used,
which means an existing file will be overwritten.
To update an existing file, use a file handle
with the h5open/h5write/h5close combination.
| |
| SEE ALSO: | h5read, h5info, h5link, h5delete | |
|
hdf5
|
HDF5 plugin: Simple HIERARCHICAL DATA FORMAT 5 wrappers.
DATA I/O:
h5read(fname,target) return data
h5write,fname,fullpath,data,zip=,mode= write data
h5open(filename,mode) return file handle
h5close(filename) close file
INFO, GROUP LINKING:
h5info,fname,target,att= print out file info/structure
h5link(fname,group,group2link2,linktype) link datasets
h5delete,fname,object delete data
ATTRIBUTE I/O:
h5awrite(fname,object,aname,attdata) write an object attribute
h5aread(fname,object,aname) read an object attribute
h5adelete,fname,object,aname delete an object attribute
MISC:
h5list_open list open files
h5version return linhdf5 version
ERROR RECOVERY
h5off close all reference to the
h5 library (clean up).
+ Many of the atomic HDF5 functions are available (e.g. H5Fopen, H5Dopen)
with mostly the same APIs. Many simple tasks can be done with the
provided high level wrappers. Beware that programming an HDF5 custom
wrapper is not trivial. Make sure you close every objects opened!
This implementation supports reading of most of the HDF5 supported
datatype. Only yorick datatype can be used for writes. Compression, soft
and hard links, as well as support for attribute read/writes is provided.
There is no support for hyperslabs, compound, enum or opaque datatype.
Generally, there is very little support for datatype related
functionalities.
EXAMPLES:
1. simplest:
h5write,"sinus.h5","/sin2t","sin(2*indgen(100));
2. ex2: save 2 vectors
fd1=h5open("sinus.h5","w"); // "w" start from scratch
t = span(0.,2*pi,100);
h5write,fd1,"/data/t",t;
h5write,fd1,"/data/sin2t",sin(2*t);
h5close,fd1;
3. ex3: append another vector and attribute
h5write,"sinus.h5","/data/damped sin",sin(t)*exp(-0.7*t),mode="a";
h5awrite,"sinus.h5","/data/damped sin", \
"functional form","sin(t)*exp(-0.7t)";
4. examine the content of the file
h5info,"sinus.h5";
NOTE: HDF5_SAFE is a global flag that, if set, will prevent to open
an existing file in mode "w". In this mode, if the file has indeed
to be overwritten, it needs to be deleted prior to the call to
h5open.
| |
| SEE ALSO: | ||