1osiv_draw(1) General Commands Manual osiv_draw(1)
2
6 osiv_draw - render vector data
7
9 osiv_draw [-q ] [-o output] [-p params] [-t type] [file]
10
12 osiv_draw creates a vector map from the vectors represented in
13 the input text file. While osiv_draw will choose default val‐
14 ues for all parameters, an optional parameter allows the figure
15 to be fine-tuned. If no input file is specified, or if the
16 input file name is "-", data is read from standard in. Simi‐
17 larly, if no output file is specified, or if the output file
18 name is "-", data is written as an EPS to standard out.
19
21 -q In quiet mode, osiv_draw doesn't print out the parame‐
22 ters it chooses.
23 -o - output file name
25 This is either an EPS file or an SVG file depending on
26 the -t option.
27 -t - output type
29 This is either eps or svg, depending on which type of
30 file you would like to generate.
31 -p - parameter file name
33 The look of the output figure can be modified by speci‐
34 fying a file from which various parameters can be read.
35 The format of the file is "variable = value", where each
36 line is a new assignment. Whitespace is ignored, blank
37 lines are okay. The variables which can be specified in
38 the file are identical to the options described below.
39
41 Vectors are input into osiv_draw as a text file with a very
42 simple format: "x,y;u,v". Each vector receives its own line,
43 blank lines are allowed.
44
46 There are four types of parameters which can be assigned:
47 floating-point numbers, strings, colors, and types. Floating-
48 point numbers are assigned just as you would expect. Strings
49 should be quoted on the command line to preserve formatting.
50 Colors can be assigned either by name (see the online documen‐
51 tation for a list of named colors), or by RGB specification.
52 To specify the RGB value of a color, you should use the format
53 "rgb(red,green,blue)" where red, green, and blue are values
54 between 0.0 and 1.0. Types are specified by name, possible
55 values are listed for each variable below.
56 --arrow_scale=FLOAT
58 The size of an arrow in points, for a vector with a mag‐
59 nitude of one. You should probably start with the value
60 osiv_draw calculates, and then modify it to taste.
61 --canvas_scale=FLOAT
63 The number of points in the figure per spatial unit.
64 Roughly, this controls the overall size of the figure.
65 Let osiv_draw calculate a default value which you can
66 then modify.
67 --xrange_lower=FLOAT
69 The lowest x value which is to be present in the figure.
70 --xrange_upper=FLOAT
72 The greatest x value which is to be present in the fig‐
73 ure.
74 --yrange_lower=FLOAT
76 The lowest y value which is to be present in the figure.
77 --yrange_upper=FLOAT
79 The greatest y value which is to be present in the fig‐
80 ure.
81 --background_type=TYPE
83 There are presently only two available types: none, and
84 solid.
85 --background_fill_color=COLOR
87 The color of background, used only with a solid back‐
88 ground type.
89 --background_stroke_color=COLOR
91 The color of outline around background, used only with a
92 solid background type.
93 --background_stroke_weight=FLOAT
95 The width of the outline in points around the back‐
96 ground, used only with a solid background type.
97 --arrowhead_type=TYPE
99 There are presently four available types: none, lines,
100 outline, and curvy. If the names aren't self-explana‐
101 tory, then try each one out.
102 --arrowhead_width=FLOAT
104 The ratio of the arrowhead width to the total arrow
105 length.
106 --arrowhead_height=FLOAT
108 The ratio of the arrowhead height to the total arrow
109 length.
110 --arrowhead_angle=FLOAT
112 The angle in degrees at the back of the arrowhead. A
113 value of 90 causes an arrowhead with a flat back, and
114 values less than 90 cause it to curve inwardly.
115 --arrowhead_fill_color=COLOR
117 The color of the arrowhead.
118 --arrowhead_stroke_color=COLOR
120 The color of the arrowhead outline.
121 --arrowhead_stroke_weight=FLOAT
123 The width in points of the arrowhead outline.
124 --arrowtail_type=TYPE
126 There are currently three types available: none, line,
127 and block. The block is different then the line in that
128 it makes use of the fill argument, and the width scales
129 with the overall arrow size.
130 --arrowtail_width=FLOAT
132 The ratio of the arrowtail width to total arrow length.
133 --arrowtail_fill_color=COLOR
135 The color of the arrowtail fill.
136 --arrowtail_stroke_color=COLOR
138 The color of the arrowtail outline.
139 --arrowtail_stroke_weight=FLOAT
141 The width in points of the arrowtail outline.
142 --legend_type=TYPE
144 There are currently two types available: none, and
145 solid.
146 --legend_placement=TYPE
148 There are currently four types available: top_left,
149 top_right, bottom_left, and bottom_right.
150 --legend_horiz_margin=FLOAT
152 The horizontal distance in points between the edge of
153 the figure and the edge of the legend.
154 --legend_vert_margin=FLOAT
156 The vertical distance in points between the edge of the
157 figure and the edge of the legend.
158 --legend_horiz_inset=FLOAT
160 The horizontal spacing in points between the components
161 of the legend.
162 --legend_vert_inset=FLOAT
164 The vertical spacing in points between the components of
165 the legend.
166 --legend_fill_color=COLOR
168 The color of the legend fill.
169 --legend_stroke_color=COLOR
171 The color of the legend outline.
172 --legend_stroke_weight=COLOR
174 The width in points of the legend outline.
175 --legend_arrow_length=FLOAT
177 The magnitude of the arrow (in user coordinates) to be
178 represented in the legend.
179 --legend_arrow_label=STRING
181 The string to be associated with the arrow.
182 --legend_arrow_label_font=TYPE
184 The font for the label; possible values are: courier,
185 times, times_bold, times_italic, helvetica, hel‐
186 vetica_bold, helvetica_italic.
187 --legend_arrow_label_color=COLOR
189 The color for the label.
190 --legend_arrow_label_size=FLOAT
192 The size of the font in points.
193 --legend_arrowhead_type=TYPE
195 Same as above, just as it pertains to the legend.
196 --legend_arrowhead_width=FLOAT
198 Same as above, just as it pertains to the legend.
199 --legend_arrowhead_height=FLOAT
201 Same as above, just as it pertains to the legend.
202 --legend_arrowhead_angle=FLOAT
204 Same as above, just as it pertains to the legend.
205 --legend_arrowhead_fill_color=COLOR
207 Same as above, just as it pertains to the legend.
208 --legend_arrowhead_stroke_color=COLOR
210 Same as above, just as it pertains to the legend.
211 --legend_arrowhead_stroke_weight=FLOAT
213 Same as above, just as it pertains to the legend.
214 --legend_arrowtail_type=TYPE
216 Same as above, just as it pertains to the legend.
217 --legend_arrowtail_width=FLOAT
219 Same as above, just as it pertains to the legend.
220 --legend_arrowtail_fill_color=COLOR
222 Same as above, just as it pertains to the legend.
223 --legend_arrowtail_stroke_color=COLOR
225 Same as above, just as it pertains to the legend.
226 --legend_arrowtail_stroke_weight=FLOAT
228 Same as above, just as it pertains to the legend.
229 --legend_ruler_length=FLOAT
231 The length of the ruler (in user coordinates) to be rep‐
232 resented in the legend.
233 --legend_ruler_label=STRING
235 The string to be associated with the ruler.
236 --legend_ruler_label_font=TYPE
238 The font used for the label; possible values are:
239 courier, times, times_bold, times_italic, helvetica,
240 helvetica_bold, helvetica_italic.
241 --legend_ruler_label_color=COLOR
243 The color of the string.
244 --legend_ruler_label_size=FLOAT
246 The size of the font in points.
247 --legend_ruler_width=FLOAT
249 The ratio of the width of the ruler to its overall
250 length.
251 --legend_ruler_fill_color=COLOR
253 The color of the ruler fill.
254 --legend_ruler_stroke_color=COLOR
256 The color of the ruler outline.
257 --legend_ruler_stroke_weight=FLOAT
259 The width in points of the ruler outline.
260
263 osiv(1), osiv_getargs(1), osiv_getvects(1),
264 osiv_getmap(1), osiv_mkwsd(1), readovd(1).
265
267 Let me know, my email address is jamesas@uclink.berkeley.edu.
268
270 Copyright © 2002 James Strother.
271 local osiv_draw(1)