NAME
osiv_draw - render vector data
SYNOPSIS
osiv_draw [-q ] [-o output]
[-p params] [-t type] [file]
DESCRIPTION
osiv_draw creates a vector map from the
vectors represented in the input text file. While osiv_draw
will choose default values for all parameters, an optional
parameter allows the figure to be fine-tuned. If no input file is
specified, or if the input file name is "-", data is read from
standard in. Similarly, if no output file is specified, or if the
output file name is "-", data is written as an EPS to standard out.
OPTIONS
- -q
- In quiet mode, osiv_draw doesn't print out the
parameters it chooses.
- -o - output file name
- This is either an EPS file or an SVG file depending on the -t
option.
- -t - output type
- This is either eps or svg, depending on which type of file you
would like to generate.
- -p - parameter file name
- The look of the output figure can be modified by specifying a
file from which various parameters can be read. The format of the
file is "variable = value", where each line is a new assignment.
Whitespace is ignored, blank lines are okay. The variables which
can be specified in the file are identical to the options described
below.
VECTOR FILE
Vectors are input into osiv_draw as a
text file with a very simple format: "x,y;u,v". Each vector
receives its own line, blank lines are allowed.
PARAMETERS
There are four types of parameters which can be
assigned: floating-point numbers, strings, colors, and types.
Floating-point numbers are assigned just as you would expect.
Strings should be quoted on the command line to preserve
formatting. Colors can be assigned either by name (see the online
documentation for a list of named colors), or by RGB specification.
To specify the RGB value of a color, you should use the format
"rgb(red,green,blue)" where red, green, and blue are values between
0.0 and 1.0. Types are specified by name, possible values are
listed for each variable below.
- --arrow_scale=FLOAT
- The size of an arrow in points, for a vector with a magnitude
of one. You should probably start with the value osiv_draw
calculates, and then modify it to taste.
- --canvas_scale=FLOAT
- The number of points in the figure per spatial unit. Roughly,
this controls the overall size of the figure. Let osiv_draw
calculate a default value which you can then modify.
- --xrange_lower=FLOAT
- The lowest x value which is to be present in the figure.
- --xrange_upper=FLOAT
- The greatest x value which is to be present in the figure.
- --yrange_lower=FLOAT
- The lowest y value which is to be present in the figure.
- --yrange_upper=FLOAT
- The greatest y value which is to be present in the figure.
- --background_type=TYPE
- There are presently only two available types: none, and solid.
- --background_fill_color=COLOR
- The color of background, used only with a solid background
type.
- --background_stroke_color=COLOR
- The color of outline around background, used only with a solid
background type.
- --background_stroke_weight=FLOAT
- The width of the outline in points around the background, used
only with a solid background type.
- --arrowhead_type=TYPE
- There are presently four available types: none, lines, outline,
and curvy. If the names aren't self-explanatory, then try each one
out.
- --arrowhead_width=FLOAT
- The ratio of the arrowhead width to the total arrow length.
- --arrowhead_height=FLOAT
- The ratio of the arrowhead height to the total arrow length.
- --arrowhead_angle=FLOAT
- The angle in degrees at the back of the arrowhead. A value of
90 causes an arrowhead with a flat back, and values less than 90
cause it to curve inwardly.
- --arrowhead_fill_color=COLOR
- The color of the arrowhead.
- --arrowhead_stroke_color=COLOR
- The color of the arrowhead outline.
- --arrowhead_stroke_weight=FLOAT
- The width in points of the arrowhead outline.
- --arrowtail_type=TYPE
- There are currently three types available: none, line, and
block. The block is different then the line in that it makes use of
the fill argument, and the width scales with the overall arrow
size.
- --arrowtail_width=FLOAT
- The ratio of the arrowtail width to total arrow length.
- --arrowtail_fill_color=COLOR
- The color of the arrowtail fill.
- --arrowtail_stroke_color=COLOR
- The color of the arrowtail outline.
- --arrowtail_stroke_weight=FLOAT
- The width in points of the arrowtail outline.
- --legend_type=TYPE
- There are currently two types available: none, and solid.
- --legend_placement=TYPE
- There are currently four types available: top_left, top_right,
bottom_left, and bottom_right.
- --legend_horiz_margin=FLOAT
- The horizontal distance in points between the edge of the
figure and the edge of the legend.
- --legend_vert_margin=FLOAT
- The vertical distance in points between the edge of the figure
and the edge of the legend.
- --legend_horiz_inset=FLOAT
- The horizontal spacing in points between the components of the
legend.
- --legend_vert_inset=FLOAT
- The vertical spacing in points between the components of the
legend.
- --legend_fill_color=COLOR
- The color of the legend fill.
- --legend_stroke_color=COLOR
- The color of the legend outline.
- --legend_stroke_weight=COLOR
- The width in points of the legend outline.
- --legend_arrow_length=FLOAT
- The magnitude of the arrow (in user coordinates) to be
represented in the legend.
- --legend_arrow_label=STRING
- The string to be associated with the arrow.
- --legend_arrow_label_font=TYPE
- The font for the label; possible values are: courier, times,
times_bold, times_italic, helvetica, helvetica_bold,
helvetica_italic.
- --legend_arrow_label_color=COLOR
- The color for the label.
- --legend_arrow_label_size=FLOAT
- The size of the font in points.
- --legend_arrowhead_type=TYPE
- Same as above, just as it pertains to the legend.
- --legend_arrowhead_width=FLOAT
- Same as above, just as it pertains to the legend.
- --legend_arrowhead_height=FLOAT
- Same as above, just as it pertains to the legend.
- --legend_arrowhead_angle=FLOAT
- Same as above, just as it pertains to the legend.
- --legend_arrowhead_fill_color=COLOR
- Same as above, just as it pertains to the legend.
- --legend_arrowhead_stroke_color=COLOR
- Same as above, just as it pertains to the legend.
- --legend_arrowhead_stroke_weight=FLOAT
- Same as above, just as it pertains to the legend.
- --legend_arrowtail_type=TYPE
- Same as above, just as it pertains to the legend.
- --legend_arrowtail_width=FLOAT
- Same as above, just as it pertains to the legend.
- --legend_arrowtail_fill_color=COLOR
- Same as above, just as it pertains to the legend.
- --legend_arrowtail_stroke_color=COLOR
- Same as above, just as it pertains to the legend.
- --legend_arrowtail_stroke_weight=FLOAT
- Same as above, just as it pertains to the legend.
- --legend_ruler_length=FLOAT
- The length of the ruler (in user coordinates) to be represented
in the legend.
- --legend_ruler_label=STRING
- The string to be associated with the ruler.
- --legend_ruler_label_font=TYPE
- The font used for the label; possible values are: courier,
times, times_bold, times_italic, helvetica, helvetica_bold,
helvetica_italic.
- --legend_ruler_label_color=COLOR
- The color of the string.
- --legend_ruler_label_size=FLOAT
- The size of the font in points.
- --legend_ruler_width=FLOAT
- The ratio of the width of the ruler to its overall length.
- --legend_ruler_fill_color=COLOR
- The color of the ruler fill.
- --legend_ruler_stroke_color=COLOR
- The color of the ruler outline.
- --legend_ruler_stroke_weight=FLOAT
- The width in points of the ruler outline.
SEE ALSO
osiv(1),
osiv_getargs(1),
osiv_getvects(1),
osiv_getmap(1),
osiv_mkwsd(1),
readovd(1).
BUGS
Let me know, my email address is jamesas@uclink.berkeley.edu.
COPYRIGHT NOTICE
Copyright © 2002 James Strother.