man/gpiv_process-chain.1

   1 .TH GPIV_PROCESS-CHAIN 1 "19 Januari 2005"
   2 .SH NAME
   3 gpiv_process-chain \- Processes a pipe of Gpiv-tool command's.
   4 .SH SYNOPSIS
   5
   6 \fBgpiv_process-chain\fP
   7 [\fB-af \fIstring\fR]
   8 [\fB-h\fR | \fB-help\fR]
   9 [\fB-n\fR | \fB-none]
  10 [\fB-c\fR | \fB-clean]
  11 [\fB-fik\fR]
  12 [\fB-p\fR | \fB-print]
  13 [\fB-pf \fI-string]
  14 [\fB-proc_*\fR]
  15 [\fB-t \fIformat\fR]
  16 [\fB-v\fR | \fI-version\fR]
  17 \fIfilename\fR
  18 \fP
  19
  20 .SH DESCRIPTION
  21
  22 \fBGpiv_process-chain\fP processes a pipe of gpiv commands. Image
  23 evaluation/interrogation with \fBgpiv_rr\fR is always included, image
  24 recording may be prepended before interrogation, validation and
  25 post-processes may be appended to the chain. The \fIfilename\fR
  26 represents the name of the image to be evaluated. The file naming
  27 conventions are idententic to the output of the individual
  28 Gpivtools programs: in case the output are (validated/scaled) PIV data,
  29 the data will be directed to \fIfilename\fR.\fBpiv\fR, with
  30 \fB-proc_vorty\fR the output will be called \fIfilename\fR.\fBvor\fR,
  31 with \fB-proc_nstrain\fR the output will be called
  32 \fIfilename\fR.\fBnstr\fR and, finally, with with \fB-proc_sstrain\fR
  33 the output will be called \fIfilename\fR.\fBsstr\fR.
  34
  35 This program does not use the parameter resources from libgpiv.
  36
  37 .SH Options
  38 \fB-af \fIstring\fR
  39 Append \fIstring\fR to file-base name.
  40
  41 .TP
  42 \fB-h\fR | \fB--help\fP
  43 On-line help.
  44
  45 .TP
  46 \fB-n\fR | \fB--none \fP
  47 Suppresses real execution.
  48
  49 .TP
  50 -\fBc\fR | \fB-clean
  51 Cleans up: removes raw image data and header.
  52
  53 .TP
  54 -\fBfik\fR
  55 Use fi-keyline for filtering gpiv parms from README.
  56
  57 .TP
  58 \fB-p\fR | \fB--print \fP
  59 Prints parameters, command line options and input and output filenames
  60 to stdout.
  61
  62 .TP
  63 -\fBpf \fIstring\fR
  64 Prepend \fIstring\fR to file-base name.
  65
  66 .TP
  67 -\fBproc_*\fR
  68 Defines processes to be included in the chain. \fB*\fR
  69 is substituted by: imgrec, valid, scale, manipiv, flipx, flipy, revert, rot90,
  70 rot180 and vorty or nstrain or sstrain. Vorty, nstrain and sstrain
  71 may not be used in combination with \fB-t \fIgpi\fR.
  72
  73 .TP
  74 \fB-t \fIformat\fR
  75 Image type or format: hdf (\fB.hdf\fR), dav (\fB.IMG\fR) or a type as
  76 defined by ImageMagic's convert. Default is raw binary image
  77 (\fB.r\fR).
  78
  79 .TP
  80 \fB-v\fR | \fB--version\fP
  81 Prints version information to standard output, then exits successfully.
  82
  83 .TP
  84 \fIfilename\fR
  85 Input image filename. Format may be: \fB.r\fR, \fB.hdf\fR (hdf), \fB.IMG\fR (davis),
  86 \fB.png\fR, \fB.gif\fR, \fB.tif\fR or\fB.bmp\fR.
  87
  88 .SH EXAMPLES
  89
  90 invoking: 'gpiv_process-chain -proc_valid -proc_scale testfile.png' will actually perform:
  91 gpiv_rr < image.png | gpiv_errvec > testfile.piv
  92
  93 invoking: 'gpiv_process-chain -proc_imgrec -proc_valid -proc_scale
  94 testfile.png' will do: gpiv_recimg | gpiv_rr | gpiv_errvec |
  95 gpiv_scale > testfile.piv
  96
  97 .SH SEE ALSO
  98 gpivtools
  99
 100 .SH AUTHOR
 101 Gerber Van der Graaf
 102