1osiv_dump(1) General Commands Manual osiv_dump(1)
2
3
4
6 osiv_dump - retrieves information from osiv data file
7
9 osiv_dump [-o output_file] FILE
10
11
13 osiv_dump is a program for extracting the arguments, vectors,
14 and correlation maps which are contained in an osiv data file.
15 The flags --vectors, --arguments, and --maps are used to con‐
16 trol which data is included in the output.
17
18
20 -o FILE
21 The text file to which the output should be written. If
22 this option is not used, then output is written to the
23 standard out by default.
24
25
26 -a --arguments
27 This flag causes the argument list stored in the data
28 file to be included in the output. The format of the
29 output is identical to the input format for osiv_corr.
30
31
32 -v --vectors
33 This flag causes the vector flow field stored in the
34 data file to be included in the output. The format of
35 the output is usually a set of four space-delimited col‐
36 umns, but the format can also be modified with the "-p"
37 option.
38
39
40 -m --maps
41 This flag causes the correlation maps stored in the data
42 file to be included in the output. The format of the
43 output is usually a set of three space-delimited col‐
44 umns, but the format can also be modified with the "-c"
45 option.
46
47
48 -f INTEGER
49 This flag is used to specify the range of frame numbers
50 for which vectors or correlation maps should be printed.
51 Ranges are specified with one of the following forms:
52 start, start:finish, or start:increment:finish. Nega‐
53 tive values for the increment or for the finish will
54 result in the use of default values for these fields.
55 By default, vectors from all frames are printed. The
56 frame number is specified as in the original osiv_corr
57 call.
58
59
60 -w INTEGER
61 This flag is used to specify the window number and is
62 set to zero by default. The window number is given in a
63 "row-major" format. In other words, the index is c+r*nc,
64 where c is the column, r is the row, and nc is the num‐
65 ber of columns in the grid.
66
67
68 -p FORMAT
69 The format for printing the vectors is specified using
70 conventions similiar to that of the C function printf.
71 The window grid is traversed row-wise and a call to
72 printf is made for every vector. The x position is spec‐
73 ified with `%x', the y position with `%y', the x dis‐
74 placement with `%u', and the y displacement with `%v'.
75 The default is `%06.1x %06.1y %+0.8u %+0.8v\n'.
76
77
78 -c FORMAT
79 The format for printing the correlation map is specified
80 using conventions similiar to that of the C function
81 printf. The map is traversed row-wise and a call to
82 printf is made for every element. The x displacement is
83 specified with `%u', the y displacement with `%v', and
84 the correlation value with `%e'. The default is `%+05.1u
85 %+05.1v %010.1e\n'.
86
87
88 --omit-fbreaks
89 This flag causes the output to occur without newlines
90 between subsequent frames. This is sometimes useful if
91 the output is intended to be parsed by another program.
92
93
94 --omit-headers
95 This flag causes the output to occur without headers.
96 This is often useful if the output is intended to be
97 parsed by another program.
98
99
100 --omit-newlines
101 This flag causes the output to occur without trailing
102 newlines. This is sometimes useful if the output is
103 intended to be parsed by another program.
104
105
107 Additional documentation can be found online at www.osiv.org.
108
109
111 osiv_corr(1), osiv_draw(1), osiv_tune(1), osiv_synth(1),
112 readovd(3).
113
114
116 No known bugs. Please report bugs as www.osiv.org.
117
118
120 Copyright © 2002 James Strother.
121
122
123
124 OSIV-2.0 osiv_dump(1)