2003-05-19 13:12:26 +08:00
#############################
Expected output for 'h5diff -h'
#############################
2006-10-26 04:38:28 +08:00
usage: h5diff file1 file2 [OPTIONS] [obj1[obj2]]
2003-05-19 13:12:26 +08:00
file1 File name of the first HDF5 file
file2 File name of the second HDF5 file
[obj1] Name of an HDF5 object, in absolute path
[obj2] Name of an HDF5 object, in absolute path
[OPTIONS] are:
[-h] Print out this information
2007-10-23 05:02:40 +08:00
[-V] Print HDF5 library version number and exit
2007-02-27 02:21:41 +08:00
[-r] Report mode. Print differences
[-v] Verbose mode. Print differences, list of objects, warnings
2004-07-21 03:21:03 +08:00
[-q] Quiet mode. Do not do output
2003-05-19 13:12:26 +08:00
[-n count] Print difference up to count number
[-d delta] Print difference when it is greater than limit delta
2003-05-20 00:14:26 +08:00
[-p relative] Print difference when it is greater than a relative limit
2003-05-19 13:12:26 +08:00
Items in [] are optional
2006-03-23 04:53:05 +08:00
[obj1] and [obj2] are HDF5 objects (datasets, groups, datatypes or links)
2003-05-19 13:12:26 +08:00
The 'count' value must be a positive integer
The 'delta' and 'relative' values must be positive numbers
The -d compare criteria is |a - b| > delta
2006-11-28 02:55:33 +08:00
The -p compare criteria is |(b-a)/a| > relative
2003-05-19 13:12:26 +08:00
2004-07-21 03:21:03 +08:00
h5diff has four modes of output:
Normal mode: print the number of differences found and where they occured
Report mode: print the above plus the differences
Verbose mode: print the above plus a list of objects and warnings
Quiet mode: do not print output (h5diff always returns an exit code of 1 when differences are found)
2003-05-19 13:12:26 +08:00
2004-07-21 03:21:03 +08:00
Examples of use:
2003-05-19 13:12:26 +08:00
2004-07-21 03:21:03 +08:00
1) h5diff file1 file2 /g1/dset1 /g1/dset2
2003-05-19 13:12:26 +08:00
2004-07-21 03:21:03 +08:00
Compares object '/g1/dset1' in file1 with '/g1/dset2' in file2
2003-05-19 13:12:26 +08:00
2004-07-21 03:21:03 +08:00
2) h5diff file1 file2 /g1/dset1
Compares object '/g1/dset1' in both files
2003-05-19 13:12:26 +08:00
3) h5diff file1 file2
Compares all objects in both files
2004-07-21 03:21:03 +08:00
Note) file1 and file2 can be the same file. Use
h5diff file1 file1 /g1/dset1 /g1/dset2
to compare '/g1/dset1' and '/g1/dset2' in the same file
2006-03-23 04:53:05 +08:00
If no objects are specified, h5diff only compares objects with the same absolute path in both files. The compare criteria is: 1) datasets: numerical array differences 2) groups: name string difference 3) datatypes: the return value of H5Tequal 2) links: name string difference of the linked value