man/gpiv_series.1

   1 .TH GPIV_SERIES 1 "19 Januari 2005"
   2 .SH NAME
   3 gpiv_series \- Script for (parallel) processing a series of numbered files.
   4
   5 .SH SYNOPSIS
   6 \fBgpiv_series\fP
   7 [\fB-a\fR | \fB-\-arg_n\fR]
   8 [\fB-b\fR | \fB-\-basename \fIFILE\fR]
   9 [\fB-e\fR | \fB-\-ext\fR \fIext\fR]
  10 [\fB-f\fR | \fB-\-first \fIN\fR]
  11 [\fB-l\fR | \fB-\-last \fIN\fR]
  12 [\fB-i\fR | \fB-\-incr \fIN\fR]
  13 [\fB-x\fR|| \fB-\-prefix\fR]
  14 [\fB-h\fR | \fB-\-help\fR]
  15 [\fB-n\fR | \fB-\-none\fR]
  16 [\fB-p\fR | \fB-\-print\fR]
  17 [\fB-\-pad\fR]
  18 [\fb-s\fR | \fb-\-subst_fname\fR]
  19 \fB"\fR\fIprocess\fR \-key1 ...\fB"\fR
  20 .SH DESCRIPTION
  21
  22 \fBgpiv_series\fP processes a series of numbered files. If no parameters are
  23 defined at the command line, standard parameters will be used that are
  24 defined in the script. Principally, any program or script may be
  25 invoked by \fBgpiv_series\fP. "\fIProcess\fR" is a string which
  26 represents the name of the program to be executed, including
  27 eventually command line options and arguments. The file to be
  28 processed, as constructed from \fB-b\fR, \fB-i\fR and \fB-l\fR,
  29 will be appended to the "\fIprocess\fR" string. If the program has to be feeded
  30 with \-f "filename", write \-f at the end of the string. Instead of appending the
  31 filename to the "\fIprocess\fR" string, there is also a way substitute all occurences FNAME.
  32
  33 When using the parallelised version, mpipython is invoked and the script
  34 may be launched with mpirun. The script needs that all input files
  35 are accessible on each node by copying all data or by (NFS) mounting
  36 the File System containing the input data on each node.
  37
  38 This program does not use the parameter resources from libgpiv.
  39
  40 .SH Options
  41 .TP
  42 \fB-a\fR | \fB--arg_n\fR
  43 If the process needs the current number in its argument list instead
  44 of prepending/appending it to the \fIFILE\fR, the number will be
  45 put before (\fB-f\fR) filename in the "\fR\fIprocess\fR" string.
  46
  47 .TP
  48 \fB-b\fR | \fB-\-basename\fR \fIFILE\fR
  49 The \fIFILE\fR has to be given without its extension. \fIFILE\fR represents
  50 the file name without its number. It is supposed that the leading or ending
  51 number in the filename is the counter that will be applied by
  52 \fBgpiv_series\fR when processing.
  53
  54 .TP
  55 \fB-e\fR | \fB-\-ext\fR \fIEXT\fR
  56 add an extension \fIEXT\fR after the filename (without the leading ".") in
  57 "\fIprocess\fR".
  58
  59 .TP
  60 \fB-f\fR | \fB-\-first\fR \fIN\fR
  61 Defines the counter \fIN\fR of the number at which the analyses
  62 starts.  Default: 0.
  63
  64 .TP
  65 \fB-l\fR | \fB-\-last\fR \fIN\fR
  66 The last number \fIN\fR that will be processed. Default: 0.
  67
  68 .TP
  69 \fB-i\fR | \fB-\-incr\fR \fIN\fR
  70 Increment number with \fIN\fR. Default: 1. This might be usefull,
  71 for example, if subsequent numbered images are combined for
  72 cross-correlation with the \fBgpiv_img2gpiv\fR tool.
  73
  74 .TP
  75 \fB-x\fR | \fB-\-prefix\fR
  76 Use prefix numbering to file basename.
  77
  78 .TP
  79 \fB-h\fR | \fB-\-help\fR \fP
  80 On-line help.
  81
  82 .TP
  83 \fB-n\fR | \fB-\-none\fR \fP
  84 Suppresses real execution, only prints the process to stdout.
  85
  86 .TP
  87 \fB-p\fR | \fB-\-print\fR \fP
  88 Prints the process to be performed on each file to stdout.
  89
  90 .TP
  91 \fB-\-pad\fR  \fIN\fR
  92 Padding a number with \fIN\fR zero's when combining with the filename.
  93
  94 .TP
  95 \fb-s\fR | \fb-\-subst_fname\fR
  96 Substitutes all occurences \"FNAME\" in the "\fIprocess\fR" string by the actual
  97 file basename. The \fB-a\fR | \fB--arg_n\fR will be useless for this case.
  98
  99 .TP
 100 .SH SEE ALSO
 101 gpivtools
 102
 103 .SH NOTES
 104
 105 .SH AUTHOR
 106 Gerber Van der Graaf
 107
 108 .SH BUGS
 109 The parallelised script has only been tested with the LAM version of mpipython.