doc/C/scale.html

   1 <HTML><HEAD><TITLE>Manpage of </TITLE>
   2 </HEAD><BODY BGCOLOR="#FFFFFF">
   3 Name: <B>scale</B><BR>
   4 Section: User Commands  (1)
   5 <HR>
   6
   7 <A NAME="lbAB">&nbsp;</A>
   8 <H2>NAME</H2>
   9
  10 scale - Scaling of PIV data.
  11 <A NAME="lbAC">&nbsp;</A>
  12 <H2>SYNOPSIS</H2>
  13
  14 <P>
  15 <B>scale</B> [<B>-f </B><I>filename</I>] [<B>-h</B>] [<B>-p</B>] [<B>-s </B><I>M</I> |<B>-S </B><I>M</I>]
  16 [<B>-t </B><I>dT</I> |<B>-T </B><I>dT</I>]
  17 [<B>-v</B>] [<B>-z </B><I>x0 y0</I>] &lt; <I>stdin</I> &gt; <I>stdoutfR
  18 <P>
  19 </I>
  20 <P>
  21 <A NAME="lbAD">&nbsp;</A>
  22 <H2>DESCRIPTION</H2>
  23
  24 <P>
  25 <B>scale</B> corrects PIV data for the image magnification and timing
  26 between successive recordings. This results that particle
  27 displacements [px] are translated to velocities [m/s]. A physical
  28 reference for the positions of the PIV data can be applied by the
  29 zero-offset option.
  30 <P>
  31 The parameters and options to be used for <B>scale</B> are subsequently
  32 searched in <I>scale.par</I> at local directory, at <I>~/.gpivrc</I> or
  33 at <I>/etc/gpivrc</I>. Each parameter is described by the program key
  34 (Scale) and the parameter name, separated by a dot (.), followed by
  35 its value. The parameters may be defined in arbitrary order. Blank
  36 lines and comment (starting with a pound sign (#) at the first column)
  37 may be included in the parameter files.  The parameters may be
  38 overruled by the command line options, as explained below.
  39 <P>
  40 <A NAME="lbAE">&nbsp;</A>
  41 <H2>Options </H2>
  42
  43 <DL COMPACT>
  44 <DT><B>-f </B><I>filename</I><DD>
  45 Overrides stdin and stdout with <I>filename</I>. The <I>filename</I> has
  46 to be given without its <B>.piv</B> extension. The output will be
  47 written to <I>filename</I><B>.sc.piv</B>. The parameters will be written or
  48 appended to <I>filename</I><B>.par</B>.
  49 <DT><B>-h</B><DD>
  50 On-line help.
  51 <DT><B>-p</B><DD>
  52 Prints parameters, command line options and input and output filenames
  53 to stdout. The output may be used as parameters of <B>scale</B> for
  54 future use by re-directing stdout to <I>scale.par</I>.
  55 <DT><B>-s </B><I>M</I><DD>
  56 spatial scaling with magnifation factor <I>M</I> [m/px]
  57 <DT><B>-S </B><I>M</I><DD>
  58 Inverse spatial scaling with magnifation factor <I>M</I> [m/px]; returns
  59 scaled data to their original magnitudes.
  60 <DT><B>-v</B><DD>
  61 Prints version information on standard output, then exits successfully.
  62 <DT><B>-t </B><I>dT</I><DD>
  63 Translates particle displacements into velocities by deviding them
  64 with the time between subsequent recordings <I>dT</I> [s].
  65 <DT><B>-T </B><I>dT</I><DD>
  66 Inverse time scaling. Returns velocities into displacements [px]
  67 <DT>[<B>-z </B><I>x0 y0</I>] <DD>
  68 Relates the positions of the observations of velocities/displacements
  69 to a physical location in the experiment by zero off-setting. <I>x0
  70 y0</I> denote the physical position of pixel (0,0) in the image.
  71 <P>
  72 </DL>
  73 <A NAME="lbAF">&nbsp;</A>
  74 <H2>SEE ALSO</H2>
  75
  76 batch-gp, dav2piv, err_vec, manipiv, hilo, rr, scale, s-avg, t-avg, peaklck,
  77 piv2vec,vorstra
  78 <P>
  79 <A NAME="lbAG">&nbsp;</A>
  80 <H2>NOTES</H2>
  81
  82 <P>
  83 <A NAME="lbAH">&nbsp;</A>
  84 <H2>AUTHOR</H2>
  85
  86 Gerber Van der Graaf
  87 <P>
  88 <A NAME="lbAI">&nbsp;</A>
  89 <H2>BUGS</H2>
  90
  91 The program has been tested for PIV data. So far, no bugs have been
  92 found.
  93 <P>
  94
  95 <HR>
  96 <A NAME="index">&nbsp;</A><H2>Table of Contents</H2>
  97 <OL>
  98 <LI><A HREF="#lbAB">Name</A>
  99 <LI><A HREF="#lbAC">Synopsis</A>
 100 <LI><A HREF="#lbAD">Description</A>
 101 <LI><A HREF="#lbAE">Options </A>
 102 <LI><A HREF="#lbAF">See also</A>
 103 <LI><A HREF="#lbAG">Notes</A>
 104 <LI><A HREF="#lbAH">Author</A>
 105 <LI><A HREF="#lbAI">Bugs</A>
 106 </OL>
 107 </BODY>
 108 </HTML>