1osiv_draw(1) General Commands Manual osiv_draw(1)
2
6 osiv_draw - visualize flow field data
7
10 osiv_draw [ -o output] [ -p file] [ -t type ] [vector file]
11
14 osiv_draw creates a vector map from the vectors represented in
15 the input text file. While osiv_draw will choose default val‐
16 ues for all parameters, an optional parameter allows the figure
17 to be fine-tuned. If no input file is specified, or if the
18 input file name is "-", data is read from standard in. Simi‐
19 larly, if no output file is specified, or if the output file
20 name is "-", data is written as an EPS to standard out.
21
24 -q In quiet mode, osiv_draw doesn't print out the parame‐
25 ters it chooses.
26 -o FILE
29 The file to which the graphic is written. This is either
30 an EPS file or an SVG file depending on the -t option.
31 -t TYPE
34 This is either the string "eps" or "svg", depending on
35 which type of file you would like to generate.
36 -p FILE
39 The name of a file from which parameters are read. The
40 same parameters can be specified either on the command
41 line or read from this file. The file is simply more
42 convienent for batch processing. The format of the file
43 is "variable = value", where each line is a new assign‐
44 ment. White space is ignored, blank lines are okay, and
45 commented lines begin with the "#" symbol. The variables
46 names which may be specified in the file are identical
47 to those which may be specified in the comand line.
48
51 Vectors are input into osiv_draw as a text file with a very
52 simple format: "x,y;u,v". Each vector receives its own line,
53 blank lines are allowed.
54
57 There are four types of parameters which can be assigned:
58 floating-point numbers, strings, colors, and types. Floating-
59 point numbers are assigned just as you would expect. Strings
60 should be quoted on the command line to preserve formatting.
61 Colors can be assigned either by name (see the online documen‐
62 tation for a list of named colors), or by RGB specification.
63 To specify the RGB value of a color, you should use the format
64 "rgb(red,green,blue)" where red, green, and blue are values
65 between 0.0 and 1.0. Types are specified by name, possible
66 values are listed for each variable below.
67 --arrow-scale FLOAT
70 The size of an arrow in points, for a vector with a mag‐
71 nitude of one. You should probably start with the value
72 osiv_draw calculates, and then modify it to taste.
73 --canvas-scale FLOAT
76 The number of points in the figure per spatial unit.
77 Roughly, this controls the overall size of the figure.
78 Let osiv_draw calculate a default value which you can
79 then modify.
80 --xrange-lower FLOAT
83 The lowest x value which is to be present in the figure.
84 --xrange-upper FLOAT
87 The greatest x value which is to be present in the fig‐
88 ure.
89 --yrange-lower FLOAT
92 The lowest y value which is to be present in the figure.
93 --yrange-upper FLOAT
96 The greatest y value which is to be present in the fig‐
97 ure.
98 --background-type TYPE
101 There are presently only two available types: none, and
102 solid.
103 --background-fill-color COLOR
106 The color of background, used only with a solid back‐
107 ground type.
108 --background-stroke-color COLOR
111 The color of outline around background, used only with a
112 solid background type.
113 --background-stroke-weight FLOAT
116 The width of the outline in points around the back‐
117 ground, used only with a solid background type.
118 --arrowhead-type TYPE
121 There are presently four available types: none, lines,
122 outline, and curvy. If the names aren't self-explana‐
123 tory, then try each one out.
124 --arrowhead-width FLOAT
127 The ratio of the arrowhead width to the total arrow
128 length.
129 --arrowhead-height FLOAT
132 The ratio of the arrowhead height to the total arrow
133 length.
134 --arrowhead-angle FLOAT
137 The angle in degrees at the back of the arrowhead. A
138 value of 90 causes an arrowhead with a flat back, and
139 values less than 90 cause it to curve inwardly.
140 --arrowhead-fill-color COLOR
143 The color of the arrowhead.
144 --arrowhead-stroke-color COLOR
147 The color of the arrowhead outline.
148 --arrowhead-stroke-weight FLOAT
151 The width in points of the arrowhead outline.
152 --arrowtail-type TYPE
155 There are currently three types available: none, line,
156 and block. The block is different then the line in that
157 it makes use of the fill argument, and the width scales
158 with the overall arrow size.
159 --arrowtail-width FLOAT
162 The ratio of the arrowtail width to total arrow length.
163 --arrowtail-fill-color COLOR
166 The color of the arrowtail fill.
167 --arrowtail-stroke-color COLOR
170 The color of the arrowtail outline.
171 --arrowtail-stroke-weight FLOAT
174 The width in points of the arrowtail outline.
175 --legend-type TYPE
178 There are currently two types available: none, and
179 solid.
180 --legend-placement TYPE
183 There are currently four types available: top_left,
184 top_right, bottom_left, and bottom_right.
185 --legend-horiz-margin FLOAT
188 The horizontal distance in points between the edge of
189 the figure and the edge of the legend.
190 --legend-vert-margin FLOAT
193 The vertical distance in points between the edge of the
194 figure and the edge of the legend.
195 --legend-horiz-inset FLOAT
198 The horizontal spacing in points between the components
199 of the legend.
200 --legend-vert-inset FLOAT
203 The vertical spacing in points between the components of
204 the legend.
205 --legend-fill-color COLOR
208 The color of the legend fill.
209 --legend-stroke-color COLOR
212 The color of the legend outline.
213 --legend-stroke-weight COLOR
216 The width in points of the legend outline.
217 --legend-arrow-length FLOAT
220 The magnitude of the arrow (in user coordinates) to be
221 represented in the legend.
222 --legend-arrow-label STRING
225 The string to be associated with the arrow.
226 --legend-arrow-label-font TYPE
229 The font for the label; possible values are: courier,
230 times, times_bold, times_italic, helvetica, hel‐
231 vetica_bold, helvetica_italic.
232 --legend-arrow-label-color COLOR
235 The color for the label.
236 --legend-arrow-label-size FLOAT
239 The size of the font in points.
240 --legend-arrowhead-type TYPE
243 Same as above, just as it pertains to the legend.
244 --legend-arrowhead-width FLOAT
247 Same as above, just as it pertains to the legend.
248 --legend-arrowhead-height FLOAT
251 Same as above, just as it pertains to the legend.
252 --legend-arrowhead-angle FLOAT
255 Same as above, just as it pertains to the legend.
256 --legend-arrowhead-fill-color COLOR
259 Same as above, just as it pertains to the legend.
260 --legend-arrowhead-stroke-color COLOR
263 Same as above, just as it pertains to the legend.
264 --legend-arrowhead-stroke-weight FLOAT
267 Same as above, just as it pertains to the legend.
268 --legend-arrowtail-type TYPE
271 Same as above, just as it pertains to the legend.
272 --legend-arrowtail-width FLOAT
275 Same as above, just as it pertains to the legend.
276 --legend-arrowtail-fill-color COLOR
279 Same as above, just as it pertains to the legend.
280 --legend-arrowtail-stroke-color COLOR
283 Same as above, just as it pertains to the legend.
284 --legend-arrowtail-stroke-weight FLOAT
287 Same as above, just as it pertains to the legend.
288 --legend-ruler-length FLOAT
291 The length of the ruler (in user coordinates) to be rep‐
292 resented in the legend.
293 --legend-ruler-label STRING
296 The string to be associated with the ruler.
297 --legend-ruler-label-font TYPE
300 The font used for the label; possible values are:
301 courier, times, times_bold, times_italic, helvetica,
302 helvetica_bold, helvetica_italic.
303 --legend-ruler-label-color COLOR
306 The color of the string.
307 --legend-ruler-label-size FLOAT
310 The size of the font in points.
311 --legend-ruler-width FLOAT
314 The ratio of the width of the ruler to its overall
315 length.
316 --legend-ruler-fill-color COLOR
319 The color of the ruler fill.
320 --legend-ruler-stroke-color COLOR
323 The color of the ruler outline.
324 --legend-ruler-stroke-weight FLOAT
327 The width in points of the ruler outline.
328
331 Additional documentation can be found online at www.osiv.org.
332
335 osiv_corr(1), osiv_dump(1), osiv_tune(1), osiv_synth(1),
336 readovd(3).
337
340 No known bugs. Please report bugs as www.osiv.org.
341
344 Copyright © 2003-2005 James Strother.
345 OSIV-2.0 osiv_draw(1)