MG Library

Library of Michael Galloy

single page | use frames     summary     class     fields     routine details     file attributes

hdf5/

mg_h5_dump.pro

file i/o, hdf5, sdf

includes main-level program

Dumps the structure of an HDF5 file to the output log. This routine does not read any data, it simply finds the names and datatypes of datasets, groups, types, and links.

Examples

See the attached main-level program for a simple example: IDL> .run mg_h5_dump

Routines

result = mg_h5_dump_typedecl(typeId, spaceId)

Return a string representing an IDL declaration of the given item (attribute or dataset).

mg_h5_dump_level, groupId, level=long, cache=strarr [, /objects] [, /attributes]

Parse a dataset or group.

mg_h5_dump, filename

Parse and display a simple hierarchy of contents of a HDF5 file.

Routine details

topmg_h5_dump_typedecl

result = mg_h5_dump_typedecl(typeId, spaceId)

Return a string representing an IDL declaration of the given item (attribute or dataset).

Return value

string

Parameters

typeId in required type=long

type identifier

spaceId in required type=long

dataspace identifier

topmg_h5_dump_level

mg_h5_dump_level, groupId, level=long, cache=strarr [, /objects] [, /attributes]

Parse a dataset or group.

Parameters

groupId in required type=long

identifier of parent item to parse (group or dataset)

Keywords

level in required type=long

level from root (where root is level 0)

cache in out required type=strarr

cache of fileno and objno used to identify a hard link

objects in optional type=boolean

set to parse objects (i.e. for groups)

attributes in optional type=boolean

set to parse attributes (i.e. for datasets and non-top-level groups)

topmg_h5_dump

mg_h5_dump, filename

Parse and display a simple hierarchy of contents of a HDF5 file.

Parameters

filename in required type=string

HDF5 file to parse

File attributes

Modification date: Fri Jun 27 17:15:32 2008
Lines: 172
Docformat: rst rst