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