man/imgproc.1

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