From 112c684fa57a959b51710481e6716755c1f5f666 Mon Sep 17 00:00:00 2001 From: Bill Wendling Date: Thu, 12 Apr 2001 17:20:46 -0500 Subject: [svn-r3806] Purpose: Update Description: Wrote description of the subsetting feature that the h5dumper has. Platforms tested: w3m --- doc/html/Tools.html | 655 +++++++++++++++++++++++++++------------------------- 1 file changed, 346 insertions(+), 309 deletions(-) diff --git a/doc/html/Tools.html b/doc/html/Tools.html index e45cf21..5a2d3d8 100644 --- a/doc/html/Tools.html +++ b/doc/html/Tools.html @@ -9,420 +9,457 @@
-
- - - - -
Introduction to HDF5 -
HDF5 User Guide -
Other HDF5 documents and links -
And in this document, the HDF5 -Reference Manual -
H5  H5A -H5D  -H5E -H5F  H5G +
-H5I  H5P -
H5R  H5S -H5T  -H5Z   Tools  Datatypes
+ + + + + + +
+ Introduction to HDF5
+ HDF5 User Guide
+ Other HDF5 documents and links
+ + 		+ And in this document, the HDF5 Reference Manual
+ H5 + H5A + H5D + H5E + H5F + H5G + H5I + H5P + +
+ + H5R + H5S + H5T + H5Z + Tools + Datatypes +
-
-
-

-HDF5 Tools

+ -

-HDF5 Tool Interfaces

-These tools enable the user to examine HDF5 files interactively. - - - - +
-
    -
  • -h5dump -- A tool for displaying HDF5 file contents 
    • +
    -
  • -h5ls -- A tool for listing specified features of -HDF5 file contents 
    • +

    HDF5 Tools

    -
  • -h5repart -- A tool for repartitioning a file, -creating a family of files 
    • +

    HDF5 Tool Interfaces

    -
  • -h5toh4 -- A tool for converting an HDF5 file -to an HDF4 file 
    • +These tools enable the user to examine HDF5 files interactively. -
  • -h4toh5 -- A tool for converting an HDF4 file -to an HDF5 file
    • -
-
+ + +
+
    +
  • h5dump -- A tool for displaying + HDF5 file contents
    • + +
  • h5ls -- A tool for listing specified + features of HDF5 file contents
    • + +
  • h5repart -- A tool for + repartitioning a file, creating a family of files
    • + +
  • h5toh4 -- A tool for converting + an HDF5 file to an HDF4 file
    • + +
  • h4toh5 -- A tool for converting + an HDF4 file to an HDF5 file
    • +
+

+

+
-
-Tool Name: h5dump
+
Tool Name: h5dump
-
-Syntax:
+
Syntax:
-
-h5dump [OPTIONS] file
+
h5dump [OPTIONS] file
-
-Purpose:
+
Purpose:
-
-Displays HDF5 file contents in HDF5 DDL or XML.
+
Displays HDF5 file contents in HDF5 DDL or XML.
-
-Description:
+
Description:
-
-h5dump enables the user to interactively examine the contents -of an HDF5 file and dump those contents, in human readable form, to an -ASCII file.  Optionally, the contents of the file may be dumped as -XML.
+
+

+The h5dump tool enables the user to interactively examine the +contents of an HDF5 file and dump those contents, in human readable form, +to an ASCII file. Optionally, the contents of the file may be dumped as +XML. +

-
  -

  -
  -
  -

h5dump displays HDF5 file content on standard output. It may -display the content of the whole HDF5 file or selected objects, which can -be groups, datasets, links, attributes, or data types. -

The --header option displays object header information only. -

Names are the absolute names of the objects. h5dump displays -objects in the order same as the command order. If a name does not start -with a slash, h5dump begins searching for the specified object -starting at the root group. -

If an object is hard linked with multiple names, h5dump displays -the content of the object in the first occurrence. Only the link information -is displayed in later occurrences. -

h5dump assigns a name for any unnamed data type in the form -of #oid1:oid2, where oid1 and oid2 -are the object identifiers assigned by the library. The unnamed types are -displayed within the root group. -

Data types are displayed with standard type names. For example, if a -data set is created with H5T_NATIVE_INT type and the standard -type name for integer on that machine is H5T_STD_I32BE, h5dump -displays H5T_STD_I32BE as the type of the data set. -

The h5dump output is described in detail in the DDL -for HDF5, the Data Description Language document. -

Note: It is no longer permissable to specify multiple attributes, +

+h5dump dumps an HDF5 file's contents to standard output. It can +display the contents of the whole HDF5 file or selected objects, which +can be groups, datasets, a subset of a dataset, links, attributes, or +data types. +

+ +

+The --header option displays object header information only. +

+ +

+Names are the absolute names of the objects. h5dump displays +objects in the same order as given on the command line. If a name does +not start with a slash (/), h5dump begins searching for the +specified object starting at the root group. +

+ +

+If an object is hard linked with multiple names, h5dump displays +the contents of the object in the first occurrence. Only the link +information is displayed in later occurrences. +

+ +

+h5dump assigns a name for any unnamed data type in the form of +#oid1:oid2, where oid1 and +oid2 are the object identifiers assigned by the library. The +unnamed types are displayed within the root group. +

+ +

+Data types are displayed with standard type names. For example, if a data +set is created with H5T_NATIVE_INT type and the standard type +name for integer on that machine is H5T_STD_I32BE, +h5dump displays H5T_STD_I32BE as the type of the data +set. +

+ +

+h5dump can also be used to dump a subset of data from a dataset. +It operates in much the same way that hyperslabs do in the HDF5 library. +The parameters specified on the command line are passed to the +H5Sselect_hyperslab +function and the resulting selection is then displayed. +

+ +

+The h5dump output is described in detail in the DDL for HDF5, the Data Description +Language document. +

+ +

+Note: It is no longer permissable to specify multiple attributes, datasets, data types, groups, or soft links with one flag. For example, before one could issue the command: -

h5dump -a /attr1 /attr2 foo.h5
-and both /attr1 and /attr2 would be dumped. In order -to do this now, one must issue the command: -
h5dump -a /attr1 -a /attr2 foo.h5
+

-
-XML Output
+
+ h5dump -a /attr1 /attr2 foo.h5 +
-
The --xml option selects output in XML. The XML output contains -a complete description of the file, marked up in XML. The XML conforms -to the HDF5 Document Type Definition (DTD), which is available at: -
http://hdf.ncsa.uiuc.edu/DTDs/HDF5-File.dtd
+

+and both /attr1 and /attr2 would be dumped. In order to +do this now, one must issue the command: +

-


The XML output is suitable for use with other tools, including the -HDF5 -Java Tools. -
  -

-Options and Parameters:
+
+ h5dump -a /attr1 -a /attr2 foo.h5 +
-
-
--h   or   --help
+
XML Output
-
-Print a usage message and exit.
+

+The --xml option selects output in XML. The XML output contains +a complete description of the file, marked up in XML. The XML conforms to +the HDF5 Document Type Definition (DTD), which is available at: +

-
--B   or   --bootblock
+
http://hdf.ncsa.uiuc.edu/DTDs/HDF5-File.dtd
-
-Print the content of the boot block.
+

+The XML output is suitable for use with other tools, including the HDF5 Java Tools. +

-
(This option is not yet implemented.) -
--H   or   --header
+
Options and Parameters:
-
-Print the header only; no data is displayed.
+
+
-h   or   --help
-
--i   or   --object-ids
+
Print a usage message and exit.
-
-Print the object ids.
+
-B   or   --bootblock
-
--V   or   --version
+
Print the content of the boot block.
+ (This option is not yet implemented.)
-
-Print version number and exit.
+
-H   or   --header
-
--a P   or   --attribute=P
+
Print the header only; no data is displayed.
-
-Print the specified attribute.
+
-i   or   --object-ids
-
--d P   or   --dataset=P
+
Print the object ids.
-
-Print the specified dataset.
+
-V   or   --version
-
--g P   or   --group=P
+
Print version number and exit.
-
-Print the specified group and all members.
+
-a P   or   --attribute=P
-
--l P   or   --soft-link=P
+
Print the specified attribute.
-
-Print the value(s) of the specified soft link.
+
-d P   or   --dataset=P
-
--o F   or   --output=F
+
Print the specified dataset.
-
-Output raw data into file F.
+
-g P   or   --group=P
-
--t T   or   --datatype=T
+
Print the specified group and all members.
-
-Print the specified named data type.
+
-l P   or   --soft-link=P
-
--w #   or   --width=#
+
Print the value(s) of the specified soft link.
-
-Set the number of columns of output.
+
-o F   or   --output=F
-
--x #   or   --xml
+
Output raw data into file F.
-
-Output XML instead of DDL.
+
-t T   or   --datatype=T
-
--D #   or   --xml-dtd=URI
+
Print the specified named data type.
-
-In XML output, refer to the DTD at URI instead of the default DTD.
+
-w N   or   --width=N
-
-file
+
Set the number of columns of output.
-
-The file to be examined.
-
+
-x U   or   --xml
-
    -
  • -P - is the full path from the root group to the object.
    • +
    Output XML instead of DDL.
    -
  • -T - is the name of the data type.
    • +
    -D U   or   --xml-dtd=U
    -
  • -F - is a filename.
    • +
    In XML output, refer to the DTD at U instead of the default DTD.
    -
  • -# - is an integer greater than 1.
    • +
    -s L   or   --start=L
    + +
    Offset of start of subsetting selection [Default: beginning of + dataset]
    + +
    -S L   or   --stride=L
    + +
    Hyperslab stride [Default: 1 in all dimensions]
    -
  • -URI - is a URI (as defined in [IETF -RFC 2396], updated by [IETF -RFC 2732]) that refers to the DTD to be used to validate the XML.
    • -
+
-c L   or   --count=L
+ +
Number of blocks to include in selection
-
-Examples:
+
-k L   or   --block=L
+ +
Size of block in hyperslab [Default: 1 in all dimensions]
-
    -
  1. -Dumping the group /GroupFoo/GroupBar in the file quux.h5:
    2. +
    file
    -
    h5dump -g /GroupFoo/GroupBar quux.h5
    +
    The file to be examined.
    +
-
  • -Dumping the dataset Fnord in the group /GroupFoo/GroupBar -in the file quux.h5:
    • + -
    -
    +

    +Subsetting parameters can be specified in a convenient compact format. +The format is: +

    -
    -Current Status:
    +
    + --dataset="/foo/mydataset[START;STRIDE;COUNT;BLOCK]" +
    -
    -The current version of h5dump displays the following information:
    +

    +All of the semicolons (;) are required to be there even if you don't +specify a value for the parameter (thereby using the default value). +

    - + +
    See Also:
    + +
    HDF5 Data Description Language syntax (DDL + for HDF5)
    + +
    HDF5 XML DTD: http://hdf.ncsa.uiuc.edu/DTDs/HDF5-File.dtd
    + +
    HDF5 XML information: http://hdf.ncsa.uiuc.edu/HDF5/XML/
    +
    +
    Tool Name: h5ls
    @@ -776,7 +813,7 @@ The HDF4 file to be created.
    h4toh5 h4file h5file
    h4toh5 h4file
    @@ -903,20 +940,20 @@ The HDF5 file to be created.
    Tool Name: h5toh4
    Syntax: -
    h5toh4 -h
    - h5toh4 +
    h5toh4 -h
    + h5toh4 h5file h4file
    - h5toh4 + h5toh4 h5file
    - h5toh4 -m + h5toh4 -m h5file1 h5file2 h5file3 ...
    Purpose:
    Purpose...
    Description: -
    TOOL is an HDF5 utility which ... +
    TOOL is an HDF5 utility which ... Paragraph 
                  sample code
               sample code
@@ -927,7 +964,7 @@ The HDF5 file to be created.
    Paragraph
    Options and Parameters:
    -
    -option +
    -option
    Description
    parameter
    Description -- cgit v0.12