~ubuntu-branches/debian/sid/libhdf4/sid

« back to all changes in this revision

Viewing changes to debian/man/fp2hdf.1

  • Committer: Bazaar Package Importer
  • Author(s): Philippe Troin
  • Date: 2001-08-17 18:15:39 UTC
  • Revision ID: james.westby@ubuntu.com-20010817181539-dxk88azjdkntsxbm
Tags: 4.1r4-13
* Fixed upstream version detection in debian/rules.
* Change all instances of the linux C preprocessor symbol to __linux__
  to avoid breaking other packages; patch courtesy of James Troup
  <james@nocrew.org>; closes: #108921.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
.TH FP2HDF 1 "October 30, 1999"
 
2
.\" man page by Jim Van Zandt <jrv@vanzandt.mv.com>         -*- nroff -*-
 
3
.SH NAME
 
4
fp2hdf \- convert floating point data to HDF
 
5
.SH SYNOPSIS
 
6
\fBfp2hdf\fP \fB-h\fP[\fBelp\fP]
 
7
\fBfp2hdf\fP \fIinfile\fP [\fIinfile\fP...]
 
8
\fB-o\fP[\fButfile\fP \fIoutfile\fP]
 
9
[\fB-r\fP[\fBaster\fP] [\fIras_options\fP...]]
 
10
[\fB-f\fP[\fBloat\fP]]
 
11
.SH DESCRIPTION
 
12
\fBfp2hdf\fP
 
13
converts floating point data to HDF Scientific Data Set (SDS)
 
14
and/or 8-bit Raster Image Set (RIS8) format, storing the results
 
15
in an HDF file.  The image data can be scaled about a mean value.
 
16
.P
 
17
Input file(s) contain a single two-dimensional or
 
18
three-dimensional floating point array in either ASCII text, native
 
19
floating point, or HDF SDS format.  If an HDF file is used for input,
 
20
it must contain an SDS.  The SDS need only contain a dimension record
 
21
and the data, but if it also contains maximum and minimum values
 
22
and/or scales for each axis, these will be used.  If the input format
 
23
is ASCII text or native floating point, see "Notes" below on how it
 
24
must be organized.
 
25
.SH OPTIONS
 
26
.TP
 
27
.BR -h [ elp ]
 
28
Print a helpful summary of usage, and exit.
 
29
.TP
 
30
.BR -o [ utfile "] \fIoutfile\fP"
 
31
Data from one or more input files are stored as one or more data sets
 
32
and/or images in one HDF output file, \fIoutfile\fP.
 
33
.TP
 
34
.BR -r [ aster ]
 
35
Store output as a raster image set in the output file
 
36
.BR -f [ loat ]
 
37
Store output as a scientific data set in the the output file.
 
38
This is the default if the "-r" option is not specified.
 
39
.P
 
40
\fIras_opts\fP:
 
41
.TP
 
42
.BR -e [ xpand "] \fIhoriz\fP \fIvert\fP [\fIdepth\fP]"
 
43
Expand float data via pixel replication to produce the image(s).
 
44
\fIhoriz\fP and \fIvert\fP give the horizontal and vertical resolution
 
45
of the image(s) to be produced; and optionally, \fIdepth\fP gives the
 
46
number of images or depth planes (for 3D input data).
 
47
.TP
 
48
.BR -i [ nterp "] \fIhoriz vert\fP [\fIdepth\fP]"
 
49
Apply bilinear, or trilinear, interpolation to the float data to
 
50
produce the image(s).  \fIhoriz\fP, \fIvert\fP, and \fIdepth\fP must
 
51
be greater than or equal to the dimensions of the original dataset.
 
52
.TP
 
53
.BR -p [ alfile "] \fIpalfile\fP"
 
54
Store the palette with the image.  Get the palette from
 
55
\fIpalfile\fP; which may be an HDF file containing a palette,
 
56
or a file containing a raw palette.
 
57
.TP
 
58
.BR -m [ ean "] \fImean\fP"
 
59
If a floating point mean value is given, the image will be
 
60
scaled about the mean.  The new extremes (newmax and newmin),
 
61
as given by:
 
62
.sp
 
63
  newmax = mean + max(abs(max-mean), abs(mean-min))
 
64
.br
 
65
  newmin = mean - max(abs(max-mean), abs(mean-min))
 
66
.IP
 
67
will be equidistant from the mean value.  If no mean value
 
68
is given, then the mean will be:  0.5 * (max + min)
 
69
.SH INPUT
 
70
If the input file format is ASCII text or native floating point, it
 
71
must have the following input fields:
 
72
.nf
 
73
 
 
74
        format
 
75
        nplanes
 
76
        nrows
 
77
        ncols
 
78
        max_value
 
79
        min_value
 
80
        [plane1 plane2 plane3 ...]
 
81
        row1 row2 row3 ...
 
82
        col1 col2 col3 ...
 
83
        data1 data2 data3 ...
 
84
        ...
 
85
 
 
86
.fi
 
87
Where:
 
88
.IP \fIformat\fP
 
89
Format designator ("TEXT", "FP32" or "FP64").
 
90
.IP \fInplanes\fP
 
91
Dimension of the depth axis ("1" for 2D input).
 
92
.IP \fInrows\fP
 
93
Dimension of the vertical axis.
 
94
.IP \fIncols\fP
 
95
Dimension of the horizontal axis.
 
96
.IP \fImax_value\fP
 
97
Maximum data value.
 
98
.IP \fImin_value\fP
 
99
Minimum data value.
 
100
.IP "\fIplane1\fP, \fIplane2\fP, \fIplane3\fP, ..."
 
101
Scales for depth axis.
 
102
.IP "\fIrow1\fP, \fIrow2\fP, \fIrow3\fP, ..."
 
103
Scales for the vertical axis.
 
104
.IP "\fIcol1\fP, \fIcol2\fP, \fIcol3\fP, ..."
 
105
Scales for the horizontal axis.
 
106
.IP "\fIdata1\fP, \fIdata2\fP, \fIdata3\fP, ..."
 
107
The data ordered by rows, left to right and top
 
108
to bottom; then optionally, ordered by planes,
 
109
front to back.
 
110
.IP
 
111
For FP32 and FP64 input format, \fIformat\fP, \fInplanes\fP,
 
112
\fInrows\fP, \fIncols\fP, and \fInplanes\fP are native integers; where
 
113
\fIformat\fP is the integer representation of the appropriate
 
114
4-character string (0x46503332 for "FP32" and 0x46503634 for "FP64").
 
115
The remaining input fields are composed of native 32-bit floating
 
116
point values for FP32 input format, or native 64-bit floating point
 
117
values for FP64 input format.
 
118
.SH EXAMPLE
 
119
Convert floating point data in "f1.txt" to SDS format, and store it
 
120
as an SDS in HDF file "o1":
 
121
.sp
 
122
        fp2hdf f1.txt -o o1
 
123
.sp
 
124
Convert floating point data in "f2.hdf" to 8-bit raster format, and
 
125
store it as an RIS8 in HDF file "o2":
 
126
.sp
 
127
        fp2hdf f2.hdf -o o2 -r
 
128
.sp
 
129
Convert floating point data in "f3.bin" to 8-bit raster format and
 
130
SDS format, and store both the RIS8 and the SDS in HDF file "o3":
 
131
.sp
 
132
        fp2hdf f3.bin -o o3 -r -f
 
133
.sp
 
134
Convert floating point data in "f4" to a 500x600 raster image, and
 
135
store the RIS8 in HDF file "o4".  Also store a palette from "palfile"
 
136
with the image:
 
137
.sp
 
138
        fp2hdf f4 -o o4 -r -e 500 600 -p palfile
 
139
.sp
 
140
Convert floating point data in "f5" to 200 planes of 500x600 raster
 
141
images, and store the RIS8 in HDF file "o5".  Also scale the image
 
142
data so that it is centered about a mean value of 10.0:
 
143
.sp
 
144
        fp2hdf f5 -o o5 -r -i 500 600 200 -m 10.0
 
145
.SH "SEE ALSO"
 
146
\fBhdf\fP(5)