man/gpiv_imgproc.1

   1 .TH GPIV_IMGPROC 1 "7 November 2006"
   2 .SH NAME
   3 gpiv_imgproc \- Image processing program for (PIV) images.
   4
   5 .SH SYNOPSIS
   6
   7 \fBgpiv_imgproc\fP
   8 [\fB-b \fIN\fR]
   9 [\fB--filter \fIN\fR]
  10 [\fB-h\fR | \fB--help\fR]
  11 [\fB-p\fR | \fB--print\fR]
  12 [\fB-o \fIN\fR | \fB--operation \fIN\fR]
  13 [\fB-t \fIN\fR | \fB--threshold \fIN\fR]
  14 [\fB-w \fIN\fR]
  15 [\fB-v\fR | \fB--version\fR]
  16 [\fIfilename\fR]
  17 < \fIstdin\fR > \fIstdout\fR
  18
  19 \fP
  20
  21 .SH DESCRIPTION
  22
  23 \fBgpiv_imgproc\fP processes, filters or converts images in order to
  24 improve the interrogation for Particle Image Velocimetry.
  25 \fBgpiv_smooth\fR: smoothing filter,
  26 \fBgpiv_hilo \fR: high-low filter,
  27 \fBgpiv_clip\fR: clipping,
  28 \fBgpiv_fft\fR: Fast Fourier Transform,
  29 \fBgpiv_invfft\fR: Inverse  Fast Fourier Transform,
  30 \fBgpiv_highpass\fR: high-pass filtering
  31 \fBgpiv_getbit\fR: get bit bumber.
  32 \fBgpiv_mktestimg\fR: generates test image-pair for PIV
  33
  34 The parameters read from the configuration resources (containing the
  35 key \fBGPIV_IMGPROC\fR) may be overruled by the command line options, as
  36 explained below.
  37
  38 .SH Options
  39 .TP
  40 \fB-b \fIN\fP
  41 In case of using \fBgpiv_getbit\fR \fIN\fP denotes the bit number [0, .., 7]
  42
  43 .TP
  44 \fB--filter \fIN\fR
  45 Image filter to be applied: make test image (\fIN\fR=0), smoothing
  46 (\fIN\fR=1), high-low filtering (\fIN\fR=2), clipping (\fIN\fR=3), fft
  47 (\fIN\fR=4), inverse fft (\fIN\fR=5), lowpass filter (\fIN\fR=8),
  48 highpass filter (\fIN\fR=9), getbit (\fIN\fR=10).
  49 .TP
  50
  51 \fB-h\fR | \fB--help\fP
  52 On-line help
  53 .TP
  54
  55 \fB-o \fIN\fR | \fB--operation \fIN\fR
  56 In case of using \fBgpiv_smooth\fR: set pixel equal to the mean of the
  57 window value (\fIN\fR0), subtract mean from from pixel (\fIN\fR1) add
  58 (\fIN\fR2), multiply (\fIN\fR3) or divide (\fIN\fR4)
  59 .TP
  60
  61 \fB-t \fIN\fR | \fB--threshold \fIN\fR
  62 In case of using \fBgpiv_clip\fR: threshold value to be set to zero
  63 .TP
  64
  65 \fB-v\fR | \fB--version\fP
  66 Print version information on standard output, then exit successfully.
  67 .TP
  68
  69 \fB-w \fIN\fR
  70 window size (default: 15)
  71 .TP
  72
  73 \fIfilename\fR
  74 Input image filename. Overrides \fIstdin\fR and \fIstdout\fR with the full \fIfilename\fR of
  75 the image. Output will be written to \fIfilename\fB.png\fR. Parameters
  76 are stored in \fIfilename\fB.par\fR and may be used for future use by
  77 including them in \fI./gpivrc\fR. If \fIstdin\fR and \fIstdout\fR are
  78 used, the input is expected to be a PNG formatted image.
  79 .TP
  80
  81
  82 .SH SEE ALSO
  83 gpivtools
  84
  85 .SH AUTHOR
  86 Gerber Van der Graaf