added man page
[gpiv.git] / doc / C / scale.html
blob6e02d8dab292211f090b82935df137c83fdeee6f
1 <HTML>
2 <BODY>
3 <PRE>
4 <!-- Manpage converted by man2html 3.0.1 -->
5 [\fB-h\fR]
6 [\fB-p\fR]
7 [\fB-s \fIM\fR |\fB-S \fIM\fR]
8 [\fB-t \fIdT\fR |\fB-T \fIdT\fR]
9 [\fB-v\fR]
10 [\fB-zp \fIx0 y0\fR]
11 [\fB-zv \fIx0 y0\fR]
12 < \fIstdin\fR &gt; \fIstdout\fR
14 \fP
16 .SH DESCRIPTION
18 \fBscale\fP applies the image magnification and the time between
19 successive recordings to the PIV estimators. This results that
20 particle displacements [px] are modified to velocities [m/s] and their
21 positions from [px] to [m]. A physical reference for the positions of
22 the PIV data can be applied by means of the image zero-offset option.
24 If \fB-f \fIfilename\fR is used, the parameters and options to be used
25 for \fBscale\fP are subsequently searched in \fIfilename\fB.h\fR or in
26 \fIgpivrc\fP at local directory, at \fI~/.gpivrc\fR or at
27 \fI/etc/gpivrc\fR. Each parameter is described by the image key (IMG)
28 and the parameter name, separated by a dot (.), followed by its
29 value. The parameters may be defined in arbitrary order. Blank lines
30 and comment (starting with a pound sign (#) at the first column) may
31 be included in the parameter files. The parameters may be overruled
32 by the command line options, as explained below.
34 .SH Options
35 .TP
36 \fB-f \fIfilename\fR
37 Overrides stdin and stdout with \fIfilename\fR. The \fIfilename\fR has
38 to be given without its \fB.piv\fR extension. The output will be
39 written to \fIfilename\fB.sc.piv\fR. The parameters will be written or
40 appended to \fIfilename\fB.par\fR.
41 .TP
42 \fB-h\fP
43 On-line help.
44 .TP
45 \fB-p\fP
46 Prints parameters, command line options and input and output filenames
47 to stdout. The output may be used as parameters of \fBscale\fP for
48 future use by re-directing stdout to \fIscale.par\fR.
49 .TP
50 \fB-s \fIM\fR
51 spatial scaling with magnification factor \fIM\fR [m/px]
52 .TP
53 \fB-S \fIM\fP
54 Inverse spatial scaling with magnification factor \fIM\fR [m/px]; returns
55 scaled data to their original magnitudes.
56 .TP
57 .TP
59 .SH SEE ALSO
60 batch-gp, dav2piv, err_vec, manipiv, hilo, rr, scale, s-avg, t-avg, peaklck,
61 piv2vec, vorstra
63 .SH NOTES
65 .SH AUTHOR
66 Gerber Van der Graaf
68 .SH BUGS
69 The program has been tested for PIV data. So far, no bugs have been
70 found.
71 </PRE>
72 <HR>
73 <ADDRESS>
74 Man(1) output converted with
75 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
76 </ADDRESS>
77 </BODY>
78 </HTML>