[svn-r8908] Purpose:
updated documentation and usage message Description: updated the html documentation for the new h5diff modes added a section for h5repack Solution: Platforms tested: linux Misc. update:
This commit is contained in:
Pedro Vicente Nunes
@@ -27,7 +27,6 @@ HDF5/Tools API Specification
|
||||
<body bgcolor="#FFFFFF">
|
||||
<!-- HEADER RIGHT " " -->
|
||||
|
||||
|
||||
<!-- #BeginLibraryItem "/ed_libs/NavBar_RM.lbi" --><hr>
|
||||
<center>
|
||||
<table border=0 width=98%>
|
||||
@@ -96,8 +95,9 @@ installed with HDF5.
|
||||
<li><a href="#Tools-Ls">h5ls</a> --
|
||||
Lists specified features of HDF5 file contents
|
||||
<li><a href="#Tools-Diff">h5diff</a> --
|
||||
Compares two HDF5 files and reports the differences
|
||||
<em>(Beta version)</em>
|
||||
Compares two HDF5 files and reports the differences.
|
||||
<li><a href="#Tools-Repack">h5repack</a> -- Copies an HDF5 file to a new
|
||||
file with or without compression/chunking.
|
||||
<li><a href="#Tools-Perf">h5perf</a> --
|
||||
Measures HDF5 performance
|
||||
<li><a href="#Tools-Repart">h5repart</a> --
|
||||
@@ -596,7 +596,7 @@ installed with HDF5.
|
||||
<!-- HEADER RIGHT "h5diff" -->
|
||||
<hr>
|
||||
<dl>
|
||||
<dt><strong>Tool Name:</strong> <a name="Tools-Diff">h5diff</a> <em>(Beta version)</em>
|
||||
<dt><strong>Tool Name:</strong> <a name="Tools-Diff">h5diff</a>
|
||||
<dt><strong>Syntax:</strong>
|
||||
<dd><code>h5diff </code> <em>file1</em> <em>file2</em>
|
||||
[<em>OPTIONS</em>]
|
||||
@@ -619,9 +619,19 @@ installed with HDF5.
|
||||
<em>object1</em> in <em>file1</em>
|
||||
with <em>object2</em> in <em>file2</em>.
|
||||
These objects must be HDF5 datasets.
|
||||
<dd>
|
||||
<p>
|
||||
<em>object1</em> and <em>object2</em> must be expressed
|
||||
as absolute paths from the respective file's root group.
|
||||
<dd>
|
||||
<p>
|
||||
<code>h5diff</code> has the following four modes of output:<br>
|
||||
Normal mode: print the number of differences found and where they occurred<br>
|
||||
Report mode (-r): print the above plus the differences<br>
|
||||
Verbose mode (-v): print the above plus a list of objects and warnings<br>
|
||||
Quiet mode (-q): do not print output (h5diff always returns an exit code of
|
||||
1 when differences are found).
|
||||
<dd>
|
||||
<p>
|
||||
Additional information, with several sample cases,
|
||||
can be found in the document
|
||||
@@ -633,12 +643,11 @@ installed with HDF5.
|
||||
<dt><em>file2</em>
|
||||
<dd>The HDF5 files to be compared.
|
||||
<dt><code>-h</code>
|
||||
<dd>Print all differences.
|
||||
<dd>help message.
|
||||
<dt><code>-r</code>
|
||||
<dd>Print only the names of objects that differ;
|
||||
do not print the differences.
|
||||
These objects may be HDF5 datasets, groups,
|
||||
or named datatypes.
|
||||
<dd>Report mode. Print the differences.<dt><code>-v</code>
|
||||
<dd>Verbose mode. Print the differences, list of objects, warnings.<dt><code>-q</code>
|
||||
<dd>Quiet mode. Do not print output.
|
||||
<dt><code>-n</code> <em>count</em>
|
||||
<dd>Print difference up to <em>count</em> differences,
|
||||
then stop.
|
||||
@@ -681,7 +690,10 @@ installed with HDF5.
|
||||
<dd>And this <code>h5diff</code> call compares
|
||||
all objects in both files:<br>
|
||||
<code> h5diff file1 file2</code>
|
||||
<!--
|
||||
<br>
|
||||
file1 and file2 can be the same file. Use:<br>
|
||||
<code> h5diff </code><code> file1 file1 /g1/dset1 /g1/dset2</code> <br>
|
||||
to compare <code>/g1/dset1</code> and <code>/g1/dset2</code> in the same file<!--
|
||||
<dt><strong>Current Status:</strong>
|
||||
<dd>
|
||||
<dt><strong>See Also:</strong>
|
||||
@@ -691,6 +703,89 @@ installed with HDF5.
|
||||
|
||||
<!-- NEW PAGE -->
|
||||
<!-- HEADER RIGHT "h5repart" -->
|
||||
<hr>
|
||||
<dl>
|
||||
<dt><strong>Tool Name:</strong> <a name="Tools-Repack">h5repack</a>
|
||||
<dt><strong>Syntax:</strong>
|
||||
<dd><code>h5repack </code> -i <em>file1</em>-o <em>file2</em> [-h] [-v] [-f
|
||||
'<i>filter</i>'] [-l '<i>layout</i>'][-m number][-e file]
|
||||
<dt><strong>Purpose:</strong>
|
||||
<dd>Copies an HDF5 file to a new file with or without compression/chunking.
|
||||
<dt><strong>Description:</strong>
|
||||
<dd><code>h5repack</code> is a command line tool that applies HDF5 filters
|
||||
to a input file <em>file1</em>, saving the output in a new file, <em>file2</em>.<p>'<i>filter</i>'
|
||||
is a string with the format <br>
|
||||
<list of objects> : <name of filter> = <filter
|
||||
parameters>.<br>
|
||||
<br>
|
||||
<list of objects> is a comma separated list of object names
|
||||
meaning apply compression only to those objects. If no object names are
|
||||
specified, the filter is applied to all objects<br>
|
||||
<name of filter> can be: <br>
|
||||
GZIP, to apply the HDF5 GZIP filter (GZIP compression)<br>
|
||||
SZIP, to apply the HDF5 SZIP filter (SZIP compression)<br>
|
||||
SHUF, to apply the HDF5 shuffle filter<br>
|
||||
FLET, to apply the HDF5 checksum filter<br>
|
||||
NONE, to remove the filter <br>
|
||||
<filter parameters> is optional compression info <br>
|
||||
SHUF (no parameter) <br>
|
||||
FLET (no parameter) <br>
|
||||
GZIP=<deflation level> from 1-9 <br>
|
||||
SZIP=<pixels per block,coding> (pixels per block is a even number in
|
||||
2-32 and coding method is 'EC' or 'NN')
|
||||
<dt> </dt>
|
||||
<dd>'<i>layout'</i> is a string with the format<br>
|
||||
<list of objects> : <layout type> <br>
|
||||
<br>
|
||||
<list of objects> is a comma separated list of object names, meaning
|
||||
that layout information is supplied for those objects. If no object names are
|
||||
specified, the layout is applied to all objects <br>
|
||||
<layout type> can be: <br>
|
||||
CHUNK, to apply chunking layout <br>
|
||||
COMPA, to apply compact layout <br>
|
||||
CONTI, to apply continuous layout <br>
|
||||
<layout parameters> is present for the chunk case only it is the chunk
|
||||
size of each dimension: <dim_1 x dim_2 x ... dim_n></dd>
|
||||
<dt> </dt>
|
||||
<dt><strong>Options and Parameters:</strong>
|
||||
<dl>
|
||||
<dt><em>file1</em>
|
||||
<dt><em>file2</em>
|
||||
<dd>The input and output HDF5 files
|
||||
<dt><code>-h</code>
|
||||
<dd>help message.<dt><code>-f</code> <em>filter</em>
|
||||
<dd>Filter type<dt><code>-l</code> <em>layout</em>
|
||||
<dd>Layout type<dt><code>-v</code>
|
||||
<dd>Verbose mode. Print output (list of objects in the file, filters
|
||||
and layout applied).<dt><code>-e</code> <em>file</em>
|
||||
<dd>File with the -f and -l options (only filter and layout flags)
|
||||
<dt><code>-d</code> <em>delta</em>
|
||||
<dd>Print only differences that are greater than the
|
||||
limit <em>delta</em>.
|
||||
<em>delta</em> must be a positive number.
|
||||
The comparison criterion is whether the
|
||||
absolute value of the difference of
|
||||
two corresponding values is greater than
|
||||
<em>delta</em>
|
||||
<br>(e.g., <code> |a–b| > <em>delta</em></code>,
|
||||
where <code>a</code> is a value in <em>file1</em> and
|
||||
<code>b</code> is a value in <em>file2</em>).<dt><code>-m</code> <em>number</em>
|
||||
<dd>Do not apply the filter to objects which size in bytes is
|
||||
smaller than number. If no size is specified a minimum of 1024
|
||||
bytes is assumed.
|
||||
</dl>
|
||||
<dt><strong>Examples:</strong>
|
||||
<dd>1) h5repack -i file1 -o file2 -f GZIP=1 -v<br>
|
||||
Applies GZIP compression to all
|
||||
objects in file1 and saves the output in file2
|
||||
<p>2) h5repack -i file1 -o file2 -f dset1:SZIP=8,NN -v<br>
|
||||
Applies SZIP compression only
|
||||
to object 'dset1'</p>
|
||||
<p>3) h5repack -i file1 -o file2 -l dset1,dset2:CHUNK=20x10 -v<br>
|
||||
Applies chunked layout to
|
||||
objects 'dset1' and 'dset2'<br>
|
||||
</dl>
|
||||
|
||||
<hr>
|
||||
<dl>
|
||||
<dt><strong>Tool Name:</strong> <a name="Tools-Repart">h5repart</a>
|
||||
|
||||
Reference in New Issue
Block a user