man/clip.1

   1 .TH GPIV_CLIP 1 "7 November 2006"
   2 .SH NAME
   3 gpiv_clip \- Image clipping program for PIV images.
   4 .SH SYNOPSIS
   5
   6 \fBgpiv_clip\fP
   7 [\fB-h\fR | \fB--help\fR]
   8 [\fB-p\fR | \fB--print\fR]
   9 [\fB-t \fIN\fR | \fB--threshold \fIN\fR]
  10 [\fB-v\fR | \fB--version\fR]
  11 [\fIfilename\fR]
  12 < \fIstdin\fR > \fIstdout\fR
  13
  14 \fP
  15
  16 .SH DESCRIPTION
  17
  18 \fBgpiv_clip\fP sets all pixels below a pre-defined value to zero
  19
  20 The parameters read from the configuration resources (containing the
  21 key \fBGPIV_IMGPROC\fR) may be overruled by the command line options, as
  22 explained below.
  23
  24 .SH Options
  25 .TP
  26
  27 \fB-h\fR | \fB--help\fP
  28 On-line help
  29 .TP
  30
  31 \fB-t \fIN\fR | \fB--threshold \fIN\fR
  32 Threshold value to be set to zero
  33 .TP
  34
  35 \fB-v\fR | \fB--version\fP
  36 Print version information on standard output, then exit successfully.
  37 .TP
  38
  39 \fIfilename\fR
  40 Input image filename. Overrides \fIstdin\fR and \fIstdout\fR with the full \fIfilename\fR of
  41 the image. Output will be written to \fIfilename\fB.png\fR. Parameters
  42 are stored in \fIfilename\fB.par\fR and may be used for future use by
  43 including them in \fI./gpivrc\fR. If \fIstdin\fR and \fIstdout\fR are
  44 used, the input is expected to be a PNG formatted image.
  45 .TP
  46
  47
  48 .SH SEE ALSO
  49 gpivtools
  50
  51 .SH AUTHOR
  52 Gerber Van der Graaf