man/gpiv_img2gpiv.1

   1 .TH GPIV_IMG2GPIV 1 "19 Januari 2005"
   2 .SH NAME
   3 gpiv_img2gpiv \- Converts images into raw data (extension .r) format with the
   4 belonging ASCII header file (extension .h) or into the hdf format
   5 (extension .hdf).
   6
   7 .SH SYNOPSIS
   8
   9 \fBgpiv_img2gpiv\fP
  10 [\fB-x\fR | \fB--cross\fR]
  11 [\fB-c\fR | \fB--cols\fR \fIncolumns\fR]
  12 [\fB--combine\fR]
  13 [\fB-h\fR | \fB--help\fR]
  14 [\fB-hdf\fR]
  15 [\fB--suf_a\fR \fIEXT\fR]
  16 [\fB--suf_b\fR \fIEXT\fR]
  17 [\fB--suf_num\fR \fIN\fR]
  18 [\fB-i\fR | \fB--inverse\fR]
  19 [\fB-n\fR]
  20 [\fB-p\fR]
  21 [\fB-r\fR | \fB--rows \fInrows\fR]
  22 [\fB-t\fR]
  23 [\fB-v\fR | \fB--version\fR] file_base_name
  24 \fP
  25
  26 .SH DESCRIPTION
  27
  28 \fBgpiv_img2gpiv\fP converts images from a common image format (gif, tif etc)
  29 into a raw data image with extension \fB.r\fR. Additionally, it generates
  30 an ASCII header file (extension \fB.h\fR). This header contains information
  31 concerning image dimensions, color depth, single or double image (for
  32 auto or cross-correlation), time and spatial scales, position of
  33 pixel# (0, 0) in the experiment and some additional (non-required)
  34 parameters.
  35
  36 \fIgpiv_img2gpiv\fP may also convert to hdf formatted images, with extension
  37 \fB.hdf\fR, that might be used by gpiv.
  38
  39 This program does not use the parameter resources from libgpiv. The
  40 default settings may be overruled by the command line options, as
  41 explained below.
  42
  43 .SH Options
  44 .TP
  45 .TP
  46 \fB-c\fR | \fB--cols\fR \fIncolumns\fR
  47 The number of columns of the image (default 1280).
  48
  49 .TP
  50 \fB--combine\fR
  51 If the images have been obtained separately, but will have to be used
  52 for cross-correlation, they will be combined to a single image
  53 file for interrogating with \fBgpiv_rr\fR (or \fBgpiv\fR).
  54 See also \fB--suf_a/b\fR and \fB--suf_num\fR.
  55
  56 .TP
  57 \fB-h\fR | \fB--help\fR
  58 On-line help.
  59
  60 .TP
  61 \fB-hdf
  62 Converts to (or from) hdf formatted data (extension \fB.hdf\fR).
  63
  64 .TP
  65 \fB-i\fR | \fB--inverse\fR
  66 Inverse conversion; from raw 8-bit data to image format.
  67
  68 .TP
  69 \fB--suf_a\fR \fIEXT\fR
  70 In combination with \fB--combine\fR: the file_base_name of the first
  71 frame to be combined is extended with suffix \fIEXT\fR (default: _a).
  72
  73 .TP
  74 \fB--suf_b\fR \fIEXT\fR
  75 In combination with \fB--combine\fR: the file_base_name of the second
  76 frame to be combined is extended with suffix \fIEXT\fR (default: _b).
  77
  78 .TP
  79 \fB--suf_num\fR \fIN\fR
  80 In combination with \fB--combine\fR: If images are numbered instead of
  81 with \fB--suf_a\fR and \fB--suf_b\fR. \fIN\fR represents the first of
  82 the two numbered frames which will be combined with frame \fIN\fR +
  83 1. The combined image will be named to file_base_name\fIN\fR\fB.r\fR.
  84 So, only odd or even numbered images will result to be loaded in
  85 \fBgpiv_rr\fR (or \fBgpiv\fR) for cross-correlation.
  86
  87 .TP
  88 \fB-n\fR
  89 No execute, only print processes.
  90
  91 .TP
  92 \fB-p\fR
  93 Prints process to stdout.
  94
  95 .TP
  96 \fB-r\fR | \fB--rows
  97 \fInrows\fR The number of rows in the frame of a SINGLE image (default 1024).
  98 An image frame containing a PIV pair of
  99 images (to be used for cross-correlation) should have the double amount
 100 of rows; from row #0 to row #\fInrows\fR - 1 contains the first image
 101 and from row #\fInrows\fR to row #2x\fInrows\fR - 1 contains the
 102 second image.
 103
 104 .TP
 105 \fB-t\fR
 106 Image type or format (default bmp).
 107
 108 .TP
 109 \fB-v\fR | \fB--version\fR
 110 Print version information on standard output, then exit successfully.
 111
 112 .TP
 113 \fB-x\fR | \fB--cross\fR
 114 Double image for cross-correlation (default: single image for
 115 auto-correlation).
 116
 117 .SH SEE ALSO
 118 gpivtools
 119
 120 .SH NOTES
 121 The program uses \fBconvert\fR.
 122
 123 .SH AUTHOR
 124 Gerber Van der Graaf