man/gpiv_combing.1

   1 .TH GPIV_COMBING 1 "31 October 2006"
   2 .SH NAME
   3
   4 gpiv_combing \- Combines two single-exposed images into one image file
   5 for cross-correlation.
   6
   7 .SH SYNOPSIS
   8
   9 \fBgpiv_combing\fP
  10 [\fB-a\fR | \fB--suf_a\fR \fIS\fR]
  11 [\fB-b\fR | \fB--suf_b\fR \fIS\fR]
  12 [\fB-d\fR | \fB--dt\fR \fIS\fR]
  13 [\fB-h\fR | \fB--help\fR]
  14 [\fB-p\fR | \fB--print\fR]
  15 [\fB-s\fR | \fB--skip\fR \fIS\fR]
  16 [\fB-t\fR | \fB--type]
  17 [\fB-u\fR | \fB--suf_num\fR \fIM\fR]
  18 [\fB-U\fR | \fB--Suf_num\fR \fIM\fR]
  19 [\fB-v\fR | \fB--version\fR]
  20 [\fB-V\fR | \fB--verbose\fR]
  21 [\fB-w\fR | \fB--warning\fR]
  22 \fIfile_basename\fR
  23 \fP
  24
  25 .SH DESCRIPTION
  26
  27 \fBgpiv_combing\fP combines two images from a common image format that
  28 use lossless compressing schemes into a Portable Network Graphics
  29 image with extension \fB.png\fR. The resulting \'double frame\' image
  30 is used for cross-correlation with \fBgpiv_rr\fR (or
  31 \fBgpiv\fR). Additional information is added to the image header, like
  32 the parameter for enabling cross correlation, separation time between
  33 the recordings of the two images and the name of this program.
  34
  35 This program uses the \fBIMG\fR configuration parameters. As the input
  36 images are single-frame and will probably not contain the required
  37 X_corr parameter in its header, the IMG.X_corr setting will have to be
  38 set to 0 for the correct loading.
  39
  40 The default settings may be overruled by the command line options, as
  41 explained below.
  42
  43 .SH Options
  44 .TP
  45 \fB-h\fR | \fB--help\fR
  46 On-line help.
  47
  48 .TP
  49 \fB-a\fR | \fB--suf_a\fR \fIS\fR
  50 The filename of the first image is generated from the file_basename,
  51 the suffix \fIS\fR (default: _a) and from the image extension type.
  52
  53 .TP
  54 \fB-b\fR | \fB--suf_b\fR \fIS\fR
  55 The filename of the second image is generated from the file_basename,
  56 the suffix \fIS\fR (default: _b) and from the image extension type.
  57
  58 .TP
  59 \fB-d\fR | \fB--dt\fR \fIS\fR
  60 The time between subsequent images in milliseconds. The value will be
  61 written to the image header. If \fB-s\fR | \fB--skip\fR is used, the
  62 separation time will be adapted to the correct value.
  63
  64 .TP
  65 \fB-p\fR | \fB--print\fR
  66 Prints parameters to stdout.
  67
  68 .TP
  69 \fB-s\fR | \fB--skip \fIS\fR
  70 Skip \fIS\fR numbers; the first image with number \fIN\fR (defined by
  71 \fB-u\fR | \fB--suf_num \fIN\fR) will be combined with the second image
  72 N+S+1 (default: \fIS\fR = 0)
  73
  74 .TP
  75 \fB-t\fR | \fB--type
  76 Type or format of the input image (default png). Supported formats are: raw
  77 binary (r), hdf5 (gpi), gif, tif, bmp and pgm. The format of the output
  78 image will always be png.
  79
  80 .TP
  81 \fB-u\fR | \fB--suf_num\fR \fIM\fR
  82 If images are numbered instead of having suffixes \fB_a\fR and \fB_b\fR. \fIM\fR
  83 represents the first of the two numbered frames which will be combined
  84 with frame \fIM\fR + 1. The combined image will be named to
  85 file_basename\fIM\fR\fB.png\fR.  So, only odd or even numbered images
  86 will result to be loaded in \fBgpiv_rr\fR (or \fBgpiv\fR) for
  87 cross-correlation.
  88
  89 .TP
  90 \fB-U\fR | \fB--Suf_num\fR \fIM\fR
  91 Same as \fB-u\fR | \fB--suf_num\fR \fIM\fR, but with the difference that the
  92 output image will be called file_basename\fIM\fR-\fIN\fR.\fBpng\fR, where \fIN\fR
  93 is the number of the second image (default: \fIM\fR + 1).
  94
  95 .TP
  96 \fB-v\fR | \fB--version\fR
  97 Print version information on standard output, then exit successfully.
  98
  99 .TP
 100 \fB-V\fR | \fB--verbose\fR
 101 Program behaves verbose during operation, like printing filenames, separation
 102 time.
 103
 104 .TP
 105 \fB-w\fR | \fB--warning\fR
 106 Checks and warns if one of the two input images already contain an
 107 image pair, i.e. the header parameter X-corr is set TRUE. The program
 108 will exit if this is the case. Besides this warning, the program will
 109 always check if the images are of equal sizes. If an input image does
 110 not contain the X-corr parameter in its header, the parameter will be
 111 read from the parameter resources. Not using this option allows to
 112 keep the settings in the parameter resources in any state.
 113
 114
 115 .TP
 116 \fIfile_basename\fR
 117 The filename without the image extension (like .png, .tif etc) and
 118 suffix or number.
 119
 120 .TP
 121 .SH Examples
 122
 123 .TP
 124 Suppose two single-exposed images will have to be combined for cross-correlation with names image_a.gif and image_b.gif: so the file_basename will be "image", _a and _b are default suffixes and the image type has to be defined. The program is used following:
 125 gpiv_combing -t gif image
 126
 127 .TP
 128 As PNG is default image format, -t key is not needed. Two images with names turtle_slow.png and turtle_fast.png are combined with:
 129 gpiv_combing -a _slow -b _fast turtle
 130
 131
 132 .TP
 133 For two numbered images img03.png and img04.png only the starting number will have to defined:
 134 .br
 135 gpiv_combing -u 3 img0
 136
 137 .TP
 138 Two numbered images img03.png and img09.png will have to be combined by skipping 5 images in-between. If \fB-d\fR | \fB--dt\fR \fIS\fR is used, the correct separation time between the combined frames is calculated from \fIS\fR:
 139 gpiv_combing -u 3 -s 5 img0
 140 .br
 141
 142 .TP
 143
 144 .SH SEE ALSO
 145 gpivtools
 146
 147 .SH NOTES
 148 The program uses \fBnetpbm\fR.
 149
 150 .SH AUTHOR
 151 Gerber Van der Graaf