aboutsummaryrefslogtreecommitdiff
path: root/doc/html/Utilities.html
blob: e9011768eb908952f41cdad0506976f006272118 (plain)
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
<html>  
  <head>
    <TITLE>IEEEIO Utilities</TITLE> 
  </head>
  <body bgcolor="#F0F0F0">
    <!--<h1>Utilities</h1>
  <table><tr>
  <td><img src="Images/info.gif"></td>
  <td><h1>Utilities</h1></td>
  </tr></table>
  <hr> -->
      <h1>Utilities</h1>
      <hr>

     <a name="convert2native"><h2>convert2native</h2></a>
      Converts an IEEEIO file to the native byte-ordering so that reading can
      occur as efficiently as possible.  The <i>-byteswap</i> flag causes the
      utility to do the opposite (switch to non-native byte ordering).  Please
      note that ieeeio does not have any problem reading files of any
      byte-order, however, byteswapping does exact a performance penalty on
      any system.  So converting to native byte order improves performance.<P>

	<b>usage</b><br>
	<code>convert2native [-byteswap] infile outfile</code>
      <DL>
	<DT><b>infile</b>
	<DD>The file to read for translation
	<DT><b>oufile</b>
	<DD>The file to write to.  It will be truncated before it is written to
	  so don't attempt to write to the input file.
	<DT><b>-byteswap</b>
	<DD>Forces byte swapping to the opposite of native byte ordering.  The
	  default is to convert to native byte ordering.
      </DL>

      <hr>
      <a name="ioconvert"><h2>ioconvert</h2></a>
      A more general utility than <b>convert2native</b>; <b>ioconvert</b>
      converts a file from source format (IEEEIO or HDF) to any allowable
      destination format (currently only IEEEIO or HDF).  It can also perform
      byteswapping to convert to native or the opposite of native format.  The
      default is native format.  <b>convert2native</b> only exists for people
      who want the byte-swapping capability but don't wish to compile the full
      HDF libraries.<p>

	<b>ioconvert</b> senses the filetype by the extension you use for the filename. 
	<i>.ieee</i> and <i>.raw</i> are interpreted as IEEEIO files and
	<i>.hdf</i> is interpreted as an HDF file.<p>

	<b>usage</b><br>
	<code>ioconvert [-byteswap] infile{.hdf|.ieee|.raw}
	  outfile{.hdf|.ieee|.raw}</code>
      <DL>
	<DT><b>infile</b>
	<DD>The file to read for translation
	<DT><b>oufile</b>
	<DD>The file to write to.  It will be truncated before it is written to
	  so don't attempt to write to the input file.
	<DT><b>-byteswap</b>
	<DD>Forces byte swapping to the opposite of native byte ordering.  The
	  default is to convert to native byte ordering.
      </DL>

      <hr>
      <a name="ioinfo"><h2>ioinfo</h2></a>
      Prints out a variety of diagnostic information about IEEEIO and HDF
      datafiles.  A variety of flags are used to control the amount and the
      type of information printed.  By default, only information about the
      datasets (rank, dimensions and datatype) as well as the number
      of attachments will be printed.<p>

	<b>usage</b><br>
	<code>ioinfo datafile [-showdata | -hidedata] 
	  [-showanndata | -hideanndata] [-showanninfo | -hideanninfo] 
	  [-showattdata | -hideattdata] [-showattinfo | -hideattinfo]
	</code>
      <DL>
	<DT><b>datafile</b>
	<DD>The file you wish to examine
	<DT><b>-showdata</b> or <b>-data</b>
	<DD>Shows the first 10 elements of each dataset.
	<DT><b>-hidedata</b> [<i>default</i>]
	<DD>Does not show the data, but shows all information about the
	  datsets like the datatype and the dimensions etc...
	  
	<DT><b>-showannotationinfo</b> or <b>-showanninfo</b>
	<DD>Shows information about the length of each annotation
	  bound to a dataset.  Otherwise
	  only the number of annotations is shown for each dataset.
	<DT><b>-hideannotationinfo</b> or <b>-hideanninfo</b> [<i>default</i>]
	<DD>Only the number of annotations is shown for each dataset.

	<DT><b>-showannotationdata</b> or <b>-showanndata</b>
	<DD>Shows the first 10 characters of each annotation.
	<DT><b>-hideannotationdata</b> or <b>-hideanndata</b> [<i>default</i>]
	<DD>None of the contents of the annotations are printed.

	<DT><b>-showattributeinfo</b> or <b>-showattinfo</b>
	<DD>Shows information about the name, length and datatype of the
	  attributes for each attribute attached to a dataset.  Otherwise
	  only the number of attributes is shown for each dataset.
	<DT><b>-hideattributeinfo</b> or <b>-hideattinfo</b> [<i>default</i>]
	<DD>Only the number of attributes is shown for each dataset.

	<DT><b>-showattributedata</b> or <b>-showattdata</b>
	<DD>Shows the first 10 elements of data stored in an attribute.
	<DT><b>-hideattributedata</b> or <b>-hideattdata</b> [<i>default</i>]
	<DD>None of the contents of the attribute is printed (except
	  information if requested).
      </DL>
      

      <hr>
      <address><a href="mailto:jshalf@suttung.aei-potsdam.mpg.de">John Shalf</a></address>
      <!-- Created: Mon Apr  7 12:52:52 MDT 1997 -->
      <!-- hhmts start -->
Last modified: Tue Apr  8 19:01:45 MDT 
<!-- hhmts end -->
  </body>
</html>