File: h5stat.htm

package info (click to toggle)
hdf5 1.8.13%2Bdocs-15
  • links: PTS, VCS
  • area: main
  • in suites: jessie-kfreebsd
  • size: 171,520 kB
  • sloc: ansic: 387,158; f90: 35,195; sh: 20,035; xml: 17,780; cpp: 13,516; makefile: 1,487; perl: 1,299; yacc: 327; lex: 178; ruby: 37
file content (206 lines) | stat: -rw-r--r-- 7,607 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206


<!--
  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
  * Copyright by The HDF Group.                                               *
  * Copyright by the Board of Trustees of the University of Illinois.         *
  * All rights reserved.                                                      *
  *                                                                           *
  * This file is part of HDF5.  The full HDF5 copyright notice, including     *
  * terms governing use, modification, and redistribution, is contained in    *
  * the files COPYING and Copyright.html.  COPYING can be found at the root   *
  * of the source code distribution tree; Copyright.html can be found at the  *
  * root level of an installed copy of the electronic HDF5 document set and   *
  * is linked from the top-level documents page.  It can also be found at     *
  * http://hdfgroup.org/HDF5/doc/Copyright.html.  If you do not have          *
  * access to either file, you may request a copy from help@hdfgroup.org.     *
  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
 -->


<!-- NEW PAGE -->
<!-- HEADER RIGHT "h5stat" -->
<hr>
<dl>

<dt><div align=right><font color=999999 size=-1><i>
    Last modified: 20 August 2013
    </i></font></div>

<dt><strong>Tool Name:</strong> <a name="Tools-Stat">h5stat</a>
<dt><strong>Syntax:</strong>
<!--
    <dd><code>h5stat </code>[<code>-h </code>|<code> --help</code>]
    <dd><code>h5stat </code>[<code>-V </code>|<code> --version</code>]
-->
    <dd><code>h5stat </code>[<em>OPTIONS</em>]&nbsp; <em>file</em>

    <p>
<dt><strong>Purpose:</strong>
    <dd>Reports statistics about an HDF5 file and its objects.

    <p>
<dt><strong>Description:</strong>
    <dd><code>h5stat</code> reports selected statistics regarding an HDF5 file 
        and the objects in that file.

    <p>
<dt><strong>Options and Parameters:</strong>
    <dd><table width=90%>
        <tr>
          <td valign="top" width="30%"><code>-h</code>
              &nbsp;&nbsp;or&nbsp;&nbsp;
              <code>--help</code></td>
          <td valign="top">Print a usage message and exit.</td></tr>
        <tr>
          <td valign="top"><code>-V</code> 
               &nbsp;&nbsp;or&nbsp;&nbsp; 
               <code>--version</code></td>
          <td valign="top">Print version of HDF5 and exit.</td></tr>
        <tr><td>&nbsp;</td><td>&nbsp;</td></tr>
        <tr>
          <td valign="top"><code>-f</code> 
               &nbsp;&nbsp;or&nbsp;&nbsp; 
               <code>--file</code></td>
          <td valign="top">Print file information.</td></tr>
        <tr>
          <td valign="top"><code>-F</code> 
               &nbsp;&nbsp;or&nbsp;&nbsp; 
               <code>--filemetadata</code></td>
          <td valign="top">Print file space information for file metadata.
               </td></tr>
        <tr>
          <td valign="top"><code>-g</code> 
               &nbsp;&nbsp;or&nbsp;&nbsp; 
               <code>--group</code></td>
          <td valign="top">Print group information.</td></tr>
        <tr>
          <td valign="top"><code>-l <i>N</i></code> 
               &nbsp;&nbsp;or&nbsp;&nbsp; 
               <code>--links=<i>N</i></code></td>
          <td valign="top"> Set the threshold for the number of links 
               when printing information for small groups.
	       <br>
               <i>N</i> is an integer greater than 0.  
               The default threshold is 10.
	  </td>
	</tr>
        <tr>
          <td valign="top"><code>-G</code>&nbsp;&nbsp;&nbsp;or&nbsp;&nbsp;&nbsp;<code>--groupmetadata&nbsp;&nbsp;&nbsp;</code></td>
          <td valign="top">Print file space information for group metadata.
               </td></tr>
        <tr>
          <td valign="top"><code>-d</code> 
               &nbsp;&nbsp;or&nbsp;&nbsp; 
               <code>--dset</code></td>
          <td valign="top">Print dataset information.</td></tr>
        <tr>
          <td valign="top"><code>-m <i>N</i></code> 
               &nbsp;&nbsp;or&nbsp;&nbsp; 
               <code>--dims=<i>N</i></code></td>
          <td valign="top"> Set the threshold for the dimension sizes 
               when printing information for small datasets.
               <br>
	       <i>N</i> is an integer greater than 0.  
               The default threshold is 10.
	  </td></tr>
        <tr>
          <td valign="top"><code>-D</code> 
               &nbsp;&nbsp;or&nbsp;&nbsp; 
               <code>--dsetmetadata</code></td>
          <td valign="top">Print file space information for dataset metadata.
               </td></tr>
        <tr>
          <td valign="top"><code>-T</code> 
               &nbsp;&nbsp;or&nbsp;&nbsp; 
               <code>--dtypemetadata</code></td>
          <td valign="top">Print dataset datatype information.</td></tr>
        <tr>
          <td valign="top"><code>-A</code> 
               &nbsp;&nbsp;or&nbsp;&nbsp; 
               <code>--attribute</code></td>
          <td valign="top">Print attribute information.</td></tr>
        <tr>
          <td valign="top"><code>-a <i>N</i></code> 
               &nbsp;&nbsp;or&nbsp;&nbsp; 
               <code>--numattrs=<i>N</i></code></td>
          <td valign="top"> Set the threshold for the number of of attributes 
               when printing information for small numbers of attributes.
               <br>
	       <i>N</i> is an integer greater than 0.  
               The default threshold is 10.
	  </td></tr>
        <tr>
          <td valign="top"><code>-S</code>
               &nbsp;&nbsp;or&nbsp;&nbsp;
               <code>--summary</code></td>
          <td valign="top">Print summary of file space information.</td></tr>
        </table>
    </dd>

    <p>
<dt><strong>Exit Status:</strong></dt>
    <dd><table border=0>
        <tr valign=top align=left>
            <td>0</td>
            <td>Succeeded.</td>
        </tr>
        <tr valign=top align=left>
            <td>&gt; 0&nbsp;&nbsp;&nbsp;&nbsp;</td>
            <td>An error occurred.</td>
        </tr>
    </table>

    <p>
<dt><strong>History:</strong>
    <dd><table width="90%">
        <tr>
          <td valign="top" align="left" width="10%">
            <strong>Release</strong>&nbsp;&nbsp;&nbsp;&nbsp;</td>
          <td valign="top" align="left">
            <strong>Change</strong></td></tr>
        <tr>
          <td valign="top">1.8.12</td>
          <td valign="top">
            Options added in this release:
            <br><code>&nbsp;&nbsp;&nbsp;&nbsp;</code>
                <code>-l <i>N</i></code>, 
                &nbsp;
                <code>--links=<i>N</i></code>
            <br><code>&nbsp;&nbsp;&nbsp;&nbsp;</code>
                <code>-m <i>N</i></code>, 
                &nbsp;
                <code>--dims=<i>N</i></code>
            <br><code>&nbsp;&nbsp;&nbsp;&nbsp;</code>
                <code>-a <i>N</i></code>, 
                &nbsp;
                <code>--numattrs=<i>N</i></code>
            
            </td></tr>
        <tr>
          <td valign="top">1.8.9</td>
          <td valign="top">
            Option added in this release:
            <br><code>&nbsp;&nbsp;&nbsp;&nbsp;</code>
                <code>-S</code>, 
                &nbsp;
                <code>--summary</code> 
            </td></tr>
        <tr>
          <td valign="top">1.8.0</td>
          <td valign="top">
            Tool introduced in this release.</td></tr>
    </table></dd>

<!--
    <p>
<dt><strong>Current Status:</strong>
    <dd>

    <p>
<dt><strong>See Also:</strong>
    <dd>
-->
</dl>