man/gpiv_scale.1

   1 .TH GPIV_SCALE 1 "8 November 2006"
   2 .SH NAME
   3 gpiv_scale \- Scaling of PIV data.
   4 .SH SYNOPSIS
   5
   6 \fBgpiv_scale\fP
   7 [\fB-h\fR | \fB--help\fR]
   8 [\fB-p\fR | \fB--print\fR]
   9 [\fB-s \fIM\fR |\fB-S \fIM\fR]
  10 [\fB-t \fIdT\fR |\fB-T \fIdT\fR]
  11 [\fB-v\fR | \fB--version\fR]
  12 [\fB-zp \fIx0 y0\fR]
  13 [\fB-zv \fIx0 y0\fR]
  14 [\fIfilename\fP]
  15 < \fIstdin\fR > \fIstdout\fR
  16
  17 \fP
  18
  19 .SH DESCRIPTION
  20
  21 \fBgpiv_scale\fP applies the image magnification and the time between
  22 successive recordings to the PIV estimators. This results that
  23 particle displacements [px] are modified to velocities [m/s] and their
  24 positions from [px] to [m]. A physical reference for the positions of
  25 the PIV data can be applied by means of the image zero-offset option.
  26
  27 If \fIfilename\fR is used, the parameters and options to be used for
  28 \fBgpiv_scale\fP are subsequently read from the image header
  29 (\fIfilename\fB.h\fR in case of raw binary images) or from the
  30 configuration resources (containing the \fBIMG\fR and \fBPOST\fR
  31 keys). The parameters may be overruled by the command line options, as
  32 explained below.
  33
  34 .SH Options
  35 .TP
  36 \fB-h\fR | \fB--help\fP
  37 On-line help.
  38
  39 .TP
  40 \fB-p\fR | \fB--print\fP
  41 Prints parameters, command line options and input and output filenames
  42 to stdout.  The output is identic of \fIfilename\fB.par\fR, in case
  43 \fB-f\fP is used.
  44
  45 .TP
  46 \fB-s \fIM\fR
  47 spatial scaling with magnification factor \fIM\fR [m/px]
  48
  49 .TP
  50 \fB-S \fIM\fP
  51 Inverse spatial scaling with magnification factor \fIM\fR [m/px]; returns
  52 scaled data to their original magnitudes.
  53
  54 .TP
  55 \fB-v\fR | \fB--version\fP
  56 Prints version information on standard output, then exits successfully.
  57
  58 .TP
  59 \fB-t \fIdT\fP
  60 Translates particle displacements into velocities by devising them
  61 with the time between subsequent recordings \fIdT\fR [s].
  62
  63 .TP
  64 \fB-T \fIdT\fP
  65 Inverse time scaling. Returns velocities into displacements [px]
  66
  67 .TP
  68 [\fB-z \fIx0 y0\fR]
  69 Relates the positions of the observations of velocities/displacements
  70 to a physical location in the experiment by image zero offsetting. \fIx0
  71 y0\fR denote the physical position of pixel (0,0) in the image.
  72
  73 .TP
  74 \fIfilename\fR
  75 Input PIV file. Overrides stdin and stdout. The output will be
  76 written to \fIfilename\fB.sc.piv\fR. Parameters are stored in
  77 \fIfilename\fB.par\fR and may be used for future use by including them
  78 in \fI./gpivrc\fR.
  79
  80 .TP
  81
  82 .SH SEE ALSO
  83 gpivtools
  84
  85 .SH NOTES
  86
  87 .SH AUTHOR
  88 Gerber Van der Graaf
  89
  90 .SH BUGS
  91 The program has been tested for PIV data. So far, no bugs have been
  92 found.